For the complete documentation index, see llms.txt. This page is also available as Markdown.

Mutations

Mutation reference for devices. Create, update, and delete devices, manage identifiers, and link or unlink device relations.

deviceCreate

Creates a new device.

deviceCreate(
    input: DeviceCreateInput!
  ): DevicePayload

Arguments

Name
Type
Description

input

DeviceCreateInput!

The input fields for creating the device.

Input types:

DeviceCreateInput

Input for creating a new device.

Field
Type
Description

organizationId

ID!

The organization that will own the device.

typeId

ID!

The device type ID.

modelId

ID!

The device model ID.

title

String

The device display name. If omitted or blank, the server generates "<vendor.title> <model.title> <identifier.value>" where the identifier is chosen by type priority: IMEI > SERIAL_NUMBER > MAC_ADDRESS, with fallback to identifiers[0] when none of the priority types are present.

identifiers

The hardware identifiers. At least one entry is required.

DeviceIdentifierInput

Input for a device identifier.

Field
Type
Description

type

The type of identifier.

value

String!

The identifier value.

namespace

Code

The namespace for uniqueness scope. Null means globally unique.

Output types:

DevicePayload

The result of a device mutation.

Field
Type
Description

device

The created or updated device.

Device (entity)

A tracking device such as a GPS tracker, sensor, or beacon.

Implements: Node, Titled, Versioned, InventoryItem

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. Can be provided in update/delete mutations to prevent lost updates. If omitted, the update proceeds without stale-read protection.

title

String!

The human-readable display name.

organization

The organization that owns this device.

type

The device type classification.

model

The specific device model.

status

The current operational status.

identifiers

The hardware identifiers for this device (IMEI, serial number, MAC address, etc.).

asset

The asset this device is currently linked to.

inventory

The inventory this device is currently assigned to.

relationsFrom

The outgoing relationships from this device to other devices.

relationsTo

The incoming relationships from other devices to this device.

inventoryHistory

The history of inventory assignments for this device.


deviceUpdate

Updates an existing device.

Arguments

Name
Type
Description

input

DeviceUpdateInput!

The input fields for updating the device.

Input types:

DeviceUpdateInput

Input for updating an existing device.

Field
Type
Description

id

ID!

The device ID to update.

version

Int

The current version for optimistic locking. If omitted, auto-increments without conflict check.

modelId

ID

The new device model.

title

String

The new display name.

Output types:

DevicePayload

The result of a device mutation.

Field
Type
Description

device

The created or updated device.

Device (entity)

A tracking device such as a GPS tracker, sensor, or beacon.

Implements: Node, Titled, Versioned, InventoryItem

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. Can be provided in update/delete mutations to prevent lost updates. If omitted, the update proceeds without stale-read protection.

title

String!

The human-readable display name.

organization

The organization that owns this device.

type

The device type classification.

model

The specific device model.

status

The current operational status.

identifiers

The hardware identifiers for this device (IMEI, serial number, MAC address, etc.).

asset

The asset this device is currently linked to.

inventory

The inventory this device is currently assigned to.

relationsFrom

The outgoing relationships from this device to other devices.

relationsTo

The incoming relationships from other devices to this device.

inventoryHistory

The history of inventory assignments for this device.


deviceDelete

Deletes a device.

Arguments

Name
Type
Description

input

DeviceDeleteInput!

The input fields for deleting the device.

Input types:

DeviceDeleteInput

Input for deleting a device.

Field
Type
Description

id

ID!

The device ID to delete.

version

Int

The current version for optimistic locking. If omitted, auto-increments without conflict check.

Output types:

DeletePayload

The result of a delete mutation.

Field
Type
Description

deletedId

ID!

The ID of the deleted entity.


deviceIdentifierAdd

Adds an identifier to a device.

Arguments

Name
Type
Description

input

DeviceIdentifierAddInput!

The input fields for adding the identifier.

Input types:

DeviceIdentifierAddInput

Input for adding an identifier to a device.

Field
Type
Description

deviceId

ID!

The device ID.

identifier

The identifier details.

DeviceIdentifierInput

Input for a device identifier.

Field
Type
Description

type

The type of identifier.

value

String!

