For the complete documentation index, see llms.txt. This page is also available as Markdown.

Types

Type definitions for geo objects, including GeoObjectType, GeoObject, geometry types, and associated inputs and enums.

Objects

GeoObjectType

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

The catalog this item belongs to.

organization

The organization that owns this item. Null for system items.

meta

Metadata about this item including description, origin, and display properties.

customFieldDefinitions

Custom field definitions specific to this geo object type, ordered by display order.


GeoPoint

A geographic coordinate point.

Field
Type
Description

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

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.

organization

The organization that owns this geo object.

type

The geo object type classification.

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.

Field
Type
Description

index

Int!

The index of the point in the input array (0-based).

point

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

The created or updated geo object.


GeoObjectTypePayload

The result of a geo object type mutation.

Field
Type
Description

geoObjectType

The created or updated geo object type.


Inputs

GeoPointInput

Input for a geographic coordinate point.

Field
Type
Description

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.

Field
Type
Description

typeIds

[ID!]

Filter by geo object types (OR within field).

titleContains

String

Partial match on title (case-insensitive contains).

customFields

Filter by custom field values.


GeoObjectOrder

Ordering options for geo objects.

Field
Type
Description

field

The standard field to order by. Mutually exclusive with customFieldCode.

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.

direction

The direction to order.


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

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

The new geometry.

customFields

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

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.

meta

The display properties.

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.

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

The display properties.

customFieldDefinitions

Operations on custom field definitions belonging to this geo object type.


Enums

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.


GeoObjectOrderField

Fields available for ordering geo objects.

Value
Description

TITLE

Order by title.


Pagination types

GeoObjectConnection

A paginated list of GeoObject items.

Implements: Connection

Field
Type
Description

edges

A list of edges.

nodes

A list of nodes in the connection (without edge metadata).

pageInfo

Information about the current page.

total

The total count of items matching the filter.


GeoObjectEdge

An edge in the GeoObject connection.

Implements: Edge

Field
Type
Description

cursor

String!

An opaque cursor for this edge.

node

The geo object at the end of the edge.


GeoObjectTypeConnection

A paginated list of GeoObjectType items.

Implements: Connection

Field
Type
Description

edges

A list of edges.

nodes

A list of nodes in the connection (without edge metadata).

pageInfo

Information about the current page.

total

The total count of items matching the filter.


GeoObjectTypeEdge

An edge in the GeoObjectType connection.

Implements: Edge

Field
Type
Description

cursor

String!

An opaque cursor for this edge.

node

The geo object type at the end of the edge.


Last updated

Was this helpful?