Mutations

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

geoObjectCreate

Creates a new geo object.

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
organizationId	ID!	The organization that will own the geo object.
typeId	ID!	The geo object type ID.
title	String!	The geo object display name.
geojsonData	GeoJSON!	The GeoJSON geometry.
customFields	CustomFieldsPatchInput	The custom field values.

CustomFieldsPatchInput

Input for updating custom field values using a patch model.

Field	Type	Description
set	JSON	Fields to set or update as a key-value map.
unset	[Code!]	Field codes to remove.

Output types:

GeoObjectPayload

The result of a geo object mutation.

Field	Type	Description
geoObject	GeoObject!	The created or updated geo object.

GeoObject (entity)

A geographic object such as a geofence, point of interest, or route.

Implements: Node, Titled, Customizable, 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. Must be provided in update/delete mutations to prevent lost updates.
title	String!	The human-readable display name.
organization	Organization!	The organization that owns this geo object.
type	GeoObjectType!	The geo object type classification.
geojsonData	GeoJSON!	The geographic shape of this object as GeoJSON geometry. This is an alias for the geojson_data custom field.
customFields	JSON!	Custom field values as a key-value map. Keys are CustomFieldDefinition codes.
containsPoints	[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.

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.
title	String	The new display name.
geojsonData	GeoJSON	The new geometry.
customFields	CustomFieldsPatchInput	The custom field changes.

CustomFieldsPatchInput

Input for updating custom field values using a patch model.

Field	Type	Description
set	JSON	Fields to set or update as a key-value map.
unset	[Code!]	Field codes to remove.

Output types:

GeoObjectPayload

The result of a geo object mutation.

Field	Type	Description
geoObject	GeoObject!	The created or updated geo object.

GeoObject (entity)

A geographic object such as a geofence, point of interest, or route.

Implements: Node, Titled, Customizable, 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. Must be provided in update/delete mutations to prevent lost updates.
title	String!	The human-readable display name.
organization	Organization!	The organization that owns this geo object.
type	GeoObjectType!	The geo object type classification.
geojsonData	GeoJSON!	The geographic shape of this object as GeoJSON geometry. This is an alias for the geojson_data custom field.
customFields	JSON!	Custom field values as a key-value map. Keys are CustomFieldDefinition codes.
containsPoints	[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.

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.

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.

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
organizationId	ID!	The organization that will own the item.
code	Code!	The machine-readable code.
title	String!	The display name.
order	Int	The display order.
meta	CatalogItemMetaInput	The display properties.

CatalogItemMetaInput

Display properties for catalog items.

Field	Type	Description
description	String	The description.
hidden	Boolean	Whether the item is hidden from regular UI lists.
textColor	HexColorCode	The text color for UI display.
backgroundColor	HexColorCode	The background color for UI display.
icon	String	A relative URL to the icon.

Output types:

GeoObjectTypePayload

The result of a geo object type mutation.

Field	Type	Description
geoObjectType	GeoObjectType!	The created or updated geo object type.

GeoObjectType (entity)

A classification type for geographic objects.

Implements: CatalogItem, Node, Versioned, Titled

Field	Type	Description
id	ID!	A globally unique identifier.
version	Int!	The version number for optimistic locking.
title	String!	The human-readable display name. Can be localized.
code	Code!	A machine-readable code, unique within the catalog scope.
order	Int!	The display order within the same level or category.
catalog	Catalog!	The catalog this item belongs to.
organization	Organization	The organization that owns this item. Null for system items.
meta	CatalogItemMeta!	Metadata about this item including description, origin, and display properties.
customFieldDefinitions	[CustomFieldDefinition!]!	Custom field definitions specific to this geo object type, ordered by display order.

---

geoObjectTypeUpdate

Updates a geo object type.

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.
title	String	The new display name.
order	Int	The new display order.
meta	CatalogItemMetaInput	The display properties.

CatalogItemMetaInput

Display properties for catalog items.

Field	Type	Description
description	String	The description.
hidden	Boolean	Whether the item is hidden from regular UI lists.
textColor	HexColorCode	The text color for UI display.
backgroundColor	HexColorCode	The background color for UI display.
icon	String	A relative URL to the icon.

Output types:

GeoObjectTypePayload

The result of a geo object type mutation.

Field	Type	Description
geoObjectType	GeoObjectType!	The created or updated geo object type.

GeoObjectType (entity)

A classification type for geographic objects.

Implements: CatalogItem, Node, Versioned, Titled

Field	Type	Description
id	ID!	A globally unique identifier.
version	Int!	The version number for optimistic locking.
title	String!	The human-readable display name. Can be localized.
code	Code!	A machine-readable code, unique within the catalog scope.
order	Int!	The display order within the same level or category.
catalog	Catalog!	The catalog this item belongs to.
organization	Organization	The organization that owns this item. Null for system items.
meta	CatalogItemMeta!	Metadata about this item including description, origin, and display properties.
customFieldDefinitions	[CustomFieldDefinition!]!	Custom field definitions specific to this geo object type, ordered by display order.

---

geoObjectTypeDelete

Deletes a geo object type.

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.

Output types:

DeletePayload

The result of a delete mutation.

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

---