Requests | Request

Service to manage entities of type 'Request'.

Overview

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

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

All Operations

This service includes the following operations:

GET:
POST:
PUT:
DELETE:

All Resources

This service uses the following resources:

ApiRequestRequestNotesResource
ApiRequestRequestRouteEquipmentsResource
ApiRequestRequestRouteLocationsResource
ApiRequestRequestRouteToolsResource
ApiRequestResource
ChangeSchemaEntityStateReturnResource
MoneyResource
RequestNoteResource
RequestResource
RequestRouteEquipmentResource
RequestRouteLocationResource
RequestRouteToolResource
RequestsAssignedToEmployeeResource
RequestsToCloseResource
StateSLA
SubscriptionAssetType
ExtensibilityCustomAttributeValueResource

All Enumerations

This service uses the following enumerations:

AssetType
VisibleTo

GET Operations

GET Requests (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 RequestResource.

Response status codes:

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

Resource URL:

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

GET /requests/requests/odata

GET Request 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 RequestResource.

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/requests/{id}

GET /requests/requests/{id}

GET Request by key

Returns the entity record that matches the specified key.

The following elements are required:

companyKey	(string) The company key.
requestKey	(string) Request.

Response:

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

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/requests/{companyKey}/{requestKey}

GET /requests/requests/{companyKey}/{requestKey}

GET Get State Transitions

Custom operation 'GetStateTransitions'.

The following elements are required:

requestKey

(string) RequestKey.

Response:

When successful, the response body contains a list of resources of type 'RequestResource'. See RequestResource.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/requests/requests/getStateTransitions/{requestKey}

GET /requests/requests/getStateTransitions/{requestKey}

GET Get Subscription Asset Types

Custom operation 'GetSubscriptionAssetTypes'.

Response:

When successful, the response body contains a list of resources of type 'SubscriptionAssetType'. See SubscriptionAssetType.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/requests/requests/getSubscriptionAssetTypes

GET /requests/requests/getSubscriptionAssetTypes

GET Get Current Schema Entity State

Custom operation 'GetCurrentSchemaEntityState'.

The following elements are required:

companyKey	(string) CompanyKey.
requestKey	(string) RequestKey.

Response:

When successful, the response body contains a list of resources of type 'RequestResource'. See RequestResource.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/requests/requests/getCurrentSchemaEntityState/{companyKey}/{requestKey}

GET /requests/requests/getCurrentSchemaEntityState/{companyKey}/{requestKey}

GET Get Requests Assigned To Employee

Custom operation 'GetRequestsAssignedToEmployee'.

The following elements are required:

modifiedOn	(DateTimeOffset) ModifiedOn.
requester	(string) Requester.
maxRecords	(int) MaxRecords.
daysLimit	(int) DaysLimit.
isCanceledState	(bool) IsCanceledState.
isFinalState	(bool) IsFinalState.
company	(string) company.

Response:

When successful, the response body contains a list of resources of type 'RequestsAssignedToEmployeeResource'. See RequestsAssignedToEmployeeResource.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/requests/requests/getRequestsAssignedToEmployee

GET /requests/requests/getRequestsAssignedToEmployee

POST Operations

POST Requests

Creates a new entity record.

The following elements are required:

requestResource

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

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 ApiRequestResource.

Response status codes:

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

Resource URL:

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

POST /requests/requests

POST Request Route Location

Inserts a new 'Request Route Location' in the 'Request'.

The following elements are required:

requestKey	(string) Request.
companyKey	(string) The company key.
value	(ApiRequestRequestRouteLocationsResource) The ApiRequestRequestRouteLocationsResource instance. See ApiRequestRequestRouteLocationsResource.

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 is empty.

Response status codes:

204	NoContent. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/requests/requests/{companyKey}/{requestKey}/requestRouteLocations

POST /requests/requests/{companyKey}/{requestKey}/requestRouteLocations

POST Request Route Equipment

Inserts a new 'Request Route Equipment' in the 'Request'.

The following elements are required:

requestKey	(string) Request.
companyKey	(string) The company key.
value	(ApiRequestRequestRouteEquipmentsResource) The ApiRequestRequestRouteEquipmentsResource instance. See ApiRequestRequestRouteEquipmentsResource.

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 is empty.

Response status codes:

204	NoContent. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/requests/requests/{companyKey}/{requestKey}/requestRouteEquipments

POST /requests/requests/{companyKey}/{requestKey}/requestRouteEquipments

POST Request Route Tool

Inserts a new 'Request Route Tool' in the 'Request'.

The following elements are required:

requestKey	(string) Request.
companyKey	(string) The company key.
value	(ApiRequestRequestRouteToolsResource) The ApiRequestRequestRouteToolsResource instance. See ApiRequestRequestRouteToolsResource.

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 is empty.

Response status codes:

204	NoContent. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/requests/requests/{companyKey}/{requestKey}/requestRouteTools

POST /requests/requests/{companyKey}/{requestKey}/requestRouteTools

POST Request Note

Inserts a new 'Request Note' in the 'Request'.

The following elements are required:

requestKey	(string) Request.
companyKey	(string) The company key.
value	(ApiRequestRequestNotesResource) The ApiRequestRequestNotesResource instance. See ApiRequestRequestNotesResource.

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 is empty.

Response status codes:

204	NoContent. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/requests/requests/{companyKey}/{requestKey}/requestNotes

POST /requests/requests/{companyKey}/{requestKey}/requestNotes

POST Change State

Changes the request state.

The following elements are required:

requestId	(Guid) The request id.
newStateId	(Guid) The new state id.
triggerStateId	(Guid) TriggerStateId.
dateTransition	(DateTimeOffset) DateTransition.
justification	(string) Justification.
stateJustificationKey	(string) StateJustificationKey.
stateJustificationTypeKey	(string) StateJustificationTypeKey.

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 an item of type 'boolean'.

Resource URL:

api/{tenantKey}/{orgKey}/requests/requests/changeState/{requestId}/{newStateId}

POST /requests/requests/changeState/{requestId}/{newStateId}

POST Change SLA

Custom operation 'ChangeSLA'.

The following elements are required:

requestId	(Guid) RequestId.
statesSLA	(List) StatesSLA.

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 an item of type 'boolean'.

Resource URL:

api/{tenantKey}/{orgKey}/requests/requests/changeSLA/{requestId}

POST /requests/requests/changeSLA/{requestId}

POST Change Work Order State To

Custom operation 'ChangeWorkOrderStateTo'.

The following elements are required:

schemaEntityStateId

(Guid) SchemaEntityStateId.

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 a unique identifier.

Resource URL:

api/{tenantKey}/{orgKey}/requests/requests/changeWorkOrderStateTo

POST /requests/requests/changeWorkOrderStateTo

POST Change Schema Entity State

Custom operation 'ChangeSchemaEntityState'.

The following elements are required:

companyKey	(string) CompanyKey.
requestKey	(string) RequestKey.
schemaEntityStateKey	(string) SchemaEntityStateKey.
schemaEntityStateTransition	(ChangeSchemaEntityStateParamsResource) SchemaEntityStateTransition.
isManager	(bool) IsManager.

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 a resource of type 'ChangeSchemaEntityStateReturnResource'. See ChangeSchemaEntityStateReturnResource.

Resource URL:

api/{tenantKey}/{orgKey}/requests/requests/changeSchemaEntityState/{companyKey}/{requestKey}/{schemaEntityStateKey}

POST /requests/requests/changeSchemaEntityState/{companyKey}/{requestKey}/{schemaEntityStateKey}

POST Automatic Close Requests

Custom operation 'AutomaticCloseRequests'.

The following elements are required:

isAzurefunction

(bool) IsAzurefunction.

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 an item of type 'boolean'.

Resource URL:

api/{tenantKey}/{orgKey}/requests/requests/automaticCloseRequests/{isAzurefunction}

POST /requests/requests/automaticCloseRequests/{isAzurefunction}

POST Change State Rating

Custom operation 'ChangeStateRating'.

The following elements are required:

companyKey	(string) CompanyKey.
requestKey	(string) RequestKey.
schemaEntityStateKey	(string) SchemaEntityStateKey.
stateJustificationKey	(string) StateJustificationKey.
stateJustificationTypeKey	(string) StateJustificationTypeKey.
stateJustificationRemarks	(string) StateJustificationRemarks.
stateChangeDate	(DateTimeOffset) StateChangeDate.
rate	(int) Rate.
rateRemarks	(string) RateRemarks.

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 a resource of type 'ChangeSchemaEntityStateReturnResource'. See ChangeSchemaEntityStateReturnResource.

Resource URL:

api/{tenantKey}/{orgKey}/requests/requests/changeStateRating/{companyKey}/{requestKey}/{schemaEntityStateKey}

POST /requests/requests/changeStateRating/{companyKey}/{requestKey}/{schemaEntityStateKey}

PUT Operations

PUT Set AllowChangeOperatingState Request

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

The following elements are required:

requestKey	(string) Request.
companyKey	(string) The company key.
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/requests/{companyKey}/{requestKey}/allowChangeOperatingState

PUT /requests/requests/{companyKey}/{requestKey}/allowChangeOperatingState

PUT Set AllowChangeTransitions Request

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

The following elements are required:

requestKey	(string) Request.
companyKey	(string) The company key.
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/requests/{companyKey}/{requestKey}/allowChangeTransitions

PUT /requests/requests/{companyKey}/{requestKey}/allowChangeTransitions

PUT Set ApplyDefaults Request

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

The following elements are required:

requestKey	(string) Request.
companyKey	(string) The company key.
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/requests/{companyKey}/{requestKey}/applyDefaults

PUT /requests/requests/{companyKey}/{requestKey}/applyDefaults

PUT Set AssetRoute Request

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

The following elements are required:

requestKey	(string) Request.
companyKey	(string) The company key.
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/requests/{companyKey}/{requestKey}/assetRoute

PUT /requests/requests/{companyKey}/{requestKey}/assetRoute

PUT Set AssetType Request

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

The following elements are required:

requestKey	(string) Request.
companyKey	(string) The company key.
value	(enum AssetType) The request body should contain the new value for the attribute. See AssetType.

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/requests/{companyKey}/{requestKey}/assetType

PUT /requests/requests/{companyKey}/{requestKey}/assetType

PUT Set Brand Request

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

The following elements are required:

requestKey	(string) Request.
companyKey	(string) The company key.
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/requests/{companyKey}/{requestKey}/brand

PUT /requests/requests/{companyKey}/{requestKey}/brand

PUT Set BrandModel Request

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

The following elements are required:

requestKey	(string) Request.
companyKey	(string) The company key.
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/requests/{companyKey}/{requestKey}/brandModel

PUT /requests/requests/{companyKey}/{requestKey}/brandModel

PUT Set CanCreateWO Request

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

The following elements are required:

requestKey	(string) Request.
companyKey	(string) The company key.
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/requests/{companyKey}/{requestKey}/canCreateWO

PUT /requests/requests/{companyKey}/{requestKey}/canCreateWO

PUT Set CloseDowntime Request

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

The following elements are required:

requestKey	(string) Request.
companyKey	(string) The company key.
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/requests/{companyKey}/{requestKey}/closeDowntime

PUT /requests/requests/{companyKey}/{requestKey}/closeDowntime

PUT Set Company Request

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

The following elements are required:

requestKey	(string) Request.
companyKey	(string) The company key.
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/requests/{companyKey}/{requestKey}/company

PUT /requests/requests/{companyKey}/{requestKey}/company

PUT Set Currency Request

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

The following elements are required:

requestKey	(string) Request.
companyKey	(string) The company key.
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/requests/{companyKey}/{requestKey}/currency

PUT /requests/requests/{companyKey}/{requestKey}/currency

PUT Set CurrentStateId Request

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

The following elements are required:

requestKey	(string) Request.
companyKey	(string) The company key.
value	(Guid) 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/requests/{companyKey}/{requestKey}/currentStateId

PUT /requests/requests/{companyKey}/{requestKey}/currentStateId

PUT Set Date Request

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

The following elements are required:

requestKey	(string) Request.
companyKey	(string) The company key.
value	(DateTimeOffset) 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/requests/{companyKey}/{requestKey}/date

PUT /requests/requests/{companyKey}/{requestKey}/date

PUT Set Date RequestNote

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

The following elements are required:

requestKey	(string) Request.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(DateTimeOffset) 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/requests/{companyKey}/{requestKey}/requestNotes/{lineId}/date

PUT /requests/requests/{companyKey}/{requestKey}/requestNotes/{lineId}/date

PUT Set Description Request

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

The following elements are required:

requestKey	(string) Request.
companyKey	(string) The company key.
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/requests/{companyKey}/{requestKey}/description

PUT /requests/requests/{companyKey}/{requestKey}/description

PUT Set Equipment Request

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

The following elements are required:

requestKey	(string) Request.
companyKey	(string) The company key.
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/requests/{companyKey}/{requestKey}/equipment

PUT /requests/requests/{companyKey}/{requestKey}/equipment

PUT Set EquipmentItem RequestRouteEquipment

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

The following elements are required:

requestKey	(string) Request.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
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/requests/{companyKey}/{requestKey}/requestRouteEquipments/{lineId}/equipmentItem

PUT /requests/requests/{companyKey}/{requestKey}/requestRouteEquipments/{lineId}/equipmentItem

PUT Set ExpectedCost Request

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

The following elements are required:

requestKey	(string) Request.
companyKey	(string) The company key.
value	(decimal) 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/requests/{companyKey}/{requestKey}/expectedCost

PUT /requests/requests/{companyKey}/{requestKey}/expectedCost

PUT Set ExpectedDate Request

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

The following elements are required:

requestKey	(string) Request.
companyKey	(string) The company key.
value	(DateTimeOffset) 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/requests/{companyKey}/{requestKey}/expectedDate

PUT /requests/requests/{companyKey}/{requestKey}/expectedDate

PUT Set ExpectedDuration Request

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

The following elements are required:

requestKey	(string) Request.
companyKey	(string) The company key.
value	(TimeSpan) 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/requests/{companyKey}/{requestKey}/expectedDuration

PUT /requests/requests/{companyKey}/{requestKey}/expectedDuration

PUT Set ExpectedDurationSeconds Request

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

The following elements are required:

requestKey	(string) Request.
companyKey	(string) The company key.
value	(int) 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/requests/{companyKey}/{requestKey}/expectedDurationSeconds

PUT /requests/requests/{companyKey}/{requestKey}/expectedDurationSeconds

PUT Set ExpectedEndDate Request

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

The following elements are required:

requestKey	(string) Request.
companyKey	(string) The company key.
value	(DateTimeOffset) 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/requests/{companyKey}/{requestKey}/expectedEndDate

PUT /requests/requests/{companyKey}/{requestKey}/expectedEndDate

PUT Set IsActive Request

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

The following elements are required:

requestKey	(string) Request.
companyKey	(string) The company key.
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/requests/{companyKey}/{requestKey}/isActive

PUT /requests/requests/{companyKey}/{requestKey}/isActive

PUT Set IsAssetLocked Request

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

The following elements are required:

requestKey	(string) Request.
companyKey	(string) The company key.
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/requests/{companyKey}/{requestKey}/isAssetLocked

PUT /requests/requests/{companyKey}/{requestKey}/isAssetLocked

PUT Set IsCanceledState Request

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

The following elements are required:

requestKey	(string) Request.
companyKey	(string) The company key.
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/requests/{companyKey}/{requestKey}/isCanceledState

PUT /requests/requests/{companyKey}/{requestKey}/isCanceledState

PUT Set IsDownOperatingState Request

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

The following elements are required:

requestKey	(string) Request.
companyKey	(string) The company key.
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/requests/{companyKey}/{requestKey}/isDownOperatingState

PUT /requests/requests/{companyKey}/{requestKey}/isDownOperatingState

PUT Set Location Request

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

The following elements are required:

requestKey	(string) Request.
companyKey	(string) The company key.
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/requests/{companyKey}/{requestKey}/location

PUT /requests/requests/{companyKey}/{requestKey}/location

PUT Set Location RequestRouteLocation

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

The following elements are required:

requestKey	(string) Request.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
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/requests/{companyKey}/{requestKey}/requestRouteLocations/{lineId}/location

PUT /requests/requests/{companyKey}/{requestKey}/requestRouteLocations/{lineId}/location

PUT Set NewStateId Request

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

The following elements are required:

requestKey	(string) Request.
companyKey	(string) The company key.
value	(Guid) 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/requests/{companyKey}/{requestKey}/newStateId

PUT /requests/requests/{companyKey}/{requestKey}/newStateId

PUT Set OperatingState Request

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

The following elements are required:

requestKey	(string) Request.
companyKey	(string) The company key.
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/requests/{companyKey}/{requestKey}/operatingState

PUT /requests/requests/{companyKey}/{requestKey}/operatingState

PUT Set ParentLocation Request

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

The following elements are required:

requestKey	(string) Request.
companyKey	(string) The company key.
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/requests/{companyKey}/{requestKey}/parentLocation

PUT /requests/requests/{companyKey}/{requestKey}/parentLocation

PUT Set Party Request

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

The following elements are required:

requestKey	(string) Request.
companyKey	(string) The company key.
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/requests/{companyKey}/{requestKey}/party

PUT /requests/requests/{companyKey}/{requestKey}/party

PUT Set PreviousStateId Request

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

The following elements are required:

requestKey	(string) Request.
companyKey	(string) The company key.
value	(Guid) 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/requests/{companyKey}/{requestKey}/previousStateId

PUT /requests/requests/{companyKey}/{requestKey}/previousStateId

PUT Set PriorityLevel Request

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

The following elements are required:

requestKey	(string) Request.
companyKey	(string) The company key.
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/requests/{companyKey}/{requestKey}/priorityLevel

PUT /requests/requests/{companyKey}/{requestKey}/priorityLevel

PUT Set Rate Request

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

The following elements are required:

requestKey	(string) Request.
companyKey	(string) The company key.
value	(int) 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/requests/{companyKey}/{requestKey}/rate

PUT /requests/requests/{companyKey}/{requestKey}/rate

PUT Set RateRemarks Request

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

The following elements are required:

requestKey	(string) Request.
companyKey	(string) The company key.
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/requests/{companyKey}/{requestKey}/rateRemarks

PUT /requests/requests/{companyKey}/{requestKey}/rateRemarks

PUT Set Remarks Request

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

The following elements are required:

requestKey	(string) Request.
companyKey	(string) The company key.
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/requests/{companyKey}/{requestKey}/remarks

PUT /requests/requests/{companyKey}/{requestKey}/remarks

PUT Set Report Request

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

The following elements are required:

requestKey	(string) Request.
companyKey	(string) The company key.
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/requests/{companyKey}/{requestKey}/report

PUT /requests/requests/{companyKey}/{requestKey}/report

PUT Set RequestKey Request

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

The following elements are required:

requestKey	(string) Request.
companyKey	(string) The company key.
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/requests/{companyKey}/{requestKey}/requestKey

PUT /requests/requests/{companyKey}/{requestKey}/requestKey

PUT Set RequestReason Request

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

The following elements are required:

requestKey	(string) Request.
companyKey	(string) The company key.
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/requests/{companyKey}/{requestKey}/requestReason

PUT /requests/requests/{companyKey}/{requestKey}/requestReason

PUT Set RequestType Request

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

The following elements are required:

requestKey	(string) Request.
companyKey	(string) The company key.
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/requests/{companyKey}/{requestKey}/requestType

PUT /requests/requests/{companyKey}/{requestKey}/requestType

PUT Set SchemaEntityState Request

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

The following elements are required:

requestKey	(string) Request.
companyKey	(string) The company key.
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/requests/{companyKey}/{requestKey}/schemaEntityState

PUT /requests/requests/{companyKey}/{requestKey}/schemaEntityState

PUT Set SLAEndDate Request

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

The following elements are required:

requestKey	(string) Request.
companyKey	(string) The company key.
value	(DateTimeOffset) 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/requests/{companyKey}/{requestKey}/sLAEndDate

PUT /requests/requests/{companyKey}/{requestKey}/sLAEndDate

PUT Set SLAStartDate Request

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

The following elements are required:

requestKey	(string) Request.
companyKey	(string) The company key.
value	(DateTimeOffset) 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/requests/{companyKey}/{requestKey}/sLAStartDate

PUT /requests/requests/{companyKey}/{requestKey}/sLAStartDate

PUT Set SubscriptionAssetTypeId Request

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

The following elements are required:

requestKey	(string) Request.
companyKey	(string) The company key.
value	(int) 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/requests/{companyKey}/{requestKey}/subscriptionAssetTypeId

PUT /requests/requests/{companyKey}/{requestKey}/subscriptionAssetTypeId

PUT Set Template Request

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

The following elements are required:

requestKey	(string) Request.
companyKey	(string) The company key.
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/requests/{companyKey}/{requestKey}/template

PUT /requests/requests/{companyKey}/{requestKey}/template

PUT Set TemplateParameters Request

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

The following elements are required:

requestKey	(string) Request.
companyKey	(string) The company key.
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/requests/{companyKey}/{requestKey}/templateParameters

PUT /requests/requests/{companyKey}/{requestKey}/templateParameters

PUT Set Tool Request

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

The following elements are required:

requestKey	(string) Request.
companyKey	(string) The company key.
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/requests/{companyKey}/{requestKey}/tool

PUT /requests/requests/{companyKey}/{requestKey}/tool

PUT Set Tool RequestRouteTool

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

The following elements are required:

requestKey	(string) Request.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
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/requests/{companyKey}/{requestKey}/requestRouteTools/{lineId}/tool

PUT /requests/requests/{companyKey}/{requestKey}/requestRouteTools/{lineId}/tool

PUT Set TriggerStateId Request

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

The following elements are required:

requestKey	(string) Request.
companyKey	(string) The company key.
value	(Guid) 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/requests/{companyKey}/{requestKey}/triggerStateId

PUT /requests/requests/{companyKey}/{requestKey}/triggerStateId

PUT Set User RequestNote

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

The following elements are required:

requestKey	(string) Request.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
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/requests/{companyKey}/{requestKey}/requestNotes/{lineId}/user

PUT /requests/requests/{companyKey}/{requestKey}/requestNotes/{lineId}/user

PUT Set Custom Attribute Request

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

The following elements are required:

companyKey	(string) The company key.
requestKey	(string) Request
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/requests/{companyKey}/{requestKey}/{customAttributeName}

PUT /requests/requests/{companyKey}/{requestKey}/{customAttributeName}

PUT Set Custom Attribute RequestRouteLocation

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

The following elements are required:

companyKey	(string) The company key.
requestKey	(string) Request
lineId	(string) The detail identifier.
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/requests/{companyKey}/{requestKey}/requestRouteLocations/{lineId}/{customAttributeName}

PUT /requests/requests/{companyKey}/{requestKey}/requestRouteLocations/{lineId}/{customAttributeName}

PUT Set Custom Attribute RequestRouteEquipment

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

The following elements are required:

companyKey	(string) The company key.
requestKey	(string) Request
lineId	(string) The detail identifier.
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/requests/{companyKey}/{requestKey}/requestRouteEquipments/{lineId}/{customAttributeName}

PUT /requests/requests/{companyKey}/{requestKey}/requestRouteEquipments/{lineId}/{customAttributeName}

PUT Set Custom Attribute RequestRouteTool

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

The following elements are required:

companyKey	(string) The company key.
requestKey	(string) Request
lineId	(string) The detail identifier.
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/requests/{companyKey}/{requestKey}/requestRouteTools/{lineId}/{customAttributeName}

PUT /requests/requests/{companyKey}/{requestKey}/requestRouteTools/{lineId}/{customAttributeName}

DELETE Operations

DELETE Request Route Location by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

requestKey	(string) Request.
companyKey	(string) The company key.
lineId	(string) The line identifier.

Response:

When successful, the response body is empty.

Response status codes:

204	NoContent. 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/requests/{companyKey}/{requestKey}/requestRouteLocations/{lineId}

DELETE /requests/requests/{companyKey}/{requestKey}/requestRouteLocations/{lineId}

DELETE Request Route Equipment by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

requestKey	(string) Request.
companyKey	(string) The company key.
lineId	(string) The line identifier.

Response:

When successful, the response body is empty.

Response status codes:

204	NoContent. 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/requests/{companyKey}/{requestKey}/requestRouteEquipments/{lineId}

DELETE /requests/requests/{companyKey}/{requestKey}/requestRouteEquipments/{lineId}

DELETE Request Route Tool by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

requestKey	(string) Request.
companyKey	(string) The company key.
lineId	(string) The line identifier.

Response:

When successful, the response body is empty.

Response status codes:

204	NoContent. 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/requests/{companyKey}/{requestKey}/requestRouteTools/{lineId}

DELETE /requests/requests/{companyKey}/{requestKey}/requestRouteTools/{lineId}

DELETE Request Note by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

requestKey	(string) Request.
companyKey	(string) The company key.
lineId	(string) The line identifier.

Response:

When successful, the response body is empty.

Response status codes:

204	NoContent. 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/requests/{companyKey}/{requestKey}/requestNotes/{lineId}

DELETE /requests/requests/{companyKey}/{requestKey}/requestNotes/{lineId}

DELETE Request 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/requests/{id}

DELETE /requests/requests/{id}

DELETE Request by key

Deletes the entity record that matches the specified key.

The following elements are required:

companyKey	(string) The company key.
requestKey	(string) Request.

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/requests/{companyKey}/{requestKey}

DELETE /requests/requests/{companyKey}/{requestKey}

Resources

ApiRequestRequestNotesResource

The following elements are required:

user	(string) User.
visibleTo	(enum VisibleTo) Visible To. See VisibleTo.

The following elements are optional:

message	(string) Message.
date	(DateTimeOffset) Date.

ApiRequestRequestRouteEquipmentsResource

The following elements are required:

equipmentItem

(string) Equipment Item.

ApiRequestRequestRouteLocationsResource

The following elements are required:

location

(string) Location.

ApiRequestRequestRouteToolsResource

The following elements are required:

tool	(string) Tool.

ApiRequestResource

The following elements are required:

requestKey	(string) Request.
description	(string) Description.
assetType	(enum AssetType) Type. See AssetType.
date	(DateTimeOffset) Date.
expectedCost	(MoneyResource) Expected Cost. See MoneyResource .
requestType	(string) Request Type.
priorityLevel	(string) Priority Level.
expectedDate	(DateTimeOffset) Expected Date.
company	(string) Company.
isCanceledState	(bool) Is Canceled State.
allowChangeTransitions	(bool) Allow Change Transitions.
isDownOperatingState	(bool) Is Down Operating State.
allowChangeOperatingState	(bool) Allow Change Operating State.
closeDowntime	(bool) Close Downtime.
newStateId	(Guid) New State Id.
canCreateWO	(bool) Can Create WO.
subscriptionAssetTypeId	(int) Type.

The following elements are optional:

equipment	(string) Equipment.
tool	(string) Tool.
location	(string) Location.
assetRoute	(string) Route.
remarks	(string) Remarks.
party	(string) Party.
report	(string) Report.
template	(string) Template.
rate	(int) Rate.
rateRemarks	(string) Rate Remarks.
parentLocation	(string) Parent Location.
expectedDurationSeconds	(int) Expected Duration Seconds.
brand	(string) Brand.
brandModel	(string) Model.
currency	(string) Currency.
requestReason	(string) Request Reason.
schemaEntityState	(string) State.
currentStateId	(Guid) Current State Id.
expectedEndDate	(DateTimeOffset) Expected End Date.
sLAStartDate	(DateTimeOffset) SLA Start Date.
sLAEndDate	(DateTimeOffset) SLA End Date.
triggerStateId	(Guid) Trigger State Id.
requestRouteLocations	(List of ApiRequestRequestRouteLocationsResource) Request Route Locations. See ApiRequestRequestRouteLocationsResource.
requestRouteEquipments	(List of ApiRequestRequestRouteEquipmentsResource) Request Route Equipments. See ApiRequestRequestRouteEquipmentsResource.
requestRouteTools	(List of ApiRequestRequestRouteToolsResource) Request Route Tools. See ApiRequestRequestRouteToolsResource.
operatingState	(string) Operating State.
previousStateId	(Guid) Previous State Id.
templateParameters	(string) Template Parameters.
requestNotes	(List of ApiRequestRequestNotesResource) Request Notes. See ApiRequestRequestNotesResource.
applyDefaults	(bool) Apply Defaults.
isAssetLocked	(bool) Is Asset Locked.
expectedDuration	(TimeSpan) Expected Duration.

ChangeSchemaEntityStateReturnResource

The following elements are required:

allowChangeTransitions	(bool) Allow Change Transitions.
isCanceledState	(bool) Is Canceled State.
canCreateWO	(bool) Can Create WO.

The following elements are optional:

rate	(int) Rate.
rateRemarks	(string) Rate Remarks.

MoneyResource

The following elements are required:

amount

(decimal) The amount.

The following elements are optional:

baseAmount	(decimal) The base amount.
reportingAmount	(decimal) The reporting amount.
fractionDigits	(int) The fraction digits.
symbol	(string) The symbol.

Notes: For the POST operation it is not necessary to send the fields: BaseAmount, ReportingAmount, FractionDigits and Symbol. Will be ignored.

RequestNoteResource

The following elements are required:

user	(string) User.
visibleTo	(enum VisibleTo) Visible To. See VisibleTo.

The following elements are optional:

message	(string) Message.
date	(DateTimeOffset) Date.

RequestResource

The following elements are required:

requestKey	(string) Request.
description	(string) Description.
assetType	(enum AssetType) Type. See AssetType.
date	(DateTimeOffset) Date.
expectedCost	(MoneyResource) Expected Cost. See MoneyResource .
requestType	(string) Request Type.
priorityLevel	(string) Priority Level.
expectedDate	(DateTimeOffset) Expected Date.
company	(string) Company.
isCanceledState	(bool) Is Canceled State.
allowChangeTransitions	(bool) Allow Change Transitions.
isDownOperatingState	(bool) Is Down Operating State.
allowChangeOperatingState	(bool) Allow Change Operating State.
closeDowntime	(bool) Close Downtime.
newStateId	(Guid) New State Id.
canCreateWO	(bool) Can Create WO.
subscriptionAssetTypeId	(int) Type.

The following elements are optional:

equipment	(string) Equipment.
tool	(string) Tool.
location	(string) Location.
assetRoute	(string) Route.
remarks	(string) Remarks.
party	(string) Party.
report	(string) Report.
template	(string) Template.
rate	(int) Rate.
rateRemarks	(string) Rate Remarks.
parentLocation	(string) Parent Location.
expectedDurationSeconds	(int) Expected Duration Seconds.
brand	(string) Brand.
brandModel	(string) Model.
currency	(string) Currency.
requestReason	(string) Request Reason.
schemaEntityState	(string) State.
currentStateId	(Guid) Current State Id.
expectedEndDate	(DateTimeOffset) Expected End Date.
sLAStartDate	(DateTimeOffset) SLA Start Date.
sLAEndDate	(DateTimeOffset) SLA End Date.
triggerStateId	(Guid) Trigger State Id.
requestRouteLocations	(List of RequestRouteLocationResource) Request Route Locations. See RequestRouteLocationResource.
requestRouteEquipments	(List of RequestRouteEquipmentResource) Request Route Equipments. See RequestRouteEquipmentResource.
requestRouteTools	(List of RequestRouteToolResource) Request Route Tools. See RequestRouteToolResource.
operatingState	(string) Operating State.
previousStateId	(Guid) Previous State Id.
templateParameters	(string) Template Parameters.
requestNotes	(List of RequestNoteResource) Request Notes. See RequestNoteResource.
applyDefaults	(bool) Apply Defaults.
isAssetLocked	(bool) Is Asset Locked.
expectedDuration	(TimeSpan) Expected Duration.

RequestRouteEquipmentResource

The following elements are required:

equipmentItem

(string) Equipment Item.

RequestRouteLocationResource

The following elements are required:

location

(string) Location.

RequestRouteToolResource

The following elements are required:

tool	(string) Tool.

RequestsAssignedToEmployeeResource

The following elements are required:

requestKey	(string) Request.
assetType	(enum AssetType) Type. See AssetType.
date	(DateTimeOffset) Date.
description	(string) Description.
expectedDate	(DateTimeOffset) Expected Date.
priorityLevel	(string) Priority Level.
requestType	(string) Request Type.
company	(string) Company.
user	(string) User.
visibleTo	(enum VisibleTo) Visible To. See VisibleTo.

The following elements are optional:

equipment	(string) Equipment.
location	(string) Location.
schemaEntityState	(string) State.
tool	(string) Tool.
expectedDurationSeconds	(int) Expected Duration Seconds.
expectedEndDate	(DateTimeOffset) Expected End Date.
currentStateId	(Guid) Current State Id.
requestReason	(string) Request Reason.
sLAEndDate	(DateTimeOffset) SLA End Date.
sLAStartDate	(DateTimeOffset) SLA Start Date.
remarks	(string) Remarks.
assetRoute	(string) Route.
date	(DateTimeOffset) Date.
message	(string) Message.
requestNotes	(string) Request Notes.

RequestsToCloseResource

The following elements are required:

dateTransition	(DateTimeOffset) Date Transition.
id	(Guid) Id.
requestKey	(string) Request Key.
schemaEntityStateId	(Guid) Schema Entity State Id.

StateSLA

The following elements are required:

stateId	(Guid) State Id.
dateTransition	(DateTimeOffset) Date Transition.
isChanged	(bool) Is Changed.

SubscriptionAssetType

The following elements are optional:

assetTypeId	(int) Asset Type Id.
assetTypeDescription	(string) Asset Type Description.

ExtensibilityCustomAttributeValueResource

The following elements are required:

value

(object) The custom attribute value.

Enumerations

AssetType

1	Location
2	Equipment
3	Tool
4	Route

VisibleTo

1	Everyone
2	MeAndManagers