This article lists the ToolWatch API request for lost and found: Retrieve List. Every request needs an authorization token. To get one, see ToolWatch API: Authorization.
Retrieve List
Request
URI
https://api.{cluster}.toolwatch.net/lostandfoundAllowable 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 |
LostFoundId | guid | Unique identifier. |
EntityId | guid | Entity id. |
ItemId | guid | Item id. |
RetiredById | guid | Entity that retired the item. |
RetiredDate | date | Date the item was retired. |
Notes | string | Free-form notes. |
RetirmentTypeId | guid | Retirement type id. |
Example response body:
[
{
"LostFoundId": "{id}",
"ItemId": "{itemId}",
"EntityId": "{entityId}",
"Notes": "Notes"
}
]
404 Not Found
Triggered when field parameters in querystring are not allowed.
Response body will contain error message
{"Message":"Criteria is invalid","Type":"Exception"}