v1
latestOpenAPI 3.1.02026-08-0420819698.7 KBAssets
This request returns a list of Assets with top level information such as name, last edited, etc.
Note: this endpoint supports pagination. Please refer to the Pagination section for more information.
Return data description
meta | Requests to gather more information on an Asset such as Fields for the Asset or what Tasks are assigned to the Asset startedOn | The date when this Asset was started on. This property is used to help determine runtime which is used in MTBF. lastEdited | A UNIX timestamp of when this Asset was last edited. parentAssetID | The Asset that is the parent of this Asset. If the value is 0 that means this Asset does not have a parent. locationID | The ID of the location this asset is located at. hoursPerWeek | The number of hours this Asset runs per week. This is used to determine runtime which is used in MTBF. If the value is -1 then the Asset uses the Location's hoursPerWeek setting. workRequestPortal | The url work requestors can use to submit problems with this Asset. image | Array of objects that have a file name and a link you can use to download that image. All links are only valid for 15 minutes, a new call will generate a new link. geoLocation | The location of an asset on a Map.
Query parameters
This parameter is used to only get specific Assets. This parameter expects a comma delimited list of Asset IDs.
This is a parameter used to string search for a name or partial name of an asset this parameter expects a string with the wildcard %.
This parameter is used to only get Assets at a specific group of Locations. This parameter accepts a comma delimited list of Location IDs.
This parameter is used to only get Assets that were last edited after the unix timestamp passed into the start parameter. For example, all Assets that were last edited after April 18th, 2018.
This parameter is used to only get Assets that were last edited before the unix timestamp passed into the end parameter.
This parameter is a cursor that selects what ID you want to start receiving results at. Without ordering, this will return results with an ID greater than the value of cursor. With ordering, this will return results starting at the next item in the order, regardless of whether its ID is greater than or lesser than the value of cursor.
This parameter is a result limiter. The default is set to return no more than 100 results at one time.
This parameter can be used to get asset(s) children using the Parent's ID. This parameter accepts a comma delimited list of Asset IDs.
This parameter is used to order results by their lastEdited property instead of the default ordering by ascending assetID. CANNOT be provided alongside the cursor parameter. to paginate in this ordering, use the start or end parameters.
This parameter is used to paginate results based on the limit. Refer to Pagination section for more information.
This parameter is used to filter results that contain a geoLocation property. By default it is false and will return all assets with and without geoLocation property. If true, it will only return assets with a geoLocation property.
Response
Pagination using Page & Limit