Work | Task
Service to manage entities of type 'Activity'.
Overview
| URL | api/{tenantKey}/{orgKey}/maintenanceCore/activities |
| Methods Supported | GET, POST, PUT, DELETE |
All Operations
This service includes the following operations:
- GET:
- POST:
-
PUT:
- PUT Set Custom Attribute Activity
- PUT Set Custom Attribute TaskItem
- PUT Set Custom Attribute TaskLabor
- PUT Set Custom Attribute TaskPart
- PUT Set IsActive Activity
- PUT Set TaskKey Activity
- PUT Set Description Activity
- PUT Set Remarks Activity
- PUT Set Picture Activity
- PUT Set Verification Activity
- PUT Set Quantity TaskItem
- PUT Set Unit TaskItem
- PUT Set Part TaskItem
- PUT Set Warehouse TaskItem
- PUT Set Employee TaskLabor
- PUT Set Expertise TaskLabor
- PUT Set TotalTime TaskLabor
- PUT Set Remarks TaskLabor
- PUT Set Part TaskPart
- PUT Set Quantity TaskPart
- PUT Set Warehouse TaskPart
- PUT Set Unit TaskPart
- PUT Set Remarks TaskPart
- PUT Set ItemType TaskPart
- DELETE:
All Resources
This service uses the following resources:
GET Activities (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 ActivityResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET Activity 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 ActivityResource. |
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 Activity by key
Returns the entity record that matches the specified key.
The following elements are required:
| taskKey | (string) Task. |
Response:
| When successful, the response body contains the entity record. See ActivityResource. |
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 Task Picture.
Returns the value of attribute 'Picture' of the specified entity record.
The following elements are required:
| id | (string) The record identifier. |
| fileName | (string) The file name. |
Response:
| When successful, the response is a stream with the image file. |
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:
POST Activities
Creates a new entity record.
The following elements are required:
| activityResource | (ApiActivityResource) The request body should contain the entity record that should be created. See ApiActivityResource. |
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 ApiActivityResource. |
Response status codes:
| 201 | Created. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
POST Task Item
Inserts a new 'Task Item' in the 'Task'.
The following elements are required:
| taskKey | (string) Task. |
| value | (ApiActivityTaskItemsResource) The ApiActivityTaskItemsResource instance. See ApiActivityTaskItemsResource. |
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:
POST Task Labor
Inserts a new 'Task Labor' in the 'Task'.
The following elements are required:
| taskKey | (string) Task. |
| value | (ApiActivityTaskLaborsResource) The ApiActivityTaskLaborsResource instance. See ApiActivityTaskLaborsResource. |
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:
POST Task Part
Inserts a new 'Task Part' in the 'Task'.
The following elements are required:
| taskKey | (string) Task. |
| value | (ApiActivityTaskPartsResource) The ApiActivityTaskPartsResource instance. See ApiActivityTaskPartsResource. |
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:
PUT Set Description Activity
Updates the value of attribute 'Description' in the specified entity record.
The following elements are required:
| taskKey | (string) Task. |
| 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 Set Employee TaskLabor
Updates the value of attribute 'Employee' in the specified entity record.
The following elements are required:
| taskKey | (string) Task. |
| 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:
PUT Set Expertise TaskLabor
Updates the value of attribute 'Expertise' in the specified entity record.
The following elements are required:
| taskKey | (string) Task. |
| 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:
PUT Set IsActive Activity
Updates the value of attribute 'IsActive' in the specified entity record.
The following elements are required:
| taskKey | (string) Task. |
| 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 Set ItemType TaskPart
Updates the value of attribute 'ItemType' in the specified entity record.
The following elements are required:
| taskKey | (string) Task. |
| lineId | (string) The detail identifier. |
| 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:
PUT Set Part TaskItem
Updates the value of attribute 'Part' in the specified entity record.
The following elements are required:
| taskKey | (string) Task. |
| 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:
PUT Set Part TaskPart
Updates the value of attribute 'Part' in the specified entity record.
The following elements are required:
| taskKey | (string) Task. |
| 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:
PUT Set Picture Activity
Updates the value of attribute 'Picture' in the specified entity record.
The following elements are required:
| taskKey | (string) Task. |
| 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 Set Quantity TaskItem
Updates the value of attribute 'Quantity' in the specified entity record.
The following elements are required:
| taskKey | (string) Task. |
| lineId | (string) The detail identifier. |
| 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:
PUT Set Quantity TaskPart
Updates the value of attribute 'Quantity' in the specified entity record.
The following elements are required:
| taskKey | (string) Task. |
| lineId | (string) The detail identifier. |
| 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:
PUT Set Remarks Activity
Updates the value of attribute 'Remarks' in the specified entity record.
The following elements are required:
| taskKey | (string) Task. |
| 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 Set Remarks TaskLabor
Updates the value of attribute 'Remarks' in the specified entity record.
The following elements are required:
| taskKey | (string) Task. |
| 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:
PUT Set Remarks TaskPart
Updates the value of attribute 'Remarks' in the specified entity record.
The following elements are required:
| taskKey | (string) Task. |
| 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:
PUT Set TaskKey Activity
Updates the value of attribute 'TaskKey' in the specified entity record.
The following elements are required:
| taskKey | (string) Task. |
| 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 Set TotalTime TaskLabor
Updates the value of attribute 'TotalTime' in the specified entity record.
The following elements are required:
| taskKey | (string) Task. |
| lineId | (string) The detail identifier. |
| 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:
PUT Set Unit TaskItem
Updates the value of attribute 'Unit' in the specified entity record.
The following elements are required:
| taskKey | (string) Task. |
| 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:
PUT Set Unit TaskPart
Updates the value of attribute 'Unit' in the specified entity record.
The following elements are required:
| taskKey | (string) Task. |
| 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:
PUT Set Verification Activity
Updates the value of attribute 'Verification' in the specified entity record.
The following elements are required:
| taskKey | (string) Task. |
| 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 Set Warehouse TaskItem
Updates the value of attribute 'Warehouse' in the specified entity record.
The following elements are required:
| taskKey | (string) Task. |
| 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:
PUT Set Warehouse TaskPart
Updates the value of attribute 'Warehouse' in the specified entity record.
The following elements are required:
| taskKey | (string) Task. |
| 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:
PUT Set Custom Attribute Activity
Updates the value of 'CustomAttribute' in the specified entity record.
The following elements are required:
| taskKey | (string) Task |
| 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 Set Custom Attribute TaskItem
Updates the value of 'CustomAttribute' in the specified entity record.
The following elements are required:
| taskKey | (string) Task |
| 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:
PUT Set Custom Attribute TaskLabor
Updates the value of 'CustomAttribute' in the specified entity record.
The following elements are required:
| taskKey | (string) Task |
| 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:
PUT Set Custom Attribute TaskPart
Updates the value of 'CustomAttribute' in the specified entity record.
The following elements are required:
| taskKey | (string) Task |
| 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:
DELETE Task Item by identifier
Deletes the entity record that matches the specified identifier.
The following elements are required:
| taskKey | (string) Task. |
| 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:
DELETE Task Labor by identifier
Deletes the entity record that matches the specified identifier.
The following elements are required:
| taskKey | (string) Task. |
| 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:
DELETE Task Part by identifier
Deletes the entity record that matches the specified identifier.
The following elements are required:
| taskKey | (string) Task. |
| 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:
DELETE Activity 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 Activity by key
Deletes the entity record that matches the specified key.
The following elements are required:
| taskKey | (string) Task. |
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:
Resources
ActivityResource
The following elements are required:
| taskKey | (string) Task. |
| description | (string) Description. |
The following elements are optional:
| remarks | (string) Remarks. |
| picture | (string) Picture. |
| verification | (string) Verification.
(fk) Allowed value: the natural key of a record of type Verification. These records are accessibly through the Verifications service. |
| taskItems | (List of TaskItemResource) Task Items.
See TaskItemResource. |
| taskLabors | (List of TaskLaborResource) Task Labors.
See TaskLaborResource. |
| taskParts | (List of TaskPartResource) Task Parts.
See TaskPartResource. |
ApiActivityResource
The following elements are required:
| taskKey | (string) Task. |
| description | (string) Description. |
The following elements are optional:
| remarks | (string) Remarks. |
| picture | (string) Picture. |
| verification | (string) Verification. |
| taskItems | (List of ApiActivityTaskItemsResource) Task Items.
See ApiActivityTaskItemsResource. |
| taskLabors | (List of ApiActivityTaskLaborsResource) Task Labors.
See ApiActivityTaskLaborsResource. |
| taskParts | (List of ApiActivityTaskPartsResource) Task Parts.
See ApiActivityTaskPartsResource. |
ApiActivityTaskItemsResource
The following elements are required:
| unit | (string) Unit. |
| part | (string) Part. |
| warehouse | (string) Warehouse. |
The following elements are optional:
| quantity | (decimal) Quantity. |
ApiActivityTaskLaborsResource
The following elements are required:
| totalTime | (TimeSpan) Total Time. |
The following elements are optional:
| employee | (string) Employee. |
| expertise | (string) Expertise. |
| remarks | (string) Remarks. |
ApiActivityTaskPartsResource
The following elements are required:
| part | (string) Part. |
| quantity | (decimal) Quantity. |
| unit | (string) Unit. |
The following elements are optional:
| warehouse | (string) Warehouse. |
| remarks | (string) Remarks. |
| itemType | (int) ItemType. |
ExtensibilityCustomAttributeValueResource
The following elements are required:
| value | (object) The custom attribute value. |