Custom fields
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.
Custom field definitions allow extending entities with organization-specific data fields.
Mutations
customFieldDefinitionCreate
Creates a custom field definition.
customFieldDefinitionCreate(
input: CustomFieldDefinitionCreateInput!
): CustomFieldDefinitionPayloadArguments
input
CustomFieldDefinitionCreateInput!
The input fields for creating the definition.
Input types:
CustomFieldDefinitionCreateInput
Input for creating a custom field definition.
organizationId
ID!
The organization ID.
ownerCatalogItemId
ID!
The owner catalog item ID (EntityType or a specific type like AssetType).
targetEntityTypeId
ID!
The target entity type ID.
code
Code!
The machine-readable code.
title
String!
The display name.
description
String
The description.
order
Int
The display order.
FieldParamsInput
Field parameters input. Exactly one field must be provided.
This input type uses @oneOf - exactly one field must be provided.
StringFieldParamsInput
Parameters for STRING field type.
isRequired
Boolean!
Whether a value is required.
minLength
Int
The minimum character length.
maxLength
Int
The maximum character length.
defaultValue
String
The default value.
trim
Boolean
Whether to trim whitespace.
TextFieldParamsInput
Parameters for TEXT field type.
isRequired
Boolean!
Whether a value is required.
maxLength
Int
The maximum character length.
defaultValue
String
The default value.
trim
Boolean
Whether to trim whitespace.
NumberFieldParamsInput
Parameters for NUMBER field type.
isRequired
Boolean!
Whether a value is required.
min
Float
The minimum allowed value.
max
Float
The maximum allowed value.
precision
Int
The decimal precision.
defaultValue
Float
The default value.
BooleanFieldParamsInput
Parameters for BOOLEAN field type.
isRequired
Boolean!
Whether a value is required.
defaultValue
Boolean
The default value.
DateFieldParamsInput
Parameters for DATE field type.
isRequired
Boolean!
Whether a value is required.
defaultValue
Date
The default value.
DateTimeFieldParamsInput
Parameters for DATETIME field type.
isRequired
Boolean!
Whether a value is required.
defaultValue
DateTime
The default value.
GeoJsonFieldParamsInput
Parameters for GEOJSON field type.
isRequired
Boolean!
Whether a value is required.
ScheduleFieldParamsInput
Parameters for SCHEDULE field type.
isRequired
Boolean!
Whether a value is required.
OptionsFieldParamsInput
Parameters for OPTIONS field type.
isRequired
Boolean!
Whether a value is required.
isMulti
Boolean
Whether multiple options can be selected.
defaultValue
Code
The default option code.
FieldOptionInput
Input for an option definition.
code
Code!
The unique code.
label
String!
The display label.
description
String
The description.
isArchived
Boolean
Whether this option is archived.
DeviceFieldParamsInput
Parameters for DEVICE field type.
isRequired
Boolean!
Whether a value is required.
isMulti
Boolean
Whether multiple devices can be selected.
ReferenceFieldParamsInput
Parameters for REFERENCE field type.
isRequired
Boolean!
Whether a value is required.
isMulti
Boolean
Whether multiple references can be selected.
refEntityTypeCode
Code!
The entity type code that can be referenced.
CatalogFieldParamsInput
Parameters for CATALOG field type.
isRequired
Boolean!
Whether a value is required.
isMulti
Boolean
Whether multiple items can be selected.
refCatalogCode
Code!
The catalog code that items can be selected from.
defaultValue
Code
The default item code.
TagFieldParamsInput
Parameters for TAG field type.
isRequired
Boolean!
Whether a value is required.
isMulti
Boolean
Whether multiple tags can be selected.
defaultValue
Code
The default tag code.
Output types:
CustomFieldDefinition (entity)
A custom field definition that specifies the metadata for a custom field.
Note: The fieldType property is immutable after creation. To change the field type, delete the definition and create a new one.
Implements: Node, Versioned, Titled
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.
code
Code!
The machine-readable code, unique per owner and organization.
description
String
A description of the field for UI hints.
order
Int!
The display order within the owner context.
owner
The owner catalog item: EntityType for system fields, or a specific type like AssetType for type-specific fields.
fieldType
The data type determining validation rules and UI rendering. This property is immutable and cannot be changed after creation.
customFieldDefinitionUpdate
Updates a custom field definition. Note: fieldType cannot be changed.
Arguments
input
CustomFieldDefinitionUpdateInput!
The input fields for updating the definition.
Input types:
CustomFieldDefinitionUpdateInput
Input for updating a custom field definition. Note: fieldType cannot be changed.
id
ID!
The definition ID to update.
version
Int!
The current version for optimistic locking.
title
String
The new display name.
description
String
The new description.
order
Int
The new display order.
params
The updated parameters. Only isRequired and type-specific fields can be changed.
FieldParamsInput
Field parameters input. Exactly one field must be provided.
This input type uses @oneOf - exactly one field must be provided.
StringFieldParamsInput
Parameters for STRING field type.
isRequired
Boolean!
Whether a value is required.
minLength
Int
The minimum character length.
maxLength
Int
The maximum character length.
defaultValue
String
The default value.
trim
Boolean
Whether to trim whitespace.
TextFieldParamsInput
Parameters for TEXT field type.
isRequired
Boolean!
Whether a value is required.
maxLength
Int
The maximum character length.
defaultValue
String
The default value.
trim
Boolean
Whether to trim whitespace.
NumberFieldParamsInput
Parameters for NUMBER field type.
isRequired
Boolean!
Whether a value is required.
min
Float
The minimum allowed value.
max
Float
The maximum allowed value.
precision
Int
The decimal precision.
defaultValue
Float
The default value.
BooleanFieldParamsInput
Parameters for BOOLEAN field type.
isRequired
Boolean!
Whether a value is required.
defaultValue
Boolean
The default value.
DateFieldParamsInput
Parameters for DATE field type.
isRequired
Boolean!
Whether a value is required.
defaultValue
Date
The default value.
DateTimeFieldParamsInput
Parameters for DATETIME field type.
isRequired
Boolean!
Whether a value is required.
defaultValue
DateTime
The default value.
GeoJsonFieldParamsInput
Parameters for GEOJSON field type.
isRequired
Boolean!
Whether a value is required.
ScheduleFieldParamsInput
Parameters for SCHEDULE field type.
isRequired
Boolean!
Whether a value is required.
OptionsFieldParamsInput
Parameters for OPTIONS field type.
isRequired
Boolean!
Whether a value is required.
isMulti
Boolean
Whether multiple options can be selected.
defaultValue
Code
The default option code.
FieldOptionInput
Input for an option definition.
code
Code!
The unique code.
label
String!
The display label.
description
String
The description.
isArchived
Boolean
Whether this option is archived.
DeviceFieldParamsInput
Parameters for DEVICE field type.
isRequired
Boolean!
Whether a value is required.
isMulti
Boolean
Whether multiple devices can be selected.
ReferenceFieldParamsInput
Parameters for REFERENCE field type.
isRequired
Boolean!
Whether a value is required.
isMulti
Boolean
Whether multiple references can be selected.
refEntityTypeCode
Code!
The entity type code that can be referenced.
CatalogFieldParamsInput
Parameters for CATALOG field type.
isRequired
Boolean!
Whether a value is required.
isMulti
Boolean
Whether multiple items can be selected.
refCatalogCode
Code!
The catalog code that items can be selected from.
defaultValue
Code
The default item code.
TagFieldParamsInput
Parameters for TAG field type.
isRequired
Boolean!
Whether a value is required.
isMulti
Boolean
Whether multiple tags can be selected.
defaultValue
Code
The default tag code.
Output types:
CustomFieldDefinition (entity)
A custom field definition that specifies the metadata for a custom field.
Note: The fieldType property is immutable after creation. To change the field type, delete the definition and create a new one.
Implements: Node, Versioned, Titled
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.
code
Code!
The machine-readable code, unique per owner and organization.
description
String
A description of the field for UI hints.
order
Int!
The display order within the owner context.
owner
The owner catalog item: EntityType for system fields, or a specific type like AssetType for type-specific fields.
fieldType
The data type determining validation rules and UI rendering. This property is immutable and cannot be changed after creation.
customFieldDefinitionDelete
Deletes a custom field definition.
Arguments
input
CustomFieldDefinitionDeleteInput!
The input fields for deleting the definition.
Input types:
CustomFieldDefinitionDeleteInput
Input for deleting a custom field definition.
id
ID!
The definition ID to delete.
version
Int!
The current version for optimistic locking.
Output types:
DeletePayload
The result of a delete mutation.
deletedId
ID!
The ID of the deleted entity.
Objects
CustomFieldDefinition
A custom field definition that specifies the metadata for a custom field.
The fieldType property is immutable after creation. To change the field type, delete the definition and create a new one.
Implements: Node, Versioned, Titled
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.
code
Code!
The machine-readable code, unique per owner and organization.
description
String
A description of the field for UI hints.
order
Int!
The display order within the owner context.
owner
The owner catalog item: EntityType for system fields, or a specific type like AssetType for type-specific fields.
fieldType
The data type determining validation rules and UI rendering. This property is immutable and cannot be changed after creation.
FieldParamsString
Parameters for STRING field type.
Implements: FieldParams
isRequired
Boolean!
Whether a value is required for this field.
minLength
Int
The minimum character length.
maxLength
Int
The maximum character length.
defaultValue
String
The default value.
trim
Boolean!
Whether to trim leading and trailing whitespace.
FieldParamsText
Parameters for TEXT field type.
Implements: FieldParams
isRequired
Boolean!
Whether a value is required for this field.
maxLength
Int
The maximum character length.
defaultValue
String
The default value.
trim
Boolean!
Whether to trim leading and trailing whitespace.
FieldParamsNumber
Parameters for NUMBER field type.
Implements: FieldParams
isRequired
Boolean!
Whether a value is required for this field.
min
Float
The minimum allowed value.
max
Float
The maximum allowed value.
precision
Int
The decimal precision.
defaultValue
Float
The default value.
FieldParamsBoolean
Parameters for BOOLEAN field type.
Implements: FieldParams
isRequired
Boolean!
Whether a value is required for this field.
defaultValue
Boolean
The default value.
FieldParamsDate
Parameters for DATE field type.
Implements: FieldParams
isRequired
Boolean!
Whether a value is required for this field.
defaultValue
Date
The default value.
FieldParamsDatetime
Parameters for DATETIME field type.
Implements: FieldParams
isRequired
Boolean!
Whether a value is required for this field.
defaultValue
DateTime
The default value.
FieldParamsGeojson
Parameters for GEOJSON field type.
Implements: FieldParams
isRequired
Boolean!
Whether a value is required for this field.
FieldParamsSchedule
Parameters for SCHEDULE field type.
Implements: FieldParams
isRequired
Boolean!
Whether a value is required for this field.
FieldParamsOptions
Parameters for OPTIONS field type.
Implements: FieldParams, MultiValue
isRequired
Boolean!
Whether a value is required for this field.
isMulti
Boolean!
Whether multiple values can be selected for this field.
defaultValue
Code
The default option code.
FieldOption
A single option in an OPTIONS field.
code
Code!
The unique code for this option within the field.
label
String!
The display label.
description
String
A description of the option.
isArchived
Boolean!
Whether this option is archived and should not be shown for new selections.
FieldParamsDevice
Parameters for DEVICE field type.
Implements: FieldParams, MultiValue
isRequired
Boolean!
Whether a value is required for this field.
isMulti
Boolean!
Whether multiple values can be selected for this field.
FieldParamsReference
Parameters for REFERENCE field type.
Implements: FieldParams, MultiValue
isRequired
Boolean!
Whether a value is required for this field.
isMulti
Boolean!
Whether multiple values can be selected for this field.
refEntityTypeCode
Code!
The entity type code that can be referenced.
FieldParamsCatalog
Parameters for CATALOG field type.
Implements: FieldParams, MultiValue
isRequired
Boolean!
Whether a value is required for this field.
isMulti
Boolean!
Whether multiple values can be selected for this field.
refCatalogCode
Code!
The catalog code that items can be selected from.
defaultValue
Code
The default item code.
FieldParamsTag
Parameters for TAG field type.
Implements: FieldParams, MultiValue
isRequired
Boolean!
Whether a value is required for this field.
isMulti
Boolean!
Whether multiple values can be selected for this field.
defaultValue
Code
The default tag code.
CustomFieldDefinitionPayload
The result of a custom field definition mutation.
Inputs
CustomFieldFilter
A filter condition for a custom field value.
code
Code!
The custom field code to filter by.
value
JSON
The value to compare against. Null for IS_NULL and IS_NOT_NULL operators.
CustomFieldsPatchInput
Input for updating custom field values using a patch model.
set
JSON
Fields to set or update as a key-value map.
unset
[Code!]
Field codes to remove.
CustomFieldDefinitionCreateInput
Input for creating a custom field definition.
organizationId
ID!
The organization ID.
ownerCatalogItemId
ID!
The owner catalog item ID (EntityType or a specific type like AssetType).
targetEntityTypeId
ID!
The target entity type ID.
code
Code!
The machine-readable code.
title
String!
The display name.
description
String
The description.
order
Int
The display order.
CustomFieldDefinitionUpdateInput
Input for updating a custom field definition. Note: fieldType cannot be changed.
id
ID!
The definition ID to update.
version
Int!
The current version for optimistic locking.
title
String
The new display name.
description
String
The new description.
order
Int
The new display order.
params
The updated parameters. Only isRequired and type-specific fields can be changed.
CustomFieldDefinitionDeleteInput
Input for deleting a custom field definition.
id
ID!
The definition ID to delete.
version
Int!
The current version for optimistic locking.
FieldParamsInput
Field parameters input. Exactly one field must be provided.
This input type uses @oneOf - exactly one field must be provided.
StringFieldParamsInput
Parameters for STRING field type.
isRequired
Boolean!
Whether a value is required.
minLength
Int
The minimum character length.
maxLength
Int
The maximum character length.
defaultValue
String
The default value.
trim
Boolean
Whether to trim whitespace.
TextFieldParamsInput
Parameters for TEXT field type.
isRequired
Boolean!
Whether a value is required.
maxLength
Int
The maximum character length.
defaultValue
String
The default value.
trim
Boolean
Whether to trim whitespace.
NumberFieldParamsInput
Parameters for NUMBER field type.
isRequired
Boolean!
Whether a value is required.
min
Float
The minimum allowed value.
max
Float
The maximum allowed value.
precision
Int
The decimal precision.
defaultValue
Float
The default value.
BooleanFieldParamsInput
Parameters for BOOLEAN field type.
isRequired
Boolean!
Whether a value is required.
defaultValue
Boolean
The default value.
DateFieldParamsInput
Parameters for DATE field type.
isRequired
Boolean!
Whether a value is required.
defaultValue
Date
The default value.
DateTimeFieldParamsInput
Parameters for DATETIME field type.
isRequired
Boolean!
Whether a value is required.
defaultValue
DateTime
The default value.
GeoJsonFieldParamsInput
Parameters for GEOJSON field type.
isRequired
Boolean!
Whether a value is required.
ScheduleFieldParamsInput
Parameters for SCHEDULE field type.
isRequired
Boolean!
Whether a value is required.
OptionsFieldParamsInput
Parameters for OPTIONS field type.
isRequired
Boolean!
Whether a value is required.
isMulti
Boolean
Whether multiple options can be selected.
defaultValue
Code
The default option code.
FieldOptionInput
Input for an option definition.
code
Code!
The unique code.
label
String!
The display label.
description
String
The description.
isArchived
Boolean
Whether this option is archived.
DeviceFieldParamsInput
Parameters for DEVICE field type.
isRequired
Boolean!
Whether a value is required.
isMulti
Boolean
Whether multiple devices can be selected.
ReferenceFieldParamsInput
Parameters for REFERENCE field type.
isRequired
Boolean!
Whether a value is required.
isMulti
Boolean
Whether multiple references can be selected.
refEntityTypeCode
Code!
The entity type code that can be referenced.
CatalogFieldParamsInput
Parameters for CATALOG field type.
isRequired
Boolean!
Whether a value is required.
isMulti
Boolean
Whether multiple items can be selected.
refCatalogCode
Code!
The catalog code that items can be selected from.
defaultValue
Code
The default item code.
TagFieldParamsInput
Parameters for TAG field type.
isRequired
Boolean!
Whether a value is required.
isMulti
Boolean
Whether multiple tags can be selected.
defaultValue
Code
The default tag code.
Enums
FieldType
The data type of a custom field, determining validation rules and UI rendering.
STRING
Single-line text input. Maximum 255 characters.
TEXT
Multi-line text input. Maximum 65,535 characters.
NUMBER
Numeric value, supporting both integers and decimals.
BOOLEAN
Boolean true/false value.
DATE
Calendar date without time component (YYYY-MM-DD).
DATETIME
Date and time with timezone information.
GEOJSON
GeoJSON geometry object (Point, Polygon, LineString, etc.).
SCHEDULE
Schedule or calendar data with time intervals and recurrence rules.
OPTIONS
Selection from a predefined list of options.
DEVICE
Reference to a Device entity.
REFERENCE
Reference to any entity by its type and ID.
CATALOG
Reference to a catalog item.
TAG
Reference to a Tag entity.
FieldOperator
Comparison operators for filtering by custom field values.
EQ
Value equals the specified value.
NE
Value does not equal the specified value.
GT
Value is greater than the specified value.
GTE
Value is greater than or equal to the specified value.
LT
Value is less than the specified value.
LTE
Value is less than or equal to the specified value.
CONTAINS
String value contains the specified substring (case-insensitive).
IN
Value is one of the specified values in the array.
IS_NULL
Value is null.
IS_NOT_NULL
Value is not null.
Interfaces
FieldParams
The base interface for field parameters.
isRequired
Boolean!
Whether a value is required for this field.
Last updated
Was this helpful?