System catalogs

circle-exclamation

System-defined catalog items that cannot be modified by users.

Objects

Module

A system module that groups related functionality and permission scopes. Examples: repo (core), fleet_management (FSM), iot (devices), reports, billing.

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.


EntityType

A definition of an entity type in the system.

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.

uuidDiscriminator

String!

The 4-character code embedded in UUIDs for entities of this type.

isCustomizable

Boolean!

Whether entities of this type support custom fields.

customFieldDefinitions

Custom field definitions for entities of this type, ordered by display order.


Country

A country reference data item.

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.

alpha2Code

CountryCode!

The ISO 3166arrow-up-right-1 alpha-2 country code.


Last updated

Was this helpful?