This article lists the ToolWatch API requests for service requests: Retrieve and Retrieve List. Every request needs an authorization token. To get one, see ToolWatch API: Authorization.
Retrieve
Request
URI
https://api.{cluster}.toolwatch.net/servicerequest/{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. |
RequestedById | guid | Entity that requested the service. |
ItemId | guid | Item the service request applies to. |
Description | string | Service request description. |
Priority | integer | Priority level. |
Note | string | Free-form note. |
Number | integer | Service request number. |
CreatedOn | date | Date the record was created. |
CreatedById | guid | Entity that created the record. |
ModifiedOn | date | Date the record was last modified. |
ModifiedById | guid | Entity that last modified the record. |
Deleted | boolean | Whether the service request is deleted. |
Example response body:
{
"Id": "{id}",
"ItemId": "{itemId}",
"Description": "Service Request",
"Priority": 1,
"Number": 1001,
"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"}Retrieve List
Request
URI
https://api.{cluster}.toolwatch.net/servicerequestlistAllowable querystring parameters
Parameter | Description |
columns | Comma-separated list of properties to return. |
itemId | Filter by item id (guid). |
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. |
RequestedById | guid | Entity that requested the service. |
ItemId | guid | Item the service request applies to. |
Description | string | Service request description. |
Priority | integer | Priority level. |
Note | string | Free-form note. |
Number | integer | Service request number. |
CreatedOn | date | Date the record was created. |
CreatedById | guid | Entity that created the record. |
ModifiedOn | date | Date the record was last modified. |
ModifiedById | guid | Entity that last modified the record. |
Deleted | boolean | Whether the service request is deleted. |
Example response body:
[
{
"Id": "{id}",
"ItemId": "{itemId}",
"Description": "Service Request",
"Priority": 1,
"Number": 1001,
"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"}