Requests | Request Type

Service to manage entities of type 'RequestType'.

Overview

api/{tenantKey}/{orgKey}/requests/requestTypes

URL	api/{tenantKey}/{orgKey}/requests/requestTypes
Methods Supported	GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

GET:
POST:
- POST RequestTypes
PUT:
DELETE:
- DELETE RequestType by identifier
- DELETE RequestType by key

All Resources

This service uses the following resources:

ApiRequestTypeResource
RequestTypeResource
ExtensibilityCustomAttributeValueResource

GET Operations

GET RequestTypes (odata)

Returns a page of the list of all the entity records available.

The following elements are optional:

opts	(ODataQueryOptions) OData query option.

Response:

When successful, the response body contains the list of records available. See RequestTypeResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/requests/requestTypes/odata

GET /requests/requestTypes/odata

GET RequestType by identifier

Returns the entity record that matches the specified identifier.

The following elements are required:

id	(string) The record identifier.

Response:

When successful, the response body contains the entity record. See RequestTypeResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/requests/requestTypes/{id}

GET /requests/requestTypes/{id}

GET RequestType by key

Returns the entity record that matches the specified key.

The following elements are required:

requestTypeKey

(string) Request Type.

Response:

When successful, the response body contains the entity record. See RequestTypeResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/requests/requestTypes/{requestTypeKey}

GET /requests/requestTypes/{requestTypeKey}

POST Operations

POST RequestTypes

Creates a new entity record.

The following elements are required:

requestTypeResource

(ApiRequestTypeResource) The request body should contain the entity record that should be created.
See ApiRequestTypeResource.

The following elements are optional:

customAttributes

(JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity.
The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName".
While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required.

Response:

When successful, the response body contains the new entity record identifier. The resource header location property contains the URL for the new entity record. See ApiRequestTypeResource.

Response status codes:

201	Created. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/requests/requestTypes

POST /requests/requestTypes

PUT Operations

PUT Set CreateWithoutAsset RequestType

Updates the value of attribute 'CreateWithoutAsset' in the specified entity record.

The following elements are required:

requestTypeKey	(string) Request Type.
value	(bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/requests/requestTypes/{requestTypeKey}/createWithoutAsset

PUT /requests/requestTypes/{requestTypeKey}/createWithoutAsset

PUT Set Description RequestType

Updates the value of attribute 'Description' in the specified entity record.

The following elements are required:

requestTypeKey	(string) Request Type.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/requests/requestTypes/{requestTypeKey}/description

PUT /requests/requestTypes/{requestTypeKey}/description

PUT Set GenerateWO RequestType

Updates the value of attribute 'GenerateWO' in the specified entity record.

The following elements are required:

requestTypeKey	(string) Request Type.
value	(bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/requests/requestTypes/{requestTypeKey}/generateWO

PUT /requests/requestTypes/{requestTypeKey}/generateWO

PUT Set IsActive RequestType

Updates the value of attribute 'IsActive' in the specified entity record.

The following elements are required:

requestTypeKey	(string) Request Type.
value	(bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/requests/requestTypes/{requestTypeKey}/isActive

PUT /requests/requestTypes/{requestTypeKey}/isActive

PUT Set IsDefault RequestType

Updates the value of attribute 'IsDefault' in the specified entity record.

The following elements are required:

requestTypeKey	(string) Request Type.
value	(bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/requests/requestTypes/{requestTypeKey}/isDefault

PUT /requests/requestTypes/{requestTypeKey}/isDefault

PUT Set MaintenancePlan RequestType

Updates the value of attribute 'MaintenancePlan' in the specified entity record.

The following elements are required:

requestTypeKey	(string) Request Type.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/requests/requestTypes/{requestTypeKey}/maintenancePlan

PUT /requests/requestTypes/{requestTypeKey}/maintenancePlan

PUT Set PriorityLevel RequestType

Updates the value of attribute 'PriorityLevel' in the specified entity record.

The following elements are required:

requestTypeKey	(string) Request Type.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/requests/requestTypes/{requestTypeKey}/priorityLevel

PUT /requests/requestTypes/{requestTypeKey}/priorityLevel

PUT Set Remarks RequestType

Updates the value of attribute 'Remarks' in the specified entity record.

The following elements are required:

requestTypeKey	(string) Request Type.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/requests/requestTypes/{requestTypeKey}/remarks

PUT /requests/requestTypes/{requestTypeKey}/remarks

PUT Set RemarksTemplate RequestType

Updates the value of attribute 'RemarksTemplate' in the specified entity record.

The following elements are required:

requestTypeKey	(string) Request Type.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/requests/requestTypes/{requestTypeKey}/remarksTemplate

PUT /requests/requestTypes/{requestTypeKey}/remarksTemplate

PUT Set RequesterClosingRequired RequestType

Updates the value of attribute 'RequesterClosingRequired' in the specified entity record.

The following elements are required:

requestTypeKey	(string) Request Type.
value	(bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/requests/requestTypes/{requestTypeKey}/requesterClosingRequired

PUT /requests/requestTypes/{requestTypeKey}/requesterClosingRequired

PUT Set RequestTypeKey RequestType

Updates the value of attribute 'RequestTypeKey' in the specified entity record.

The following elements are required:

requestTypeKey	(string) Request Type.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/requests/requestTypes/{requestTypeKey}/requestTypeKey

PUT /requests/requestTypes/{requestTypeKey}/requestTypeKey

PUT Set WorkOrderType RequestType

Updates the value of attribute 'WorkOrderType' in the specified entity record.

The following elements are required:

requestTypeKey	(string) Request Type.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/requests/requestTypes/{requestTypeKey}/workOrderType

PUT /requests/requestTypes/{requestTypeKey}/workOrderType

PUT Set Workshop RequestType

Updates the value of attribute 'Workshop' in the specified entity record.

The following elements are required:

requestTypeKey	(string) Request Type.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/requests/requestTypes/{requestTypeKey}/workshop

PUT /requests/requestTypes/{requestTypeKey}/workshop

PUT Set Custom Attribute RequestType

Updates the value of 'CustomAttribute' in the specified entity record.

The following elements are required:

requestTypeKey	(string) Request Type
customAttributeName	(string) The custom attribute name.
value	(ExtensibilityCustomAttributeValueResource) The request body should contain the new value for the custom attribute. See ExtensibilityCustomAttributeValueResource.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/requests/requestTypes/{requestTypeKey}/{customAttributeName}

PUT /requests/requestTypes/{requestTypeKey}/{customAttributeName}

DELETE Operations

DELETE RequestType by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

id	(string) The record identifier.

Response:

When successful, the response body is empty.

Response status codes:

204	Deleted. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/requests/requestTypes/{id}

DELETE /requests/requestTypes/{id}

DELETE RequestType by key

Deletes the entity record that matches the specified key.

The following elements are required:

requestTypeKey

(string) Request Type.

Response:

When successful, the response body is empty.

Response status codes:

204	Deleted. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/requests/requestTypes/{requestTypeKey}

DELETE /requests/requestTypes/{requestTypeKey}

Resources

ApiRequestTypeResource

The following elements are required:

requestTypeKey	(string) Request Type.
description	(string) Description.

The following elements are optional:

remarks	(string) Remarks.
isDefault	(bool) Is Default.
requesterClosingRequired	(bool) Requester Closing Required.
generateWO	(bool) Generate WO.
createWithoutAsset	(bool) Create Without Asset.
maintenancePlan	(string) Maintenance Plan.
workshop	(string) Workshop.
workOrderType	(string) Work Order Type.
priorityLevel	(string) Priority Level.
remarksTemplate	(string) Remarks Template.

RequestTypeResource

The following elements are required:

requestTypeKey	(string) Request Type.
description	(string) Description.

The following elements are optional:

remarks	(string) Remarks.
isDefault	(bool) Is Default.
requesterClosingRequired	(bool) Requester Closing Required.
generateWO	(bool) Generate WO.
createWithoutAsset	(bool) Create Without Asset.
maintenancePlan	(string) Maintenance Plan. (fk) Allowed value: the natural key of a record of type MaintenancePlan. These records are accessibly through the MaintenancePlans service.
workshop	(string) Workshop. (fk) Allowed value: the natural key of a record of type Workshop. These records are accessibly through the Workshops service.
workOrderType	(string) Work Order Type. (fk) Allowed value: the natural key of a record of type WorkOrderType. These records are accessibly through the WorkOrderTypes service.
priorityLevel	(string) Priority Level. (fk) Allowed value: the natural key of a record of type PriorityLevel. These records are accessibly through the PriorityLevels service.
remarksTemplate	(string) Remarks Template.

ExtensibilityCustomAttributeValueResource

The following elements are required:

value

(object) The custom attribute value.