Queries

circle-exclamation

assetTypes

Lists asset types for an organization.

assetTypes(
    organizationId: ID!
    filter: CatalogItemFilter
    first: Int
    after: String
    last: Int
    before: String
    orderBy: CatalogItemOrder = { field: ORDER, direction: ASC }
  ): AssetTypeConnection!

Arguments

Name
Type
Description

organizationId

ID!

The organization to retrieve asset types for.

filter

CatalogItemFilter

Filtering options for the returned asset types.

first

Int

The first n elements from the paginated listarrow-up-right.

after

String

The elements that come after the specified cursorarrow-up-right.

last

Int

The last n elements from the paginated listarrow-up-right.

before

String

The elements that come before the specified cursorarrow-up-right.

orderBy

CatalogItemOrder

The ordering options for the returned asset types.

Input types:

chevron-rightCatalogItemFilterhashtag

Filtering options for catalog items.

Field
Type
Description

titleContains

String

Partial match on title (case-insensitive contains).

codes

[Code!]

Match any of these codes.

chevron-rightCatalogItemOrderhashtag

Ordering options for catalog items.

Field
Type
Description

field

The field to order by.

direction

The direction to order.

Output types:

chevron-rightAssetTypeConnectionhashtag

A paginated list of AssetType items.

Implements: Connection

Field
Type
Description

edges

A list of edges.

nodes

A list of nodes in the connection (without edge metadata).

pageInfo

Information about the current page.

total

The total count of items matching the filter.

chevron-rightPageInfo (entity)hashtag

Information about the current page in a paginated connection.

Field
Type
Description

hasNextPage

Boolean!

Whether more items exist after the current page.

hasPreviousPage

Boolean!

Whether more items exist before the current page.

startCursor

String

The cursor pointing to the first item in the current page.

endCursor

String

The cursor pointing to the last item in the current page.


asset

Retrieves an asset by its ID.

Arguments

Name
Type
Description

id

ID!

The ID of the asset to retrieve.

Output types:

chevron-rightAssethashtag

A physical or logical asset being tracked.

Implements: Node, Titled, Customizable, Versioned

Field
Type
Description

id

ID!

A globally unique identifier. This ID is opaque and should not be parsed by clients.

version

Int!

The version number for optimistic locking. Incremented on each update. Must be provided in update/delete mutations to prevent lost updates.

title

String!

The human-readable display name.

organization

The organization that owns this asset.

type

The asset type classification.

customFields

JSON!

Custom field values as a key-value map. Keys are CustomFieldDefinition codes.

device

The primary tracking device linked to this asset. This is an alias for the device custom field.

groups

The groups this asset belongs to.

chevron-rightOrganization (entity)hashtag

An organization in the hierarchy that owns entities and users.

Implements: Node, Versioned, Titled

Field
Type
Description

id

ID!

A globally unique identifier. This ID is opaque and should not be parsed by clients.

version

Int!

The version number for optimistic locking. Incremented on each update. Must be provided in update/delete mutations to prevent lost updates.

title

String!

The human-readable display name.

externalId

String

An external system identifier for integration purposes.

isActive

Boolean!

Whether this organization is active.

features

The feature flags enabled for this organization.

parent

The parent organization in the hierarchy. Null for root organizations.

children

The child organizations.

members

The members of this organization.

devices

The devices owned by this organization.

assets

The assets owned by this organization.

geoObjects

The geographic objects owned by this organization.

schedules

The schedules owned by this organization.


assets

Lists assets for an organization.

Arguments

Name
Type
Description

organizationId

ID!

The organization to retrieve assets for.

filter

AssetFilter

Filtering options for the returned assets.

first

Int

The first n elements from the paginated listarrow-up-right.

after

String

The elements that come after the specified cursorarrow-up-right.

last

Int

The last n elements from the paginated listarrow-up-right.

before

String

The elements that come before the specified cursorarrow-up-right.

orderBy

AssetOrder

The ordering options for the returned assets.

Input types:

chevron-rightAssetFilterhashtag

Filtering options for assets.

Field
Type
Description

typeIds

[ID!]

Filter by asset types (OR within field).

deviceIds

[ID!]

Filter by linked devices (OR within field).

titleContains

String

Partial match on title (case-insensitive contains).

customFields

Filter by custom field values.

chevron-rightCustomFieldFilterhashtag

A filter condition for a custom field value.

Field
Type
Description

code

Code!

The custom field code to filter by.

operator

The comparison operator.

value

JSON

The value to compare against. Null for IS_NULL and IS_NOT_NULL operators.

chevron-rightAssetOrderhashtag

Ordering options for assets.

Field
Type
Description

field

The standard field to order by. Mutually exclusive with customFieldCode.

customFieldCode

Code

The custom field code to order by. Mutually exclusive with field.

direction

The direction to order.

Output types:

chevron-rightAssetConnectionhashtag

A paginated list of Asset items.

Implements: Connection

Field
Type
Description

edges

A list of edges.

nodes

[Asset!]!

A list of nodes in the connection (without edge metadata).

pageInfo

Information about the current page.

total

The total count of items matching the filter.

chevron-rightPageInfo (entity)hashtag

Information about the current page in a paginated connection.

Field
Type
Description

hasNextPage

Boolean!

Whether more items exist after the current page.

hasPreviousPage

Boolean!

Whether more items exist before the current page.

startCursor

String

The cursor pointing to the first item in the current page.

endCursor

String

The cursor pointing to the last item in the current page.


Last updated

Was this helpful?