This article lists the ToolWatch API request for work orders: Retrieve. Every request needs an authorization token. To get one, see ToolWatch API: Authorization.
Retrieve
Request
URI
https://api.{cluster}.toolwatch.net/workorders/{id}Allowable querystring parameters
Parameter | Description |
columns | Comma-separated list of properties to return. |
Http Method
GET
Headers
Authorization: {token}
Request Body
Not allowed for GET
Response
200 Ok
By default every property is returned. Use the columns querystring parameter to limit the response to specific properties.
Field | Type | Description |
Id | guid | Unique identifier. |
Number | integer | Work order number. |
Instructions | string | Work order instructions. |
AssignedToId | guid | Entity the work order is assigned to. |
ScheduledDate | date | Scheduled date. |
PONumber | string | Purchase order number. |
CreatedById | guid | Entity that created the record. |
CreatedBy | string | Name of the entity that created the record. |
CreatedOn | date | Date the record was created. |
ModifiedById | guid | Entity that last modified the record. |
ModifiedOn | date | Date the record was last modified. |
CompletedById | guid | Entity that completed the work order. |
CompletedOn | date | Date the work order was completed. |
CompletedNote | string | Completion note. |
Deleted | boolean | Whether the work order is deleted. |
Example response body:
{
"Id": "{id}",
"Number": 2001,
"Instructions": "Work Order",
"PONumber": "PO-123",
"Deleted": false
}404 Not Found
Triggered when field parameters in querystring are not allowed.
Response body will contain error message
{"Message":"Criteria is invalid","Type":"Exception"}