Every asset is referred to by it's asset group object id.
Asset Object
If an asset is part of an active asset group, it's location will be overwritten by that of the asset group.
| Field | Type | Description |
|---|
| id | snowflake | the asset's id |
| organisation_id | snowflake | the id of the organisation the asset belongs to |
| fleet_id | ?snowflake | the id of the fleet the asset belongs to |
| type | asset type | the asset's type |
| status | asset status | the asset's status |
| location | location object | the asset's location |
| position | integer | the order of the assets |
| name | string | the asset's name (2-20 characters) |
| description | string | the asset's description |
| fields | | custom fields |
Asset Group Object
| Field | Type | Description |
|---|
| id | snowflake | the asset group's id |
| type | asset group type | the asset group's type |
| active | boolean | a flag that determines if the asset group is active |
| name | string | the asset group's name (2-20 characters) |
| description | string | the asset group's description |
| assets | array of asset group asset objects | the assets assigned to the asset group |
Asset Group Asset Object
| Field | Type | Description |
|---|
| asset | asset object | the asset |
| position | integer | the order of the asset in the group |
Asset Status Object
| Field | Type | Description |
|---|
| id | snowflake | the asset status's id |
| organisation_id | snowflake | the id of the organisation the asset status belongs to |
| active | boolean | a flag that determines if the asset is active |
| name | string | the asset's name (2-20 characters) |
| description | string | the asset's description |
Asset Type Object
| Field | Type | Description |
|---|
| id | snowflake | the asset type's id |
| organisation_id | snowflake | the id of the organisation the asset type belongs to |
| fleet_id | ?snowflake | the id of the fleet the asset type belongs to |
| name | string | the asset's name (2-20 characters) |
| description | string | the asset's description |
Asset Group Ephemerality
| Name | Value | Description |
|---|
| single | 0 | this is a single asset |
| temporary | 1 | this is a temporary group of assets |
| permanent | 2 | this is a permanent group of assets |
Asset Field Object
| Field | Type | Description |
|---|
| id | snowflake | the asset type's id |
| organisation_id | snowflake | the id of the organisation the asset type belongs to |
| name | string | the asset's name (2-20 characters) |
| description | string | the asset's description |
List Assets
GET /organisations/{organisation.id}/assets
Returns an array of asset objects for the organisation.
All filters for this method are optional.
Filters
| Field | Type | Description | Default |
|---|
| type | snowflake | filter assets by the asset type | wildcard |
| status | snowflake | filter assets by the asset status | all asset statuses that are active |
| fleet | snowflake | filter assets by fleet | |
| location | snowflake | filter assets by the current location | wildcard |
Create Asset
List Asset Groups
GET /organisations/{organisation.id}/assetgroups
Returns an array of asset group objects for the organisation.
All filters for this method are optional.
Filters
| Field | Type | Description | Default |
|---|
| type | asset group type | filter asset groups by the asset group type | wildcard |
| fleet | snowflake | filter asset groups by fleet | |
| location | snowflake | filter assets by the current location | wildcard |
Create Asset Group
Modify Asset Group