> 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/geo-objects.md).
# Geo objects
Complete reference for geo objects: queries, mutations, and types for geofences, points of interest, and routes with GeoJSON geometry.
{% 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 %}
Geo objects define geographic boundaries and points of interest - geofences, routes, and landmarks used for location-based automation.
## Queries
### geoObjectTypes
Lists geo object types for a workspace.
```graphql
geoObjectTypes(
workspaceId: ID!
filter: CatalogItemFilter
first: Int
after: String
last: Int
before: String
orderBy: CatalogItemOrder = { field: ORDER, direction: ASC }
): GeoObjectTypeConnection!
```
**Arguments**
| Name | Type | Description |
| ------------- | ------------------- | --------------------------------------------------------------------------------------------- |
| `workspaceId` | `ID!` | The workspace to retrieve geo object types for. |
| `filter` | `CatalogItemFilter` | Filtering options for the returned geo object types. |
| `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 geo object types. |
**Input types:**
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. |
CatalogItemOrder
Ordering options for catalog items.
| Field | Type | Description |
| ----------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------- |
| `field` | [CatalogItemOrderField](/docs/navixy-graphql-api/business-data-repository/api-reference/catalogs/catalog-items.md#catalogitemorderfield)! | The field to order by. |
| `direction` | [OrderDirection](/docs/navixy-graphql-api/core-api-reference/common.md#orderdirection)! | The direction to order. |
**Output types:**
GeoObjectTypeConnection
A paginated list of GeoObjectType items.
**Implements:** [Connection](/docs/navixy-graphql-api/core-api-reference/common.md#connection)
| Field | Type | Description |
| ---------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------- |
| `edges` | \[[GeoObjectTypeEdge](#geoobjecttypeedge)!]! | A list of edges. |
| `nodes` | \[[GeoObjectType](#geoobjecttype)!]! | 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. |
***
### geoObject (query)
Retrieves a geo object by its ID.
```graphql
geoObject(id: ID!): GeoObject
```
**Arguments**
| Name | Type | Description |
| ---- | ----- | ------------------------------------- |
| `id` | `ID!` | The ID of the geo object to retrieve. |
**Output types:**
GeoObject
A geographic object such as a geofence, point of interest, or route.
**Implements:** [Node](/docs/navixy-graphql-api/core-api-reference/common.md#node), [Titled](/docs/navixy-graphql-api/core-api-reference/common.md#titled), [Customizable](/docs/navixy-graphql-api/core-api-reference/common.md#customizable), [Versioned](/docs/navixy-graphql-api/core-api-reference/common.md#versioned)
| 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](/docs/navixy-graphql-api/business-data-repository/api-reference/workspaces.md#workspace)! | The workspace that owns this geo object. |
| `type` | [GeoObjectType](#geoobjecttype)! | The geo object type classification. |
| `geojsonData` | [GeoJSON](/docs/navixy-graphql-api/core-api-reference/common.md#geojson)! | The geographic shape of this object as GeoJSON geometry. |
| `customFields` | \[[CustomFieldValue](/docs/navixy-graphql-api/business-data-repository/api-reference/custom-fields.md#customfieldvalue)!]! | Typed custom field values, one entry per set field code. Each element is a concrete `CustomFieldValue` implementation matching the field's `FieldType` — select fields via inline fragments. The system-reserved code `geojson_data` is excluded — it is exposed through `GeoObject.geojsonData` instead. |
| `containsPoints` | \[[PointContainmentResult](#pointcontainmentresult)!]! | Checks if the given points are contained within this geo object's geometry. Returns the containment status for each point. Only applicable to Polygon and MultiPolygon geometries. |
***
### geoObjects
Lists geo objects for a workspace.
```graphql
geoObjects(
workspaceId: ID!
filter: GeoObjectFilter
first: Int
after: String
last: Int
before: String
orderBy: GeoObjectOrder = { field: TITLE, direction: ASC }
): GeoObjectConnection!
```
**Arguments**
| Name | Type | Description |
| ------------- | ----------------- | --------------------------------------------------------------------------------------------- |
| `workspaceId` | `ID!` | The workspace to retrieve geo objects for. |
| `filter` | `GeoObjectFilter` | Filtering options for the returned geo objects. |
| `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` | `GeoObjectOrder` | The ordering options for the returned geo objects. |
**Input types:**
GeoObjectFilter
Filtering options for geo objects.
| Field | Type | Description |
| --------------- | --------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `typeIds` | `[ID!]` | Filter by geo object types (OR within field). |
| `titleContains` | `String` | Partial match on title (case-insensitive contains). |
| `customFields` | \[[CustomFieldFilter](/docs/navixy-graphql-api/business-data-repository/api-reference/custom-fields.md#customfieldfilter)!] | Filter by custom field values. Unlike the ID list filter above, the conditions in this list combine with AND: a geo object must satisfy every one of them. See `CustomFieldFilter` for how a single condition matches. |
CustomFieldFilter
A filter condition for a custom field value.
One condition is one code compared one way. Where a filter input takes a LIST of these (`AssetFilter.customFields`, `GeoObjectFilter.customFields`), the entries combine with AND — an entity must satisfy every one of them, and repeating a code narrows rather than widens.
Inside a single condition:
* `IN` matches when the stored value equals ANY member of the list — the list itself is an OR.
* On a multi-value field (`isMulti` OPTIONS / REFERENCE), a positive operator matches when ANY stored value satisfies it: `["red","blue"]` matches `{operator: EQ, value: {string: "red"}}`. `NE` and `IS_NULL` are the inversions of that, so they match only when NO stored value qualifies — `NE "red"` does not match `["red","blue"]`.
* A code with no field definition behind it is treated as SQL NULL: `IS_NULL` and `NE` match every entity, every other operator matches none.
| Field | Type | Description |
| ---------- | --------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
| `code` | [Code](/docs/navixy-graphql-api/core-api-reference/common.md#code)! | The custom field code to filter by. |
| `operator` | [FieldOperator](/docs/navixy-graphql-api/business-data-repository/api-reference/custom-fields.md#fieldoperator)! | The comparison operator. |
| `value` | [CustomFieldFilterValue](/docs/navixy-graphql-api/business-data-repository/api-reference/custom-fields.md#customfieldfiltervalue) | The value to compare against. Null for `IS_NULL` and `IS_NOT_NULL` operators. |
CustomFieldFilterValue
Typed filter value for custom fields. Exactly one field must be set (`@oneOf`). Choose the variant that matches the custom field's data type:
| FieldType | Variant | Example |
| ----------------- | ------------ | -------------------------------------- |
| STRING, TEXT | `string` | `{ string: "hello" }` |
| DECIMAL | `decimal` | `{ decimal: "42.50" }` |
| INTEGER | `integer` | `{ integer: 42 }` |
| BOOLEAN | `boolean` | `{ boolean: true }` |
| DATE | `date` | `{ date: "2024-01-15" }` |
| DATETIME | `datetime` | `{ datetime: "2024-01-15T10:30:00Z" }` |
| OPTIONS | `string` | `{ string: "option_code" }` |
| DEVICE, REFERENCE | `id` | `{ id: "019a6a3f-..." }` |
| (IN operator) | `stringList` | `{ stringList: ["a", "b"] }` |
| (IN operator) | `idList` | `{ idList: ["uuid1", "uuid2"] }` |
*This input type uses `@oneOf` - exactly one field must be provided.*
| Field | Type | Description |
| ------------ | -------------------------------------------------------------------------- | --------------------------------------------------------- |
| `string` | `String` | String value — for STRING, TEXT, OPTIONS fields. |
| `decimal` | [Decimal](/docs/navixy-graphql-api/core-api-reference/common.md#decimal) | Arbitrary-precision decimal value — for DECIMAL fields. |
| `integer` | [Long](/docs/navixy-graphql-api/core-api-reference/common.md#long) | Signed 64-bit integer value — for INTEGER fields. |
| `boolean` | `Boolean` | Boolean value — for BOOLEAN fields. |
| `date` | [Date](/docs/navixy-graphql-api/core-api-reference/common.md#date) | Date value — for DATE fields. |
| `datetime` | [DateTime](/docs/navixy-graphql-api/core-api-reference/common.md#datetime) | Date-time value — for DATETIME fields. |
| `id` | `ID` | ID value — for DEVICE, REFERENCE fields. |
| `stringList` | `[String!]` | List of strings — for IN operator on string-based fields. |
| `idList` | `[ID!]` | List of IDs — for IN operator on reference fields. |
GeoObjectOrder
Ordering options for geo objects.
| Field | Type | Description |
| ----------------- | --------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `field` | [GeoObjectOrderField](#geoobjectorderfield) | The standard field to order by. Mutually exclusive with `customFieldCode`. |
| `customFieldCode` | [Code](/docs/navixy-graphql-api/core-api-reference/common.md#code) | The custom field code to order by. Mutually exclusive with `field`. Supported field types: STRING, DECIMAL, INTEGER, DATE, DATETIME, and the reference types DEVICE and single-value REFERENCE, which sort by the title of the entity they point at rather than by the stored id. TEXT, OPTIONS, BOOLEAN and GEOJSON are not supported for sorting, nor is a multi-value REFERENCE or a REFERENCE at an entity with no title. |
| `direction` | [OrderDirection](/docs/navixy-graphql-api/core-api-reference/common.md#orderdirection)! | The direction to order. |
**Output types:**
GeoObjectConnection
A paginated list of GeoObject items.
**Implements:** [Connection](/docs/navixy-graphql-api/core-api-reference/common.md#connection)
| Field | Type | Description |
| ---------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------- |
| `edges` | \[[GeoObjectEdge](#geoobjectedge)!]! | A list of edges. |
| `nodes` | \[[GeoObject](#geoobject)!]! | 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. |
***
## Mutations
### geoObjectCreate
Creates a new geo object.
```graphql
geoObjectCreate(
input: GeoObjectCreateInput!
): GeoObjectPayload
```
**Arguments**
| Name | Type | Description |
| ------- | ----------------------- | --------------------------------------------- |
| `input` | `GeoObjectCreateInput!` | The input fields for creating the geo object. |
**Input types:**
GeoObjectCreateInput
Input for creating a new geo object.
| Field | Type | Description |
| -------------- | --------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------- |
| `workspaceId` | `ID!` | The workspace that will own the geo object. |
| `typeId` | `ID!` | The geo object type ID. |
| `title` | `String!` | The geo object display name. |
| `geojsonData` | [GeoJSON](/docs/navixy-graphql-api/core-api-reference/common.md#geojson)! | The GeoJSON geometry. |
| `customFields` | [CustomFieldsPatchInput](/docs/navixy-graphql-api/business-data-repository/api-reference/custom-fields.md#customfieldspatchinput) | The custom field values. |
CustomFieldsPatchInput
Input for updating custom field values using a patch model.
`set` provides typed values (create/overwrite); `unset` removes fields by code. Primary status travels with the value on the primary-capable variants (DEVICE/REFERENCE) via their required `isPrimary` flag — there is no separate setPrimary/unsetPrimary list.
| Field | Type | Description |
| ------- | ----------------------------------------------------------------------------------------------------------------------------------- | --------------------------------- |
| `set` | \[[CustomFieldValueInput](/docs/navixy-graphql-api/business-data-repository/api-reference/custom-fields.md#customfieldvalueinput)!] | Field values to set or overwrite. |
| `unset` | \[[Code](/docs/navixy-graphql-api/core-api-reference/common.md#code)!] | Field codes to remove entirely. |
CustomFieldValueInput
A single custom-field value to set, addressed by code.
Omitting `value` is the same as passing null, so an entry clears the field unless it carries one. An `isDefault` override cannot be changed on its own: send the current value alongside it.
| Field | Type | Description |
| ----------- | --------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `code` | [Code](/docs/navixy-graphql-api/core-api-reference/common.md#code)! | The custom field code. |
| `value` | [CustomFieldValueDataInput](/docs/navixy-graphql-api/business-data-repository/api-reference/custom-fields.md#customfieldvaluedatainput) | The typed value. Null clears the field but keeps the key (distinct from `unset`). |
| `isDefault` | `Boolean` | Overrides the definition's `isDefault` for this entity, in either direction. Omit to leave any existing override untouched; the override is dropped when the field is `unset` or its value is cleared. |
CustomFieldValueDataInput
Typed custom-field value. Exactly one variant must be set (`@oneOf`), matching the custom field's declared FieldType:
| FieldType | Variant |
| ------------------ | ------------ |
| STRING, TEXT | `string` |
| DECIMAL | `decimal` |
| INTEGER | `integer` |
| BOOLEAN | `boolean` |
| DATE | `date` |
| DATETIME | `datetime` |
| GEOJSON | `geojson` |
| DEVICE | `device` |
| REFERENCE (single) | `reference` |
| REFERENCE (multi) | `references` |
| OPTIONS (single) | `option` |
| OPTIONS (multi) | `options` |
*This input type uses `@oneOf` - exactly one field must be provided.*
| Field | Type | Description |
| ------------ | ----------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------- |
| `string` | `String` | STRING / TEXT value. |
| `decimal` | [Decimal](/docs/navixy-graphql-api/core-api-reference/common.md#decimal) | DECIMAL value (arbitrary precision, string-encoded). |
| `integer` | [Long](/docs/navixy-graphql-api/core-api-reference/common.md#long) | INTEGER value (signed 64-bit). |
| `boolean` | `Boolean` | BOOLEAN value. |
| `date` | [Date](/docs/navixy-graphql-api/core-api-reference/common.md#date) | DATE value. |
| `datetime` | [DateTime](/docs/navixy-graphql-api/core-api-reference/common.md#datetime) | DATETIME value. |
| `geojson` | [GeoJSON](/docs/navixy-graphql-api/core-api-reference/common.md#geojson) | GEOJSON value. |
| `device` | [DeviceValueInput](/docs/navixy-graphql-api/business-data-repository/api-reference/custom-fields.md#devicevalueinput) | DEVICE value (primary-capable). |
| `reference` | [ReferenceValueInput](/docs/navixy-graphql-api/business-data-repository/api-reference/custom-fields.md#referencevalueinput) | REFERENCE value for a single-value field (primary-capable). |
| `references` | [ReferenceListValueInput](/docs/navixy-graphql-api/business-data-repository/api-reference/custom-fields.md#referencelistvalueinput) | REFERENCE value for an isMulti field (primary-capable). |
| `option` | [Code](/docs/navixy-graphql-api/core-api-reference/common.md#code) | OPTIONS value for a single-value field. |
| `options` | \[[Code](/docs/navixy-graphql-api/core-api-reference/common.md#code)!] | OPTIONS value for an isMulti field. |
DeviceValueInput
DEVICE custom-field value.
| Field | Type | Description |
| ----------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `id` | `ID!` | The device to assign. |
| `isPrimary` | `Boolean!` | Whether this device is the entity's primary DEVICE. Required — prevents silent demotion. |
| `reassign` | `Boolean` | If the device is already assigned to another asset, detach it there and reassign it here, atomically, instead of failing with VALIDATION\_ERROR. Asset holders only. A DEVICE field may only be defined on an AssetType since v0.7.0, but definitions written before it stay live, and on such a field `reassign: true` is rejected with VALIDATION\_ERROR naming it: only an asset holds a device exclusively, so there is nothing to detach it from. |
ReferenceValueInput
REFERENCE custom-field value for a single-value field.
| Field | Type | Description |
| ----------- | ---------- | ---------------------------------------------------------------------------------------------- |
| `id` | `ID!` | The referenced entity ID. |
| `isPrimary` | `Boolean!` | Whether this reference is the entity's primary REFERENCE. Required — prevents silent demotion. |
ReferenceListValueInput
REFERENCE custom-field value for an isMulti field.
| Field | Type | Description |
| ----------- | ---------- | ---------------------------------------------------------------------------------------------- |
| `ids` | `[ID!]!` | The referenced entity IDs, in the order they are stored. |
| `isPrimary` | `Boolean!` | Whether this reference is the entity's primary REFERENCE. Required — prevents silent demotion. |
**Output types:**
GeoObjectPayload
The result of a geo object mutation.
| Field | Type | Description |
| ----------- | ------------------------ | ---------------------------------- |
| `geoObject` | [GeoObject](#geoobject)! | The created or updated geo object. |
GeoObject (entity)
A geographic object such as a geofence, point of interest, or route.
**Implements:** [Node](/docs/navixy-graphql-api/core-api-reference/common.md#node), [Titled](/docs/navixy-graphql-api/core-api-reference/common.md#titled), [Customizable](/docs/navixy-graphql-api/core-api-reference/common.md#customizable), [Versioned](/docs/navixy-graphql-api/core-api-reference/common.md#versioned)
| 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](/docs/navixy-graphql-api/business-data-repository/api-reference/workspaces.md#workspace)! | The workspace that owns this geo object. |
| `type` | [GeoObjectType](#geoobjecttype)! | The geo object type classification. |
| `geojsonData` | [GeoJSON](/docs/navixy-graphql-api/core-api-reference/common.md#geojson)! | The geographic shape of this object as GeoJSON geometry. |
| `customFields` | \[[CustomFieldValue](/docs/navixy-graphql-api/business-data-repository/api-reference/custom-fields.md#customfieldvalue)!]! | Typed custom field values, one entry per set field code. Each element is a concrete `CustomFieldValue` implementation matching the field's `FieldType` — select fields via inline fragments. The system-reserved code `geojson_data` is excluded — it is exposed through `GeoObject.geojsonData` instead. |
| `containsPoints` | \[[PointContainmentResult](#pointcontainmentresult)!]! | Checks if the given points are contained within this geo object's geometry. Returns the containment status for each point. Only applicable to Polygon and MultiPolygon geometries. |
***
### geoObjectUpdate
Updates an existing geo object.
```graphql
geoObjectUpdate(
input: GeoObjectUpdateInput!
): GeoObjectPayload
```
**Arguments**
| Name | Type | Description |
| ------- | ----------------------- | --------------------------------------------- |
| `input` | `GeoObjectUpdateInput!` | The input fields for updating the geo object. |
**Input types:**
GeoObjectUpdateInput
Input for updating an existing geo object.
| Field | Type | Description |
| -------------- | --------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
| `id` | `ID!` | The geo object ID to update. |
| `version` | `Int` | The current version for optimistic locking. If omitted, auto-increments without conflict check. |
| `title` | `String` | The new display name. |
| `geojsonData` | [GeoJSON](/docs/navixy-graphql-api/core-api-reference/common.md#geojson) | The new geometry. |
| `customFields` | [CustomFieldsPatchInput](/docs/navixy-graphql-api/business-data-repository/api-reference/custom-fields.md#customfieldspatchinput) | The custom field changes. |
CustomFieldsPatchInput
Input for updating custom field values using a patch model.
`set` provides typed values (create/overwrite); `unset` removes fields by code. Primary status travels with the value on the primary-capable variants (DEVICE/REFERENCE) via their required `isPrimary` flag — there is no separate setPrimary/unsetPrimary list.
| Field | Type | Description |
| ------- | ----------------------------------------------------------------------------------------------------------------------------------- | --------------------------------- |
| `set` | \[[CustomFieldValueInput](/docs/navixy-graphql-api/business-data-repository/api-reference/custom-fields.md#customfieldvalueinput)!] | Field values to set or overwrite. |
| `unset` | \[[Code](/docs/navixy-graphql-api/core-api-reference/common.md#code)!] | Field codes to remove entirely. |
CustomFieldValueInput
A single custom-field value to set, addressed by code.
Omitting `value` is the same as passing null, so an entry clears the field unless it carries one. An `isDefault` override cannot be changed on its own: send the current value alongside it.
| Field | Type | Description |
| ----------- | --------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `code` | [Code](/docs/navixy-graphql-api/core-api-reference/common.md#code)! | The custom field code. |
| `value` | [CustomFieldValueDataInput](/docs/navixy-graphql-api/business-data-repository/api-reference/custom-fields.md#customfieldvaluedatainput) | The typed value. Null clears the field but keeps the key (distinct from `unset`). |
| `isDefault` | `Boolean` | Overrides the definition's `isDefault` for this entity, in either direction. Omit to leave any existing override untouched; the override is dropped when the field is `unset` or its value is cleared. |
CustomFieldValueDataInput
Typed custom-field value. Exactly one variant must be set (`@oneOf`), matching the custom field's declared FieldType:
| FieldType | Variant |
| ------------------ | ------------ |
| STRING, TEXT | `string` |
| DECIMAL | `decimal` |
| INTEGER | `integer` |
| BOOLEAN | `boolean` |
| DATE | `date` |
| DATETIME | `datetime` |
| GEOJSON | `geojson` |
| DEVICE | `device` |
| REFERENCE (single) | `reference` |
| REFERENCE (multi) | `references` |
| OPTIONS (single) | `option` |
| OPTIONS (multi) | `options` |
*This input type uses `@oneOf` - exactly one field must be provided.*
| Field | Type | Description |
| ------------ | ----------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------- |
| `string` | `String` | STRING / TEXT value. |
| `decimal` | [Decimal](/docs/navixy-graphql-api/core-api-reference/common.md#decimal) | DECIMAL value (arbitrary precision, string-encoded). |
| `integer` | [Long](/docs/navixy-graphql-api/core-api-reference/common.md#long) | INTEGER value (signed 64-bit). |
| `boolean` | `Boolean` | BOOLEAN value. |
| `date` | [Date](/docs/navixy-graphql-api/core-api-reference/common.md#date) | DATE value. |
| `datetime` | [DateTime](/docs/navixy-graphql-api/core-api-reference/common.md#datetime) | DATETIME value. |
| `geojson` | [GeoJSON](/docs/navixy-graphql-api/core-api-reference/common.md#geojson) | GEOJSON value. |
| `device` | [DeviceValueInput](/docs/navixy-graphql-api/business-data-repository/api-reference/custom-fields.md#devicevalueinput) | DEVICE value (primary-capable). |
| `reference` | [ReferenceValueInput](/docs/navixy-graphql-api/business-data-repository/api-reference/custom-fields.md#referencevalueinput) | REFERENCE value for a single-value field (primary-capable). |
| `references` | [ReferenceListValueInput](/docs/navixy-graphql-api/business-data-repository/api-reference/custom-fields.md#referencelistvalueinput) | REFERENCE value for an isMulti field (primary-capable). |
| `option` | [Code](/docs/navixy-graphql-api/core-api-reference/common.md#code) | OPTIONS value for a single-value field. |
| `options` | \[[Code](/docs/navixy-graphql-api/core-api-reference/common.md#code)!] | OPTIONS value for an isMulti field. |
DeviceValueInput
DEVICE custom-field value.
| Field | Type | Description |
| ----------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `id` | `ID!` | The device to assign. |
| `isPrimary` | `Boolean!` | Whether this device is the entity's primary DEVICE. Required — prevents silent demotion. |
| `reassign` | `Boolean` | If the device is already assigned to another asset, detach it there and reassign it here, atomically, instead of failing with VALIDATION\_ERROR. Asset holders only. A DEVICE field may only be defined on an AssetType since v0.7.0, but definitions written before it stay live, and on such a field `reassign: true` is rejected with VALIDATION\_ERROR naming it: only an asset holds a device exclusively, so there is nothing to detach it from. |
ReferenceValueInput
REFERENCE custom-field value for a single-value field.
| Field | Type | Description |
| ----------- | ---------- | ---------------------------------------------------------------------------------------------- |
| `id` | `ID!` | The referenced entity ID. |
| `isPrimary` | `Boolean!` | Whether this reference is the entity's primary REFERENCE. Required — prevents silent demotion. |
ReferenceListValueInput
REFERENCE custom-field value for an isMulti field.
| Field | Type | Description |
| ----------- | ---------- | ---------------------------------------------------------------------------------------------- |
| `ids` | `[ID!]!` | The referenced entity IDs, in the order they are stored. |
| `isPrimary` | `Boolean!` | Whether this reference is the entity's primary REFERENCE. Required — prevents silent demotion. |
**Output types:**
GeoObjectPayload
The result of a geo object mutation.
| Field | Type | Description |
| ----------- | ------------------------ | ---------------------------------- |
| `geoObject` | [GeoObject](#geoobject)! | The created or updated geo object. |
GeoObject (entity)
A geographic object such as a geofence, point of interest, or route.
**Implements:** [Node](/docs/navixy-graphql-api/core-api-reference/common.md#node), [Titled](/docs/navixy-graphql-api/core-api-reference/common.md#titled), [Customizable](/docs/navixy-graphql-api/core-api-reference/common.md#customizable), [Versioned](/docs/navixy-graphql-api/core-api-reference/common.md#versioned)
| 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](/docs/navixy-graphql-api/business-data-repository/api-reference/workspaces.md#workspace)! | The workspace that owns this geo object. |
| `type` | [GeoObjectType](#geoobjecttype)! | The geo object type classification. |
| `geojsonData` | [GeoJSON](/docs/navixy-graphql-api/core-api-reference/common.md#geojson)! | The geographic shape of this object as GeoJSON geometry. |
| `customFields` | \[[CustomFieldValue](/docs/navixy-graphql-api/business-data-repository/api-reference/custom-fields.md#customfieldvalue)!]! | Typed custom field values, one entry per set field code. Each element is a concrete `CustomFieldValue` implementation matching the field's `FieldType` — select fields via inline fragments. The system-reserved code `geojson_data` is excluded — it is exposed through `GeoObject.geojsonData` instead. |
| `containsPoints` | \[[PointContainmentResult](#pointcontainmentresult)!]! | Checks if the given points are contained within this geo object's geometry. Returns the containment status for each point. Only applicable to Polygon and MultiPolygon geometries. |
***
### geoObjectDelete
Deletes a geo object.
```graphql
geoObjectDelete(
input: GeoObjectDeleteInput!
): DeletePayload
```
**Arguments**
| Name | Type | Description |
| ------- | ----------------------- | --------------------------------------------- |
| `input` | `GeoObjectDeleteInput!` | The input fields for deleting the geo object. |
**Input types:**
GeoObjectDeleteInput
Input for deleting a geo object.
| Field | Type | Description |
| --------- | ----- | ----------------------------------------------------------------------------------------------- |
| `id` | `ID!` | The geo object ID to delete. |
| `version` | `Int` | The current version for optimistic locking. If omitted, auto-increments without conflict check. |
**Output types:**
DeletePayload
The result of a delete mutation.
| Field | Type | Description |
| ----------- | ----- | ----------------------------- |
| `deletedId` | `ID!` | The ID of the deleted entity. |
***
### geoObjectTypeCreate
Creates a new geo object type.
```graphql
geoObjectTypeCreate(
input: GeoObjectTypeCreateInput!
): GeoObjectTypePayload
```
**Arguments**
| Name | Type | Description |
| ------- | --------------------------- | -------------------------------------------------- |
| `input` | `GeoObjectTypeCreateInput!` | The input fields for creating the geo object type. |
**Input types:**
GeoObjectTypeCreateInput
Input for creating a geo object type.
| Field | Type | Description |
| ------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |
| `workspaceId` | `ID!` | The workspace that will own the item. |
| `code` | [Code](/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](/docs/navixy-graphql-api/business-data-repository/api-reference/catalogs/catalog-items.md#catalogitemmetainput) | The display properties. |
| `customFieldDefinitions` | \[[CustomFieldDefinitionInput](/docs/navixy-graphql-api/business-data-repository/api-reference/custom-fields.md#customfielddefinitioninput)!] | Operations on custom field definitions for this geo object type. Only `create` is allowed when creating a new catalog item. |
CatalogItemMetaInput
Display properties for catalog items.
| Field | Type | Description |
| ------------- | --------- | ------------------------------------------------- |
| `description` | `String` | The description. |
| `hidden` | `Boolean` | Whether the item is hidden from regular UI lists. |
CustomFieldDefinitionInput
A single operation on a custom field definition within the parent catalog item. Exactly one action must be provided.
*This input type uses `@oneOf` - exactly one field must be provided.*
| Field | Type | Description |
| --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------- |
| `create` | [CustomFieldDefinitionCreateData](/docs/navixy-graphql-api/business-data-repository/api-reference/custom-fields.md#customfielddefinitioncreatedata) | Create a new custom field definition. |
| `update` | [CustomFieldDefinitionUpdateData](/docs/navixy-graphql-api/business-data-repository/api-reference/custom-fields.md#customfielddefinitionupdatedata) | Update an existing custom field definition. |
| `delete` | [CustomFieldDefinitionDeleteData](/docs/navixy-graphql-api/business-data-repository/api-reference/custom-fields.md#customfielddefinitiondeletedata) | Delete a custom field definition. |
| `archive` | [CustomFieldDefinitionArchiveData](/docs/navixy-graphql-api/business-data-repository/api-reference/custom-fields.md#customfielddefinitionarchivedata) | Archive a custom field definition (non-destructive deactivation). |
| `restore` | [CustomFieldDefinitionRestoreData](/docs/navixy-graphql-api/business-data-repository/api-reference/custom-fields.md#customfielddefinitionrestoredata) | Restore a previously archived custom field definition. |
CustomFieldDefinitionCreateData
Data for creating a custom field definition within its parent catalog item.
A type carries at most **50 active** definitions, and at most **100 in total** — active and archived together. Archiving a field frees an active slot but not a total one: an archived definition accepts no new values, so it cannot grow, but it keeps its row and the values already stored under it, and only `delete` releases that. System-level fields owned by the entity type rather than by the type, such as the platform's own `geojson_data`, sit in a separate scope and never reduce either allowance. A type belongs to exactly one workspace, so the allowances are per type.
Neither bound is expressible in the schema and both are enforced by the server: a `create` past either is rejected with `VALIDATION_ERROR`, naming the total bound when both are reached, since that is the one archiving cannot resolve. Since the commands in one `customFieldDefinitions` list share a transaction, a batch that crosses a bound is rejected whole — it does not fill the type to the limit and stop.
| Field | Type | Description |
| ------------- | ---------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `code` | [Code](/docs/navixy-graphql-api/core-api-reference/common.md#code) | The machine-readable code. Must start with `cf_`, so a custom-field code can never be confused with an entity's own field name. Auto-generated from the title if omitted, prefix included. The prefix also keeps this input clear of the platform's own reserved code `geojson_data`. |
| `title` | `String!` | The display name. |
| `description` | `String` | The description. |
| `fieldType` | [FieldType](/docs/navixy-graphql-api/business-data-repository/api-reference/custom-fields.md#fieldtype)! | The data type. Immutable after creation. |
| `order` | `Int` | The display order. Auto-calculated as last position if omitted. |
| `params` | [FieldParamsInput](/docs/navixy-graphql-api/business-data-repository/api-reference/custom-fields.md#fieldparamsinput)! | The type-specific parameters. Exactly one variant must be provided. |
| `isDefault` | `Boolean` | Whether the field is on by default for entities of this type. Defaults to false. |
FieldParamsInput
Field parameters input. Exactly one field must be provided.
*This input type uses `@oneOf` - exactly one field must be provided.*
| Field | Type | Description |
| ----------- | --------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------ |
| `string` | [StringFieldParamsInput](/docs/navixy-graphql-api/business-data-repository/api-reference/custom-fields.md#stringfieldparamsinput) | Parameters for STRING field type. |
| `text` | [TextFieldParamsInput](/docs/navixy-graphql-api/business-data-repository/api-reference/custom-fields.md#textfieldparamsinput) | Parameters for TEXT field type. |
| `decimal` | [DecimalFieldParamsInput](/docs/navixy-graphql-api/business-data-repository/api-reference/custom-fields.md#decimalfieldparamsinput) | Parameters for DECIMAL field type. |
| `integer` | [IntegerFieldParamsInput](/docs/navixy-graphql-api/business-data-repository/api-reference/custom-fields.md#integerfieldparamsinput) | Parameters for INTEGER field type. |
| `boolean` | [BooleanFieldParamsInput](/docs/navixy-graphql-api/business-data-repository/api-reference/custom-fields.md#booleanfieldparamsinput) | Parameters for BOOLEAN field type. |
| `date` | [DateFieldParamsInput](/docs/navixy-graphql-api/business-data-repository/api-reference/custom-fields.md#datefieldparamsinput) | Parameters for DATE field type. |
| `datetime` | [DateTimeFieldParamsInput](/docs/navixy-graphql-api/business-data-repository/api-reference/custom-fields.md#datetimefieldparamsinput) | Parameters for DATETIME field type. |
| `geojson` | [GeoJsonFieldParamsInput](/docs/navixy-graphql-api/business-data-repository/api-reference/custom-fields.md#geojsonfieldparamsinput) | Parameters for GEOJSON field type. |
| `options` | [OptionsFieldParamsInput](/docs/navixy-graphql-api/business-data-repository/api-reference/custom-fields.md#optionsfieldparamsinput) | Parameters for OPTIONS field type. |
| `device` | [DeviceFieldParamsInput](/docs/navixy-graphql-api/business-data-repository/api-reference/custom-fields.md#devicefieldparamsinput) | Parameters for DEVICE field type. |
| `reference` | [ReferenceFieldParamsInput](/docs/navixy-graphql-api/business-data-repository/api-reference/custom-fields.md#referencefieldparamsinput) | Parameters for REFERENCE field type. |
StringFieldParamsInput
Parameters for STRING field type.
| Field | Type | Description |
| --------------- | ---------- | --------------------------------------------------------------------------------------- |
| `isRequired` | `Boolean!` | Whether a value is required. |
| `minLength` | `Int` | The minimum character length. |
| `maxLength` | `Int` | The maximum character length. Narrows the `FieldType.STRING` limit; it cannot raise it. |
| `defaultString` | `String` | The default value. |
| `trim` | `Boolean` | Whether to trim whitespace. |
TextFieldParamsInput
Parameters for TEXT field type.
| Field | Type | Description |
| ------------- | ---------- | ----------------------------------------------------------------------------------------------- |
| `isRequired` | `Boolean!` | Whether a value is required. |
| `maxLength` | `Int` | The maximum character length. Narrows the `FieldType.TEXT` limit of 65,535; it cannot raise it. |
| `defaultText` | `String` | The default value. |
| `trim` | `Boolean` | Whether to trim whitespace. |
DecimalFieldParamsInput
Parameters for DECIMAL field type.
| Field | Type | Description |
| ---------------- | ------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------- |
| `isRequired` | `Boolean!` | Whether a value is required. |
| `minDecimal` | [Decimal](/docs/navixy-graphql-api/core-api-reference/common.md#decimal) | The minimum allowed value. |
| `maxDecimal` | [Decimal](/docs/navixy-graphql-api/core-api-reference/common.md#decimal) | The maximum allowed value. |
| `scale` | `Int!` | Digits after the decimal point. Must be >= 0. Values sent with more fractional digits than `scale` are rounded using HALF\_UP before storage. |
| `defaultDecimal` | [Decimal](/docs/navixy-graphql-api/core-api-reference/common.md#decimal) | The default value. |
IntegerFieldParamsInput
Parameters for INTEGER field type.
| Field | Type | Description |
| ---------------- | ------------------------------------------------------------------ | ---------------------------- |
| `isRequired` | `Boolean!` | Whether a value is required. |
| `minInteger` | [Long](/docs/navixy-graphql-api/core-api-reference/common.md#long) | The minimum allowed value. |
| `maxInteger` | [Long](/docs/navixy-graphql-api/core-api-reference/common.md#long) | The maximum allowed value. |
| `defaultInteger` | [Long](/docs/navixy-graphql-api/core-api-reference/common.md#long) | The default value. |
BooleanFieldParamsInput
Parameters for BOOLEAN field type.
| Field | Type | Description |
| ---------------- | ---------- | ---------------------------- |
| `isRequired` | `Boolean!` | Whether a value is required. |
| `defaultBoolean` | `Boolean` | The default value. |
DateFieldParamsInput
Parameters for DATE field type.
| Field | Type | Description |
| ------------- | ------------------------------------------------------------------ | ---------------------------- |
| `isRequired` | `Boolean!` | Whether a value is required. |
| `defaultDate` | [Date](/docs/navixy-graphql-api/core-api-reference/common.md#date) | The default value. |
DateTimeFieldParamsInput
Parameters for DATETIME field type.
| Field | Type | Description |
| ----------------- | -------------------------------------------------------------------------- | ---------------------------- |
| `isRequired` | `Boolean!` | Whether a value is required. |
| `defaultDatetime` | [DateTime](/docs/navixy-graphql-api/core-api-reference/common.md#datetime) | The default value. |
GeoJsonFieldParamsInput
Parameters for GEOJSON field type.
| Field | Type | Description |
| -------------- | ----------------------------------------------- | ------------------------------------------------------------- |
| `isRequired` | `Boolean!` | Whether a value is required. |
| `allowedTypes` | \[[GeoJsonGeometryType](#geojsongeometrytype)!] | The allowed geometry types. Null means all types are allowed. |
OptionsFieldParamsInput
Parameters for OPTIONS field type.
| Field | Type | Description |
| ---------------- | -------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------- |
| `isRequired` | `Boolean!` | Whether a value is required. |
| `isMulti` | `Boolean` | Whether multiple options can be selected. |
| `options` | \[[FieldOptionInput](/docs/navixy-graphql-api/business-data-repository/api-reference/custom-fields.md#fieldoptioninput)!]! | The available options. |
| `defaultOptions` | [Code](/docs/navixy-graphql-api/core-api-reference/common.md#code) | The default option code. |
FieldOptionInput
Input for an option definition. When updating options: if an entry without `code` is provided, a new option is created. If the label already exists within this field, an error is returned.
| Field | Type | Description |
| ------------- | ------------------------------------------------------------------ | ---------------------------------------------------------- |
| `code` | [Code](/docs/navixy-graphql-api/core-api-reference/common.md#code) | The unique code. Auto-generated from label if omitted. |
| `label` | `String!` | The display label. Must be unique within the custom field. |
| `description` | `String` | The description. |
| `isArchived` | `Boolean` | Whether this option is archived. |
DeviceFieldParamsInput
Parameters for DEVICE field type.
| Field | Type | Description |
| --------------- | ---------- | ---------------------------------------------------------------------------------------- |
| `isRequired` | `Boolean!` | Whether a value is required. |
| `refSubtypeIds` | `[ID!]` | The device type IDs a value may belong to. Omit or leave empty to allow any device type. |
ReferenceFieldParamsInput
Parameters for REFERENCE field type.
| Field | Type | Description |
| ------------------- | ------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `isRequired` | `Boolean!` | Whether a value is required. |
| `isMulti` | `Boolean` | Whether multiple entities can be referenced. |
| `refEntityTypeCode` | [Code](/docs/navixy-graphql-api/core-api-reference/common.md#code)! | The target entity type code, e.g. `asset`, `geo_object`, `schedule`, `tag`, `user_catalog_item`. The `customFieldTypes` query lists the accepted values for a given owner. |
| `refSubtypeIds` | `[ID!]` | The subtype IDs a value may belong to (AssetType / GeoObjectType / catalog). Required for `user_catalog_item`, which needs exactly one catalog; rejected for target types that nothing narrows further. Omit or leave empty to allow the whole target type. |
| `defaultRefIds` | `[ID!]` | The default referenced entity IDs. |
CustomFieldDefinitionUpdateData
Data for updating an existing custom field definition. Note: `fieldType` cannot be changed.
| Field | Type | Description |
| ------------- | --------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
| `code` | [Code](/docs/navixy-graphql-api/core-api-reference/common.md#code)! | The code of the field definition to update. |
| `title` | `String` | The new display name. |
| `description` | `String` | The new description. |
| `order` | `Int` | The new display order. |
| `params` | [FieldParamsInput](/docs/navixy-graphql-api/business-data-repository/api-reference/custom-fields.md#fieldparamsinput) | The updated parameters. Only `isRequired` and type-specific fields can be changed. |
| `isDefault` | `Boolean` | The new type-level default. Omit to leave unchanged. |
CustomFieldDefinitionDeleteData
Data for permanently deleting a custom field definition.
If entities have values for this field, the default behavior is to reject the deletion. Use `onValues: CASCADE` to explicitly allow deletion with all associated values.
Prefer archiving for non-destructive deactivation.
| Field | Type | Description |
| ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- |
| `code` | [Code](/docs/navixy-graphql-api/core-api-reference/common.md#code)! | The code of the field definition to delete. |
| `onValues` | [CustomFieldDefinitionDeleteBehavior](/docs/navixy-graphql-api/business-data-repository/api-reference/custom-fields.md#customfielddefinitiondeletebehavior) | What to do when existing entities have values for this field. Defaults to `REJECT` to prevent accidental data loss. |
CustomFieldDefinitionArchiveData
Data for archiving or restoring a custom field definition.
Archiving deactivates the field without data loss:
* The field definition and all its values are preserved.
* The field no longer appears in forms and accepts no new values.
* Existing values remain readable and visible in history/exports.
| Field | Type | Description |
| ------ | ------------------------------------------------------------------- | -------------------------------------------- |
| `code` | [Code](/docs/navixy-graphql-api/core-api-reference/common.md#code)! | The code of the field definition to archive. |
CustomFieldDefinitionRestoreData
Data for restoring a previously archived custom field definition.
Restoring makes the field active again, so it is refused with `VALIDATION_ERROR` when the type is already at the **active** limit stated on `CustomFieldDefinitionCreateData` — otherwise archiving would be a way around that limit. The total limit never refuses a restore: the row already exists and is already counted, so restoring moves it between the two buckets without adding to the total. Restoring a definition that is already active is never refused either, since it adds no field to the type; it still bumps the definition's `version`.
| Field | Type | Description |
| ------ | ------------------------------------------------------------------- | -------------------------------------------- |
| `code` | [Code](/docs/navixy-graphql-api/core-api-reference/common.md#code)! | The code of the field definition to restore. |
**Output types:**
GeoObjectTypePayload
The result of a geo object type mutation.
| Field | Type | Description |
| --------------- | -------------------------------- | --------------------------------------- |
| `geoObjectType` | [GeoObjectType](#geoobjecttype)! | The created or updated geo object type. |
GeoObjectType (entity)
A classification type for geographic objects.
**Implements:** [CatalogItem](/docs/navixy-graphql-api/business-data-repository/api-reference/catalogs/catalog-items.md#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](/docs/navixy-graphql-api/business-data-repository/api-reference/catalogs/catalog-items.md#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](/docs/navixy-graphql-api/business-data-repository/api-reference/catalogs/catalog-items.md#catalogitemmeta)! | Metadata about this item including description, origin, and display properties. |
| `customFieldDefinitions` | \[[CustomFieldDefinition](/docs/navixy-graphql-api/business-data-repository/api-reference/custom-fields.md#customfielddefinition)!]! | Custom field definitions specific to this geo object type, ordered by display order. |
***
### geoObjectTypeUpdate
Updates a geo object type.
```graphql
geoObjectTypeUpdate(
input: GeoObjectTypeUpdateInput!
): GeoObjectTypePayload
```
**Arguments**
| Name | Type | Description |
| ------- | --------------------------- | -------------------------------------------------- |
| `input` | `GeoObjectTypeUpdateInput!` | The input fields for updating the geo object type. |
**Input types:**
GeoObjectTypeUpdateInput
Input for updating a geo object 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](/docs/navixy-graphql-api/business-data-repository/api-reference/catalogs/catalog-items.md#catalogitemmetainput) | The display properties. |
| `customFieldDefinitions` | \[[CustomFieldDefinitionInput](/docs/navixy-graphql-api/business-data-repository/api-reference/custom-fields.md#customfielddefinitioninput)!] | Operations on custom field definitions belonging to this geo object type. |
CatalogItemMetaInput
Display properties for catalog items.
| Field | Type | Description |
| ------------- | --------- | ------------------------------------------------- |
| `description` | `String` | The description. |
| `hidden` | `Boolean` | Whether the item is hidden from regular UI lists. |
CustomFieldDefinitionInput
A single operation on a custom field definition within the parent catalog item. Exactly one action must be provided.
*This input type uses `@oneOf` - exactly one field must be provided.*
| Field | Type | Description |
| --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------- |
| `create` | [CustomFieldDefinitionCreateData](/docs/navixy-graphql-api/business-data-repository/api-reference/custom-fields.md#customfielddefinitioncreatedata) | Create a new custom field definition. |
| `update` | [CustomFieldDefinitionUpdateData](/docs/navixy-graphql-api/business-data-repository/api-reference/custom-fields.md#customfielddefinitionupdatedata) | Update an existing custom field definition. |
| `delete` | [CustomFieldDefinitionDeleteData](/docs/navixy-graphql-api/business-data-repository/api-reference/custom-fields.md#customfielddefinitiondeletedata) | Delete a custom field definition. |
| `archive` | [CustomFieldDefinitionArchiveData](/docs/navixy-graphql-api/business-data-repository/api-reference/custom-fields.md#customfielddefinitionarchivedata) | Archive a custom field definition (non-destructive deactivation). |
| `restore` | [CustomFieldDefinitionRestoreData](/docs/navixy-graphql-api/business-data-repository/api-reference/custom-fields.md#customfielddefinitionrestoredata) | Restore a previously archived custom field definition. |
CustomFieldDefinitionCreateData
Data for creating a custom field definition within its parent catalog item.
A type carries at most **50 active** definitions, and at most **100 in total** — active and archived together. Archiving a field frees an active slot but not a total one: an archived definition accepts no new values, so it cannot grow, but it keeps its row and the values already stored under it, and only `delete` releases that. System-level fields owned by the entity type rather than by the type, such as the platform's own `geojson_data`, sit in a separate scope and never reduce either allowance. A type belongs to exactly one workspace, so the allowances are per type.
Neither bound is expressible in the schema and both are enforced by the server: a `create` past either is rejected with `VALIDATION_ERROR`, naming the total bound when both are reached, since that is the one archiving cannot resolve. Since the commands in one `customFieldDefinitions` list share a transaction, a batch that crosses a bound is rejected whole — it does not fill the type to the limit and stop.
| Field | Type | Description |
| ------------- | ---------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `code` | [Code](/docs/navixy-graphql-api/core-api-reference/common.md#code) | The machine-readable code. Must start with `cf_`, so a custom-field code can never be confused with an entity's own field name. Auto-generated from the title if omitted, prefix included. The prefix also keeps this input clear of the platform's own reserved code `geojson_data`. |
| `title` | `String!` | The display name. |
| `description` | `String` | The description. |
| `fieldType` | [FieldType](/docs/navixy-graphql-api/business-data-repository/api-reference/custom-fields.md#fieldtype)! | The data type. Immutable after creation. |
| `order` | `Int` | The display order. Auto-calculated as last position if omitted. |
| `params` | [FieldParamsInput](/docs/navixy-graphql-api/business-data-repository/api-reference/custom-fields.md#fieldparamsinput)! | The type-specific parameters. Exactly one variant must be provided. |
| `isDefault` | `Boolean` | Whether the field is on by default for entities of this type. Defaults to false. |
FieldParamsInput
Field parameters input. Exactly one field must be provided.
*This input type uses `@oneOf` - exactly one field must be provided.*
| Field | Type | Description |
| ----------- | --------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------ |
| `string` | [StringFieldParamsInput](/docs/navixy-graphql-api/business-data-repository/api-reference/custom-fields.md#stringfieldparamsinput) | Parameters for STRING field type. |
| `text` | [TextFieldParamsInput](/docs/navixy-graphql-api/business-data-repository/api-reference/custom-fields.md#textfieldparamsinput) | Parameters for TEXT field type. |
| `decimal` | [DecimalFieldParamsInput](/docs/navixy-graphql-api/business-data-repository/api-reference/custom-fields.md#decimalfieldparamsinput) | Parameters for DECIMAL field type. |
| `integer` | [IntegerFieldParamsInput](/docs/navixy-graphql-api/business-data-repository/api-reference/custom-fields.md#integerfieldparamsinput) | Parameters for INTEGER field type. |
| `boolean` | [BooleanFieldParamsInput](/docs/navixy-graphql-api/business-data-repository/api-reference/custom-fields.md#booleanfieldparamsinput) | Parameters for BOOLEAN field type. |
| `date` | [DateFieldParamsInput](/docs/navixy-graphql-api/business-data-repository/api-reference/custom-fields.md#datefieldparamsinput) | Parameters for DATE field type. |
| `datetime` | [DateTimeFieldParamsInput](/docs/navixy-graphql-api/business-data-repository/api-reference/custom-fields.md#datetimefieldparamsinput) | Parameters for DATETIME field type. |
| `geojson` | [GeoJsonFieldParamsInput](/docs/navixy-graphql-api/business-data-repository/api-reference/custom-fields.md#geojsonfieldparamsinput) | Parameters for GEOJSON field type. |
| `options` | [OptionsFieldParamsInput](/docs/navixy-graphql-api/business-data-repository/api-reference/custom-fields.md#optionsfieldparamsinput) | Parameters for OPTIONS field type. |
| `device` | [DeviceFieldParamsInput](/docs/navixy-graphql-api/business-data-repository/api-reference/custom-fields.md#devicefieldparamsinput) | Parameters for DEVICE field type. |
| `reference` | [ReferenceFieldParamsInput](/docs/navixy-graphql-api/business-data-repository/api-reference/custom-fields.md#referencefieldparamsinput) | Parameters for REFERENCE field type. |
StringFieldParamsInput
Parameters for STRING field type.
| Field | Type | Description |
| --------------- | ---------- | --------------------------------------------------------------------------------------- |
| `isRequired` | `Boolean!` | Whether a value is required. |
| `minLength` | `Int` | The minimum character length. |
| `maxLength` | `Int` | The maximum character length. Narrows the `FieldType.STRING` limit; it cannot raise it. |
| `defaultString` | `String` | The default value. |
| `trim` | `Boolean` | Whether to trim whitespace. |
TextFieldParamsInput
Parameters for TEXT field type.
| Field | Type | Description |
| ------------- | ---------- | ----------------------------------------------------------------------------------------------- |
| `isRequired` | `Boolean!` | Whether a value is required. |
| `maxLength` | `Int` | The maximum character length. Narrows the `FieldType.TEXT` limit of 65,535; it cannot raise it. |
| `defaultText` | `String` | The default value. |
| `trim` | `Boolean` | Whether to trim whitespace. |
DecimalFieldParamsInput
Parameters for DECIMAL field type.
| Field | Type | Description |
| ---------------- | ------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------- |
| `isRequired` | `Boolean!` | Whether a value is required. |
| `minDecimal` | [Decimal](/docs/navixy-graphql-api/core-api-reference/common.md#decimal) | The minimum allowed value. |
| `maxDecimal` | [Decimal](/docs/navixy-graphql-api/core-api-reference/common.md#decimal) | The maximum allowed value. |
| `scale` | `Int!` | Digits after the decimal point. Must be >= 0. Values sent with more fractional digits than `scale` are rounded using HALF\_UP before storage. |
| `defaultDecimal` | [Decimal](/docs/navixy-graphql-api/core-api-reference/common.md#decimal) | The default value. |
IntegerFieldParamsInput
Parameters for INTEGER field type.
| Field | Type | Description |
| ---------------- | ------------------------------------------------------------------ | ---------------------------- |
| `isRequired` | `Boolean!` | Whether a value is required. |
| `minInteger` | [Long](/docs/navixy-graphql-api/core-api-reference/common.md#long) | The minimum allowed value. |
| `maxInteger` | [Long](/docs/navixy-graphql-api/core-api-reference/common.md#long) | The maximum allowed value. |
| `defaultInteger` | [Long](/docs/navixy-graphql-api/core-api-reference/common.md#long) | The default value. |
BooleanFieldParamsInput
Parameters for BOOLEAN field type.
| Field | Type | Description |
| ---------------- | ---------- | ---------------------------- |
| `isRequired` | `Boolean!` | Whether a value is required. |
| `defaultBoolean` | `Boolean` | The default value. |
DateFieldParamsInput
Parameters for DATE field type.
| Field | Type | Description |
| ------------- | ------------------------------------------------------------------ | ---------------------------- |
| `isRequired` | `Boolean!` | Whether a value is required. |
| `defaultDate` | [Date](/docs/navixy-graphql-api/core-api-reference/common.md#date) | The default value. |
DateTimeFieldParamsInput
Parameters for DATETIME field type.
| Field | Type | Description |
| ----------------- | -------------------------------------------------------------------------- | ---------------------------- |
| `isRequired` | `Boolean!` | Whether a value is required. |
| `defaultDatetime` | [DateTime](/docs/navixy-graphql-api/core-api-reference/common.md#datetime) | The default value. |
GeoJsonFieldParamsInput
Parameters for GEOJSON field type.
| Field | Type | Description |
| -------------- | ----------------------------------------------- | ------------------------------------------------------------- |
| `isRequired` | `Boolean!` | Whether a value is required. |
| `allowedTypes` | \[[GeoJsonGeometryType](#geojsongeometrytype)!] | The allowed geometry types. Null means all types are allowed. |
OptionsFieldParamsInput
Parameters for OPTIONS field type.
| Field | Type | Description |
| ---------------- | -------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------- |
| `isRequired` | `Boolean!` | Whether a value is required. |
| `isMulti` | `Boolean` | Whether multiple options can be selected. |
| `options` | \[[FieldOptionInput](/docs/navixy-graphql-api/business-data-repository/api-reference/custom-fields.md#fieldoptioninput)!]! | The available options. |
| `defaultOptions` | [Code](/docs/navixy-graphql-api/core-api-reference/common.md#code) | The default option code. |
FieldOptionInput
Input for an option definition. When updating options: if an entry without `code` is provided, a new option is created. If the label already exists within this field, an error is returned.
| Field | Type | Description |
| ------------- | ------------------------------------------------------------------ | ---------------------------------------------------------- |
| `code` | [Code](/docs/navixy-graphql-api/core-api-reference/common.md#code) | The unique code. Auto-generated from label if omitted. |
| `label` | `String!` | The display label. Must be unique within the custom field. |
| `description` | `String` | The description. |
| `isArchived` | `Boolean` | Whether this option is archived. |
DeviceFieldParamsInput
Parameters for DEVICE field type.
| Field | Type | Description |
| --------------- | ---------- | ---------------------------------------------------------------------------------------- |
| `isRequired` | `Boolean!` | Whether a value is required. |
| `refSubtypeIds` | `[ID!]` | The device type IDs a value may belong to. Omit or leave empty to allow any device type. |
ReferenceFieldParamsInput
Parameters for REFERENCE field type.
| Field | Type | Description |
| ------------------- | ------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `isRequired` | `Boolean!` | Whether a value is required. |
| `isMulti` | `Boolean` | Whether multiple entities can be referenced. |
| `refEntityTypeCode` | [Code](/docs/navixy-graphql-api/core-api-reference/common.md#code)! | The target entity type code, e.g. `asset`, `geo_object`, `schedule`, `tag`, `user_catalog_item`. The `customFieldTypes` query lists the accepted values for a given owner. |
| `refSubtypeIds` | `[ID!]` | The subtype IDs a value may belong to (AssetType / GeoObjectType / catalog). Required for `user_catalog_item`, which needs exactly one catalog; rejected for target types that nothing narrows further. Omit or leave empty to allow the whole target type. |
| `defaultRefIds` | `[ID!]` | The default referenced entity IDs. |
CustomFieldDefinitionUpdateData
Data for updating an existing custom field definition. Note: `fieldType` cannot be changed.
| Field | Type | Description |
| ------------- | --------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
| `code` | [Code](/docs/navixy-graphql-api/core-api-reference/common.md#code)! | The code of the field definition to update. |
| `title` | `String` | The new display name. |
| `description` | `String` | The new description. |
| `order` | `Int` | The new display order. |
| `params` | [FieldParamsInput](/docs/navixy-graphql-api/business-data-repository/api-reference/custom-fields.md#fieldparamsinput) | The updated parameters. Only `isRequired` and type-specific fields can be changed. |
| `isDefault` | `Boolean` | The new type-level default. Omit to leave unchanged. |
CustomFieldDefinitionDeleteData
Data for permanently deleting a custom field definition.
If entities have values for this field, the default behavior is to reject the deletion. Use `onValues: CASCADE` to explicitly allow deletion with all associated values.
Prefer archiving for non-destructive deactivation.
| Field | Type | Description |
| ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- |
| `code` | [Code](/docs/navixy-graphql-api/core-api-reference/common.md#code)! | The code of the field definition to delete. |
| `onValues` | [CustomFieldDefinitionDeleteBehavior](/docs/navixy-graphql-api/business-data-repository/api-reference/custom-fields.md#customfielddefinitiondeletebehavior) | What to do when existing entities have values for this field. Defaults to `REJECT` to prevent accidental data loss. |
CustomFieldDefinitionArchiveData
Data for archiving or restoring a custom field definition.
Archiving deactivates the field without data loss:
* The field definition and all its values are preserved.
* The field no longer appears in forms and accepts no new values.
* Existing values remain readable and visible in history/exports.
| Field | Type | Description |
| ------ | ------------------------------------------------------------------- | -------------------------------------------- |
| `code` | [Code](/docs/navixy-graphql-api/core-api-reference/common.md#code)! | The code of the field definition to archive. |
CustomFieldDefinitionRestoreData
Data for restoring a previously archived custom field definition.
Restoring makes the field active again, so it is refused with `VALIDATION_ERROR` when the type is already at the **active** limit stated on `CustomFieldDefinitionCreateData` — otherwise archiving would be a way around that limit. The total limit never refuses a restore: the row already exists and is already counted, so restoring moves it between the two buckets without adding to the total. Restoring a definition that is already active is never refused either, since it adds no field to the type; it still bumps the definition's `version`.
| Field | Type | Description |
| ------ | ------------------------------------------------------------------- | -------------------------------------------- |
| `code` | [Code](/docs/navixy-graphql-api/core-api-reference/common.md#code)! | The code of the field definition to restore. |
**Output types:**
GeoObjectTypePayload
The result of a geo object type mutation.
| Field | Type | Description |
| --------------- | -------------------------------- | --------------------------------------- |
| `geoObjectType` | [GeoObjectType](#geoobjecttype)! | The created or updated geo object type. |
GeoObjectType (entity)
A classification type for geographic objects.
**Implements:** [CatalogItem](/docs/navixy-graphql-api/business-data-repository/api-reference/catalogs/catalog-items.md#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](/docs/navixy-graphql-api/business-data-repository/api-reference/catalogs/catalog-items.md#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](/docs/navixy-graphql-api/business-data-repository/api-reference/catalogs/catalog-items.md#catalogitemmeta)! | Metadata about this item including description, origin, and display properties. |
| `customFieldDefinitions` | \[[CustomFieldDefinition](/docs/navixy-graphql-api/business-data-repository/api-reference/custom-fields.md#customfielddefinition)!]! | Custom field definitions specific to this geo object type, ordered by display order. |
***
### geoObjectTypeDelete
Deletes a geo object type.
```graphql
geoObjectTypeDelete(
input: CatalogItemDeleteInput!
): DeletePayload
```
**Arguments**
| Name | Type | Description |
| ------- | ------------------------- | -------------------------------------------------- |
| `input` | `CatalogItemDeleteInput!` | The input fields for deleting the geo object type. |
**Input types:**
CatalogItemDeleteInput
Input for deleting a catalog item.
| Field | Type | Description |
| --------- | ----- | ----------------------------------------------------------------------------------------------- |
| `id` | `ID!` | The catalog item ID to delete. |
| `version` | `Int` | The current version for optimistic locking. If omitted, auto-increments without conflict check. |
**Output types:**
DeletePayload
The result of a delete mutation.
| Field | Type | Description |
| ----------- | ----- | ----------------------------- |
| `deletedId` | `ID!` | The ID of the deleted entity. |
***
## Objects
### GeoObjectType
A classification type for geographic objects.
**Implements:** [CatalogItem](/docs/navixy-graphql-api/business-data-repository/api-reference/catalogs/catalog-items.md#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](/docs/navixy-graphql-api/business-data-repository/api-reference/catalogs/catalog-items.md#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](/docs/navixy-graphql-api/business-data-repository/api-reference/catalogs/catalog-items.md#catalogitemmeta)! | Metadata about this item including description, origin, and display properties. |
| `customFieldDefinitions` | \[[CustomFieldDefinition](/docs/navixy-graphql-api/business-data-repository/api-reference/custom-fields.md#customfielddefinition)!]! | Custom field definitions specific to this geo object type, ordered by display order. |
***
### GeoPoint
A geographic coordinate point.
| Field | Type | Description |
| ---------- | ----------------------------------------------------------------------------- | -------------------------------------------- |
| `lat` | [Latitude](/docs/navixy-graphql-api/core-api-reference/common.md#latitude)! | The latitude coordinate in decimal degrees. |
| `lng` | [Longitude](/docs/navixy-graphql-api/core-api-reference/common.md#longitude)! | The longitude coordinate in decimal degrees. |
| `altitude` | `Float` | The altitude in meters above sea level. |
| `accuracy` | `Float` | The horizontal accuracy in meters. |
***
### GeoObject
A geographic object such as a geofence, point of interest, or route.
**Implements:** [Node](/docs/navixy-graphql-api/core-api-reference/common.md#node), [Titled](/docs/navixy-graphql-api/core-api-reference/common.md#titled), [Customizable](/docs/navixy-graphql-api/core-api-reference/common.md#customizable), [Versioned](/docs/navixy-graphql-api/core-api-reference/common.md#versioned)
| 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](/docs/navixy-graphql-api/business-data-repository/api-reference/workspaces.md#workspace)! | The workspace that owns this geo object. |
| `type` | [GeoObjectType](#geoobjecttype)! | The geo object type classification. |
| `geojsonData` | [GeoJSON](/docs/navixy-graphql-api/core-api-reference/common.md#geojson)! | The geographic shape of this object as GeoJSON geometry. |
| `customFields` | \[[CustomFieldValue](/docs/navixy-graphql-api/business-data-repository/api-reference/custom-fields.md#customfieldvalue)!]! | Typed custom field values, one entry per set field code. Each element is a concrete `CustomFieldValue` implementation matching the field's `FieldType` — select fields via inline fragments. The system-reserved code `geojson_data` is excluded — it is exposed through `GeoObject.geojsonData` instead. |
| `containsPoints` | \[[PointContainmentResult](#pointcontainmentresult)!]! | Checks if the given points are contained within this geo object's geometry. Returns the containment status for each point. Only applicable to Polygon and MultiPolygon geometries. |
***
### PointContainmentResult
The result of checking whether a point is contained within a geometry.
| Field | Type | Description |
| ------------- | ---------------------- | ---------------------------------------------------- |
| `index` | `Int!` | The index of the point in the input array (0-based). |
| `point` | [GeoPoint](#geopoint)! | The point that was checked. |
| `isContained` | `Boolean!` | Whether the point is inside the geometry. |
***
### GeoObjectPayload
The result of a geo object mutation.
| Field | Type | Description |
| ----------- | ------------------------ | ---------------------------------- |
| `geoObject` | [GeoObject](#geoobject)! | The created or updated geo object. |
***
### GeoObjectTypePayload
The result of a geo object type mutation.
| Field | Type | Description |
| --------------- | -------------------------------- | --------------------------------------- |
| `geoObjectType` | [GeoObjectType](#geoobjecttype)! | The created or updated geo object type. |
***
## Inputs
### GeoPointInput
Input for a geographic coordinate point.
| Field | Type | Description |
| ---------- | ----------------------------------------------------------------------------- | ----------------------------------------------- |
| `lat` | [Latitude](/docs/navixy-graphql-api/core-api-reference/common.md#latitude)! | The latitude coordinate (-90 to 90 degrees). |
| `lng` | [Longitude](/docs/navixy-graphql-api/core-api-reference/common.md#longitude)! | The longitude coordinate (-180 to 180 degrees). |
| `altitude` | `Float` | The altitude in meters above sea level. |
| `accuracy` | `Float` | The horizontal accuracy in meters. |
***
### GeoObjectFilter
Filtering options for geo objects.
| Field | Type | Description |
| --------------- | --------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `typeIds` | `[ID!]` | Filter by geo object types (OR within field). |
| `titleContains` | `String` | Partial match on title (case-insensitive contains). |
| `customFields` | \[[CustomFieldFilter](/docs/navixy-graphql-api/business-data-repository/api-reference/custom-fields.md#customfieldfilter)!] | Filter by custom field values. Unlike the ID list filter above, the conditions in this list combine with AND: a geo object must satisfy every one of them. See `CustomFieldFilter` for how a single condition matches. |
***
### GeoObjectOrder
Ordering options for geo objects.
| Field | Type | Description |
| ----------------- | --------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `field` | [GeoObjectOrderField](#geoobjectorderfield) | The standard field to order by. Mutually exclusive with `customFieldCode`. |
| `customFieldCode` | [Code](/docs/navixy-graphql-api/core-api-reference/common.md#code) | The custom field code to order by. Mutually exclusive with `field`. Supported field types: STRING, DECIMAL, INTEGER, DATE, DATETIME, and the reference types DEVICE and single-value REFERENCE, which sort by the title of the entity they point at rather than by the stored id. TEXT, OPTIONS, BOOLEAN and GEOJSON are not supported for sorting, nor is a multi-value REFERENCE or a REFERENCE at an entity with no title. |
| `direction` | [OrderDirection](/docs/navixy-graphql-api/core-api-reference/common.md#orderdirection)! | The direction to order. |
***
### GeoObjectCreateInput
Input for creating a new geo object.
| Field | Type | Description |
| -------------- | --------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------- |
| `workspaceId` | `ID!` | The workspace that will own the geo object. |
| `typeId` | `ID!` | The geo object type ID. |
| `title` | `String!` | The geo object display name. |
| `geojsonData` | [GeoJSON](/docs/navixy-graphql-api/core-api-reference/common.md#geojson)! | The GeoJSON geometry. |
| `customFields` | [CustomFieldsPatchInput](/docs/navixy-graphql-api/business-data-repository/api-reference/custom-fields.md#customfieldspatchinput) | The custom field values. |
***
### GeoObjectUpdateInput
Input for updating an existing geo object.
| Field | Type | Description |
| -------------- | --------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
| `id` | `ID!` | The geo object ID to update. |
| `version` | `Int` | The current version for optimistic locking. If omitted, auto-increments without conflict check. |
| `title` | `String` | The new display name. |
| `geojsonData` | [GeoJSON](/docs/navixy-graphql-api/core-api-reference/common.md#geojson) | The new geometry. |
| `customFields` | [CustomFieldsPatchInput](/docs/navixy-graphql-api/business-data-repository/api-reference/custom-fields.md#customfieldspatchinput) | The custom field changes. |
***
### GeoObjectDeleteInput
Input for deleting a geo object.
| Field | Type | Description |
| --------- | ----- | ----------------------------------------------------------------------------------------------- |
| `id` | `ID!` | The geo object ID to delete. |
| `version` | `Int` | The current version for optimistic locking. If omitted, auto-increments without conflict check. |
***
### GeoObjectTypeCreateInput
Input for creating a geo object type.
| Field | Type | Description |
| ------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |
| `workspaceId` | `ID!` | The workspace that will own the item. |
| `code` | [Code](/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](/docs/navixy-graphql-api/business-data-repository/api-reference/catalogs/catalog-items.md#catalogitemmetainput) | The display properties. |
| `customFieldDefinitions` | \[[CustomFieldDefinitionInput](/docs/navixy-graphql-api/business-data-repository/api-reference/custom-fields.md#customfielddefinitioninput)!] | Operations on custom field definitions for this geo object type. Only `create` is allowed when creating a new catalog item. |
***
### GeoObjectTypeUpdateInput
Input for updating a geo object 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](/docs/navixy-graphql-api/business-data-repository/api-reference/catalogs/catalog-items.md#catalogitemmetainput) | The display properties. |
| `customFieldDefinitions` | \[[CustomFieldDefinitionInput](/docs/navixy-graphql-api/business-data-repository/api-reference/custom-fields.md#customfielddefinitioninput)!] | Operations on custom field definitions belonging to this geo object type. |
***
## Enums
### GeoObjectOrderField
Fields available for ordering geo objects.
| Value | Description |
| ------- | --------------- |
| `TITLE` | Order by title. |
***
### GeoJsonGeometryType
The type of GeoJSON geometry.
| Value | Description |
| --------------------- | ----------------------------------------------- |
| `POINT` | A single geographic point. |
| `MULTI_POINT` | A collection of points. |
| `LINE_STRING` | A sequence of connected line segments. |
| `MULTI_LINE_STRING` | A collection of line strings. |
| `POLYGON` | A closed shape defined by a linear ring. |
| `MULTI_POLYGON` | A collection of polygons. |
| `GEOMETRY_COLLECTION` | A heterogeneous collection of geometry objects. |
***
## Pagination types
### GeoObjectConnection
A paginated list of GeoObject items.
**Implements:** [Connection](/docs/navixy-graphql-api/core-api-reference/common.md#connection)
| Field | Type | Description |
| ---------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------- |
| `edges` | \[[GeoObjectEdge](#geoobjectedge)!]! | A list of edges. |
| `nodes` | \[[GeoObject](#geoobject)!]! | 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. |
***
### GeoObjectEdge
An edge in the GeoObject 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` | [GeoObject](#geoobject)! | The geo object at the end of the edge. |
***
### GeoObjectTypeConnection
A paginated list of GeoObjectType items.
**Implements:** [Connection](/docs/navixy-graphql-api/core-api-reference/common.md#connection)
| Field | Type | Description |
| ---------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------- |
| `edges` | \[[GeoObjectTypeEdge](#geoobjecttypeedge)!]! | A list of edges. |
| `nodes` | \[[GeoObjectType](#geoobjecttype)!]! | 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. |
***
### GeoObjectTypeEdge
An edge in the GeoObjectType 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` | [GeoObjectType](#geoobjecttype)! | The geo object type 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/geo-objects.md?ask=&goal=
```
`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.