Types
Type definitions for geo objects, including GeoObjectType, GeoObject, geometry types, and associated inputs and enums.
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.
Objects
GeoObjectType
A classification type for geographic objects.
Implements: CatalogItem, Node, Versioned, Titled
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.
customFieldDefinitions
Custom field definitions specific to this geo object type, ordered by display order.
GeoPoint
A geographic coordinate point.
lat
Latitude!
The latitude coordinate in decimal degrees.
lng
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, Titled, Customizable, Versioned
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.
geojsonData
GeoJSON!
The geographic shape of this object as GeoJSON geometry.
customFields
JSON!
Custom field values as a key-value map. Keys are CustomFieldDefinition codes. System-reserved codes (geojson_data, schedule_data) are excluded from this map and exposed through dedicated typed fields on the entity instead.
containsPoints
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.
index
Int!
The index of the point in the input array (0-based).
isContained
Boolean!
Whether the point is inside the geometry.
GeoObjectPayload
The result of a geo object mutation.
GeoObjectTypePayload
The result of a geo object type mutation.
Inputs
GeoPointInput
Input for a geographic coordinate point.
lat
Latitude!
The latitude coordinate (-90 to 90 degrees).
lng
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.
typeIds
[ID!]
Filter by geo object types (OR within field).
titleContains
String
Partial match on title (case-insensitive contains).
GeoObjectOrder
Ordering options for geo objects.
customFieldCode
Code
The custom field code to order by. Mutually exclusive with field. Supported field types: STRING, TEXT, DECIMAL, INTEGER, DATE, DATETIME. OPTIONS, TAG, BOOLEAN, GEOJSON, SCHEDULE, DEVICE, REFERENCE, CATALOG are not supported for sorting.
GeoObjectCreateInput
Input for creating a new geo object.
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.
GeoObjectUpdateInput
Input for updating an existing geo object.
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
The new geometry.
GeoObjectDeleteInput
Input for deleting a geo object.
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.
organizationId
ID!
The organization that will own the item.
code
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.
customFieldDefinitions
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.
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.
customFieldDefinitions
Operations on custom field definitions belonging to this geo object type.
Enums
GeoJsonGeometryType
The type of GeoJSON geometry.
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.
GeoObjectOrderField
Fields available for ordering geo objects.
TITLE
Order by title.
Pagination types
GeoObjectConnection
A paginated list of GeoObject items.
Implements: Connection
GeoObjectEdge
An edge in the GeoObject connection.
Implements: Edge
cursor
String!
An opaque cursor for this edge.
GeoObjectTypeConnection
A paginated list of GeoObjectType items.
Implements: Connection
GeoObjectTypeEdge
An edge in the GeoObjectType connection.
Implements: Edge
cursor
String!
An opaque cursor for this edge.
Last updated
Was this helpful?