Work | Request State

Service to manage entities of type 'RequestState'.

This service extends VKSchemaEntityStates.

Overview

api/{tenantKey}/{orgKey}/maintenanceCore/requestStates

URL	api/{tenantKey}/{orgKey}/maintenanceCore/requestStates
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:

ApiBaseRequestStateRequestWorkOrderStatesResource
ApiBaseRequestStateResource
ApiRequestStateRequestWorkOrderStatesResource
ApiRequestStateResource
BaseRequestStateRequestWorkOrderStatesResource
BaseRequestStateResource
RequestStateResource
RequestWorkOrderStateResource
ExtensibilityCustomAttributeValueResource

GET Operations

GET RequestStates (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 RequestStateResource.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/maintenanceCore/requestStates/extension/odata

GET /maintenanceCore/requestStates/extension/odata

GET RequestState 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 RequestStateResource.

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}/maintenanceCore/requestStates/{id}/extension

GET /maintenanceCore/requestStates/{id}/extension

GET RequestState by key

Returns the entity record that matches the specified key.

The following elements are required:

stateKey

(string) State.

Response:

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

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}/maintenanceCore/requestStates/{stateKey}/extension

GET /maintenanceCore/requestStates/{stateKey}/extension

GET RequestStates (with VKSchemaEntityState)

Returns the list of all the entity records available. Each record contains both data from the entity and the base entity.

Response:

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/maintenanceCore/requestStates

GET /maintenanceCore/requestStates

GET RequestStates (with VKSchemaEntityState) (paged)

Returns a page of the list of all the entity records available. Each record contains both data from the entity and the base entity.

The following elements are optional:

page	(int) The index of the page of the list that should be returned. This is a query string parameter.
pageSize	(int) The number of page elements that should be returned (max. is 1000). This is a query string parameter.

Response:

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/maintenanceCore/requestStates?page={page}&pageSize={pageSize}

GET /maintenanceCore/requestStates?page={page}&pageSize={pageSize}

GET RequestState (with VKSchemaEntityState) by identifier

Returns the entity record that matches the specified identifier. The record contains both data from the entity and the base entity.

The following elements are required:

id	(string) The record identifier.

Response:

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

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

GET /maintenanceCore/requestStates/{id}

GET RequestState (with VKSchemaEntityState) by key

Returns the entity record that matches the specified key. The record contains both data from the entity and the base entity.

The following elements are required:

stateKey

(string) State.

Response:

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

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}/maintenanceCore/requestStates/{stateKey}

GET /maintenanceCore/requestStates/{stateKey}

POST Operations

POST RequestStates

Creates a new entity record.

The following elements are required:

requestStateResource

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

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/maintenanceCore/requestStates/extension

POST /maintenanceCore/requestStates/extension

POST RequestStates (with ApiBaseRequestState)

Creates a new entity record. The record shoud contain both data from the entity and the base entity.

The following elements are required:

requestStateResource

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

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/maintenanceCore/requestStates

POST /maintenanceCore/requestStates

POST Request Work Order State

Inserts a new 'Request Work Order State' in the 'Request State'.

The following elements are required:

stateKey	(string) State.
value	(ApiRequestStateRequestWorkOrderStatesResource) The ApiRequestStateRequestWorkOrderStatesResource instance. See ApiRequestStateRequestWorkOrderStatesResource.

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}/maintenanceCore/requestStates/{stateKey}/requestWorkOrderStates

POST /maintenanceCore/requestStates/{stateKey}/requestWorkOrderStates

POST Get State Configuration

Gets the state configuration.

The following elements are required:

stateId

(Guid) The state id.

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 'RequestStateResource'. See RequestStateResource.

Resource URL:

api/{tenantKey}/{orgKey}/maintenanceCore/requestStates/getStateConfiguration/{stateId}

POST /maintenanceCore/requestStates/getStateConfiguration/{stateId}

POST Get All Request States

Custom operation 'GetAllRequestStates'.

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 list of resources of type 'RequestStateResource'. See RequestStateResource.

Resource URL:

