v1

latestOpenAPI 3.1.02026-08-0420819698.7 KB
Routes
Assets
Fields

Asset Suggested Fields

This request gets all possible fields an Asset can pick from when deciding which fields it should have.

To understand this concept, let's pretend you have the following assets:

Your first Asset (a Truck) has the fields Make, Model, and VIN.

Your second Asset (a HVAC) has the fields Make, Model, and Serial Number.

This would mean there are 4 suggested fields that exist: Make, Model, VIN and Serial Number. If I added a third new asset I could pick from any of the 4 suggested fields.

Suggested fields are the full list of possible fields that can be added to assets at that location.

get/v2/assets/fields/suggested

Query parameters

fieldsinteger

This parameter can be used to get a single Asset Fields or a list of Asset Fields in a comma-separated list.

namestring

This parameter is used to only get specific field by name. This parameter expects a string full name of a field or partial name with the wildcard %.

cursorinteger

This parameter is a cursor that selects what id you want to start receiving results at. e.g. passing 137 here will only get you asset fields with an id greater than 137.

limitinteger

This parameter is a result limiter. The default is set to return no more than 100 results at one time.

locationsinteger

This parameter is used to only get fields at a specific group of Locations. This parameter accepts a comma delimited list of Location IDs.

Response

Asset Suggested Fields

fieldIDinteger
fieldTypestring
fieldNamestring
locationIDinteger