The identifier value.

namespace

Code

The namespace for uniqueness scope. Null means globally unique.

Output types:

DeviceIdentifierPayload

The result of a device identifier mutation.

Field
Type
Description

deviceIdentifier

The added device identifier.

DeviceIdentifier (entity)

A hardware identifier for a device.

Implements: Node

Field
Type
Description

id

ID!

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

device

The device this identifier belongs to.

type

The type of identifier.

value

String!

The identifier value.

namespace

Code

The namespace for uniqueness scope. Null means the identifier is globally unique.


deviceIdentifierRemove

Removes an identifier from a device.

Arguments

Name
Type
Description

input

DeviceIdentifierRemoveInput!

The input fields for removing the identifier.

Input types:

DeviceIdentifierRemoveInput

Input for removing an identifier from a device.

Field
Type
Description

identifierId

ID!

The identifier ID to remove.

Output types:

DeletePayload

The result of a delete mutation.

Field
Type
Description

deletedId

ID!

The ID of the deleted entity.


deviceRelationCreate

Creates a relationship between devices.

Arguments

Name
Type
Description

input

DeviceRelationCreateInput!

The input fields for creating the relationship.

Input types:

DeviceRelationCreateInput

Input for creating a relationship between devices.

Field
Type
Description

firstId

ID!

The first device ID.

secondId

ID!

The second device ID.

typeId

ID!

The relationship type ID.

Output types:

DeviceRelationPayload

The result of a device relation mutation.

Field
Type
Description

deviceRelation

The created device relationship.

DeviceRelation (entity)

A relationship between two devices.

Implements: Node

Field
Type
Description

id

ID!

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

first

The first device in the relationship.

second

The second device in the relationship.

type

The type of relationship.


deviceRelationRemove

Removes a device relationship.

Arguments

Name
Type
Description

input

DeviceRelationRemoveInput!

The input fields for removing the relationship.

Input types:

DeviceRelationRemoveInput

Input for removing a device relationship.

Field
Type
Description

id

ID!

The relationship ID to remove.

Output types:

DeletePayload

The result of a delete mutation.

Field
Type
Description

deletedId

ID!

The ID of the deleted entity.


deviceTypeCreate

Creates a new device type.

Arguments

Name
Type
Description

input

DeviceTypeCreateInput!

The input fields for creating the device type.

Input types:

DeviceTypeCreateInput

Input for creating a device type.

Field
Type
Description

organizationId

ID!

The organization that will own the item.

code

Code

The machine-readable code. Auto-generated from title if omitted.

title

String!

The display name.

order

Int

The display order. Auto-calculated as last position if omitted.

meta

The display properties.

CatalogItemMetaInput

Display properties for catalog items.

Field
Type
Description

description

String

The description.

hidden

Boolean

Whether the item is hidden from regular UI lists.

Output types:

DeviceTypePayload

The result of a device type mutation.

Field
Type
Description

deviceType

The created or updated device type.

DeviceType (entity)

A classification type for devices.

Implements: CatalogItem, Node, Versioned, Titled

Field
Type
Description

id

ID!

A globally unique identifier.

version

Int!

The version number for optimistic locking.

title

String!

The human-readable display name. Can be localized.

code

Code!

A machine-readable code, unique within the catalog scope.

order

Int!

The display order within the same level or category.

catalog

The catalog this item belongs to.

organization

The organization that owns this item. Null for system items.

meta

Metadata about this item including description, origin, and display properties.


deviceTypeUpdate

Updates a device type.

Arguments

Name
Type
Description

input

DeviceTypeUpdateInput!

The input fields for updating the device type.

Input types:

DeviceTypeUpdateInput

Input for updating a device type.

Field
Type
Description

id

ID!

The item ID to update.

version

Int

The current version for optimistic locking. If omitted, auto-increments without conflict check.

title

String

The new display name.

order

Int

The new display order.

meta

The display properties.

CatalogItemMetaInput

Display properties for catalog items.

Field
Type
Description

description

String

The description.

hidden

Boolean

Whether the item is hidden from regular UI lists.

Output types:

DeviceTypePayload

The result of a device type mutation.

Field
Type
Description

deviceType

