Valuekeep Developers - Web API Reference

Work | Assignment

Service to manage entities of type 'WorkOrderAssignment'.

Overview


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

All Operations

This service includes the following operations:

All Resources

This service uses the following resources:

GET Operations

GET WorkOrderAssignments (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 WorkOrderAssignmentResource.

Response status codes:

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

Resource URL:

GET /maintenance/workOrderAssignments/odata

GET WorkOrderAssignment 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 WorkOrderAssignmentResource.

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

GET WorkOrderAssignment by key

Returns the entity record that matches the specified key.

The following elements are required:

companyKey (string) The company key.
workOrderAssignmentKey (string) Work Scheduling.

Response:

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

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/workOrderAssignments/{companyKey}/{workOrderAssignmentKey}

POST Operations

POST WorkOrderAssignments

Creates a new entity record.

The following elements are required:

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

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

Response status codes:

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

Resource URL:

POST /maintenance/workOrderAssignments

POST Add Expertises by keys

Adds the specified 'Expertises' to the 'Work Scheduling' (by specifying its keys).

The following elements are required:

workOrderAssignmentKey (string) Work Scheduling.
value (Array of string) A list of record keys to be added.

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:

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

Resource URL:

POST /maintenance/workOrderAssignments/{workOrderAssignmentKey}/expertises/add

POST Add Expertises by identifiers

Adds the specified 'Expertises' to the 'Work Scheduling' (by specifying its identifiers).

The following elements are required:

workOrderAssignmentKey (string) Work Scheduling.
value (Array of string) A list of record identifiers to be added.

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:

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

Resource URL:

POST /maintenance/workOrderAssignments/{workOrderAssignmentKey}/expertises/addById

POST Remove Expertises by keys

Removes the specified 'Expertises' to the 'Work Scheduling' (by specifying its keys).

The following elements are required:

workOrderAssignmentKey (string) Work Scheduling.
value (Array of string) A list of record keys to be removed.

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:

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

Resource URL:

POST /maintenance/workOrderAssignments/{workOrderAssignmentKey}/expertises/remove

POST Remove Expertises by identifiers

Removes the specified 'Expertises' to the 'Work Scheduling' (by specifying its identifiers).

The following elements are required:

workOrderAssignmentKey (string) Work Scheduling.
value (Array of string) A list of record identifiers to be removed.

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:

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

Resource URL:

POST /maintenance/workOrderAssignments/{workOrderAssignmentKey}/expertises/removeById

POST Add Parties by keys

Adds the specified 'Parties' to the 'Work Scheduling' (by specifying its keys).

The following elements are required:

workOrderAssignmentKey (string) Work Scheduling.
value (Array of string) A list of record keys to be added.

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:

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

Resource URL:

POST /maintenance/workOrderAssignments/{workOrderAssignmentKey}/parties/add

POST Add Parties by identifiers

Adds the specified 'Parties' to the 'Work Scheduling' (by specifying its identifiers).

The following elements are required:

workOrderAssignmentKey (string) Work Scheduling.
value (Array of string) A list of record identifiers to be added.

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:

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

Resource URL:

POST /maintenance/workOrderAssignments/{workOrderAssignmentKey}/parties/addById

POST Remove Parties by keys

Removes the specified 'Parties' to the 'Work Scheduling' (by specifying its keys).

The following elements are required:

workOrderAssignmentKey (string) Work Scheduling.
value (Array of string) A list of record keys to be removed.

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:

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

Resource URL:

POST /maintenance/workOrderAssignments/{workOrderAssignmentKey}/parties/remove

POST Remove Parties by identifiers

Removes the specified 'Parties' to the 'Work Scheduling' (by specifying its identifiers).

The following elements are required:

workOrderAssignmentKey (string) Work Scheduling.
value (Array of string) A list of record identifiers to be removed.

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:

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

Resource URL:

POST /maintenance/workOrderAssignments/{workOrderAssignmentKey}/parties/removeById

PUT Operations

PUT Set AssignedToIds WorkOrderAssignment

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

The following elements are required:

workOrderAssignmentKey (string) Work Scheduling.
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:

PUT /maintenance/workOrderAssignments/{companyKey}/{workOrderAssignmentKey}/assignedToIds

PUT Set Company WorkOrderAssignment

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

The following elements are required:

workOrderAssignmentKey (string) Work Scheduling.
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:

PUT /maintenance/workOrderAssignments/{companyKey}/{workOrderAssignmentKey}/company

PUT Set Expertises WorkOrderAssignment

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

The following elements are required:

workOrderAssignmentKey (string) Work Scheduling.
companyKey (string) The company key.
value (Expertise) 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:

PUT /maintenance/workOrderAssignments/{companyKey}/{workOrderAssignmentKey}/expertises

PUT Set IsActive WorkOrderAssignment

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

The following elements are required:

workOrderAssignmentKey (string) Work Scheduling.
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:

PUT /maintenance/workOrderAssignments/{companyKey}/{workOrderAssignmentKey}/isActive

PUT Set IsLocked WorkOrderAssignment

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

The following elements are required:

workOrderAssignmentKey (string) Work Scheduling.
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:

PUT /maintenance/workOrderAssignments/{companyKey}/{workOrderAssignmentKey}/isLocked

PUT Set Parties WorkOrderAssignment

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

The following elements are required:

workOrderAssignmentKey (string) Work Scheduling.
companyKey (string) The company key.
value (Party) 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:

PUT /maintenance/workOrderAssignments/{companyKey}/{workOrderAssignmentKey}/parties

PUT Set Remarks WorkOrderAssignment

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

The following elements are required:

workOrderAssignmentKey (string) Work Scheduling.
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:

PUT /maintenance/workOrderAssignments/{companyKey}/{workOrderAssignmentKey}/remarks

PUT Set Task WorkOrderAssignment

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

The following elements are required:

workOrderAssignmentKey (string) Work Scheduling.
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:

PUT /maintenance/workOrderAssignments/{companyKey}/{workOrderAssignmentKey}/task

PUT Set TemplateParameters WorkOrderAssignment

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

The following elements are required:

workOrderAssignmentKey (string) Work Scheduling.
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:

PUT /maintenance/workOrderAssignments/{companyKey}/{workOrderAssignmentKey}/templateParameters

PUT Set WOMaintenancePlanId WorkOrderAssignment

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

The following elements are required:

workOrderAssignmentKey (string) Work Scheduling.
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:

PUT /maintenance/workOrderAssignments/{companyKey}/{workOrderAssignmentKey}/wOMaintenancePlanId

PUT Set WOMaintenancePlanTaskId WorkOrderAssignment

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

The following elements are required:

workOrderAssignmentKey (string) Work Scheduling.
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:

PUT /maintenance/workOrderAssignments/{companyKey}/{workOrderAssignmentKey}/wOMaintenancePlanTaskId

PUT Set WorkOrder WorkOrderAssignment

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

The following elements are required:

workOrderAssignmentKey (string) Work Scheduling.
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:

PUT /maintenance/workOrderAssignments/{companyKey}/{workOrderAssignmentKey}/workOrder

PUT Set WorkOrderAssignmentKey WorkOrderAssignment

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

The following elements are required:

workOrderAssignmentKey (string) Work Scheduling.
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:

PUT /maintenance/workOrderAssignments/{companyKey}/{workOrderAssignmentKey}/workOrderAssignmentKey

PUT Set WorkOrderMaintenancePlan WorkOrderAssignment

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

The following elements are required:

workOrderAssignmentKey (string) Work Scheduling.
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:

PUT /maintenance/workOrderAssignments/{companyKey}/{workOrderAssignmentKey}/workOrderMaintenancePlan

PUT Set WOTaskId WorkOrderAssignment

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

The following elements are required:

workOrderAssignmentKey (string) Work Scheduling.
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:

PUT /maintenance/workOrderAssignments/{companyKey}/{workOrderAssignmentKey}/wOTaskId

PUT Set Custom Attribute WorkOrderAssignment

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

The following elements are required:

companyKey (string) The company key.
workOrderAssignmentKey (string) Work Scheduling
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/workOrderAssignments/{companyKey}/{workOrderAssignmentKey}/{customAttributeName}

DELETE Operations

DELETE WorkOrderAssignment 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:

DELETE /maintenance/workOrderAssignments/{id}

DELETE WorkOrderAssignment by key

Deletes the entity record that matches the specified key.

The following elements are required:

companyKey (string) The company key.
workOrderAssignmentKey (string) Work Scheduling.

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:

DELETE /maintenance/workOrderAssignments/{companyKey}/{workOrderAssignmentKey}

Resources


ApiWorkOrderAssignmentResource

The following elements are required:

workOrderAssignmentKey (string) Work Scheduling.
workOrder (string) Work Order.
company (string) Company.
isLocked (bool) Is Locked.

The following elements are optional:

parties (Party) Parties.
expertises (Expertise) Expertises.
remarks (string) Remarks.
workOrderMaintenancePlan (string) Maintenance Plan.
wOMaintenancePlanId (Guid) WO Maintenance Plan Id.
wOMaintenancePlanTaskId (Guid) WO Maintenance Plan Task Id.
wOTaskId (Guid) WO Task Id.
task (string) Task.
templateParameters (string) Template Parameters.
assignedToIds (string) Assigned To Ids.


WorkOrderAssignmentResource

The following elements are required:

workOrderAssignmentKey (string) Work Scheduling.
workOrder (string) Work Order.
(fk) Allowed value: the natural key of a record of type WorkOrder. These records are accessibly through the WorkOrders service.
company (string) Company.
(fk) Allowed value: the natural key of a record of type Company. These records are accessibly through the Companies service.
isLocked (bool) Is Locked.

The following elements are optional:

parties (Party) Parties.
expertises (Expertise) Expertises.
remarks (string) Remarks.
workOrderMaintenancePlan (string) Maintenance Plan.
(fk) Allowed value: the natural key of a record of type MaintenancePlan. These records are accessibly through the MaintenancePlans service.
wOMaintenancePlanId (Guid) WO Maintenance Plan Id.
wOMaintenancePlanTaskId (Guid) WO Maintenance Plan Task Id.
wOTaskId (Guid) WO Task Id.
task (string) Task.
(fk) Allowed value: the natural key of a record of type Activity. These records are accessibly through the Activities service.
templateParameters (string) Template Parameters.
assignedToIds (string) Assigned To Ids.


ExtensibilityCustomAttributeValueResource

The following elements are required:

value (object) The custom attribute value.