Valuekeep Developers - Web API Reference

Work | WO Task Selection

Service to manage entities of type 'WOTaskSelection'.

Overview


URL api/{tenantKey}/{orgKey}/maintenance/wOTaskSelections
Methods Supported GET

All Operations

This service includes the following operations:

All Resources

This service uses the following resources:

GET Operations

GET WOTaskSelections (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 WOTaskSelectionResource.

Response status codes:

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

Resource URL:

GET /maintenance/wOTaskSelections/odata

GET WOTaskSelection 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 WOTaskSelectionResource.

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:

GET /maintenance/wOTaskSelections/{id}

GET WOTaskSelection by key

Returns the entity record that matches the specified key.

The following elements are required:

wOTaskSelectionKey (string) WO Task Selection.

Response:

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

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:

GET /maintenance/wOTaskSelections/{wOTaskSelectionKey}

PUT Operations

PUT Set Custom Attribute WOTaskSelection

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

The following elements are required:

wOTaskSelectionKey (string) WO Task Selection
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:

PUT /maintenance/wOTaskSelections/{wOTaskSelectionKey}/{customAttributeName}

Resources


WOTaskSelectionResource

The following elements are required:

wOTaskSelectionKey (string) WO Task Selection.

The following elements are optional:

workOrderTaskId (Guid) Work Order Task Id.
taskKey (string) Task.
description (string) Description.
workOrderId (Guid) Work Order Id.
taskId (Guid) Task Id.