PATCH api/order/{OrderID}/Task/{TaskID}
This API updates the values on a task on successful submission of the task
Error Messages
- 404/Not Found - Error getting order with id x - Task ID specified does not exist.
- 404/Not Found - No order found with id x - Order ID specified does not exist.
- 404/Not Found - Task with ID x not found in order ID y - Task ID specified is not associated with the specified Order ID.
- 403/Forbidden - This task is not updateable by agents - Agent Users cannot update this task.
- 403/Forbidden - Task has already been completed - Task has already been marked as completed.
- 403/Forbidden - TaskID x is not a supported task type - Specify a supported task type.
- 403/Forbidden - Value must be a date - Check the specified date and try again.
- 403/forbidden - Value must be one of the following.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| OrderID | Order to be updated | integer |
Required |
| TaskID | Task to be updated | integer |
Required |
Body Parameters
TaskPatch object
TaskPatch| Name | Description | Type | Additional information |
|---|---|---|---|
| Values | Value to be set that will complete the task | string |
None. |
| Notes | Additional information e.g. Team name | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"Values": "sample string 1",
"Notes": "sample string 2"
}
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
None.