The created or updated device type.

DeviceType (entity)

A classification type for devices.

Implements: CatalogItem, Node, Versioned, Titled

Field
Type
Description

id

ID!

A globally unique identifier.

version

Int!

The version number for optimistic locking.

title

String!

The human-readable display name. Can be localized.

code

Code!

A machine-readable code, unique within the catalog scope.

order

Int!

The display order within the same level or category.

catalog

The catalog this item belongs to.

organization

The organization that owns this item. Null for system items.

meta

Metadata about this item including description, origin, and display properties.


deviceTypeDelete

Deletes a device type.

Arguments

Name
Type
Description

input

CatalogItemDeleteInput!

The input fields for deleting the device type.

Input types:

CatalogItemDeleteInput

Input for deleting a catalog item.

Field
Type
Description

id

ID!

The catalog item ID to delete.

version

Int

The current version for optimistic locking. If omitted, auto-increments without conflict check.

Output types:

DeletePayload

The result of a delete mutation.

Field
Type
Description

deletedId

ID!

The ID of the deleted entity.


deviceStatusCreate

Creates a new device status.

Arguments

Name
Type
Description

input

DeviceStatusCreateInput!

The input fields for creating the device status.

Input types:

DeviceStatusCreateInput

Input for creating a device status.

Field
Type
Description

organizationId

ID!

The organization that will own the item.

code

Code

The machine-readable code. Auto-generated from title if omitted.

title

String!

The display name.

order

Int

The display order. Auto-calculated as last position if omitted.

meta

The display properties.

CatalogItemMetaInput

Display properties for catalog items.

Field
Type
Description

description

String

The description.

hidden

Boolean

Whether the item is hidden from regular UI lists.

Output types:

DeviceStatusPayload

The result of a device status mutation.

Field
Type
Description

deviceStatus

The created or updated device status.

DeviceStatus (entity)

An operational status for devices.

Implements: CatalogItem, Node, Versioned, Titled

Field
Type
Description

id

ID!

A globally unique identifier.

version

Int!

The version number for optimistic locking.

title

String!

The human-readable display name. Can be localized.

code

Code!

A machine-readable code, unique within the catalog scope.

order

Int!

The display order within the same level or category.

catalog

The catalog this item belongs to.

organization

The organization that owns this item. Null for system items.

meta

Metadata about this item including description, origin, and display properties.


deviceStatusUpdate

Updates a device status.

Arguments

Name
Type
Description

input

DeviceStatusUpdateInput!

The input fields for updating the device status.

Input types:

DeviceStatusUpdateInput

Input for updating a device status.

Field
Type
Description

id

ID!

The item ID to update.

version

Int

The current version for optimistic locking. If omitted, auto-increments without conflict check.

title

String

The new display name.

order

Int

The new display order.

meta

The display properties.

CatalogItemMetaInput

Display properties for catalog items.

Field
Type
Description

description

String

The description.

hidden

Boolean

Whether the item is hidden from regular UI lists.

Output types:

DeviceStatusPayload

The result of a device status mutation.

Field
Type
Description

deviceStatus

The created or updated device status.

DeviceStatus (entity)

An operational status for devices.

Implements: CatalogItem, Node, Versioned, Titled

Field
Type
Description

id

ID!

A globally unique identifier.

version

Int!

The version number for optimistic locking.

title

String!

The human-readable display name. Can be localized.

code

Code!

A machine-readable code, unique within the catalog scope.

order

Int!

The display order within the same level or category.

catalog

The catalog this item belongs to.

organization

The organization that owns this item. Null for system items.

meta

Metadata about this item including description, origin, and display properties.


deviceStatusDelete

Deletes a device status.

Arguments

Name
Type
Description

input

CatalogItemDeleteInput!

The input fields for deleting the device status.

Input types:

CatalogItemDeleteInput

Input for deleting a catalog item.

Field
Type
Description

id

ID!

The catalog item ID to delete.

version

Int

The current version for optimistic locking. If omitted, auto-increments without conflict check.

Output types:

DeletePayload

The result of a delete mutation.

Field
Type
Description

deletedId

ID!

The ID of the deleted entity.


Last updated

Was this helpful?