api/{tenantKey}/{orgKey}/maintenanceCore/requestStates/getAllRequestStates

POST /maintenanceCore/requestStates/getAllRequestStates

PUT Operations

PUT Set AllowChangeRemarks RequestState

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

The following elements are required:

stateKey	(string) State.
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}/maintenanceCore/requestStates/{stateKey}/allowChangeRemarks

PUT /maintenanceCore/requestStates/{stateKey}/allowChangeRemarks

PUT Set ChangeWOStateTo RequestState

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

The following elements are required:

stateKey	(string) State.
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}/maintenanceCore/requestStates/{stateKey}/changeWOStateTo

PUT /maintenanceCore/requestStates/{stateKey}/changeWOStateTo

PUT Set CopyJustification RequestState

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

The following elements are required:

stateKey	(string) State.
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}/maintenanceCore/requestStates/{stateKey}/copyJustification

PUT /maintenanceCore/requestStates/{stateKey}/copyJustification

PUT Set DownTimeInfo RequestState

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

The following elements are required:

stateKey	(string) State.
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}/maintenanceCore/requestStates/{stateKey}/downTimeInfo

PUT /maintenanceCore/requestStates/{stateKey}/downTimeInfo

PUT Set EndSLA RequestState

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

The following elements are required:

stateKey	(string) State.
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}/maintenanceCore/requestStates/{stateKey}/endSLA

PUT /maintenanceCore/requestStates/{stateKey}/endSLA

PUT Set IsActive RequestState

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

The following elements are required:

stateKey	(string) State.
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}/maintenanceCore/requestStates/{stateKey}/isActive

PUT /maintenanceCore/requestStates/{stateKey}/isActive

PUT Set IsCanceledState RequestState

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

The following elements are required:

stateKey	(string) State.
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}/maintenanceCore/requestStates/{stateKey}/isCanceledState

PUT /maintenanceCore/requestStates/{stateKey}/isCanceledState

PUT Set SLAInfo RequestState

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

The following elements are required:

stateKey	(string) State.
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}/maintenanceCore/requestStates/{stateKey}/sLAInfo

PUT /maintenanceCore/requestStates/{stateKey}/sLAInfo

PUT Set StartDownTime RequestState

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

The following elements are required:

stateKey	(string) State.
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}/maintenanceCore/requestStates/{stateKey}/startDownTime

PUT /maintenanceCore/requestStates/{stateKey}/startDownTime

PUT Set StartSLA RequestState

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

The following elements are required:

stateKey	(string) State.
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}/maintenanceCore/requestStates/{stateKey}/startSLA

PUT /maintenanceCore/requestStates/{stateKey}/startSLA

PUT Set WorkOrderState RequestWorkOrderState

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

The following elements are required:

stateKey	(string) State.
lineId	(string) The detail identifier.
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}/maintenanceCore/requestStates/{stateKey}/requestWorkOrderStates/{lineId}/workOrderState

PUT /maintenanceCore/requestStates/{stateKey}/requestWorkOrderStates/{lineId}/workOrderState

PUT Set Custom Attribute RequestState

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

The following elements are required:

stateKey	(string) State
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}/maintenanceCore/requestStates/{stateKey}/{customAttributeName}

PUT /maintenanceCore/requestStates/{stateKey}/{customAttributeName}

PUT Set Custom Attribute RequestWorkOrderState

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

The following elements are required:

stateKey	(string) State
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}/maintenanceCore/requestStates/{stateKey}/requestWorkOrderStates/{lineId}/{customAttributeName}

PUT /maintenanceCore/requestStates/{stateKey}/requestWorkOrderStates/{lineId}/{customAttributeName}

DELETE Operations

DELETE Request Work Order State by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

stateKey	(string) State.
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}/maintenanceCore/requestStates/{stateKey}/requestWorkOrderStates/{lineId}

DELETE /maintenanceCore/requestStates/{stateKey}/requestWorkOrderStates/{lineId}

DELETE RequestState 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}/maintenanceCore/requestStates/{id}

DELETE /maintenanceCore/requestStates/{id}

