Returns all configured usage types.
Scope | assets |
App Type | Agency |
Authorization Type | Access token |
URI | /v4/settings/assettypes/usageTypes?assetGroup={assetGroup}&assetType={assetType}&offset={offset}&limit={limit}&fields={fields}&lang={lang} |
HTTP Method | GET |
Automation Version(s) | 9.0.0 |
Field or Parameter | Type | Required | Values | Description | Automation Version |
---|---|---|---|---|---|
assetGroup | string | No | The name of the asset group. For example: Water or Street. An Asset Group is an agency-defined collection of objects the agency owns or maintains. | 8.0 | |
assetType | string | No | The type of asset. For example: Hydrant or Manhole. An Asset Type is an agencydefined classification of similar objects that share the same standard asset attributes. Related asset types belong to an asset group, and multiple asset types can share the same Class Type. | 8.0 | |
fields | string | No | Comma-delimited names of fields to be returned in the response. Note: Field names are case-sensitive and only first-level fields are supported. Invalid field names are ignored. | 9.0.0 | |
lang | String | No | Indicates the language applied. | 9.0.0 | |
limit | long | No | Indicates the number of items that are returned in each page. | 9.0.0 | |
offset | long | No | Indicates the offset start of each page by the number specified. | 9.0.0 |
Field | Type | Description | Automation Version |
---|---|---|---|
result[] | result{} | 9.0.0 | |
result.recordStatus | string | Indicates whether or not the attribute is active. | 9.0.0 |
result.updatedBy | string | The user who last updated the usage type. | 9.0.0 |
result.updatedDate | dateTime | The date and time the usage type was last updated. | 9.0.0 |
result.usageDescription | string | The usage type's description. | 9.0.0 |
result.usageType | string | The usage type value. | 9.0.0 |
status | integer | The request status. | 9.0.0 |