> 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/business-data-repository/api-reference/catalogs/catalog-items.md).

# Catalog items

Queries, mutations, and types for catalog items, the configurable lookup entries used for device types, asset types, statuses, and other reference data.

{% hint style="warning" %}
**Navixy GraphQL API is a work in progress.** This documentation is published for preview purposes only and doesn't reflect a stable release. Structure, field names, and behaviors are subject to change.
{% endhint %}

Operations and types for managing catalog items - the configurable lookup entries.

## Queries

### catalog (query)

Retrieves a catalog by its ID.

```graphql
catalog(id: ID!): Catalog
```

**Arguments**

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

**Output types:**

<details>

<summary>Catalog</summary>

A catalog definition that contains catalog items. Catalogs are themselves catalog items.

**Implements:** [CatalogItem](#catalogitem), [Node](/docs/navixy-graphql-api/core-api-reference/common.md#node), [Versioned](/docs/navixy-graphql-api/core-api-reference/common.md#versioned), [Titled](/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](/docs/navixy-graphql-api/core-api-reference/common.md#code)!                                  | A machine-readable code, unique within the catalog scope.                       |
| `order`     | `Int!`                                                                                               | The display order within the same level or category.                            |
| `catalog`   | [Catalog](#catalog)!                                                                                 | Self-reference for the meta-catalog.                                            |
| `workspace` | [Workspace](/docs/navixy-graphql-api/business-data-repository/api-reference/workspaces.md#workspace) | The workspace that owns this item. Null for system items.                       |
| `meta`      | [CatalogItemMeta](#catalogitemmeta)!                                                                 | Metadata about this item including description, origin, and display properties. |
| `module`    | [Module](/docs/navixy-graphql-api/business-data-repository/api-reference/catalogs/system.md#module)! | The module this catalog is associated with.                                     |
| `items`     | [CatalogItemConnection](#catalogitemconnection)!                                                     | The items in this catalog.                                                      |

</details>

***

### catalogs

Lists catalogs for a workspace.

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

**Arguments**

| Name          | Type                | Description                                                                                   |
| ------------- | ------------------- | --------------------------------------------------------------------------------------------- |
| `workspaceId` | `ID!`               | The workspace to retrieve catalogs for.                                                       |
| `filter`      | `CatalogItemFilter` | Filtering options for the returned catalogs.                                                  |
| `first`       | `Int`               | The first `n` elements from the [paginated list](/docs/navixy-graphql-api/pagination.md).     |
| `after`       | `String`            | The elements that come after the specified [cursor](/docs/navixy-graphql-api/pagination.md).  |
| `last`        | `Int`               | The last `n` elements from the [paginated list](/docs/navixy-graphql-api/pagination.md).      |
| `before`      | `String`            | The elements that come before the specified [cursor](/docs/navixy-graphql-api/pagination.md). |
| `orderBy`     | `CatalogItemOrder`  | The ordering options for the returned catalogs.                                               |

**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](/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](#catalogitemorderfield)!                                        | The field to order by.  |
| `direction` | [OrderDirection](/docs/navixy-graphql-api/core-api-reference/common.md#orderdirection)! | The direction to order. |

</details>

**Output types:**

<details>

<summary>CatalogConnection</summary>

A paginated list of Catalog items.

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

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

</details>

***

## Mutations

### catalogCreate

Creates a new user-defined catalog.

```graphql
catalogCreate(
    input: CatalogCreateInput!
  ): CatalogPayload
```

**Arguments**

| Name    | Type                  | Description                                |
| ------- | --------------------- | ------------------------------------------ |
| `input` | `CatalogCreateInput!` | The input fields for creating the catalog. |

**Input types:**

<details>

<summary>CatalogCreateInput</summary>

Input for creating a user-defined catalog (a container for user catalog items).

| Field         | Type                                                               | Description                                                                                   |
| ------------- | ------------------------------------------------------------------ | --------------------------------------------------------------------------------------------- |
| `workspaceId` | `ID!`                                                              | The workspace that will own the catalog.                                                      |
| `moduleId`    | `ID`                                                               | The module this catalog belongs to. Defaults to the platform's own module (`bdr`) if omitted. |
| `code`        | [Code](/docs/navixy-graphql-api/core-api-reference/common.md#code) | The machine-readable code, unique within the workspace. 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](#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>CatalogPayload</summary>

The result of a catalog mutation.

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

</details>

<details>

<summary>Catalog (entity)</summary>

A catalog definition that contains catalog items. Catalogs are themselves catalog items.

**Implements:** [CatalogItem](#catalogitem), [Node](/docs/navixy-graphql-api/core-api-reference/common.md#node), [Versioned](/docs/navixy-graphql-api/core-api-reference/common.md#versioned), [Titled](/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](/docs/navixy-graphql-api/core-api-reference/common.md#code)!                                  | A machine-readable code, unique within the catalog scope.                       |
| `order`     | `Int!`                                                                                               | The display order within the same level or category.                            |
| `catalog`   | [Catalog](#catalog)!                                                                                 | Self-reference for the meta-catalog.                                            |
| `workspace` | [Workspace](/docs/navixy-graphql-api/business-data-repository/api-reference/workspaces.md#workspace) | The workspace that owns this item. Null for system items.                       |
| `meta`      | [CatalogItemMeta](#catalogitemmeta)!                                                                 | Metadata about this item including description, origin, and display properties. |
| `module`    | [Module](/docs/navixy-graphql-api/business-data-repository/api-reference/catalogs/system.md#module)! | The module this catalog is associated with.                                     |
| `items`     | [CatalogItemConnection](#catalogitemconnection)!                                                     | The items in this catalog.                                                      |

</details>

***

### catalogUpdate

Updates a user-defined catalog.

```graphql
catalogUpdate(
    input: CatalogUpdateInput!
  ): CatalogPayload
```

**Arguments**

| Name    | Type                  | Description                                |
| ------- | --------------------- | ------------------------------------------ |
| `input` | `CatalogUpdateInput!` | The input fields for updating the catalog. |

**Input types:**

<details>

<summary>CatalogUpdateInput</summary>

Input for updating a user-defined catalog.

| Field     | Type                                          | Description                                                                                     |
| --------- | --------------------------------------------- | ----------------------------------------------------------------------------------------------- |
| `id`      | `ID!`                                         | The catalog 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](#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>CatalogPayload</summary>

The result of a catalog mutation.

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

</details>

<details>

<summary>Catalog (entity)</summary>

A catalog definition that contains catalog items. Catalogs are themselves catalog items.

**Implements:** [CatalogItem](#catalogitem), [Node](/docs/navixy-graphql-api/core-api-reference/common.md#node), [Versioned](/docs/navixy-graphql-api/core-api-reference/common.md#versioned), [Titled](/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](/docs/navixy-graphql-api/core-api-reference/common.md#code)!                                  | A machine-readable code, unique within the catalog scope.                       |
| `order`     | `Int!`                                                                                               | The display order within the same level or category.                            |
| `catalog`   | [Catalog](#catalog)!                                                                                 | Self-reference for the meta-catalog.                                            |
| `workspace` | [Workspace](/docs/navixy-graphql-api/business-data-repository/api-reference/workspaces.md#workspace) | The workspace that owns this item. Null for system items.                       |
| `meta`      | [CatalogItemMeta](#catalogitemmeta)!                                                                 | Metadata about this item including description, origin, and display properties. |
| `module`    | [Module](/docs/navixy-graphql-api/business-data-repository/api-reference/catalogs/system.md#module)! | The module this catalog is associated with.                                     |
| `items`     | [CatalogItemConnection](#catalogitemconnection)!                                                     | The items in this catalog.                                                      |

</details>

***

### catalogDelete

Deletes a user-defined catalog.

```graphql
catalogDelete(
    input: CatalogDeleteInput!
  ): DeletePayload
```

**Arguments**

| Name    | Type                  | Description                                |
| ------- | --------------------- | ------------------------------------------ |
| `input` | `CatalogDeleteInput!` | The input fields for deleting the catalog. |

**Input types:**

<details>

<summary>CatalogDeleteInput</summary>

Input for deleting a user-defined catalog.

| Field     | Type  | Description                                                                            |
| --------- | ----- | -------------------------------------------------------------------------------------- |
| `id`      | `ID!` | The catalog ID to delete.                                                              |
| `version` | `Int` | The current version for optimistic locking. If omitted, deletes regardless of version. |

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

### CatalogItemMeta

Metadata about a catalog item.

| Field          | Type                                     | Description                                                                                          |
| -------------- | ---------------------------------------- | ---------------------------------------------------------------------------------------------------- |
| `description`  | `String`                                 | A description of the catalog item. Can be localized.                                                 |
| `origin`       | [CatalogItemOrigin](#catalogitemorigin)! | The origin indicating how this item was created.                                                     |
| `canBeDeleted` | `Boolean!`                               | Whether this item can be deleted. Returns `false` if the item has dependencies or is system-managed. |
| `hidden`       | `Boolean!`                               | Whether this item is hidden from regular UI lists.                                                   |

***

### Catalog

A catalog definition that contains catalog items. Catalogs are themselves catalog items.

**Implements:** [CatalogItem](#catalogitem), [Node](/docs/navixy-graphql-api/core-api-reference/common.md#node), [Versioned](/docs/navixy-graphql-api/core-api-reference/common.md#versioned), [Titled](/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](/docs/navixy-graphql-api/core-api-reference/common.md#code)!                                  | A machine-readable code, unique within the catalog scope.                       |
| `order`     | `Int!`                                                                                               | The display order within the same level or category.                            |
| `catalog`   | [Catalog](#catalog)!                                                                                 | Self-reference for the meta-catalog.                                            |
| `workspace` | [Workspace](/docs/navixy-graphql-api/business-data-repository/api-reference/workspaces.md#workspace) | The workspace that owns this item. Null for system items.                       |
| `meta`      | [CatalogItemMeta](#catalogitemmeta)!                                                                 | Metadata about this item including description, origin, and display properties. |
| `module`    | [Module](/docs/navixy-graphql-api/business-data-repository/api-reference/catalogs/system.md#module)! | The module this catalog is associated with.                                     |
| `items`     | [CatalogItemConnection](#catalogitemconnection)!                                                     | The items in this catalog.                                                      |

***

### CatalogPayload

The result of a catalog mutation.

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

***

## Inputs

### CatalogItemFilter

Filtering options for catalog items.

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

***

### CatalogItemChildrenFilter

Filtering options for catalog item children.

| Field           | Type     | Description                                         |
| --------------- | -------- | --------------------------------------------------- |
| `titleContains` | `String` | Partial match on title (case-insensitive contains). |

***

### CatalogItemOrder

Ordering options for catalog items.

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

***

### CatalogItemMetaInput

Display properties for catalog items.

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

***

### CatalogCreateInput

Input for creating a user-defined catalog (a container for user catalog items).

| Field         | Type                                                               | Description                                                                                   |
| ------------- | ------------------------------------------------------------------ | --------------------------------------------------------------------------------------------- |
| `workspaceId` | `ID!`                                                              | The workspace that will own the catalog.                                                      |
| `moduleId`    | `ID`                                                               | The module this catalog belongs to. Defaults to the platform's own module (`bdr`) if omitted. |
| `code`        | [Code](/docs/navixy-graphql-api/core-api-reference/common.md#code) | The machine-readable code, unique within the workspace. 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](#catalogitemmetainput)                      | The display properties.                                                                       |

***

### CatalogUpdateInput

Input for updating a user-defined catalog.

| Field     | Type                                          | Description                                                                                     |
| --------- | --------------------------------------------- | ----------------------------------------------------------------------------------------------- |
| `id`      | `ID!`                                         | The catalog 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](#catalogitemmetainput) | The display properties.                                                                         |

***

### CatalogDeleteInput

Input for deleting a user-defined catalog.

| Field     | Type  | Description                                                                            |
| --------- | ----- | -------------------------------------------------------------------------------------- |
| `id`      | `ID!` | The catalog ID to delete.                                                              |
| `version` | `Int` | The current version for optimistic locking. If omitted, deletes regardless of version. |

***

### CatalogItemDeleteInput

Input for deleting a catalog item.

| Field     | Type  | Description                                                                                     |
| --------- | ----- | ----------------------------------------------------------------------------------------------- |
| `id`      | `ID!` | The catalog item ID to delete.                                                                  |
| `version` | `Int` | The current version for optimistic locking. If omitted, auto-increments without conflict check. |

***

## Enums

### CatalogItemOrigin

The origin of a catalog item, indicating how it was created.

| Value       | Description                                                        |
| ----------- | ------------------------------------------------------------------ |
| `SYSTEM`    | Predefined by platform. Immutable and available to all workspaces. |
| `WORKSPACE` | Created by the current workspace.                                  |

***

### CatalogItemOrderField

Fields available for ordering catalog items.

| Value        | Description                      |
| ------------ | -------------------------------- |
| `ORDER`      | Order by display order.          |
| `CODE`       | Order by code.                   |
| `TITLE`      | Order by title.                  |
| `CREATED_AT` | Order by creation date and time. |

***

## Interfaces

### CatalogItem

A dictionary item that provides reference data for the system.

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

***

### HierarchicalCatalogItem

A catalog item that supports parent-child hierarchy.

| Field    | Type                        | Description                                            |
| -------- | --------------------------- | ------------------------------------------------------ |
| `parent` | [CatalogItem](#catalogitem) | The parent item in the hierarchy. Null for root items. |

***

## Pagination types

### CatalogItemConnection

A paginated list of CatalogItem items.

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

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

***

### CatalogItemEdge

An edge in the CatalogItem connection.

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

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

***

### CatalogConnection

A paginated list of Catalog items.

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

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

***

### CatalogEdge

An edge in the Catalog connection.

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

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

***

## See also

* [Pagination](/docs/navixy-graphql-api/pagination.md)
* [Filtering and sorting](/docs/navixy-graphql-api/filtering-and-sorting.md)
* [Error handling](/docs/navixy-graphql-api/error-handling.md)
* [Optimistic locking](/docs/navixy-graphql-api/optimistic-locking.md)
* [Limits](/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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://navixy.com/docs/navixy-graphql-api/business-data-repository/api-reference/catalogs/catalog-items.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.