DELETE RequestState by key

Deletes the entity record that matches the specified key.

The following elements are required:

stateKey

(string) State.

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}/maintenanceCore/requestStates/{stateKey}

DELETE /maintenanceCore/requestStates/{stateKey}

Resources

ApiBaseRequestStateRequestWorkOrderStatesResource

The following elements are required:

workOrderState

(string) WO State.

ApiBaseRequestStateResource

The following elements are required:

startSLA	(bool) Start SLA.
endSLA	(bool) End SLA.
allowChangeRemarks	(bool) Allow change remarks.
startDownTime	(bool) Start Down Time.
copyJustification	(bool) Copy Justification.
stateKey	(string) State.
description	(string) Description.
isInitialState	(bool) Is Initial State.
isFinalState	(bool) Is Final State.
schemaEntity	(string) Entity.

The following elements are optional:

changeWOStateTo	(string) State.
requestWorkOrderStates	(List of ApiBaseRequestStateRequestWorkOrderStatesResource) Request Work Order States. See ApiBaseRequestStateRequestWorkOrderStatesResource.
isCanceledState	(bool) Canceled.
downTimeInfo	(string) Down Time Info.
sLAInfo	(string) Information.
isLockedForChanges	(bool) Is Locked For Changes.
localizedDescription	(string) Localized Description.
notificationId	(Guid) Initial Notification.

ApiRequestStateRequestWorkOrderStatesResource

The following elements are required:

workOrderState

(string) WO State.

ApiRequestStateResource

The following elements are required:

startSLA	(bool) Start SLA.
endSLA	(bool) End SLA.
allowChangeRemarks	(bool) Allow change remarks.
startDownTime	(bool) Start Down Time.
copyJustification	(bool) Copy Justification.
stateKey	(string) State.

The following elements are optional:

changeWOStateTo	(string) State.
requestWorkOrderStates	(List of ApiRequestStateRequestWorkOrderStatesResource) Request Work Order States. See ApiRequestStateRequestWorkOrderStatesResource.
isCanceledState	(bool) Canceled.
downTimeInfo	(string) Down Time Info.
sLAInfo	(string) Information.

BaseRequestStateRequestWorkOrderStatesResource

The following elements are required:

workOrderState

(string) WO State.

BaseRequestStateResource

The following elements are required:

startSLA	(bool) Start SLA.
endSLA	(bool) End SLA.
allowChangeRemarks	(bool) Allow change remarks.
startDownTime	(bool) Start Down Time.
copyJustification	(bool) Copy Justification.
stateKey	(string) State.
description	(string) Description.
isInitialState	(bool) Is Initial State.
isFinalState	(bool) Is Final State.
schemaEntity	(string) Entity.

The following elements are optional:

changeWOStateTo	(string) State.
requestWorkOrderStates	(List of BaseRequestStateRequestWorkOrderStatesResource) Request Work Order States. See BaseRequestStateRequestWorkOrderStatesResource.
isCanceledState	(bool) Canceled.
downTimeInfo	(string) Down Time Info.
sLAInfo	(string) Information.
isLockedForChanges	(bool) Is Locked For Changes.
localizedDescription	(string) Localized Description.
notificationId	(Guid) Initial Notification.

RequestStateResource

The following elements are required:

startSLA	(bool) Start SLA.
endSLA	(bool) End SLA.
allowChangeRemarks	(bool) Allow change remarks.
startDownTime	(bool) Start Down Time.
copyJustification	(bool) Copy Justification.
stateKey	(string) State.

The following elements are optional:

changeWOStateTo	(string) State.
requestWorkOrderStates	(List of RequestWorkOrderStateResource) Request Work Order States. See RequestWorkOrderStateResource.
isCanceledState	(bool) Canceled.
downTimeInfo	(string) Down Time Info.
sLAInfo	(string) Information.

RequestWorkOrderStateResource

The following elements are required:

workOrderState

(string) WO State.

ExtensibilityCustomAttributeValueResource

The following elements are required:

value

(object) The custom attribute value.