Queries

circle-exclamation

assetGroupTypes

Lists asset group types for an organization.

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

Arguments

Name
Type
Description

organizationId

ID!

The organization to retrieve asset group types for.

filter

CatalogItemFilter

Filtering options for the returned asset group 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 group 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-rightAssetGroupTypeConnectionhashtag

A paginated list of AssetGroupType 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.


assetGroup

Retrieves an asset group by its ID.

Arguments

Name
Type
Description

id

ID!

The ID of the asset group to retrieve.

Output types:

chevron-rightAssetGrouphashtag

A group of assets.

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.

organization

The organization that owns this group.

type

The group type with membership constraints.

color

HexColorCode

The color for UI display in hexadecimal format.

currentAssets

The assets currently in this group.

history

The full membership history for this group.

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.


assetGroups

Lists asset groups for an organization.

Arguments

Name
Type
Description

organizationId

ID!

The organization to retrieve asset groups for.

filter

AssetGroupFilter

Filtering options for the returned asset groups.

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

AssetGroupOrder

The ordering options for the returned asset groups.

Input types:

chevron-rightAssetGroupFilterhashtag

Filtering options for asset groups.

Field
Type
Description

typeIds

[ID!]

Filter by group types (OR within field).

titleContains

String

Partial match on title (case-insensitive contains).

chevron-rightAssetGroupOrderhashtag

Ordering options for asset groups.

Field
Type
Description

field

The field to order by.

direction

The direction to order.

Output types:

chevron-rightAssetGroupConnectionhashtag

A paginated list of AssetGroup 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.


Last updated

Was this helpful?