The information in this document is currently in BETA and subject to change.
The Units resource represents the various units of measure used across the system. This list can be managed in Actionstep, adding to, or removing units that are suitable for system.
Resource Properties
| Scope Parameter | units |
|---|---|
| Location | /units |
| Methods | GET |
| Default Page Size | 50 |
| Max Page Size | 200 |
| Default Includes | None |
Resource Attributes
| Field | Description | Format | Required | Field Type | Notes |
|---|---|---|---|---|---|
| symbol | The abbreviation for the unit of measure. | string | true | default | i.e. "h" |
| nameSingular | The singular form for the full name for the unit of measure. | string | true | default | i.e. "hour" |
| namePlural | The plural form for the full name for the unit of measure. | string | true | default | i.e. "hours" |
| description | A general description for this record. | string | false | default | |
| category | An optional category name used to group similar units. | string | false | default | |
| defaultSortOrder | A default sort order used to control the displayed list. | number | false | default |
Link Templates
| Identifier | Resource | Location Template |
|---|