> For the complete documentation index, see [llms.txt](https://navixy.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://navixy.com/docs/navixy-graphql-api/products/business-data-repository/api-reference/devices.md).

# Devices

Complete reference for devices: register GPS trackers and sensors, manage hardware identifiers, link devices to assets, and track relations.

Devices are GPS trackers, sensors, and other hardware that collect and transmit location and telemetry data.

## Queries

### deviceTypes

Lists device types in the caller's workspace.

```graphql
deviceTypes(
    filter: CatalogItemFilter
    first: Int
    after: String
    last: Int
    before: String
    orderBy: CatalogItemOrder = { field: ORDER, direction: ASC }
  ): DeviceTypeConnection!
```

**Arguments**

| Name      | Type                | Description                                                                                                     |
| --------- | ------------------- | --------------------------------------------------------------------------------------------------------------- |
| `filter`  | `CatalogItemFilter` | Filtering options for the returned device types.                                                                |
| `first`   | `Int`               | The first `n` elements from the [paginated list](https://navixy.com/docs/navixy-graphql-api/pagination.md).     |
| `after`   | `String`            | The elements that come after the specified [cursor](https://navixy.com/docs/navixy-graphql-api/pagination.md).  |
| `last`    | `Int`               | The last `n` elements from the [paginated list](https://navixy.com/docs/navixy-graphql-api/pagination.md).      |
| `before`  | `String`            | The elements that come before the specified [cursor](https://navixy.com/docs/navixy-graphql-api/pagination.md). |
| `orderBy` | `CatalogItemOrder`  | The ordering options for the returned device types.                                                             |

**Input types:**

<details>

<summary>CatalogItemFilter</summary>

Filtering options for catalog items.

| Field           | Type                                                                                     | Description                                         |
| --------------- | ---------------------------------------------------------------------------------------- | --------------------------------------------------- |
| `titleContains` | `String`                                                                                 | Partial match on title (case-insensitive contains). |
| `codes`         | \[[Code](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#code)!] | Match any of these codes.                           |

</details>

<details>

<summary>CatalogItemOrder</summary>

Ordering options for catalog items.

| Field       | Type                                                                                                                                                                 | Description             |
| ----------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------- |
| `field`     | [CatalogItemOrderField](https://navixy.com/docs/navixy-graphql-api/products/business-data-repository/api-reference/catalogs/catalog-items.md#catalogitemorderfield)! | The field to order by.  |
| `direction` | [OrderDirection](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#orderdirection)!                                                            | The direction to order. |

</details>

**Output types:**

<details>

<summary>DeviceTypeConnection</summary>

A paginated list of DeviceType items.

**Implements:** [Connection](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#connection)

| Field      | Type                                                                                           | Description                                                |
| ---------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------- |
| `edges`    | \[[DeviceTypeEdge](#devicetypeedge)!]!                                                         | A list of edges.                                           |
| `nodes`    | \[[DeviceType](#devicetype)!]!                                                                 | A list of nodes in the connection (without edge metadata). |
| `pageInfo` | [PageInfo](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#pageinfo)!  | Information about the current page.                        |
| `total`    | [CountInfo](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#countinfo) | The total count of items matching the filter.              |

</details>

***

### deviceStatuses

Lists device statuses in the caller's workspace.

```graphql
deviceStatuses(
    filter: CatalogItemFilter
    first: Int
    after: String
    last: Int
    before: String
    orderBy: CatalogItemOrder = { field: ORDER, direction: ASC }
  ): DeviceStatusConnection!
```

**Arguments**

| Name      | Type                | Description                                                                                                     |
| --------- | ------------------- | --------------------------------------------------------------------------------------------------------------- |
| `filter`  | `CatalogItemFilter` | Filtering options for the returned device statuses.                                                             |
| `first`   | `Int`               | The first `n` elements from the [paginated list](https://navixy.com/docs/navixy-graphql-api/pagination.md).     |
| `after`   | `String`            | The elements that come after the specified [cursor](https://navixy.com/docs/navixy-graphql-api/pagination.md).  |
| `last`    | `Int`               | The last `n` elements from the [paginated list](https://navixy.com/docs/navixy-graphql-api/pagination.md).      |
| `before`  | `String`            | The elements that come before the specified [cursor](https://navixy.com/docs/navixy-graphql-api/pagination.md). |
| `orderBy` | `CatalogItemOrder`  | The ordering options for the returned device statuses.                                                          |

**Input types:**

<details>

<summary>CatalogItemFilter</summary>

Filtering options for catalog items.

| Field           | Type                                                                                     | Description                                         |
| --------------- | ---------------------------------------------------------------------------------------- | --------------------------------------------------- |
| `titleContains` | `String`                                                                                 | Partial match on title (case-insensitive contains). |
| `codes`         | \[[Code](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#code)!] | Match any of these codes.                           |

</details>

<details>

<summary>CatalogItemOrder</summary>

Ordering options for catalog items.

| Field       | Type                                                                                                                                                                 | Description             |
| ----------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------- |
| `field`     | [CatalogItemOrderField](https://navixy.com/docs/navixy-graphql-api/products/business-data-repository/api-reference/catalogs/catalog-items.md#catalogitemorderfield)! | The field to order by.  |
| `direction` | [OrderDirection](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#orderdirection)!                                                            | The direction to order. |

</details>

**Output types:**

<details>

<summary>DeviceStatusConnection</summary>

A paginated list of DeviceStatus items.

**Implements:** [Connection](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#connection)

| Field      | Type                                                                                           | Description                                                |
| ---------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------- |
| `edges`    | \[[DeviceStatusEdge](#devicestatusedge)!]!                                                     | A list of edges.                                           |
| `nodes`    | \[[DeviceStatus](#devicestatus)!]!                                                             | A list of nodes in the connection (without edge metadata). |
| `pageInfo` | [PageInfo](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#pageinfo)!  | Information about the current page.                        |
| `total`    | [CountInfo](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#countinfo) | The total count of items matching the filter.              |

</details>

***

### deviceModels

Lists device models with optional vendor filter.

```graphql
deviceModels(
    filter: DeviceModelFilter
    first: Int
    after: String
    last: Int
    before: String
    orderBy: CatalogItemOrder = { field: TITLE, direction: ASC }
  ): DeviceModelConnection!
```

**Arguments**

| Name      | Type                | Description                                                                                                     |
| --------- | ------------------- | --------------------------------------------------------------------------------------------------------------- |
| `filter`  | `DeviceModelFilter` | Filtering options for the returned device models.                                                               |
| `first`   | `Int`               | The first `n` elements from the [paginated list](https://navixy.com/docs/navixy-graphql-api/pagination.md).     |
| `after`   | `String`            | The elements that come after the specified [cursor](https://navixy.com/docs/navixy-graphql-api/pagination.md).  |
| `last`    | `Int`               | The last `n` elements from the [paginated list](https://navixy.com/docs/navixy-graphql-api/pagination.md).      |
| `before`  | `String`            | The elements that come before the specified [cursor](https://navixy.com/docs/navixy-graphql-api/pagination.md). |
| `orderBy` | `CatalogItemOrder`  | The ordering options for the returned device models.                                                            |

**Input types:**

<details>

<summary>DeviceModelFilter</summary>

Filtering options for device models.

| Field           | Type                                                                                 | Description                                                       |
| --------------- | ------------------------------------------------------------------------------------ | ----------------------------------------------------------------- |
| `vendorIds`     | `[ID!]`                                                                              | Filter by vendors (OR within field).                              |
| `titleContains` | `String`                                                                             | Partial match on title (case-insensitive contains).               |
| `code`          | [Code](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#code) | Exact code match.                                                 |
| `supported`     | `Boolean`                                                                            | Filter to models the platform supports (`DeviceModel.supported`). |

</details>

<details>

<summary>CatalogItemOrder</summary>

Ordering options for catalog items.

| Field       | Type                                                                                                                                                                 | Description             |
| ----------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------- |
| `field`     | [CatalogItemOrderField](https://navixy.com/docs/navixy-graphql-api/products/business-data-repository/api-reference/catalogs/catalog-items.md#catalogitemorderfield)! | The field to order by.  |
| `direction` | [OrderDirection](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#orderdirection)!                                                            | The direction to order. |

</details>

**Output types:**

<details>

<summary>DeviceModelConnection</summary>

A paginated list of DeviceModel items.

**Implements:** [Connection](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#connection)

| Field      | Type                                                                                           | Description                                                |
| ---------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------- |
| `edges`    | \[[DeviceModelEdge](#devicemodeledge)!]!                                                       | A list of edges.                                           |
| `nodes`    | \[[DeviceModel](#devicemodel)!]!                                                               | A list of nodes in the connection (without edge metadata). |
| `pageInfo` | [PageInfo](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#pageinfo)!  | Information about the current page.                        |
| `total`    | [CountInfo](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#countinfo) | The total count of items matching the filter.              |

</details>

***

### deviceVendors

Lists device vendors in the caller's workspace.

```graphql
deviceVendors(
    filter: CatalogItemFilter
    first: Int
    after: String
    last: Int
    before: String
    orderBy: CatalogItemOrder = { field: ORDER, direction: ASC }
  ): DeviceVendorConnection!
```

**Arguments**

| Name      | Type                | Description                                                                                                     |
| --------- | ------------------- | --------------------------------------------------------------------------------------------------------------- |
| `filter`  | `CatalogItemFilter` | Filtering options for the returned device vendors.                                                              |
| `first`   | `Int`               | The first `n` elements from the [paginated list](https://navixy.com/docs/navixy-graphql-api/pagination.md).     |
| `after`   | `String`            | The elements that come after the specified [cursor](https://navixy.com/docs/navixy-graphql-api/pagination.md).  |
| `last`    | `Int`               | The last `n` elements from the [paginated list](https://navixy.com/docs/navixy-graphql-api/pagination.md).      |
| `before`  | `String`            | The elements that come before the specified [cursor](https://navixy.com/docs/navixy-graphql-api/pagination.md). |
| `orderBy` | `CatalogItemOrder`  | The ordering options for the returned device vendors.                                                           |

**Input types:**

<details>

<summary>CatalogItemFilter</summary>

Filtering options for catalog items.

| Field           | Type                                                                                     | Description                                         |
| --------------- | ---------------------------------------------------------------------------------------- | --------------------------------------------------- |
| `titleContains` | `String`                                                                                 | Partial match on title (case-insensitive contains). |
| `codes`         | \[[Code](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#code)!] | Match any of these codes.                           |

</details>

<details>

<summary>CatalogItemOrder</summary>

Ordering options for catalog items.

| Field       | Type                                                                                                                                                                 | Description             |
| ----------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------- |
| `field`     | [CatalogItemOrderField](https://navixy.com/docs/navixy-graphql-api/products/business-data-repository/api-reference/catalogs/catalog-items.md#catalogitemorderfield)! | The field to order by.  |
| `direction` | [OrderDirection](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#orderdirection)!                                                            | The direction to order. |

</details>

**Output types:**

<details>

<summary>DeviceVendorConnection</summary>

A paginated list of DeviceVendor items.

**Implements:** [Connection](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#connection)

| Field      | Type                                                                                           | Description                                                |
| ---------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------- |
| `edges`    | \[[DeviceVendorEdge](#devicevendoredge)!]!                                                     | A list of edges.                                           |
| `nodes`    | \[[DeviceVendor](#devicevendor)!]!                                                             | A list of nodes in the connection (without edge metadata). |
| `pageInfo` | [PageInfo](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#pageinfo)!  | Information about the current page.                        |
| `total`    | [CountInfo](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#countinfo) | The total count of items matching the filter.              |

</details>

***

### deviceRelationTypes

Lists device relation types in the caller's workspace.

```graphql
deviceRelationTypes(
    filter: CatalogItemFilter
    first: Int
    after: String
    last: Int
    before: String
    orderBy: CatalogItemOrder = { field: ORDER, direction: ASC }
  ): DeviceRelationTypeConnection!
```

**Arguments**

| Name      | Type                | Description                                                                                                     |
| --------- | ------------------- | --------------------------------------------------------------------------------------------------------------- |
| `filter`  | `CatalogItemFilter` | Filtering options for the returned device relation types.                                                       |
| `first`   | `Int`               | The first `n` elements from the [paginated list](https://navixy.com/docs/navixy-graphql-api/pagination.md).     |
| `after`   | `String`            | The elements that come after the specified [cursor](https://navixy.com/docs/navixy-graphql-api/pagination.md).  |
| `last`    | `Int`               | The last `n` elements from the [paginated list](https://navixy.com/docs/navixy-graphql-api/pagination.md).      |
| `before`  | `String`            | The elements that come before the specified [cursor](https://navixy.com/docs/navixy-graphql-api/pagination.md). |
| `orderBy` | `CatalogItemOrder`  | The ordering options for the returned device relation types.                                                    |

**Input types:**

<details>

<summary>CatalogItemFilter</summary>

Filtering options for catalog items.

| Field           | Type                                                                                     | Description                                         |
| --------------- | ---------------------------------------------------------------------------------------- | --------------------------------------------------- |
| `titleContains` | `String`                                                                                 | Partial match on title (case-insensitive contains). |
| `codes`         | \[[Code](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#code)!] | Match any of these codes.                           |

</details>

<details>

<summary>CatalogItemOrder</summary>

Ordering options for catalog items.

| Field       | Type                                                                                                                                                                 | Description             |
| ----------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------- |
| `field`     | [CatalogItemOrderField](https://navixy.com/docs/navixy-graphql-api/products/business-data-repository/api-reference/catalogs/catalog-items.md#catalogitemorderfield)! | The field to order by.  |
| `direction` | [OrderDirection](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#orderdirection)!                                                            | The direction to order. |

</details>

**Output types:**

<details>

<summary>DeviceRelationTypeConnection</summary>

A paginated list of DeviceRelationType items.

**Implements:** [Connection](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#connection)

| Field      | Type                                                                                           | Description                                                |
| ---------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------- |
| `edges`    | \[[DeviceRelationTypeEdge](#devicerelationtypeedge)!]!                                         | A list of edges.                                           |
| `nodes`    | \[[DeviceRelationType](#devicerelationtype)!]!                                                 | A list of nodes in the connection (without edge metadata). |
| `pageInfo` | [PageInfo](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#pageinfo)!  | Information about the current page.                        |
| `total`    | [CountInfo](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#countinfo) | The total count of items matching the filter.              |

</details>

***

### device (query)

Retrieves a device by its ID.

```graphql
device(id: ID!): Device
```

**Arguments**

| Name | Type  | Description                       |
| ---- | ----- | --------------------------------- |
| `id` | `ID!` | The ID of the device to retrieve. |

**Output types:**

<details>

<summary>Device</summary>

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

**Implements:** [Node](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#node), [Titled](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#titled), [Versioned](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#versioned), [InventoryItem](https://navixy.com/docs/navixy-graphql-api/products/business-data-repository/api-reference/devices/inventory.md#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.                                                                                                                                                                                                                                                                                                    |
| `workspace`        | [Workspace](https://navixy.com/docs/navixy-graphql-api/products/business-data-repository/api-reference/workspaces.md#workspace)!                                                        | The workspace that owns this device.                                                                                                                                                                                                                                                                                                |
| `type`             | [DeviceType](#devicetype)!                                                                                                                                                              | The device type classification.                                                                                                                                                                                                                                                                                                     |
| `model`            | [DeviceModel](#devicemodel)!                                                                                                                                                            | The specific device model.                                                                                                                                                                                                                                                                                                          |
| `status`           | [DeviceStatus](#devicestatus)!                                                                                                                                                          | The current operational status.                                                                                                                                                                                                                                                                                                     |
| `createdAt`        | [DateTime](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#datetime)!                                                                                           | When this device record was created.                                                                                                                                                                                                                                                                                                |
| `activation`       | [DeviceActivation](#deviceactivation)                                                                                                                                                   | SIM/APN activation data, present once the device has gone through `deviceActivate`. Null for a device created only via `deviceCreate`. Also null, with an `INTERNAL_ERROR` on this field alone, for a stored activation the server cannot read, such as one with a missing key; the device itself and the list it is in are served. |
| `identifiers`      | \[[DeviceIdentifier](#deviceidentifier)!]!                                                                                                                                              | The hardware identifiers for this device (IMEI, serial number, MAC address, etc.).                                                                                                                                                                                                                                                  |
| `asset`            | [Asset](https://navixy.com/docs/navixy-graphql-api/products/business-data-repository/api-reference/assets.md#asset)                                                                     | The asset this device is currently linked to.                                                                                                                                                                                                                                                                                       |
| `inventory`        | [Inventory](https://navixy.com/docs/navixy-graphql-api/products/business-data-repository/api-reference/devices/inventory.md#inventory)                                                  | The inventory this device is currently assigned to.                                                                                                                                                                                                                                                                                 |
| `relationsFrom`    | \[[DeviceRelation](#devicerelation)!]!                                                                                                                                                  | The outgoing relationships from this device to other devices.                                                                                                                                                                                                                                                                       |
| `relationsTo`      | \[[DeviceRelation](#devicerelation)!]!                                                                                                                                                  | The incoming relationships from other devices to this device.                                                                                                                                                                                                                                                                       |
| `inventoryHistory` | [DeviceInventoryRelationConnection](https://navixy.com/docs/navixy-graphql-api/products/business-data-repository/api-reference/devices/inventory.md#deviceinventoryrelationconnection)! | The history of inventory assignments for this device.                                                                                                                                                                                                                                                                               |

</details>

***

### devices

Lists devices in the caller's workspace.

```graphql
devices(
    filter: DeviceFilter
    first: Int
    after: String
    last: Int
    before: String
    orderBy: DeviceOrder = { field: TITLE, direction: ASC }
  ): DeviceConnection!
```

**Arguments**

| Name      | Type           | Description                                                                                                     |
| --------- | -------------- | --------------------------------------------------------------------------------------------------------------- |
| `filter`  | `DeviceFilter` | Filtering options for the returned devices.                                                                     |
| `first`   | `Int`          | The first `n` elements from the [paginated list](https://navixy.com/docs/navixy-graphql-api/pagination.md).     |
| `after`   | `String`       | The elements that come after the specified [cursor](https://navixy.com/docs/navixy-graphql-api/pagination.md).  |
| `last`    | `Int`          | The last `n` elements from the [paginated list](https://navixy.com/docs/navixy-graphql-api/pagination.md).      |
| `before`  | `String`       | The elements that come before the specified [cursor](https://navixy.com/docs/navixy-graphql-api/pagination.md). |
| `orderBy` | `DeviceOrder`  | The ordering options for the returned devices.                                                                  |

**Input types:**

<details>

<summary>DeviceFilter</summary>

Filtering options for devices.

| Field                | Type     | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| -------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `typeIds`            | `[ID!]`  | Filter by device types (OR within field).                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| `modelIds`           | `[ID!]`  | Filter by device models (OR within field).                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| `statusIds`          | `[ID!]`  | Filter by statuses (OR within field).                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| `vendorIds`          | `[ID!]`  | Filter by vendors (OR within field).                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| `identifierContains` | `String` | Partial match on device identifier value (case-insensitive contains).                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| `inventoryIds`       | `[ID!]`  | Filter by inventories (OR within field).                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| `titleContains`      | `String` | Partial match on title (case-insensitive contains).                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| `search`             | `String` | Free-text search for a device list search box: a device matches when its title or any of its identifier values contains the value (case-insensitive), or its activation SIM phone number contains it. The phone is stored as digits only, so spaces and the characters `+`, `-`, `(`, `)` and `.` are dropped from the value before it is compared with the phone. So `866104` finds a device by IMEI or by phone, and `+49 151` by phone. A value of only those characters still matches by title and identifier. |

</details>

<details>

<summary>DeviceOrder</summary>

Ordering options for devices.

| Field       | Type                                                                                                      | Description             |
| ----------- | --------------------------------------------------------------------------------------------------------- | ----------------------- |
| `field`     | [DeviceOrderField](#deviceorderfield)                                                                     | The field to order by.  |
| `direction` | [OrderDirection](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#orderdirection)! | The direction to order. |

</details>

**Output types:**

<details>

<summary>DeviceConnection</summary>

A paginated list of Device items.

**Implements:** [Connection](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#connection)

| Field      | Type                                                                                           | Description                                                |
| ---------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------- |
| `edges`    | \[[DeviceEdge](#deviceedge)!]!                                                                 | A list of edges.                                           |
| `nodes`    | \[[Device](#device)!]!                                                                         | A list of nodes in the connection (without edge metadata). |
| `pageInfo` | [PageInfo](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#pageinfo)!  | Information about the current page.                        |
| `total`    | [CountInfo](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#countinfo) | The total count of items matching the filter.              |

</details>

***

### deviceActivationServer

The data gateway address a device of this model is pointed at: what the user enters on the device for `MANUAL` setup, before `deviceActivate`, and what the `Register` SMS carries for `AUTOMATIC`. The port is that of the model's protocol. Null while the installation publishes no address. Refused for a model that is not `supported`, as `deviceActivate` is. Needs the `create` right on devices.

```graphql
deviceActivationServer(
    modelId: ID!
  ): ActivationServerAddress
```

**Arguments**

| Name      | Type  | Description                                                         |
| --------- | ----- | ------------------------------------------------------------------- |
| `modelId` | `ID!` | The device model the device is activated with. Must be `supported`. |

**Output types:**

<details>

<summary>ActivationServerAddress</summary>

The data gateway address a device connects to.

| Field  | Type      | Description                  |
| ------ | --------- | ---------------------------- |
| `host` | `String!` | The host name or IP address. |
| `port` | `Int!`    | The TCP port.                |

</details>

***

### deviceActivationPhoneAvailable

Whether `deviceActivate` would accept this phone: no device of any workspace holds it, or the one that does is the caller's device with `identifier`. Lets a client check the phone before submitting the form; `deviceActivate` still enforces uniqueness, so a phone taken in between is refused there with `DUPLICATE`.

```graphql
deviceActivationPhoneAvailable(
    phone: String! @trim
    identifier: String @trim
  ): Boolean!
```

**Arguments**

| Name         | Type      | Description                                                                                                                                                                                                       |
| ------------ | --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `phone`      | `String!` | The SIM phone number, as `DeviceActivateInput.phone` takes it: 5 to 20 digits.                                                                                                                                    |
| `identifier` | `String`  | The identifier the form activates, as `DeviceActivateInput.identifier` takes it. The phone of the caller's device with this identifier counts as available, since re-running activation for that device keeps it. |

***

## Mutations

### deviceCreate

Creates a new device.

```graphql
deviceCreate(
    input: DeviceCreateInput!
  ): DevicePayload @effect(kinds: [NONE])
```

**Arguments**

| Name    | Type                 | Description                               |
| ------- | -------------------- | ----------------------------------------- |
| `input` | `DeviceCreateInput!` | The input fields for creating the device. |

**Input types:**

<details>

<summary>DeviceCreateInput</summary>

Input for creating a new device.

| Field         | Type                                                | Description                                                                                                                                                                                                                                                                                                                                                                      |
| ------------- | --------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `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. With no identifiers at all the generated title is "\<vendor.title> \<model.title>". |
| `identifiers` | \[[DeviceIdentifierInput](#deviceidentifierinput)!] | The hardware identifiers. Optional: a device may be registered before its hardware is known. Identifiers can be added later with `deviceIdentifierAdd`.                                                                                                                                                                                                                          |
| `inventoryId` | `ID`                                                | Optionally assign the new device to an existing inventory. When provided, the inventory must belong to the same workspace; the assignment is atomic with device creation (the device is not created if the assignment fails).                                                                                                                                                    |

</details>

<details>

<summary>DeviceIdentifierInput</summary>

Input for a device identifier.

| Field       | Type                                                                                 | Description                                                                                                                                                                                                                                                                                                                                          |
| ----------- | ------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `type`      | [DeviceIdType](#deviceidtype)!                                                       | The type of identifier.                                                                                                                                                                                                                                                                                                                              |
| `value`     | `String!`                                                                            | The identifier value. 1 to 64 Unicode code points, measured after `@trim` has removed leading and trailing whitespace. An astral character such as an emoji counts as one, though a UTF-16 `length` reports it as two. The limit is not expressible in the schema and is enforced by the server: a longer value is rejected with `VALIDATION_ERROR`. |
| `namespace` | [Code](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#code) | The namespace for uniqueness scope. Null means globally unique.                                                                                                                                                                                                                                                                                      |

</details>

**Output types:**

<details>

<summary>DevicePayload</summary>

The result of a device mutation.

| Field    | Type               | Description                    |
| -------- | ------------------ | ------------------------------ |
| `device` | [Device](#device)! | The created or updated device. |

</details>

<details>

<summary>Device (entity)</summary>

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

**Implements:** [Node](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#node), [Titled](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#titled), [Versioned](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#versioned), [InventoryItem](https://navixy.com/docs/navixy-graphql-api/products/business-data-repository/api-reference/devices/inventory.md#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.                                                                                                                                                                                                                                                                                                    |
| `workspace`        | [Workspace](https://navixy.com/docs/navixy-graphql-api/products/business-data-repository/api-reference/workspaces.md#workspace)!                                                        | The workspace that owns this device.                                                                                                                                                                                                                                                                                                |
| `type`             | [DeviceType](#devicetype)!                                                                                                                                                              | The device type classification.                                                                                                                                                                                                                                                                                                     |
| `model`            | [DeviceModel](#devicemodel)!                                                                                                                                                            | The specific device model.                                                                                                                                                                                                                                                                                                          |
| `status`           | [DeviceStatus](#devicestatus)!                                                                                                                                                          | The current operational status.                                                                                                                                                                                                                                                                                                     |
| `createdAt`        | [DateTime](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#datetime)!                                                                                           | When this device record was created.                                                                                                                                                                                                                                                                                                |
| `activation`       | [DeviceActivation](#deviceactivation)                                                                                                                                                   | SIM/APN activation data, present once the device has gone through `deviceActivate`. Null for a device created only via `deviceCreate`. Also null, with an `INTERNAL_ERROR` on this field alone, for a stored activation the server cannot read, such as one with a missing key; the device itself and the list it is in are served. |
| `identifiers`      | \[[DeviceIdentifier](#deviceidentifier)!]!                                                                                                                                              | The hardware identifiers for this device (IMEI, serial number, MAC address, etc.).                                                                                                                                                                                                                                                  |
| `asset`            | [Asset](https://navixy.com/docs/navixy-graphql-api/products/business-data-repository/api-reference/assets.md#asset)                                                                     | The asset this device is currently linked to.                                                                                                                                                                                                                                                                                       |
| `inventory`        | [Inventory](https://navixy.com/docs/navixy-graphql-api/products/business-data-repository/api-reference/devices/inventory.md#inventory)                                                  | The inventory this device is currently assigned to.                                                                                                                                                                                                                                                                                 |
| `relationsFrom`    | \[[DeviceRelation](#devicerelation)!]!                                                                                                                                                  | The outgoing relationships from this device to other devices.                                                                                                                                                                                                                                                                       |
| `relationsTo`      | \[[DeviceRelation](#devicerelation)!]!                                                                                                                                                  | The incoming relationships from other devices to this device.                                                                                                                                                                                                                                                                       |
| `inventoryHistory` | [DeviceInventoryRelationConnection](https://navixy.com/docs/navixy-graphql-api/products/business-data-repository/api-reference/devices/inventory.md#deviceinventoryrelationconnection)! | The history of inventory assignments for this device.                                                                                                                                                                                                                                                                               |

</details>

***

### deviceUpdate

Updates an existing device.

```graphql
deviceUpdate(
    input: DeviceUpdateInput!
  ): DevicePayload @effect(kinds: [NONE])
```

**Arguments**

| Name    | Type                 | Description                               |
| ------- | -------------------- | ----------------------------------------- |
| `input` | `DeviceUpdateInput!` | The input fields for updating the device. |

**Input types:**

<details>

<summary>DeviceUpdateInput</summary>

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.                                                                           |

</details>

**Output types:**

<details>

<summary>DevicePayload</summary>

The result of a device mutation.

| Field    | Type               | Description                    |
| -------- | ------------------ | ------------------------------ |
| `device` | [Device](#device)! | The created or updated device. |

</details>

<details>

<summary>Device (entity)</summary>

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

**Implements:** [Node](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#node), [Titled](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#titled), [Versioned](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#versioned), [InventoryItem](https://navixy.com/docs/navixy-graphql-api/products/business-data-repository/api-reference/devices/inventory.md#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.                                                                                                                                                                                                                                                                                                    |
| `workspace`        | [Workspace](https://navixy.com/docs/navixy-graphql-api/products/business-data-repository/api-reference/workspaces.md#workspace)!                                                        | The workspace that owns this device.                                                                                                                                                                                                                                                                                                |
| `type`             | [DeviceType](#devicetype)!                                                                                                                                                              | The device type classification.                                                                                                                                                                                                                                                                                                     |
| `model`            | [DeviceModel](#devicemodel)!                                                                                                                                                            | The specific device model.                                                                                                                                                                                                                                                                                                          |
| `status`           | [DeviceStatus](#devicestatus)!                                                                                                                                                          | The current operational status.                                                                                                                                                                                                                                                                                                     |
| `createdAt`        | [DateTime](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#datetime)!                                                                                           | When this device record was created.                                                                                                                                                                                                                                                                                                |
| `activation`       | [DeviceActivation](#deviceactivation)                                                                                                                                                   | SIM/APN activation data, present once the device has gone through `deviceActivate`. Null for a device created only via `deviceCreate`. Also null, with an `INTERNAL_ERROR` on this field alone, for a stored activation the server cannot read, such as one with a missing key; the device itself and the list it is in are served. |
| `identifiers`      | \[[DeviceIdentifier](#deviceidentifier)!]!                                                                                                                                              | The hardware identifiers for this device (IMEI, serial number, MAC address, etc.).                                                                                                                                                                                                                                                  |
| `asset`            | [Asset](https://navixy.com/docs/navixy-graphql-api/products/business-data-repository/api-reference/assets.md#asset)                                                                     | The asset this device is currently linked to.                                                                                                                                                                                                                                                                                       |
| `inventory`        | [Inventory](https://navixy.com/docs/navixy-graphql-api/products/business-data-repository/api-reference/devices/inventory.md#inventory)                                                  | The inventory this device is currently assigned to.                                                                                                                                                                                                                                                                                 |
| `relationsFrom`    | \[[DeviceRelation](#devicerelation)!]!                                                                                                                                                  | The outgoing relationships from this device to other devices.                                                                                                                                                                                                                                                                       |
| `relationsTo`      | \[[DeviceRelation](#devicerelation)!]!                                                                                                                                                  | The incoming relationships from other devices to this device.                                                                                                                                                                                                                                                                       |
| `inventoryHistory` | [DeviceInventoryRelationConnection](https://navixy.com/docs/navixy-graphql-api/products/business-data-repository/api-reference/devices/inventory.md#deviceinventoryrelationconnection)! | The history of inventory assignments for this device.                                                                                                                                                                                                                                                                               |

</details>

***

### deviceDelete

Deletes a device.

Every `DEVICE` custom-field value pointing at it is detached in the same transaction, on assets and on geo objects alike, so no holder is left naming a device that is gone. A value in a field that `isRequired` is not detached, since that would leave its holder invalid; it refuses the delete instead.

Refused with `IN_USE` while another live entity points at it through one of its own fields, custom-field values and field definitions included; the error's `blockers` name the first five of them, and `hasMoreBlockers` says whether it left any out. A required `DEVICE` field holding the device and a live flow linking it, in a workspace that has IoT Logic, are among them; the flows of a workspace without IoT Logic block nothing. Nothing is detached when the delete is refused.

```graphql
deviceDelete(
    input: DeviceDeleteInput!
  ): DeletePayload @effect(kinds: [DATA_LOSS])
```

**Arguments**

| Name    | Type                 | Description                               |
| ------- | -------------------- | ----------------------------------------- |
| `input` | `DeviceDeleteInput!` | The input fields for deleting the device. |

**Input types:**

<details>

<summary>DeviceDeleteInput</summary>

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. |

</details>

**Output types:**

<details>

<summary>DeletePayload</summary>

The result of a delete mutation.

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

</details>

***

### deviceIdentifierAdd

Adds an identifier to a device.

Not an idempotent command: `DUPLICATE` when an identifier with the same `type`, `value` and `namespace` already exists — the uniqueness scope is the whole installation, not the device, so the conflict may sit on a device the caller cannot see. A `null` namespace is global and collides with other `null` namespaces.

```graphql
deviceIdentifierAdd(
    input: DeviceIdentifierAddInput!
  ): DeviceIdentifierPayload @effect(kinds: [NONE])
```

**Arguments**

| Name    | Type                        | Description                                 |
| ------- | --------------------------- | ------------------------------------------- |
| `input` | `DeviceIdentifierAddInput!` | The input fields for adding the identifier. |

**Input types:**

<details>

<summary>DeviceIdentifierAddInput</summary>

Input for adding an identifier to a device.

| Field        | Type                                             | Description             |
| ------------ | ------------------------------------------------ | ----------------------- |
| `deviceId`   | `ID!`                                            | The device ID.          |
| `identifier` | [DeviceIdentifierInput](#deviceidentifierinput)! | The identifier details. |

</details>

<details>

<summary>DeviceIdentifierInput</summary>

Input for a device identifier.

| Field       | Type                                                                                 | Description                                                                                                                                                                                                                                                                                                                                          |
| ----------- | ------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `type`      | [DeviceIdType](#deviceidtype)!                                                       | The type of identifier.                                                                                                                                                                                                                                                                                                                              |
| `value`     | `String!`                                                                            | The identifier value. 1 to 64 Unicode code points, measured after `@trim` has removed leading and trailing whitespace. An astral character such as an emoji counts as one, though a UTF-16 `length` reports it as two. The limit is not expressible in the schema and is enforced by the server: a longer value is rejected with `VALIDATION_ERROR`. |
| `namespace` | [Code](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#code) | The namespace for uniqueness scope. Null means globally unique.                                                                                                                                                                                                                                                                                      |

</details>

**Output types:**

<details>

<summary>DeviceIdentifierPayload</summary>

The result of a device identifier mutation.

| Field              | Type                                   | Description                  |
| ------------------ | -------------------------------------- | ---------------------------- |
| `deviceIdentifier` | [DeviceIdentifier](#deviceidentifier)! | The added device identifier. |

</details>

<details>

<summary>DeviceIdentifier (entity)</summary>

A hardware identifier for a device.

**Implements:** [Node](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#node)

| Field       | Type                                                                                 | Description                                                                          |
| ----------- | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
| `id`        | `ID!`                                                                                | A globally unique identifier. This ID is opaque and should not be parsed by clients. |
| `device`    | [Device](#device)!                                                                   | The device this identifier belongs to.                                               |
| `type`      | [DeviceIdType](#deviceidtype)!                                                       | The type of identifier.                                                              |
| `value`     | `String!`                                                                            | The identifier value.                                                                |
| `namespace` | [Code](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#code) | The namespace for uniqueness scope. Null means the identifier is globally unique.    |

</details>

***

### deviceIdentifierRemove

Removes an identifier from a device.

Not an idempotent command: `NOT_FOUND` when `identifierId` names no identifier, including a repeat of a call that already succeeded.

```graphql
deviceIdentifierRemove(
    input: DeviceIdentifierRemoveInput!
  ): DeletePayload @effect(kinds: [DATA_LOSS])
```

**Arguments**

| Name    | Type                           | Description                                   |
| ------- | ------------------------------ | --------------------------------------------- |
| `input` | `DeviceIdentifierRemoveInput!` | The input fields for removing the identifier. |

**Input types:**

<details>

<summary>DeviceIdentifierRemoveInput</summary>

Input for removing an identifier from a device.

| Field          | Type  | Description                  |
| -------------- | ----- | ---------------------------- |
| `identifierId` | `ID!` | The identifier ID to remove. |

</details>

**Output types:**

<details>

<summary>DeletePayload</summary>

The result of a delete mutation.

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

</details>

***

### deviceActivate

Activates a device: creates it with the given identifier, records SIM/APN data and sets it `awaiting_connection`. For `AUTOMATIC` setup it also queues the SMS with APN and server settings; for `MANUAL` setup nothing is sent, and the user enters `DeviceActivation.server` on the device. The first frame makes it `active`. For an IMEI already on a `not_activated` or `awaiting_connection` device of the caller's workspace, replaces that device's activation data and model, cancels an SMS of its previous activation still waiting to be sent and, for `AUTOMATIC` setup, queues the SMS again; an `active` or `inactive` device is refused. A serial number already on any device is refused as `DUPLICATE`, whatever its status. The device is returned even when the SMS could not be queued, and `activationSms` says whether it was.

```graphql
deviceActivate(
    input: DeviceActivateInput!
  ): DeviceActivatePayload @effect(kinds: [DEVICES, PEOPLE])
```

**Arguments**

| Name    | Type                   | Description                                 |
| ------- | ---------------------- | ------------------------------------------- |
| `input` | `DeviceActivateInput!` | The input fields for activating the device. |

**Input types:**

<details>

<summary>DeviceActivateInput</summary>

Input for activating a device: creates it with the given identifier, records SIM/APN data, sets it `awaiting_connection`, and for `AUTOMATIC` setup queues the SMS that pushes APN and server settings to it.

| Field        | Type                                  | Description                                                                                                                                                                                                                                                                                                                                                                                |
| ------------ | ------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `setup`      | [DeviceSetup](#devicesetup)!          | How the device receives its server settings.                                                                                                                                                                                                                                                                                                                                               |
| `modelId`    | `ID!`                                 | The device model. Must be `supported`.                                                                                                                                                                                                                                                                                                                                                     |
| `title`      | `String`                              | The device display name. For a new device, `<model title> <identifier>` when omitted or blank. For an existing device this activation attaches to, replaces its title when given and keeps it when omitted or blank.                                                                                                                                                                       |
| `identifier` | `String!`                             | The identifier the model's protocol names a device by: the IMEI (15 digits) for most models, the serial number (6 to 10 digits, not all zeros, leading zeros kept) for Suntech models. Becomes the device's `IMEI` or `SERIAL_NUMBER` identifier, the serial number in the namespace of its protocol (`suntech`). Checked against the model: `VALIDATION_ERROR` on `identifier` otherwise. |
| `phone`      | `String`                              | The SIM phone number the activation SMS is sent to: 5 to 20 digits, globally unique across the installation. Required for `AUTOMATIC` setup, optional for `MANUAL`.                                                                                                                                                                                                                        |
| `apn`        | [ApnSettingsInput](#apnsettingsinput) | The APN settings pushed to the device. Required for `AUTOMATIC` setup, optional for `MANUAL`.                                                                                                                                                                                                                                                                                              |

</details>

<details>

<summary>ApnSettingsInput</summary>

APN settings for `deviceActivate`.

| Field      | Type      | Description                                                                                                                                                                                                                                                                      |
| ---------- | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `name`     | `String!` | The APN name: 1-40 characters of letters, digits, `.`, `_` or `-`.                                                                                                                                                                                                               |
| `user`     | `String`  | The APN username, if the carrier requires one: at most 40 characters of letters, digits, `.`, `_`, `-` or `@`.                                                                                                                                                                   |
| `password` | `String`  | The APN password, if the carrier requires one: at most 40 characters of letters, digits, `.`, `_`, `-` or `@`. Not saved in the device activation: it goes only into the activation SMS text, which the command queue keeps with the queued command. Ignored for `MANUAL` setup. |

</details>

**Output types:**

<details>

<summary>DeviceActivatePayload</summary>

The result of `deviceActivate`.

| Field           | Type                                          | Description                                                                                                |
| --------------- | --------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
| `device`        | [Device](#device)!                            | The activated device.                                                                                      |
| `activationSms` | [ActivationSmsOutcome](#activationsmsoutcome) | Whether the activation SMS was queued, for `AUTOMATIC` setup. Null for `MANUAL` setup, which sends no SMS. |

</details>

<details>

<summary>Device (entity)</summary>

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

**Implements:** [Node](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#node), [Titled](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#titled), [Versioned](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#versioned), [InventoryItem](https://navixy.com/docs/navixy-graphql-api/products/business-data-repository/api-reference/devices/inventory.md#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.                                                                                                                                                                                                                                                                                                    |
| `workspace`        | [Workspace](https://navixy.com/docs/navixy-graphql-api/products/business-data-repository/api-reference/workspaces.md#workspace)!                                                        | The workspace that owns this device.                                                                                                                                                                                                                                                                                                |
| `type`             | [DeviceType](#devicetype)!                                                                                                                                                              | The device type classification.                                                                                                                                                                                                                                                                                                     |
| `model`            | [DeviceModel](#devicemodel)!                                                                                                                                                            | The specific device model.                                                                                                                                                                                                                                                                                                          |
| `status`           | [DeviceStatus](#devicestatus)!                                                                                                                                                          | The current operational status.                                                                                                                                                                                                                                                                                                     |
| `createdAt`        | [DateTime](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#datetime)!                                                                                           | When this device record was created.                                                                                                                                                                                                                                                                                                |
| `activation`       | [DeviceActivation](#deviceactivation)                                                                                                                                                   | SIM/APN activation data, present once the device has gone through `deviceActivate`. Null for a device created only via `deviceCreate`. Also null, with an `INTERNAL_ERROR` on this field alone, for a stored activation the server cannot read, such as one with a missing key; the device itself and the list it is in are served. |
| `identifiers`      | \[[DeviceIdentifier](#deviceidentifier)!]!                                                                                                                                              | The hardware identifiers for this device (IMEI, serial number, MAC address, etc.).                                                                                                                                                                                                                                                  |
| `asset`            | [Asset](https://navixy.com/docs/navixy-graphql-api/products/business-data-repository/api-reference/assets.md#asset)                                                                     | The asset this device is currently linked to.                                                                                                                                                                                                                                                                                       |
| `inventory`        | [Inventory](https://navixy.com/docs/navixy-graphql-api/products/business-data-repository/api-reference/devices/inventory.md#inventory)                                                  | The inventory this device is currently assigned to.                                                                                                                                                                                                                                                                                 |
| `relationsFrom`    | \[[DeviceRelation](#devicerelation)!]!                                                                                                                                                  | The outgoing relationships from this device to other devices.                                                                                                                                                                                                                                                                       |
| `relationsTo`      | \[[DeviceRelation](#devicerelation)!]!                                                                                                                                                  | The incoming relationships from other devices to this device.                                                                                                                                                                                                                                                                       |
| `inventoryHistory` | [DeviceInventoryRelationConnection](https://navixy.com/docs/navixy-graphql-api/products/business-data-repository/api-reference/devices/inventory.md#deviceinventoryrelationconnection)! | The history of inventory assignments for this device.                                                                                                                                                                                                                                                                               |

</details>

***

### deviceRelationCreate

Creates a relationship between devices.

Not an idempotent command: `DUPLICATE` when the same `firstId`, `secondId` and `typeId` are already related. The pair is ordered — relating A to B does not relate B to A, and creating the reverse is a second, separate relationship rather than a duplicate.

```graphql
deviceRelationCreate(
    input: DeviceRelationCreateInput!
  ): DeviceRelationPayload @effect(kinds: [NONE])
```

**Arguments**

| Name    | Type                         | Description                                     |
| ------- | ---------------------------- | ----------------------------------------------- |
| `input` | `DeviceRelationCreateInput!` | The input fields for creating the relationship. |

**Input types:**

<details>

<summary>DeviceRelationCreateInput</summary>

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. |

</details>

**Output types:**

<details>

<summary>DeviceRelationPayload</summary>

The result of a device relation mutation.

| Field            | Type                               | Description                      |
| ---------------- | ---------------------------------- | -------------------------------- |
| `deviceRelation` | [DeviceRelation](#devicerelation)! | The created device relationship. |

</details>

<details>

<summary>DeviceRelation (entity)</summary>

A relationship between two devices.

**Implements:** [Node](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#node)

| Field    | Type                                       | Description                                                                          |
| -------- | ------------------------------------------ | ------------------------------------------------------------------------------------ |
| `id`     | `ID!`                                      | A globally unique identifier. This ID is opaque and should not be parsed by clients. |
| `first`  | [Device](#device)!                         | The first device in the relationship.                                                |
| `second` | [Device](#device)!                         | The second device in the relationship.                                               |
| `type`   | [DeviceRelationType](#devicerelationtype)! | The type of relationship.                                                            |

</details>

***

### deviceRelationRemove

Removes a device relationship.

Not an idempotent command: `NOT_FOUND` when `id` names no relationship, including a repeat of a call that already succeeded.

```graphql
deviceRelationRemove(
    input: DeviceRelationRemoveInput!
  ): DeletePayload @effect(kinds: [NONE])
```

**Arguments**

| Name    | Type                         | Description                                     |
| ------- | ---------------------------- | ----------------------------------------------- |
| `input` | `DeviceRelationRemoveInput!` | The input fields for removing the relationship. |

**Input types:**

<details>

<summary>DeviceRelationRemoveInput</summary>

Input for removing a device relationship.

| Field | Type  | Description                    |
| ----- | ----- | ------------------------------ |
| `id`  | `ID!` | The relationship ID to remove. |

</details>

**Output types:**

<details>

<summary>DeletePayload</summary>

The result of a delete mutation.

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

</details>

***

### deviceTypeCreate

Creates a new device type.

```graphql
deviceTypeCreate(
    input: DeviceTypeCreateInput!
  ): DeviceTypePayload @effect(kinds: [NONE])
```

**Arguments**

| Name    | Type                     | Description                                    |
| ------- | ------------------------ | ---------------------------------------------- |
| `input` | `DeviceTypeCreateInput!` | The input fields for creating the device type. |

**Input types:**

<details>

<summary>DeviceTypeCreateInput</summary>

Input for creating a device type.

| Field   | Type                                                                                                                                                              | Description                                                      |
| ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------- |
| `code`  | [Code](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#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`  | [CatalogItemMetaInput](https://navixy.com/docs/navixy-graphql-api/products/business-data-repository/api-reference/catalogs/catalog-items.md#catalogitemmetainput) | The display properties.                                          |

</details>

<details>

<summary>CatalogItemMetaInput</summary>

Display properties for catalog items.

| Field         | Type      | Description                                       |
| ------------- | --------- | ------------------------------------------------- |
| `description` | `String`  | The description.                                  |
| `hidden`      | `Boolean` | Whether the item is hidden from regular UI lists. |

</details>

**Output types:**

<details>

<summary>DeviceTypePayload</summary>

The result of a device type mutation.

| Field        | Type                       | Description                         |
| ------------ | -------------------------- | ----------------------------------- |
| `deviceType` | [DeviceType](#devicetype)! | The created or updated device type. |

</details>

<details>

<summary>DeviceType (entity)</summary>

A classification type for devices.

**Implements:** [CatalogItem](https://navixy.com/docs/navixy-graphql-api/products/business-data-repository/api-reference/catalogs/catalog-items.md#catalogitem), [Node](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#node), [Versioned](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#versioned), [Titled](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#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](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#code)!                                                                    | A machine-readable code, unique within the catalog for a given workspace. A workspace item may reuse the code of the system item it overrides. |
| `order`     | `Int!`                                                                                                                                                   | The display order within the same level or category.                                                                                           |
| `catalog`   | [Catalog](https://navixy.com/docs/navixy-graphql-api/products/business-data-repository/api-reference/catalogs/catalog-items.md#catalog)!                 | The catalog this item belongs to.                                                                                                              |
| `workspace` | [Workspace](https://navixy.com/docs/navixy-graphql-api/products/business-data-repository/api-reference/workspaces.md#workspace)                          | The workspace that owns this item. Null for system items.                                                                                      |
| `meta`      | [CatalogItemMeta](https://navixy.com/docs/navixy-graphql-api/products/business-data-repository/api-reference/catalogs/catalog-items.md#catalogitemmeta)! | Metadata about this item including description, origin, and display properties.                                                                |

</details>

***

### deviceTypeUpdate

Updates a device type.

```graphql
deviceTypeUpdate(
    input: DeviceTypeUpdateInput!
  ): DeviceTypePayload @effect(kinds: [NONE])
```

**Arguments**

| Name    | Type                     | Description                                    |
| ------- | ------------------------ | ---------------------------------------------- |
| `input` | `DeviceTypeUpdateInput!` | The input fields for updating the device type. |

**Input types:**

<details>

<summary>DeviceTypeUpdateInput</summary>

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`    | [CatalogItemMetaInput](https://navixy.com/docs/navixy-graphql-api/products/business-data-repository/api-reference/catalogs/catalog-items.md#catalogitemmetainput) | The display properties.                                                                         |

</details>

<details>

<summary>CatalogItemMetaInput</summary>

Display properties for catalog items.

| Field         | Type      | Description                                       |
| ------------- | --------- | ------------------------------------------------- |
| `description` | `String`  | The description.                                  |
| `hidden`      | `Boolean` | Whether the item is hidden from regular UI lists. |

</details>

**Output types:**

<details>

<summary>DeviceTypePayload</summary>

The result of a device type mutation.

| Field        | Type                       | Description                         |
| ------------ | -------------------------- | ----------------------------------- |
| `deviceType` | [DeviceType](#devicetype)! | The created or updated device type. |

</details>

<details>

<summary>DeviceType (entity)</summary>

A classification type for devices.

**Implements:** [CatalogItem](https://navixy.com/docs/navixy-graphql-api/products/business-data-repository/api-reference/catalogs/catalog-items.md#catalogitem), [Node](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#node), [Versioned](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#versioned), [Titled](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#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](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#code)!                                                                    | A machine-readable code, unique within the catalog for a given workspace. A workspace item may reuse the code of the system item it overrides. |
| `order`     | `Int!`                                                                                                                                                   | The display order within the same level or category.                                                                                           |
| `catalog`   | [Catalog](https://navixy.com/docs/navixy-graphql-api/products/business-data-repository/api-reference/catalogs/catalog-items.md#catalog)!                 | The catalog this item belongs to.                                                                                                              |
| `workspace` | [Workspace](https://navixy.com/docs/navixy-graphql-api/products/business-data-repository/api-reference/workspaces.md#workspace)                          | The workspace that owns this item. Null for system items.                                                                                      |
| `meta`      | [CatalogItemMeta](https://navixy.com/docs/navixy-graphql-api/products/business-data-repository/api-reference/catalogs/catalog-items.md#catalogitemmeta)! | Metadata about this item including description, origin, and display properties.                                                                |

</details>

***

### deviceTypeDelete

Deletes a device type.

Refused with `IN_USE` while another live entity points at it through one of its own fields, custom-field values and field definitions included; the error's `blockers` name the first five of them, and `hasMoreBlockers` says whether it left any out.

```graphql
deviceTypeDelete(
    input: CatalogItemDeleteInput!
  ): DeletePayload @effect(kinds: [DATA_LOSS])
```

**Arguments**

| Name    | Type                      | Description                                    |
| ------- | ------------------------- | ---------------------------------------------- |
| `input` | `CatalogItemDeleteInput!` | The input fields for deleting the device type. |

**Input types:**

<details>

<summary>CatalogItemDeleteInput</summary>

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. |

</details>

**Output types:**

<details>

<summary>DeletePayload</summary>

The result of a delete mutation.

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

</details>

***

### deviceStatusCreate

Creates a new device status.

```graphql
deviceStatusCreate(
    input: DeviceStatusCreateInput!
  ): DeviceStatusPayload @effect(kinds: [NONE])
```

**Arguments**

| Name    | Type                       | Description                                      |
| ------- | -------------------------- | ------------------------------------------------ |
| `input` | `DeviceStatusCreateInput!` | The input fields for creating the device status. |

**Input types:**

<details>

<summary>DeviceStatusCreateInput</summary>

Input for creating a device status.

| Field   | Type                                                                                                                                                              | Description                                                      |
| ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------- |
| `code`  | [Code](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#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`  | [CatalogItemMetaInput](https://navixy.com/docs/navixy-graphql-api/products/business-data-repository/api-reference/catalogs/catalog-items.md#catalogitemmetainput) | The display properties.                                          |

</details>

<details>

<summary>CatalogItemMetaInput</summary>

Display properties for catalog items.

| Field         | Type      | Description                                       |
| ------------- | --------- | ------------------------------------------------- |
| `description` | `String`  | The description.                                  |
| `hidden`      | `Boolean` | Whether the item is hidden from regular UI lists. |

</details>

**Output types:**

<details>

<summary>DeviceStatusPayload</summary>

The result of a device status mutation.

| Field          | Type                           | Description                           |
| -------------- | ------------------------------ | ------------------------------------- |
| `deviceStatus` | [DeviceStatus](#devicestatus)! | The created or updated device status. |

</details>

<details>

<summary>DeviceStatus (entity)</summary>

An operational status for devices.

**Implements:** [CatalogItem](https://navixy.com/docs/navixy-graphql-api/products/business-data-repository/api-reference/catalogs/catalog-items.md#catalogitem), [Node](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#node), [Versioned](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#versioned), [Titled](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#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](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#code)!                                                                    | A machine-readable code, unique within the catalog for a given workspace. A workspace item may reuse the code of the system item it overrides. |
| `order`     | `Int!`                                                                                                                                                   | The display order within the same level or category.                                                                                           |
| `catalog`   | [Catalog](https://navixy.com/docs/navixy-graphql-api/products/business-data-repository/api-reference/catalogs/catalog-items.md#catalog)!                 | The catalog this item belongs to.                                                                                                              |
| `workspace` | [Workspace](https://navixy.com/docs/navixy-graphql-api/products/business-data-repository/api-reference/workspaces.md#workspace)                          | The workspace that owns this item. Null for system items.                                                                                      |
| `meta`      | [CatalogItemMeta](https://navixy.com/docs/navixy-graphql-api/products/business-data-repository/api-reference/catalogs/catalog-items.md#catalogitemmeta)! | Metadata about this item including description, origin, and display properties.                                                                |

</details>

***

### deviceStatusUpdate

Updates a device status.

```graphql
deviceStatusUpdate(
    input: DeviceStatusUpdateInput!
  ): DeviceStatusPayload @effect(kinds: [NONE])
```

**Arguments**

| Name    | Type                       | Description                                      |
| ------- | -------------------------- | ------------------------------------------------ |
| `input` | `DeviceStatusUpdateInput!` | The input fields for updating the device status. |

**Input types:**

<details>

<summary>DeviceStatusUpdateInput</summary>

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`    | [CatalogItemMetaInput](https://navixy.com/docs/navixy-graphql-api/products/business-data-repository/api-reference/catalogs/catalog-items.md#catalogitemmetainput) | The display properties.                                                                         |

</details>

<details>

<summary>CatalogItemMetaInput</summary>

Display properties for catalog items.

| Field         | Type      | Description                                       |
| ------------- | --------- | ------------------------------------------------- |
| `description` | `String`  | The description.                                  |
| `hidden`      | `Boolean` | Whether the item is hidden from regular UI lists. |

</details>

**Output types:**

<details>

<summary>DeviceStatusPayload</summary>

The result of a device status mutation.

| Field          | Type                           | Description                           |
| -------------- | ------------------------------ | ------------------------------------- |
| `deviceStatus` | [DeviceStatus](#devicestatus)! | The created or updated device status. |

</details>

<details>

<summary>DeviceStatus (entity)</summary>

An operational status for devices.

**Implements:** [CatalogItem](https://navixy.com/docs/navixy-graphql-api/products/business-data-repository/api-reference/catalogs/catalog-items.md#catalogitem), [Node](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#node), [Versioned](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#versioned), [Titled](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#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](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#code)!                                                                    | A machine-readable code, unique within the catalog for a given workspace. A workspace item may reuse the code of the system item it overrides. |
| `order`     | `Int!`                                                                                                                                                   | The display order within the same level or category.                                                                                           |
| `catalog`   | [Catalog](https://navixy.com/docs/navixy-graphql-api/products/business-data-repository/api-reference/catalogs/catalog-items.md#catalog)!                 | The catalog this item belongs to.                                                                                                              |
| `workspace` | [Workspace](https://navixy.com/docs/navixy-graphql-api/products/business-data-repository/api-reference/workspaces.md#workspace)                          | The workspace that owns this item. Null for system items.                                                                                      |
| `meta`      | [CatalogItemMeta](https://navixy.com/docs/navixy-graphql-api/products/business-data-repository/api-reference/catalogs/catalog-items.md#catalogitemmeta)! | Metadata about this item including description, origin, and display properties.                                                                |

</details>

***

### deviceStatusDelete

Deletes a device status.

Refused with `IN_USE` while another live entity points at it through one of its own fields, custom-field values and field definitions included; the error's `blockers` name the first five of them, and `hasMoreBlockers` says whether it left any out.

```graphql
deviceStatusDelete(
    input: CatalogItemDeleteInput!
  ): DeletePayload @effect(kinds: [DATA_LOSS])
```

**Arguments**

| Name    | Type                      | Description                                      |
| ------- | ------------------------- | ------------------------------------------------ |
| `input` | `CatalogItemDeleteInput!` | The input fields for deleting the device status. |

**Input types:**

<details>

<summary>CatalogItemDeleteInput</summary>

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. |

</details>

**Output types:**

<details>

<summary>DeletePayload</summary>

The result of a delete mutation.

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

</details>

***

## Objects

### DeviceVendor

A device manufacturer or vendor.

**Implements:** [CatalogItem](https://navixy.com/docs/navixy-graphql-api/products/business-data-repository/api-reference/catalogs/catalog-items.md#catalogitem), [Node](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#node), [Versioned](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#versioned), [Titled](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#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](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#code)!                                                                    | A machine-readable code, unique within the catalog for a given workspace. A workspace item may reuse the code of the system item it overrides. |
| `order`     | `Int!`                                                                                                                                                   | The display order within the same level or category.                                                                                           |
| `catalog`   | [Catalog](https://navixy.com/docs/navixy-graphql-api/products/business-data-repository/api-reference/catalogs/catalog-items.md#catalog)!                 | The catalog this item belongs to.                                                                                                              |
| `workspace` | [Workspace](https://navixy.com/docs/navixy-graphql-api/products/business-data-repository/api-reference/workspaces.md#workspace)                          | The workspace that owns this item. Null for system items.                                                                                      |
| `meta`      | [CatalogItemMeta](https://navixy.com/docs/navixy-graphql-api/products/business-data-repository/api-reference/catalogs/catalog-items.md#catalogitemmeta)! | Metadata about this item including description, origin, and display properties.                                                                |
| `models`    | [DeviceModelConnection](#devicemodelconnection)!                                                                                                         | Device models produced by this vendor.                                                                                                         |

**Arguments of `models`**

| Name      | Type                                                                                                                                                        | Description                                                                                                     |
| --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- |
| `filter`  | [CatalogItemFilter](https://navixy.com/docs/navixy-graphql-api/products/business-data-repository/api-reference/catalogs/catalog-items.md#catalogitemfilter) | Filtering options for the returned models.                                                                      |
| `first`   | `Int`                                                                                                                                                       | The first `n` elements from the [paginated list](https://navixy.com/docs/navixy-graphql-api/pagination.md).     |
| `after`   | `String`                                                                                                                                                    | The elements that come after the specified [cursor](https://navixy.com/docs/navixy-graphql-api/pagination.md).  |
| `last`    | `Int`                                                                                                                                                       | The last `n` elements from the [paginated list](https://navixy.com/docs/navixy-graphql-api/pagination.md).      |
| `before`  | `String`                                                                                                                                                    | The elements that come before the specified [cursor](https://navixy.com/docs/navixy-graphql-api/pagination.md). |
| `orderBy` | [CatalogItemOrder](https://navixy.com/docs/navixy-graphql-api/products/business-data-repository/api-reference/catalogs/catalog-items.md#catalogitemorder)   | The ordering options for the returned models. Default: `{ field: TITLE, direction: ASC }`.                      |

***

### DeviceModel

A specific device model produced by a vendor.

**Implements:** [CatalogItem](https://navixy.com/docs/navixy-graphql-api/products/business-data-repository/api-reference/catalogs/catalog-items.md#catalogitem), [Node](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#node), [Versioned](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#versioned), [Titled](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#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](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#code)!                                                                    | A machine-readable code, unique within the catalog for a given workspace. A workspace item may reuse the code of the system item it overrides. |
| `order`     | `Int!`                                                                                                                                                   | The display order within the same level or category.                                                                                           |
| `catalog`   | [Catalog](https://navixy.com/docs/navixy-graphql-api/products/business-data-repository/api-reference/catalogs/catalog-items.md#catalog)!                 | The catalog this item belongs to.                                                                                                              |
| `workspace` | [Workspace](https://navixy.com/docs/navixy-graphql-api/products/business-data-repository/api-reference/workspaces.md#workspace)                          | The workspace that owns this item. Null for system items.                                                                                      |
| `meta`      | [CatalogItemMeta](https://navixy.com/docs/navixy-graphql-api/products/business-data-repository/api-reference/catalogs/catalog-items.md#catalogitemmeta)! | Metadata about this item including description, origin, and display properties.                                                                |
| `vendor`    | [DeviceVendor](#devicevendor)!                                                                                                                           | The vendor that manufactures this model.                                                                                                       |
| `supported` | `Boolean!`                                                                                                                                               | Whether the platform decodes this model's data.                                                                                                |

***

### DeviceType

A classification type for devices.

**Implements:** [CatalogItem](https://navixy.com/docs/navixy-graphql-api/products/business-data-repository/api-reference/catalogs/catalog-items.md#catalogitem), [Node](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#node), [Versioned](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#versioned), [Titled](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#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](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#code)!                                                                    | A machine-readable code, unique within the catalog for a given workspace. A workspace item may reuse the code of the system item it overrides. |
| `order`     | `Int!`                                                                                                                                                   | The display order within the same level or category.                                                                                           |
| `catalog`   | [Catalog](https://navixy.com/docs/navixy-graphql-api/products/business-data-repository/api-reference/catalogs/catalog-items.md#catalog)!                 | The catalog this item belongs to.                                                                                                              |
| `workspace` | [Workspace](https://navixy.com/docs/navixy-graphql-api/products/business-data-repository/api-reference/workspaces.md#workspace)                          | The workspace that owns this item. Null for system items.                                                                                      |
| `meta`      | [CatalogItemMeta](https://navixy.com/docs/navixy-graphql-api/products/business-data-repository/api-reference/catalogs/catalog-items.md#catalogitemmeta)! | Metadata about this item including description, origin, and display properties.                                                                |

***

### DeviceStatus

An operational status for devices.

**Implements:** [CatalogItem](https://navixy.com/docs/navixy-graphql-api/products/business-data-repository/api-reference/catalogs/catalog-items.md#catalogitem), [Node](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#node), [Versioned](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#versioned), [Titled](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#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](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#code)!                                                                    | A machine-readable code, unique within the catalog for a given workspace. A workspace item may reuse the code of the system item it overrides. |
| `order`     | `Int!`                                                                                                                                                   | The display order within the same level or category.                                                                                           |
| `catalog`   | [Catalog](https://navixy.com/docs/navixy-graphql-api/products/business-data-repository/api-reference/catalogs/catalog-items.md#catalog)!                 | The catalog this item belongs to.                                                                                                              |
| `workspace` | [Workspace](https://navixy.com/docs/navixy-graphql-api/products/business-data-repository/api-reference/workspaces.md#workspace)                          | The workspace that owns this item. Null for system items.                                                                                      |
| `meta`      | [CatalogItemMeta](https://navixy.com/docs/navixy-graphql-api/products/business-data-repository/api-reference/catalogs/catalog-items.md#catalogitemmeta)! | Metadata about this item including description, origin, and display properties.                                                                |

***

### DeviceRelationType

A type of relationship between two devices.

**Implements:** [CatalogItem](https://navixy.com/docs/navixy-graphql-api/products/business-data-repository/api-reference/catalogs/catalog-items.md#catalogitem), [Node](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#node), [Versioned](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#versioned), [Titled](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#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](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#code)!                                                                    | A machine-readable code, unique within the catalog for a given workspace. A workspace item may reuse the code of the system item it overrides. |
| `order`     | `Int!`                                                                                                                                                   | The display order within the same level or category.                                                                                           |
| `catalog`   | [Catalog](https://navixy.com/docs/navixy-graphql-api/products/business-data-repository/api-reference/catalogs/catalog-items.md#catalog)!                 | The catalog this item belongs to.                                                                                                              |
| `workspace` | [Workspace](https://navixy.com/docs/navixy-graphql-api/products/business-data-repository/api-reference/workspaces.md#workspace)                          | The workspace that owns this item. Null for system items.                                                                                      |
| `meta`      | [CatalogItemMeta](https://navixy.com/docs/navixy-graphql-api/products/business-data-repository/api-reference/catalogs/catalog-items.md#catalogitemmeta)! | Metadata about this item including description, origin, and display properties.                                                                |

***

### Device

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

**Implements:** [Node](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#node), [Titled](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#titled), [Versioned](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#versioned), [InventoryItem](https://navixy.com/docs/navixy-graphql-api/products/business-data-repository/api-reference/devices/inventory.md#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.                                                                                                                                                                                                                                                                                                    |
| `workspace`        | [Workspace](https://navixy.com/docs/navixy-graphql-api/products/business-data-repository/api-reference/workspaces.md#workspace)!                                                        | The workspace that owns this device.                                                                                                                                                                                                                                                                                                |
| `type`             | [DeviceType](#devicetype)!                                                                                                                                                              | The device type classification.                                                                                                                                                                                                                                                                                                     |
| `model`            | [DeviceModel](#devicemodel)!                                                                                                                                                            | The specific device model.                                                                                                                                                                                                                                                                                                          |
| `status`           | [DeviceStatus](#devicestatus)!                                                                                                                                                          | The current operational status.                                                                                                                                                                                                                                                                                                     |
| `createdAt`        | [DateTime](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#datetime)!                                                                                           | When this device record was created.                                                                                                                                                                                                                                                                                                |
| `activation`       | [DeviceActivation](#deviceactivation)                                                                                                                                                   | SIM/APN activation data, present once the device has gone through `deviceActivate`. Null for a device created only via `deviceCreate`. Also null, with an `INTERNAL_ERROR` on this field alone, for a stored activation the server cannot read, such as one with a missing key; the device itself and the list it is in are served. |
| `identifiers`      | \[[DeviceIdentifier](#deviceidentifier)!]!                                                                                                                                              | The hardware identifiers for this device (IMEI, serial number, MAC address, etc.).                                                                                                                                                                                                                                                  |
| `asset`            | [Asset](https://navixy.com/docs/navixy-graphql-api/products/business-data-repository/api-reference/assets.md#asset)                                                                     | The asset this device is currently linked to.                                                                                                                                                                                                                                                                                       |
| `inventory`        | [Inventory](https://navixy.com/docs/navixy-graphql-api/products/business-data-repository/api-reference/devices/inventory.md#inventory)                                                  | The inventory this device is currently assigned to.                                                                                                                                                                                                                                                                                 |
| `relationsFrom`    | \[[DeviceRelation](#devicerelation)!]!                                                                                                                                                  | The outgoing relationships from this device to other devices.                                                                                                                                                                                                                                                                       |
| `relationsTo`      | \[[DeviceRelation](#devicerelation)!]!                                                                                                                                                  | The incoming relationships from other devices to this device.                                                                                                                                                                                                                                                                       |
| `inventoryHistory` | [DeviceInventoryRelationConnection](https://navixy.com/docs/navixy-graphql-api/products/business-data-repository/api-reference/devices/inventory.md#deviceinventoryrelationconnection)! | The history of inventory assignments for this device.                                                                                                                                                                                                                                                                               |

**Arguments of `inventoryHistory`**

| Name      | Type                                                                                                                                                                         | Description                                                                                                     |
| --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- |
| `first`   | `Int`                                                                                                                                                                        | The first `n` elements from the [paginated list](https://navixy.com/docs/navixy-graphql-api/pagination.md).     |
| `after`   | `String`                                                                                                                                                                     | The elements that come after the specified [cursor](https://navixy.com/docs/navixy-graphql-api/pagination.md).  |
| `last`    | `Int`                                                                                                                                                                        | The last `n` elements from the [paginated list](https://navixy.com/docs/navixy-graphql-api/pagination.md).      |
| `before`  | `String`                                                                                                                                                                     | The elements that come before the specified [cursor](https://navixy.com/docs/navixy-graphql-api/pagination.md). |
| `orderBy` | [DeviceInventoryRelationOrder](https://navixy.com/docs/navixy-graphql-api/products/business-data-repository/api-reference/devices/inventory.md#deviceinventoryrelationorder) | The ordering options for the returned history. Default: `{ field: ASSIGNED_AT direction: DESC }`.               |

***

### DeviceActivation

SIM/APN data recorded by `deviceActivate`; for `AUTOMATIC` setup, the `Register` SMS the platform sends to the device is built from it. Present once activation has run; absent for a device created only via `deviceCreate`. Whether the device has connected since is its status: `awaiting_connection` until its first frame reaches the platform, `active` after.

| Field         | Type                                                                                          | Description                                                                                                                                                                                                                                                                                                       |
| ------------- | --------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `setup`       | [DeviceSetup](#devicesetup)!                                                                  | How the device receives its server settings.                                                                                                                                                                                                                                                                      |
| `phone`       | `String`                                                                                      | The SIM phone number, globally unique across the installation. The activation SMS is sent to it for `AUTOMATIC` setup. Null for `MANUAL` setup activated without one.                                                                                                                                             |
| `apn`         | [ApnSettings](#apnsettings)                                                                   | The APN settings, pushed to the device for `AUTOMATIC` setup. Null for `MANUAL` setup activated without them.                                                                                                                                                                                                     |
| `server`      | [ActivationServerAddress](#activationserveraddress)                                           | The data gateway address the device connects to, to be entered on the device for `MANUAL` setup. The port is that of the protocol of the device's model, and follows the model when it changes. Null while the installation publishes no address, and for a device whose model has no protocol the gateway knows. |
| `activatedAt` | [DateTime](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#datetime)! | When `deviceActivate` last recorded this activation.                                                                                                                                                                                                                                                              |

***

### ActivationServerAddress

The data gateway address a device connects to.

| Field  | Type      | Description                  |
| ------ | --------- | ---------------------------- |
| `host` | `String!` | The host name or IP address. |
| `port` | `Int!`    | The TCP port.                |

***

### ApnSettings

APN (Access Point Name) settings pushed to a device by the `Register` command.

| Field  | Type      | Description                                    |
| ------ | --------- | ---------------------------------------------- |
| `name` | `String!` | The APN name.                                  |
| `user` | `String`  | The APN username, if the carrier requires one. |

***

### DeviceIdentifier

A hardware identifier for a device.

**Implements:** [Node](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#node)

| Field       | Type                                                                                 | Description                                                                          |
| ----------- | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
| `id`        | `ID!`                                                                                | A globally unique identifier. This ID is opaque and should not be parsed by clients. |
| `device`    | [Device](#device)!                                                                   | The device this identifier belongs to.                                               |
| `type`      | [DeviceIdType](#deviceidtype)!                                                       | The type of identifier.                                                              |
| `value`     | `String!`                                                                            | The identifier value.                                                                |
| `namespace` | [Code](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#code) | The namespace for uniqueness scope. Null means the identifier is globally unique.    |

***

### DeviceRelation

A relationship between two devices.

**Implements:** [Node](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#node)

| Field    | Type                                       | Description                                                                          |
| -------- | ------------------------------------------ | ------------------------------------------------------------------------------------ |
| `id`     | `ID!`                                      | A globally unique identifier. This ID is opaque and should not be parsed by clients. |
| `first`  | [Device](#device)!                         | The first device in the relationship.                                                |
| `second` | [Device](#device)!                         | The second device in the relationship.                                               |
| `type`   | [DeviceRelationType](#devicerelationtype)! | The type of relationship.                                                            |

***

### DevicePayload

The result of a device mutation.

| Field    | Type               | Description                    |
| -------- | ------------------ | ------------------------------ |
| `device` | [Device](#device)! | The created or updated device. |

***

### DeviceActivatePayload

The result of `deviceActivate`.

| Field           | Type                                          | Description                                                                                                |
| --------------- | --------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
| `device`        | [Device](#device)!                            | The activated device.                                                                                      |
| `activationSms` | [ActivationSmsOutcome](#activationsmsoutcome) | Whether the activation SMS was queued, for `AUTOMATIC` setup. Null for `MANUAL` setup, which sends no SMS. |

***

### DeviceIdentifierPayload

The result of a device identifier mutation.

| Field              | Type                                   | Description                  |
| ------------------ | -------------------------------------- | ---------------------------- |
| `deviceIdentifier` | [DeviceIdentifier](#deviceidentifier)! | The added device identifier. |

***

### DeviceRelationPayload

The result of a device relation mutation.

| Field            | Type                               | Description                      |
| ---------------- | ---------------------------------- | -------------------------------- |
| `deviceRelation` | [DeviceRelation](#devicerelation)! | The created device relationship. |

***

### DeviceTypePayload

The result of a device type mutation.

| Field        | Type                       | Description                         |
| ------------ | -------------------------- | ----------------------------------- |
| `deviceType` | [DeviceType](#devicetype)! | The created or updated device type. |

***

### DeviceStatusPayload

The result of a device status mutation.

| Field          | Type                           | Description                           |
| -------------- | ------------------------------ | ------------------------------------- |
| `deviceStatus` | [DeviceStatus](#devicestatus)! | The created or updated device status. |

***

## Inputs

### DeviceFilter

Filtering options for devices.

| Field                | Type     | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| -------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `typeIds`            | `[ID!]`  | Filter by device types (OR within field).                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| `modelIds`           | `[ID!]`  | Filter by device models (OR within field).                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| `statusIds`          | `[ID!]`  | Filter by statuses (OR within field).                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| `vendorIds`          | `[ID!]`  | Filter by vendors (OR within field).                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| `identifierContains` | `String` | Partial match on device identifier value (case-insensitive contains).                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| `inventoryIds`       | `[ID!]`  | Filter by inventories (OR within field).                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| `titleContains`      | `String` | Partial match on title (case-insensitive contains).                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| `search`             | `String` | Free-text search for a device list search box: a device matches when its title or any of its identifier values contains the value (case-insensitive), or its activation SIM phone number contains it. The phone is stored as digits only, so spaces and the characters `+`, `-`, `(`, `)` and `.` are dropped from the value before it is compared with the phone. So `866104` finds a device by IMEI or by phone, and `+49 151` by phone. A value of only those characters still matches by title and identifier. |

***

### DeviceOrder

Ordering options for devices.

| Field       | Type                                                                                                      | Description             |
| ----------- | --------------------------------------------------------------------------------------------------------- | ----------------------- |
| `field`     | [DeviceOrderField](#deviceorderfield)                                                                     | The field to order by.  |
| `direction` | [OrderDirection](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#orderdirection)! | The direction to order. |

***

### DeviceModelFilter

Filtering options for device models.

| Field           | Type                                                                                 | Description                                                       |
| --------------- | ------------------------------------------------------------------------------------ | ----------------------------------------------------------------- |
| `vendorIds`     | `[ID!]`                                                                              | Filter by vendors (OR within field).                              |
| `titleContains` | `String`                                                                             | Partial match on title (case-insensitive contains).               |
| `code`          | [Code](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#code) | Exact code match.                                                 |
| `supported`     | `Boolean`                                                                            | Filter to models the platform supports (`DeviceModel.supported`). |

***

### DeviceCreateInput

Input for creating a new device.

| Field         | Type                                                | Description                                                                                                                                                                                                                                                                                                                                                                      |
| ------------- | --------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `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. With no identifiers at all the generated title is "\<vendor.title> \<model.title>". |
| `identifiers` | \[[DeviceIdentifierInput](#deviceidentifierinput)!] | The hardware identifiers. Optional: a device may be registered before its hardware is known. Identifiers can be added later with `deviceIdentifierAdd`.                                                                                                                                                                                                                          |
| `inventoryId` | `ID`                                                | Optionally assign the new device to an existing inventory. When provided, the inventory must belong to the same workspace; the assignment is atomic with device creation (the device is not created if the assignment fails).                                                                                                                                                    |

***

### 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.                                                                           |

***

### 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. |

***

### DeviceIdentifierInput

Input for a device identifier.

| Field       | Type                                                                                 | Description                                                                                                                                                                                                                                                                                                                                          |
| ----------- | ------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `type`      | [DeviceIdType](#deviceidtype)!                                                       | The type of identifier.                                                                                                                                                                                                                                                                                                                              |
| `value`     | `String!`                                                                            | The identifier value. 1 to 64 Unicode code points, measured after `@trim` has removed leading and trailing whitespace. An astral character such as an emoji counts as one, though a UTF-16 `length` reports it as two. The limit is not expressible in the schema and is enforced by the server: a longer value is rejected with `VALIDATION_ERROR`. |
| `namespace` | [Code](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#code) | The namespace for uniqueness scope. Null means globally unique.                                                                                                                                                                                                                                                                                      |

***

### DeviceIdentifierAddInput

Input for adding an identifier to a device.

| Field        | Type                                             | Description             |
| ------------ | ------------------------------------------------ | ----------------------- |
| `deviceId`   | `ID!`                                            | The device ID.          |
| `identifier` | [DeviceIdentifierInput](#deviceidentifierinput)! | The identifier details. |

***

### DeviceIdentifierRemoveInput

Input for removing an identifier from a device.

| Field          | Type  | Description                  |
| -------------- | ----- | ---------------------------- |
| `identifierId` | `ID!` | The identifier ID to remove. |

***

### ApnSettingsInput

APN settings for `deviceActivate`.

| Field      | Type      | Description                                                                                                                                                                                                                                                                      |
| ---------- | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `name`     | `String!` | The APN name: 1-40 characters of letters, digits, `.`, `_` or `-`.                                                                                                                                                                                                               |
| `user`     | `String`  | The APN username, if the carrier requires one: at most 40 characters of letters, digits, `.`, `_`, `-` or `@`.                                                                                                                                                                   |
| `password` | `String`  | The APN password, if the carrier requires one: at most 40 characters of letters, digits, `.`, `_`, `-` or `@`. Not saved in the device activation: it goes only into the activation SMS text, which the command queue keeps with the queued command. Ignored for `MANUAL` setup. |

***

### DeviceActivateInput

Input for activating a device: creates it with the given identifier, records SIM/APN data, sets it `awaiting_connection`, and for `AUTOMATIC` setup queues the SMS that pushes APN and server settings to it.

| Field        | Type                                  | Description                                                                                                                                                                                                                                                                                                                                                                                |
| ------------ | ------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `setup`      | [DeviceSetup](#devicesetup)!          | How the device receives its server settings.                                                                                                                                                                                                                                                                                                                                               |
| `modelId`    | `ID!`                                 | The device model. Must be `supported`.                                                                                                                                                                                                                                                                                                                                                     |
| `title`      | `String`                              | The device display name. For a new device, `<model title> <identifier>` when omitted or blank. For an existing device this activation attaches to, replaces its title when given and keeps it when omitted or blank.                                                                                                                                                                       |
| `identifier` | `String!`                             | The identifier the model's protocol names a device by: the IMEI (15 digits) for most models, the serial number (6 to 10 digits, not all zeros, leading zeros kept) for Suntech models. Becomes the device's `IMEI` or `SERIAL_NUMBER` identifier, the serial number in the namespace of its protocol (`suntech`). Checked against the model: `VALIDATION_ERROR` on `identifier` otherwise. |
| `phone`      | `String`                              | The SIM phone number the activation SMS is sent to: 5 to 20 digits, globally unique across the installation. Required for `AUTOMATIC` setup, optional for `MANUAL`.                                                                                                                                                                                                                        |
| `apn`        | [ApnSettingsInput](#apnsettingsinput) | The APN settings pushed to the device. Required for `AUTOMATIC` setup, optional for `MANUAL`.                                                                                                                                                                                                                                                                                              |

***

### 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. |

***

### DeviceRelationRemoveInput

Input for removing a device relationship.

| Field | Type  | Description                    |
| ----- | ----- | ------------------------------ |
| `id`  | `ID!` | The relationship ID to remove. |

***

### DeviceTypeCreateInput

Input for creating a device type.

| Field   | Type                                                                                                                                                              | Description                                                      |
| ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------- |
| `code`  | [Code](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#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`  | [CatalogItemMetaInput](https://navixy.com/docs/navixy-graphql-api/products/business-data-repository/api-reference/catalogs/catalog-items.md#catalogitemmetainput) | The display properties.                                          |

***

### 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`    | [CatalogItemMetaInput](https://navixy.com/docs/navixy-graphql-api/products/business-data-repository/api-reference/catalogs/catalog-items.md#catalogitemmetainput) | The display properties.                                                                         |

***

### DeviceStatusCreateInput

Input for creating a device status.

| Field   | Type                                                                                                                                                              | Description                                                      |
| ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------- |
| `code`  | [Code](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#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`  | [CatalogItemMetaInput](https://navixy.com/docs/navixy-graphql-api/products/business-data-repository/api-reference/catalogs/catalog-items.md#catalogitemmetainput) | The display properties.                                          |

***

### 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`    | [CatalogItemMetaInput](https://navixy.com/docs/navixy-graphql-api/products/business-data-repository/api-reference/catalogs/catalog-items.md#catalogitemmetainput) | The display properties.                                                                         |

***

## Enums

### DeviceIdType

The type of hardware identifier used to identify a device.

| Value           | Description                                                 |
| --------------- | ----------------------------------------------------------- |
| `GUID`          | A GUID/UUID identifier.                                     |
| `IMEI`          | International Mobile Equipment Identity. A 15-digit number. |
| `MEID_HEX`      | Mobile Equipment Identifier in hexadecimal format.          |
| `MEID_DEC`      | Mobile Equipment Identifier in decimal format.              |
| `MAC_ADDRESS`   | Media Access Control address of a network interface.        |
| `SERIAL_NUMBER` | Manufacturer-assigned serial number.                        |
| `CUSTOM`        | A custom identifier type defined by the workspace.          |

***

### DeviceSetup

How a device activated by `deviceActivate` receives its server settings.

| Value       | Description                                                                                                |
| ----------- | ---------------------------------------------------------------------------------------------------------- |
| `AUTOMATIC` | The platform queues an SMS that pushes the APN and server settings to the device. Needs `phone` and `apn`. |
| `MANUAL`    | The user enters the server settings on the device by hand, from `DeviceActivation.server`. No SMS is sent. |

***

### ActivationSmsOutcome

Whether `deviceActivate` with `AUTOMATIC` setup queued the SMS with the APN and server settings; some models take them in several SMS. Whether a queued SMS is sent and delivered later is not part of it. With `SERVICE_UNAVAILABLE` and `MODEL_NOT_SUPPORTED` no SMS is queued. With `QUEUE_REFUSED` the SMS queued before the refused one stay queued, but they do not carry all the settings. With any value but `QUEUED` the user enters the server settings on the device by hand, from `DeviceActivation.server` when it is set.

| Value                 | Description                                                                                                                                                                                        |
| --------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `QUEUED`              | Every SMS is queued for sending.                                                                                                                                                                   |
| `SERVICE_UNAVAILABLE` | The installation cannot send activation SMS.                                                                                                                                                       |
| `MODEL_NOT_SUPPORTED` | The platform cannot build the SMS for this device: its model or protocol has no such command, the installation publishes no server address, or the device lacks the identifier its protocol needs. |
| `QUEUE_REFUSED`       | The command queue refused an SMS, for example because the queue is full. The SMS queued before it stay queued.                                                                                     |

***

### DeviceOrderField

Fields available for ordering devices.

| Value   | Description     |
| ------- | --------------- |
| `TITLE` | Order by title. |

***

## Pagination types

### DeviceConnection

A paginated list of Device items.

**Implements:** [Connection](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#connection)

| Field      | Type                                                                                           | Description                                                |
| ---------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------- |
| `edges`    | \[[DeviceEdge](#deviceedge)!]!                                                                 | A list of edges.                                           |
| `nodes`    | \[[Device](#device)!]!                                                                         | A list of nodes in the connection (without edge metadata). |
| `pageInfo` | [PageInfo](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#pageinfo)!  | Information about the current page.                        |
| `total`    | [CountInfo](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#countinfo) | The total count of items matching the filter.              |

***

### DeviceEdge

An edge in the Device connection.

**Implements:** [Edge](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#edge)

| Field    | Type               | Description                        |
| -------- | ------------------ | ---------------------------------- |
| `cursor` | `String!`          | An opaque cursor for this edge.    |
| `node`   | [Device](#device)! | The device at the end of the edge. |

***

### DeviceTypeConnection

A paginated list of DeviceType items.

**Implements:** [Connection](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#connection)

| Field      | Type                                                                                           | Description                                                |
| ---------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------- |
| `edges`    | \[[DeviceTypeEdge](#devicetypeedge)!]!                                                         | A list of edges.                                           |
| `nodes`    | \[[DeviceType](#devicetype)!]!                                                                 | A list of nodes in the connection (without edge metadata). |
| `pageInfo` | [PageInfo](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#pageinfo)!  | Information about the current page.                        |
| `total`    | [CountInfo](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#countinfo) | The total count of items matching the filter.              |

***

### DeviceTypeEdge

An edge in the DeviceType connection.

**Implements:** [Edge](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#edge)

| Field    | Type                       | Description                             |
| -------- | -------------------------- | --------------------------------------- |
| `cursor` | `String!`                  | An opaque cursor for this edge.         |
| `node`   | [DeviceType](#devicetype)! | The device type at the end of the edge. |

***

### DeviceStatusConnection

A paginated list of DeviceStatus items.

**Implements:** [Connection](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#connection)

| Field      | Type                                                                                           | Description                                                |
| ---------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------- |
| `edges`    | \[[DeviceStatusEdge](#devicestatusedge)!]!                                                     | A list of edges.                                           |
| `nodes`    | \[[DeviceStatus](#devicestatus)!]!                                                             | A list of nodes in the connection (without edge metadata). |
| `pageInfo` | [PageInfo](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#pageinfo)!  | Information about the current page.                        |
| `total`    | [CountInfo](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#countinfo) | The total count of items matching the filter.              |

***

### DeviceStatusEdge

An edge in the DeviceStatus connection.

**Implements:** [Edge](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#edge)

| Field    | Type                           | Description                               |
| -------- | ------------------------------ | ----------------------------------------- |
| `cursor` | `String!`                      | An opaque cursor for this edge.           |
| `node`   | [DeviceStatus](#devicestatus)! | The device status at the end of the edge. |

***

### DeviceModelConnection

A paginated list of DeviceModel items.

**Implements:** [Connection](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#connection)

| Field      | Type                                                                                           | Description                                                |
| ---------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------- |
| `edges`    | \[[DeviceModelEdge](#devicemodeledge)!]!                                                       | A list of edges.                                           |
| `nodes`    | \[[DeviceModel](#devicemodel)!]!                                                               | A list of nodes in the connection (without edge metadata). |
| `pageInfo` | [PageInfo](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#pageinfo)!  | Information about the current page.                        |
| `total`    | [CountInfo](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#countinfo) | The total count of items matching the filter.              |

***

### DeviceModelEdge

An edge in the DeviceModel connection.

**Implements:** [Edge](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#edge)

| Field    | Type                         | Description                              |
| -------- | ---------------------------- | ---------------------------------------- |
| `cursor` | `String!`                    | An opaque cursor for this edge.          |
| `node`   | [DeviceModel](#devicemodel)! | The device model at the end of the edge. |

***

### DeviceVendorConnection

A paginated list of DeviceVendor items.

**Implements:** [Connection](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#connection)

| Field      | Type                                                                                           | Description                                                |
| ---------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------- |
| `edges`    | \[[DeviceVendorEdge](#devicevendoredge)!]!                                                     | A list of edges.                                           |
| `nodes`    | \[[DeviceVendor](#devicevendor)!]!                                                             | A list of nodes in the connection (without edge metadata). |
| `pageInfo` | [PageInfo](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#pageinfo)!  | Information about the current page.                        |
| `total`    | [CountInfo](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#countinfo) | The total count of items matching the filter.              |

***

### DeviceVendorEdge

An edge in the DeviceVendor connection.

**Implements:** [Edge](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#edge)

| Field    | Type                           | Description                               |
| -------- | ------------------------------ | ----------------------------------------- |
| `cursor` | `String!`                      | An opaque cursor for this edge.           |
| `node`   | [DeviceVendor](#devicevendor)! | The device vendor at the end of the edge. |

***

### DeviceRelationTypeConnection

A paginated list of DeviceRelationType items.

**Implements:** [Connection](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#connection)

| Field      | Type                                                                                           | Description                                                |
| ---------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------- |
| `edges`    | \[[DeviceRelationTypeEdge](#devicerelationtypeedge)!]!                                         | A list of edges.                                           |
| `nodes`    | \[[DeviceRelationType](#devicerelationtype)!]!                                                 | A list of nodes in the connection (without edge metadata). |
| `pageInfo` | [PageInfo](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#pageinfo)!  | Information about the current page.                        |
| `total`    | [CountInfo](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#countinfo) | The total count of items matching the filter.              |

***

### DeviceRelationTypeEdge

An edge in the DeviceRelationType connection.

**Implements:** [Edge](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#edge)

| Field    | Type                                       | Description                                      |
| -------- | ------------------------------------------ | ------------------------------------------------ |
| `cursor` | `String!`                                  | An opaque cursor for this edge.                  |
| `node`   | [DeviceRelationType](#devicerelationtype)! | The device relation type at the end of the edge. |

***

## See also

* [Pagination](https://navixy.com/docs/navixy-graphql-api/pagination.md)
* [Filtering and sorting](https://navixy.com/docs/navixy-graphql-api/filtering-and-sorting.md)
* [Error handling](https://navixy.com/docs/navixy-graphql-api/error-handling.md)
* [Optimistic locking](https://navixy.com/docs/navixy-graphql-api/optimistic-locking.md)
* [Limits](https://navixy.com/docs/navixy-graphql-api/limits.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://navixy.com/docs/navixy-graphql-api/products/business-data-repository/api-reference/devices.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
