Mutations

Navixy Repository API is a work in progress. This documentation is published for preview purposes only and doesn't reflect a stable release. Structure, field names, and behaviors are subject to change.

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.
statusId	ID!	The initial device status ID.
title	String!	The device display name.
identifiers	[DeviceIdentifierInput!]	The hardware identifiers.

DeviceIdentifierInput

Input for a device identifier.

Field	Type	Description
type	DeviceIdType!	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	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. Must be provided in update/delete mutations to prevent lost updates.
title	String!	The human-readable display name.
organization	Organization!	The organization that owns this device.
type	DeviceType!	The device type classification.
model	DeviceModel!	The specific device model.
status	DeviceStatus!	The current operational status.
identifiers	[DeviceIdentifier!]!	The hardware identifiers for this device (IMEI, serial number, MAC address, etc.).
inventory	Inventory	The inventory this device is currently assigned to.
relationsFrom	[DeviceRelation!]!	The outgoing relationships from this device to other devices.
relationsTo	[DeviceRelation!]!	The incoming relationships from other devices to this device.
inventoryHistory	DeviceInventoryRelationConnection!	The history of inventory assignments for this device.

---

deviceUpdate

Updates an existing device.

deviceUpdate(
    input: DeviceUpdateInput!
  ): DevicePayload

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.
modelId	ID	The new device model.
statusId	ID	The new device status.
title	String	The new display name.

Output types:

DevicePayload

The result of a device mutation.

Field	Type	Description
device	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. Must be provided in update/delete mutations to prevent lost updates.
title	String!	The human-readable display name.
organization	Organization!	The organization that owns this device.
type	DeviceType!	The device type classification.
model	DeviceModel!	The specific device model.
status	DeviceStatus!	The current operational status.
identifiers	[DeviceIdentifier!]!	The hardware identifiers for this device (IMEI, serial number, MAC address, etc.).
inventory	Inventory	The inventory this device is currently assigned to.
relationsFrom	[DeviceRelation!]!	The outgoing relationships from this device to other devices.
relationsTo	[DeviceRelation!]!	The incoming relationships from other devices to this device.
inventoryHistory	DeviceInventoryRelationConnection!	The history of inventory assignments for this device.

---

deviceDelete

Deletes a device.

deviceDelete(
    input: DeviceDeleteInput!
  ): DeletePayload

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.

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.

deviceIdentifierAdd(
    input: DeviceIdentifierAddInput!
  ): DeviceIdentifierPayload

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	DeviceIdentifierInput!	The identifier details.

DeviceIdentifierInput

Input for a device identifier.

Field	Type	Description
type	DeviceIdType!	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	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	Device!	The device this identifier belongs to.
type	DeviceIdType!	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.

deviceIdentifierRemove(
    input: DeviceIdentifierRemoveInput!
  ): DeletePayload

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.

deviceRelationCreate(
    input: DeviceRelationCreateInput!
  ): DeviceRelationPayload

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	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	Device!	The first device in the relationship.
second	Device!	The second device in the relationship.
type	DeviceRelationType!	The type of relationship.

---

deviceRelationRemove

Removes a device relationship.

deviceRelationRemove(
    input: DeviceRelationRemoveInput!
  ): DeletePayload

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.

deviceTypeCreate(
    input: DeviceTypeCreateInput!
  ): DeviceTypePayload

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.
title	String!	The display name.
order	Int	The display order.
meta	CatalogItemMetaInput	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.
textColor	HexColorCode	The text color for UI display.
backgroundColor	HexColorCode	The background color for UI display.
icon	String	A relative URL to the icon.

Output types:

DeviceTypePayload

The result of a device type mutation.

Field	Type	Description
deviceType	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	Catalog!	The catalog this item belongs to.
organization	Organization	The organization that owns this item. Null for system items.
meta	CatalogItemMeta!	Metadata about this item including description, origin, and display properties.
customFieldDefinitions	[CustomFieldDefinition!]!	Custom field definitions specific to this device type, ordered by display order.

---

deviceTypeUpdate

Updates a device type.

deviceTypeUpdate(
    input: DeviceTypeUpdateInput!
  ): DeviceTypePayload

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.
title	String	The new display name.
order	Int	The new display order.
meta	CatalogItemMetaInput	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.
textColor	HexColorCode	The text color for UI display.
backgroundColor	HexColorCode	The background color for UI display.
icon	String	A relative URL to the icon.

Output types:

DeviceTypePayload

The result of a device type mutation.

Field	Type	Description
deviceType	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	Catalog!	The catalog this item belongs to.
organization	Organization	The organization that owns this item. Null for system items.
meta	CatalogItemMeta!	Metadata about this item including description, origin, and display properties.
customFieldDefinitions	[CustomFieldDefinition!]!	Custom field definitions specific to this device type, ordered by display order.

---

deviceTypeDelete

Deletes a device type.

deviceTypeDelete(
    input: CatalogItemDeleteInput!
  ): DeletePayload

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.

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.

deviceStatusCreate(
    input: DeviceStatusCreateInput!
  ): DeviceStatusPayload

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.
title	String!	The display name.
order	Int	The display order.
meta	CatalogItemMetaInput	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.
textColor	HexColorCode	The text color for UI display.
backgroundColor	HexColorCode	The background color for UI display.
icon	String	A relative URL to the icon.

Output types:

DeviceStatusPayload

The result of a device status mutation.

Field	Type	Description
deviceStatus	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	Catalog!	The catalog this item belongs to.
organization	Organization	The organization that owns this item. Null for system items.
meta	CatalogItemMeta!	Metadata about this item including description, origin, and display properties.

---

deviceStatusUpdate

Updates a device status.

deviceStatusUpdate(
    input: DeviceStatusUpdateInput!
  ): DeviceStatusPayload

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.
title	String	The new display name.
order	Int	The new display order.
meta	CatalogItemMetaInput	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.
textColor	HexColorCode	The text color for UI display.
backgroundColor	HexColorCode	The background color for UI display.
icon	String	A relative URL to the icon.

Output types:

DeviceStatusPayload

The result of a device status mutation.

Field	Type	Description
deviceStatus	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	Catalog!	The catalog this item belongs to.
organization	Organization	The organization that owns this item. Null for system items.
meta	CatalogItemMeta!	Metadata about this item including description, origin, and display properties.

---

deviceStatusDelete

Deletes a device status.

deviceStatusDelete(
    input: CatalogItemDeleteInput!
  ): DeletePayload

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.

Output types:

DeletePayload

The result of a delete mutation.

Field	Type	Description
deletedId	ID!	The ID of the deleted entity.

---