Interfaces

Interfaces define common fields shared by multiple object types. When a type implements an interface, it guarantees those fields are present.

Node

An object with a globally unique identifier.

Field	Type	Description
id	ID!	A globally unique identifier. This ID is opaque and should not be parsed by clients.

Implemented by: InventoryItem, Actor, CatalogItem, Module, EntityType, DeviceVendor, DeviceModel, DeviceType, DeviceStatus, DeviceRelationType, AssetType, AssetGroupType, GeoObjectType, ScheduleType, Role, PermissionScope, Tag, Country, UserCatalogItem, Catalog, Organization, SystemActor, User, Member, Integration, ActorRole, RolePermission, UserScope, Device, DeviceIdentifier, DeviceRelation, DeviceInventoryRelation, Asset, AssetGroup, AssetGroupItem, Inventory, GeoObject, Schedule, CustomFieldDefinition, AuditEvent

Titled

An object with a human-readable display name.

Field	Type	Description
title	String!	The human-readable display name.

Implemented by: Actor, CatalogItem, Module, EntityType, DeviceVendor, DeviceModel, DeviceType, DeviceStatus, DeviceRelationType, AssetType, AssetGroupType, GeoObjectType, ScheduleType, Role, PermissionScope, Tag, Country, UserCatalogItem, Catalog, Organization, SystemActor, User, Integration, Device, Asset, AssetGroup, Inventory, GeoObject, Schedule, CustomFieldDefinition

Customizable

An object that supports custom field values.

Field	Type	Description
customFields	JSON!	Custom field values as a key-value map. Keys are CustomFieldDefinition codes.

Implemented by: Member, Device, Asset, GeoObject, Schedule

Versioned

An object that supports optimistic locking for concurrency control.

Field	Type	Description
version	Int!	The version number for optimistic locking. Incremented on each update. Must be provided in update/delete mutations to prevent lost updates.

Implemented by: CatalogItem, Module, EntityType, DeviceVendor, DeviceModel, DeviceType, DeviceStatus, DeviceRelationType, AssetType, AssetGroupType, GeoObjectType, ScheduleType, Role, PermissionScope, Tag, Country, UserCatalogItem, Catalog, Organization, User, Member, Integration, Device, Asset, AssetGroup, Inventory, GeoObject, Schedule, CustomFieldDefinition

MultiValue

An interface for field parameters that support selecting multiple values.

Field	Type	Description
isMulti	Boolean!	Whether multiple values can be selected for this field.

Implemented by: FieldParamsOptions, FieldParamsDevice, FieldParamsReference, FieldParamsCatalog, FieldParamsTag

InventoryItem

An object that can be assigned to an inventory.

Field	Type	Description
id	ID!	A globally unique identifier.
inventory	Inventory	The inventory this item is currently assigned to.

Implemented by: Device

Edge

An edge in a paginated connection.

Field	Type	Description
cursor	String!	An opaque cursor for this edge, used for pagination.

Implemented by: CatalogItemEdge, UserCatalogItemEdge, OrganizationEdge, UserEdge, MemberEdge, IntegrationEdge, DeviceEdge, AssetEdge, AssetGroupEdge, AssetGroupItemEdge, InventoryEdge, GeoObjectEdge, ScheduleEdge, AuditEventEdge, DeviceInventoryRelationEdge, CatalogEdge, DeviceTypeEdge, DeviceStatusEdge, DeviceModelEdge, AssetTypeEdge, AssetGroupTypeEdge, GeoObjectTypeEdge, ScheduleTypeEdge, RoleEdge, TagEdge, ActorRoleEdge, RolePermissionEdge, UserScopeEdge

Connection

A paginated connection following the Relay Cursor Connections specification.

Field	Type	Description
pageInfo	PageInfo!	Information about the current page.
total	CountInfo	The total count of items matching the filter.

Implemented by: CatalogItemConnection, UserCatalogItemConnection, OrganizationConnection, UserConnection, MemberConnection, IntegrationConnection, DeviceConnection, AssetConnection, AssetGroupConnection, AssetGroupItemConnection, InventoryConnection, GeoObjectConnection, ScheduleConnection, AuditEventConnection, DeviceInventoryRelationConnection, CatalogConnection, DeviceTypeConnection, DeviceStatusConnection, DeviceModelConnection, AssetTypeConnection, AssetGroupTypeConnection, GeoObjectTypeConnection, ScheduleTypeConnection, RoleConnection, TagConnection, ActorRoleConnection, RolePermissionConnection, UserScopeConnection

Actor

An entity that can perform actions and have permissions assigned.

Field	Type	Description
id	ID!	A globally unique identifier.
title	String!	The display name of the actor.

Implemented by: SystemActor, User, Integration

CatalogItem

A dictionary item that provides reference data for the system.

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.

Implemented by: Module, EntityType, DeviceVendor, DeviceModel, DeviceType, DeviceStatus, DeviceRelationType, AssetType, AssetGroupType, GeoObjectType, ScheduleType, Role, PermissionScope, Tag, Country, UserCatalogItem, Catalog

HierarchicalCatalogItem

A catalog item that supports parent-child hierarchy.

Field	Type	Description
parent	CatalogItem	The parent item in the hierarchy. Null for root items.

Implemented by: UserCatalogItem

FieldParams

The base interface for field parameters.

Field	Type	Description
isRequired	Boolean!	Whether a value is required for this field.

Implemented by: FieldParamsString, FieldParamsText, FieldParamsNumber, FieldParamsBoolean, FieldParamsDate, FieldParamsDatetime, FieldParamsGeojson, FieldParamsSchedule, FieldParamsOptions, FieldParamsDevice, FieldParamsReference, FieldParamsCatalog, FieldParamsTag