# Mutations
{% hint style="warning" %}
**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.
{% endhint %}
### assetCreate
Creates a new asset.
```graphql
assetCreate(
input: AssetCreateInput!
): AssetPayload
```
**Arguments**
| Name | Type | Description |
| ------- | ------------------- | ---------------------------------------- |
| `input` | `AssetCreateInput!` | The input fields for creating the asset. |
**Input types:**
AssetCreateInput
Input for creating a new asset.
| Field | Type | Description |
| ---------------- | --------------------------------------------------------------------------------------------------------------------- | ----------------------------------------- |
| `organizationId` | `ID!` | The organization that will own the asset. |
| `typeId` | `ID!` | The asset type ID. |
| `title` | `String!` | The asset display name. |
| `customFields` | [CustomFieldsPatchInput](https://www.navixy.com/docs/navixy-repository-api/custom-fields#type-customfieldspatchinput) | The custom field values. |
CustomFieldsPatchInput
Input for updating custom field values using a patch model.
| Field | Type | Description |
| -------------- | --------- | ---------------------------------------------------------------------------------- |
| `set` | `JSON` | Fields to set or update as a key-value map. |
| `unset` | `[Code!]` | Field codes to remove. |
| `setPrimary` | `[Code!]` | Field codes to mark as primary (replaces previous primary of the same field type). |
| `unsetPrimary` | `[Code!]` | Field codes to unmark as primary. |
**Output types:**
AssetPayload
The result of an asset mutation.
| Field | Type | Description |
| ------- | ----------------------------------------------------------------------------------------------- | ----------------------------- |
| `asset` | [Asset](https://www.navixy.com/docs/navixy-repository-api/core-api-reference/types#type-asset)! | The created or updated asset. |
Asset (entity)
A physical or logical asset being tracked.
**Implements:** [Node](https://www.navixy.com/docs/navixy-repository-api/common#type-node), [Titled](https://www.navixy.com/docs/navixy-repository-api/common#type-titled), [Customizable](https://www.navixy.com/docs/navixy-repository-api/common#type-customizable), [Versioned](https://www.navixy.com/docs/navixy-repository-api/common#type-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` | [Organization](https://www.navixy.com/docs/navixy-repository-api/organizations#type-organization)! | The organization that owns this asset. |
| `type` | [AssetType](https://www.navixy.com/docs/navixy-repository-api/core-api-reference/types#type-assettype)! | The asset type classification. |
| `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. |
| `primaryDevice` | [Device](https://www.navixy.com/docs/navixy-repository-api/devices/types#type-device) | The primary device (isPrimary=true among DEVICE-type custom fields). |
| `devices` | \[[Device](https://www.navixy.com/docs/navixy-repository-api/devices/types#type-device)!]! | All devices linked via DEVICE-type custom fields. |
| `groups` | [AssetGroupConnection](https://www.navixy.com/docs/navixy-repository-api/core-api-reference/groups/types#type-assetgroupconnection)! | The groups this asset belongs to. |
***
### assetUpdate
Updates an existing asset.
```graphql
assetUpdate(
input: AssetUpdateInput!
): AssetPayload
```
**Arguments**
| Name | Type | Description |
| ------- | ------------------- | ---------------------------------------- |
| `input` | `AssetUpdateInput!` | The input fields for updating the asset. |
**Input types:**
AssetUpdateInput
Input for updating an existing asset.
| Field | Type | Description |
| -------------- | --------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
| `id` | `ID!` | The asset ID to update. |
| `version` | `Int` | The current version for optimistic locking. If omitted, auto-increments without conflict check. |
| `title` | `String` | The new display name. |
| `customFields` | [CustomFieldsPatchInput](https://www.navixy.com/docs/navixy-repository-api/custom-fields#type-customfieldspatchinput) | The custom field changes. |
CustomFieldsPatchInput
Input for updating custom field values using a patch model.
| Field | Type | Description |
| -------------- | --------- | ---------------------------------------------------------------------------------- |
| `set` | `JSON` | Fields to set or update as a key-value map. |
| `unset` | `[Code!]` | Field codes to remove. |
| `setPrimary` | `[Code!]` | Field codes to mark as primary (replaces previous primary of the same field type). |
| `unsetPrimary` | `[Code!]` | Field codes to unmark as primary. |
**Output types:**
AssetPayload
The result of an asset mutation.
| Field | Type | Description |
| ------- | ----------------------------------------------------------------------------------------------- | ----------------------------- |
| `asset` | [Asset](https://www.navixy.com/docs/navixy-repository-api/core-api-reference/types#type-asset)! | The created or updated asset. |
Asset (entity)
A physical or logical asset being tracked.
**Implements:** [Node](https://www.navixy.com/docs/navixy-repository-api/common#type-node), [Titled](https://www.navixy.com/docs/navixy-repository-api/common#type-titled), [Customizable](https://www.navixy.com/docs/navixy-repository-api/common#type-customizable), [Versioned](https://www.navixy.com/docs/navixy-repository-api/common#type-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` | [Organization](https://www.navixy.com/docs/navixy-repository-api/organizations#type-organization)! | The organization that owns this asset. |
| `type` | [AssetType](https://www.navixy.com/docs/navixy-repository-api/core-api-reference/types#type-assettype)! | The asset type classification. |
| `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. |
| `primaryDevice` | [Device](https://www.navixy.com/docs/navixy-repository-api/devices/types#type-device) | The primary device (isPrimary=true among DEVICE-type custom fields). |
| `devices` | \[[Device](https://www.navixy.com/docs/navixy-repository-api/devices/types#type-device)!]! | All devices linked via DEVICE-type custom fields. |
| `groups` | [AssetGroupConnection](https://www.navixy.com/docs/navixy-repository-api/core-api-reference/groups/types#type-assetgroupconnection)! | The groups this asset belongs to. |
***
### assetDelete
Deletes an asset.
```graphql
assetDelete(
input: AssetDeleteInput!
): DeletePayload
```
**Arguments**
| Name | Type | Description |
| ------- | ------------------- | ---------------------------------------- |
| `input` | `AssetDeleteInput!` | The input fields for deleting the asset. |
**Input types:**
AssetDeleteInput
Input for deleting an asset.
| Field | Type | Description |
| --------- | ----- | ----------------------------------------------------------------------------------------------- |
| `id` | `ID!` | The asset ID to delete. |
| `version` | `Int` | The current version for optimistic locking. If omitted, auto-increments without conflict check. |
**Output types:**
DeletePayload
The result of a delete mutation.
| Field | Type | Description |
| ----------- | ----- | ----------------------------- |
| `deletedId` | `ID!` | The ID of the deleted entity. |
***
### assetTypeCreate
Creates a new asset type.
```graphql
assetTypeCreate(
input: AssetTypeCreateInput!
): AssetTypePayload
```
**Arguments**
| Name | Type | Description |
| ------- | ----------------------- | --------------------------------------------- |
| `input` | `AssetTypeCreateInput!` | The input fields for creating the asset type. |
**Input types:**
AssetTypeCreateInput
Input for creating an asset 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` | [CatalogItemMetaInput](https://www.navixy.com/docs/navixy-repository-api/catalogs/catalog-items#type-catalogitemmetainput) | The display properties. |
| `customFieldDefinitions` | \[[CustomFieldDefinitionInput](https://www.navixy.com/docs/navixy-repository-api/custom-fields#type-customfielddefinitioninput)!] | Operations on custom field definitions for this asset type. Only `create` is allowed when creating a new catalog item. |
CatalogItemMetaInput
Display properties for catalog items.
| Field | Type | Description |
| ------------- | --------- | ------------------------------------------------- |
| `description` | `String` | The description. |
| `hidden` | `Boolean` | Whether the item is hidden from regular UI lists. |
CustomFieldDefinitionInput
A single operation on a custom field definition within the parent catalog item. Exactly one action must be provided.
*This input type uses `@oneOf` - exactly one field must be provided.*
| Field | Type | Description |
| --------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------- |
| `create` | [CustomFieldDefinitionCreateData](https://www.navixy.com/docs/navixy-repository-api/custom-fields#type-customfielddefinitioncreatedata) | Create a new custom field definition. |
| `update` | [CustomFieldDefinitionUpdateData](https://www.navixy.com/docs/navixy-repository-api/custom-fields#type-customfielddefinitionupdatedata) | Update an existing custom field definition. |
| `delete` | [CustomFieldDefinitionDeleteData](https://www.navixy.com/docs/navixy-repository-api/custom-fields#type-customfielddefinitiondeletedata) | Delete a custom field definition. |
| `archive` | [CustomFieldDefinitionArchiveData](https://www.navixy.com/docs/navixy-repository-api/custom-fields#type-customfielddefinitionarchivedata) | Archive a custom field definition (non-destructive deactivation). |
| `restore` | [CustomFieldDefinitionRestoreData](https://www.navixy.com/docs/navixy-repository-api/custom-fields#type-customfielddefinitionrestoredata) | Restore a previously archived custom field definition. |
CustomFieldDefinitionCreateData
Data for creating a custom field definition within its parent catalog item.
| Field | Type | Description |
| ------------- | ---------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- |
| `code` | `Code` | The machine-readable code. Auto-generated from title if omitted. Codes `geojson_data` and `schedule_data` are reserved by the platform. |
| `title` | `String!` | The display name. |
| `description` | `String` | The description. |
| `fieldType` | [FieldType](https://www.navixy.com/docs/navixy-repository-api/custom-fields#type-fieldtype)! | The data type. Immutable after creation. |
| `order` | `Int` | The display order. Auto-calculated as last position if omitted. |
| `params` | [FieldParamsInput](https://www.navixy.com/docs/navixy-repository-api/custom-fields#type-fieldparamsinput)! | The type-specific parameters. Exactly one variant must be provided. |
FieldParamsInput
Field parameters input. Exactly one field must be provided.
*This input type uses `@oneOf` - exactly one field must be provided.*
| Field | Type | Description |
| ----------- | --------------------------------------------------------------------------------------------------------------------------- | ------------------------------------ |
| `string` | [StringFieldParamsInput](https://www.navixy.com/docs/navixy-repository-api/custom-fields#type-stringfieldparamsinput) | Parameters for STRING field type. |
| `text` | [TextFieldParamsInput](https://www.navixy.com/docs/navixy-repository-api/custom-fields#type-textfieldparamsinput) | Parameters for TEXT field type. |
| `number` | [NumberFieldParamsInput](https://www.navixy.com/docs/navixy-repository-api/custom-fields#type-numberfieldparamsinput) | Parameters for NUMBER field type. |
| `boolean` | [BooleanFieldParamsInput](https://www.navixy.com/docs/navixy-repository-api/custom-fields#type-booleanfieldparamsinput) | Parameters for BOOLEAN field type. |
| `date` | [DateFieldParamsInput](https://www.navixy.com/docs/navixy-repository-api/custom-fields#type-datefieldparamsinput) | Parameters for DATE field type. |
| `datetime` | [DateTimeFieldParamsInput](https://www.navixy.com/docs/navixy-repository-api/custom-fields#type-datetimefieldparamsinput) | Parameters for DATETIME field type. |
| `geojson` | [GeoJsonFieldParamsInput](https://www.navixy.com/docs/navixy-repository-api/custom-fields#type-geojsonfieldparamsinput) | Parameters for GEOJSON field type. |
| `schedule` | [ScheduleFieldParamsInput](https://www.navixy.com/docs/navixy-repository-api/custom-fields#type-schedulefieldparamsinput) | Parameters for SCHEDULE field type. |
| `options` | [OptionsFieldParamsInput](https://www.navixy.com/docs/navixy-repository-api/custom-fields#type-optionsfieldparamsinput) | Parameters for OPTIONS field type. |
| `device` | [DeviceFieldParamsInput](https://www.navixy.com/docs/navixy-repository-api/custom-fields#type-devicefieldparamsinput) | Parameters for DEVICE field type. |
| `reference` | [ReferenceFieldParamsInput](https://www.navixy.com/docs/navixy-repository-api/custom-fields#type-referencefieldparamsinput) | Parameters for REFERENCE field type. |
| `catalog` | [CatalogFieldParamsInput](https://www.navixy.com/docs/navixy-repository-api/custom-fields#type-catalogfieldparamsinput) | Parameters for CATALOG field type. |
| `tag` | [TagFieldParamsInput](https://www.navixy.com/docs/navixy-repository-api/custom-fields#type-tagfieldparamsinput) | Parameters for TAG field type. |
StringFieldParamsInput
Parameters for STRING field type.
| Field | Type | Description |
| -------------- | ---------- | ----------------------------- |
| `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.
| Field | Type | Description |
| -------------- | ---------- | ----------------------------- |
| `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.
| Field | Type | Description |
| -------------- | ---------- | ---------------------------- |
| `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.
| Field | Type | Description |
| -------------- | ---------- | ---------------------------- |
| `isRequired` | `Boolean!` | Whether a value is required. |
| `defaultValue` | `Boolean` | The default value. |
DateFieldParamsInput
Parameters for DATE field type.
| Field | Type | Description |
| -------------- | ---------- | ---------------------------- |
| `isRequired` | `Boolean!` | Whether a value is required. |
| `defaultValue` | `Date` | The default value. |
DateTimeFieldParamsInput
Parameters for DATETIME field type.
| Field | Type | Description |
| -------------- | ---------- | ---------------------------- |
| `isRequired` | `Boolean!` | Whether a value is required. |
| `defaultValue` | `DateTime` | The default value. |
GeoJsonFieldParamsInput
Parameters for GEOJSON field type.
| Field | Type | Description |
| -------------- | ----------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------- |
| `isRequired` | `Boolean!` | Whether a value is required. |
| `allowedTypes` | \[[GeoJsonGeometryType](https://www.navixy.com/docs/navixy-repository-api/geo-objects/types#type-geojsongeometrytype)!] | The allowed geometry types. Null means all types are allowed. |
ScheduleFieldParamsInput
Parameters for SCHEDULE field type.
| Field | Type | Description |
| ------------ | ---------- | ---------------------------- |
| `isRequired` | `Boolean!` | Whether a value is required. |
OptionsFieldParamsInput
Parameters for OPTIONS field type.
| Field | Type | Description |
| -------------- | -------------------------------------------------------------------------------------------------------------- | ----------------------------------------- |
| `isRequired` | `Boolean!` | Whether a value is required. |
| `isMulti` | `Boolean` | Whether multiple options can be selected. |
| `options` | \[[FieldOptionInput](https://www.navixy.com/docs/navixy-repository-api/custom-fields#type-fieldoptioninput)!]! | The available options. |
| `defaultValue` | `Code` | The default option code. |
FieldOptionInput
Input for an option definition. When updating options: if an entry without `code` is provided, a new option is created. If the label already exists within this field, an error is returned.
| Field | Type | Description |
| ------------- | --------- | ---------------------------------------------------------- |
| `code` | `Code` | The unique code. Auto-generated from label if omitted. |
| `label` | `String!` | The display label. Must be unique within the custom field. |
| `description` | `String` | The description. |
| `isArchived` | `Boolean` | Whether this option is archived. |
DeviceFieldParamsInput
Parameters for DEVICE field type.
| Field | Type | Description |
| ------------ | ---------- | ---------------------------- |
| `isRequired` | `Boolean!` | Whether a value is required. |
ReferenceFieldParamsInput
Parameters for REFERENCE field type.
| Field | Type | Description |
| ------------------- | ---------- | -------------------------------------------- |
| `isRequired` | `Boolean!` | Whether a value is required. |
| `refEntityTypeCode` | `Code!` | The entity type code that can be referenced. |
CatalogFieldParamsInput
Parameters for CATALOG field type.
| Field | Type | Description |
| ---------------- | ---------- | ------------------------------------------------- |
| `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.
| Field | Type | Description |
| -------------- | ---------- | ---------------------------- |
| `isRequired` | `Boolean!` | Whether a value is required. |
| `defaultValue` | `Code` | The default tag code. |
CustomFieldDefinitionUpdateData
Data for updating an existing custom field definition. Note: `fieldType` cannot be changed.
| Field | Type | Description |
| ------------- | --------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
| `code` | `Code!` | The code of the field definition to update. |
| `title` | `String` | The new display name. |
| `description` | `String` | The new description. |
| `order` | `Int` | The new display order. |
| `params` | [FieldParamsInput](https://www.navixy.com/docs/navixy-repository-api/custom-fields#type-fieldparamsinput) | The updated parameters. Only `isRequired` and type-specific fields can be changed. |
CustomFieldDefinitionDeleteData
Data for permanently deleting a custom field definition.
If entities have values for this field, the default behavior is to reject the deletion. Use `onValues: CASCADE` to explicitly allow deletion with all associated values.
Prefer archiving for non-destructive deactivation.
| Field | Type | Description |
| ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- |
| `code` | `Code!` | The code of the field definition to delete. |
| `onValues` | [CustomFieldDefinitionDeleteBehavior](https://www.navixy.com/docs/navixy-repository-api/custom-fields#type-customfielddefinitiondeletebehavior) | What to do when existing entities have values for this field. Defaults to `REJECT` to prevent accidental data loss. |
CustomFieldDefinitionArchiveData
Data for archiving or restoring a custom field definition.
Archiving deactivates the field without data loss:
* The field definition and all its values are preserved.
* The field no longer appears in forms and accepts no new values.
* Existing values remain readable and visible in history/exports.
| Field | Type | Description |
| ------ | ------- | -------------------------------------------- |
| `code` | `Code!` | The code of the field definition to archive. |
CustomFieldDefinitionRestoreData
Data for restoring a previously archived custom field definition.
| Field | Type | Description |
| ------ | ------- | -------------------------------------------- |
| `code` | `Code!` | The code of the field definition to restore. |
**Output types:**
AssetTypePayload
The result of an asset type mutation.
| Field | Type | Description |
| ----------- | ------------------------------------------------------------------------------------------------------- | ---------------------------------- |
| `assetType` | [AssetType](https://www.navixy.com/docs/navixy-repository-api/core-api-reference/types#type-assettype)! | The created or updated asset type. |
AssetType (entity)
A classification type for assets.
**Implements:** [CatalogItem](https://www.navixy.com/docs/navixy-repository-api/catalogs/catalog-items#type-catalogitem), [Node](https://www.navixy.com/docs/navixy-repository-api/common#type-node), [Versioned](https://www.navixy.com/docs/navixy-repository-api/common#type-versioned), [Titled](https://www.navixy.com/docs/navixy-repository-api/common#type-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` | [Catalog](https://www.navixy.com/docs/navixy-repository-api/catalogs/catalog-items#type-catalog)! | The catalog this item belongs to. |
| `organization` | [Organization](https://www.navixy.com/docs/navixy-repository-api/organizations#type-organization) | The organization that owns this item. Null for system items. |
| `meta` | [CatalogItemMeta](https://www.navixy.com/docs/navixy-repository-api/catalogs/catalog-items#type-catalogitemmeta)! | Metadata about this item including description, origin, and display properties. |
| `customFieldDefinitions` | \[[CustomFieldDefinition](https://www.navixy.com/docs/navixy-repository-api/custom-fields#type-customfielddefinition)!]! | Custom field definitions specific to this asset type, ordered by display order. |
***
### assetTypeUpdate
Updates an asset type.
```graphql
assetTypeUpdate(
input: AssetTypeUpdateInput!
): AssetTypePayload
```
**Arguments**
| Name | Type | Description |
| ------- | ----------------------- | --------------------------------------------- |
| `input` | `AssetTypeUpdateInput!` | The input fields for updating the asset type. |
**Input types:**
AssetTypeUpdateInput
Input for updating an asset 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` | [CatalogItemMetaInput](https://www.navixy.com/docs/navixy-repository-api/catalogs/catalog-items#type-catalogitemmetainput) | The display properties. |
| `customFieldDefinitions` | \[[CustomFieldDefinitionInput](https://www.navixy.com/docs/navixy-repository-api/custom-fields#type-customfielddefinitioninput)!] | Operations on custom field definitions belonging to this asset type. |
CatalogItemMetaInput
Display properties for catalog items.
| Field | Type | Description |
| ------------- | --------- | ------------------------------------------------- |
| `description` | `String` | The description. |
| `hidden` | `Boolean` | Whether the item is hidden from regular UI lists. |
CustomFieldDefinitionInput
A single operation on a custom field definition within the parent catalog item. Exactly one action must be provided.
*This input type uses `@oneOf` - exactly one field must be provided.*
| Field | Type | Description |
| --------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------- |
| `create` | [CustomFieldDefinitionCreateData](https://www.navixy.com/docs/navixy-repository-api/custom-fields#type-customfielddefinitioncreatedata) | Create a new custom field definition. |
| `update` | [CustomFieldDefinitionUpdateData](https://www.navixy.com/docs/navixy-repository-api/custom-fields#type-customfielddefinitionupdatedata) | Update an existing custom field definition. |
| `delete` | [CustomFieldDefinitionDeleteData](https://www.navixy.com/docs/navixy-repository-api/custom-fields#type-customfielddefinitiondeletedata) | Delete a custom field definition. |
| `archive` | [CustomFieldDefinitionArchiveData](https://www.navixy.com/docs/navixy-repository-api/custom-fields#type-customfielddefinitionarchivedata) | Archive a custom field definition (non-destructive deactivation). |
| `restore` | [CustomFieldDefinitionRestoreData](https://www.navixy.com/docs/navixy-repository-api/custom-fields#type-customfielddefinitionrestoredata) | Restore a previously archived custom field definition. |
CustomFieldDefinitionCreateData
Data for creating a custom field definition within its parent catalog item.
| Field | Type | Description |
| ------------- | ---------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- |
| `code` | `Code` | The machine-readable code. Auto-generated from title if omitted. Codes `geojson_data` and `schedule_data` are reserved by the platform. |
| `title` | `String!` | The display name. |
| `description` | `String` | The description. |
| `fieldType` | [FieldType](https://www.navixy.com/docs/navixy-repository-api/custom-fields#type-fieldtype)! | The data type. Immutable after creation. |
| `order` | `Int` | The display order. Auto-calculated as last position if omitted. |
| `params` | [FieldParamsInput](https://www.navixy.com/docs/navixy-repository-api/custom-fields#type-fieldparamsinput)! | The type-specific parameters. Exactly one variant must be provided. |
FieldParamsInput
Field parameters input. Exactly one field must be provided.
*This input type uses `@oneOf` - exactly one field must be provided.*
| Field | Type | Description |
| ----------- | --------------------------------------------------------------------------------------------------------------------------- | ------------------------------------ |
| `string` | [StringFieldParamsInput](https://www.navixy.com/docs/navixy-repository-api/custom-fields#type-stringfieldparamsinput) | Parameters for STRING field type. |
| `text` | [TextFieldParamsInput](https://www.navixy.com/docs/navixy-repository-api/custom-fields#type-textfieldparamsinput) | Parameters for TEXT field type. |
| `number` | [NumberFieldParamsInput](https://www.navixy.com/docs/navixy-repository-api/custom-fields#type-numberfieldparamsinput) | Parameters for NUMBER field type. |
| `boolean` | [BooleanFieldParamsInput](https://www.navixy.com/docs/navixy-repository-api/custom-fields#type-booleanfieldparamsinput) | Parameters for BOOLEAN field type. |
| `date` | [DateFieldParamsInput](https://www.navixy.com/docs/navixy-repository-api/custom-fields#type-datefieldparamsinput) | Parameters for DATE field type. |
| `datetime` | [DateTimeFieldParamsInput](https://www.navixy.com/docs/navixy-repository-api/custom-fields#type-datetimefieldparamsinput) | Parameters for DATETIME field type. |
| `geojson` | [GeoJsonFieldParamsInput](https://www.navixy.com/docs/navixy-repository-api/custom-fields#type-geojsonfieldparamsinput) | Parameters for GEOJSON field type. |
| `schedule` | [ScheduleFieldParamsInput](https://www.navixy.com/docs/navixy-repository-api/custom-fields#type-schedulefieldparamsinput) | Parameters for SCHEDULE field type. |
| `options` | [OptionsFieldParamsInput](https://www.navixy.com/docs/navixy-repository-api/custom-fields#type-optionsfieldparamsinput) | Parameters for OPTIONS field type. |
| `device` | [DeviceFieldParamsInput](https://www.navixy.com/docs/navixy-repository-api/custom-fields#type-devicefieldparamsinput) | Parameters for DEVICE field type. |
| `reference` | [ReferenceFieldParamsInput](https://www.navixy.com/docs/navixy-repository-api/custom-fields#type-referencefieldparamsinput) | Parameters for REFERENCE field type. |
| `catalog` | [CatalogFieldParamsInput](https://www.navixy.com/docs/navixy-repository-api/custom-fields#type-catalogfieldparamsinput) | Parameters for CATALOG field type. |
| `tag` | [TagFieldParamsInput](https://www.navixy.com/docs/navixy-repository-api/custom-fields#type-tagfieldparamsinput) | Parameters for TAG field type. |
StringFieldParamsInput
Parameters for STRING field type.
| Field | Type | Description |
| -------------- | ---------- | ----------------------------- |
| `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.
| Field | Type | Description |
| -------------- | ---------- | ----------------------------- |
| `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.
| Field | Type | Description |
| -------------- | ---------- | ---------------------------- |
| `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.
| Field | Type | Description |
| -------------- | ---------- | ---------------------------- |
| `isRequired` | `Boolean!` | Whether a value is required. |
| `defaultValue` | `Boolean` | The default value. |
DateFieldParamsInput
Parameters for DATE field type.
| Field | Type | Description |
| -------------- | ---------- | ---------------------------- |
| `isRequired` | `Boolean!` | Whether a value is required. |
| `defaultValue` | `Date` | The default value. |
DateTimeFieldParamsInput
Parameters for DATETIME field type.
| Field | Type | Description |
| -------------- | ---------- | ---------------------------- |
| `isRequired` | `Boolean!` | Whether a value is required. |
| `defaultValue` | `DateTime` | The default value. |
GeoJsonFieldParamsInput
Parameters for GEOJSON field type.
| Field | Type | Description |
| -------------- | ----------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------- |
| `isRequired` | `Boolean!` | Whether a value is required. |
| `allowedTypes` | \[[GeoJsonGeometryType](https://www.navixy.com/docs/navixy-repository-api/geo-objects/types#type-geojsongeometrytype)!] | The allowed geometry types. Null means all types are allowed. |
ScheduleFieldParamsInput
Parameters for SCHEDULE field type.
| Field | Type | Description |
| ------------ | ---------- | ---------------------------- |
| `isRequired` | `Boolean!` | Whether a value is required. |
OptionsFieldParamsInput
Parameters for OPTIONS field type.
| Field | Type | Description |
| -------------- | -------------------------------------------------------------------------------------------------------------- | ----------------------------------------- |
| `isRequired` | `Boolean!` | Whether a value is required. |
| `isMulti` | `Boolean` | Whether multiple options can be selected. |
| `options` | \[[FieldOptionInput](https://www.navixy.com/docs/navixy-repository-api/custom-fields#type-fieldoptioninput)!]! | The available options. |
| `defaultValue` | `Code` | The default option code. |
FieldOptionInput
Input for an option definition. When updating options: if an entry without `code` is provided, a new option is created. If the label already exists within this field, an error is returned.
| Field | Type | Description |
| ------------- | --------- | ---------------------------------------------------------- |
| `code` | `Code` | The unique code. Auto-generated from label if omitted. |
| `label` | `String!` | The display label. Must be unique within the custom field. |
| `description` | `String` | The description. |
| `isArchived` | `Boolean` | Whether this option is archived. |
DeviceFieldParamsInput
Parameters for DEVICE field type.
| Field | Type | Description |
| ------------ | ---------- | ---------------------------- |
| `isRequired` | `Boolean!` | Whether a value is required. |
ReferenceFieldParamsInput
Parameters for REFERENCE field type.
| Field | Type | Description |
| ------------------- | ---------- | -------------------------------------------- |
| `isRequired` | `Boolean!` | Whether a value is required. |
| `refEntityTypeCode` | `Code!` | The entity type code that can be referenced. |
CatalogFieldParamsInput
Parameters for CATALOG field type.
| Field | Type | Description |
| ---------------- | ---------- | ------------------------------------------------- |
| `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.
| Field | Type | Description |
| -------------- | ---------- | ---------------------------- |
| `isRequired` | `Boolean!` | Whether a value is required. |
| `defaultValue` | `Code` | The default tag code. |
CustomFieldDefinitionUpdateData
Data for updating an existing custom field definition. Note: `fieldType` cannot be changed.
| Field | Type | Description |
| ------------- | --------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
| `code` | `Code!` | The code of the field definition to update. |
| `title` | `String` | The new display name. |
| `description` | `String` | The new description. |
| `order` | `Int` | The new display order. |
| `params` | [FieldParamsInput](https://www.navixy.com/docs/navixy-repository-api/custom-fields#type-fieldparamsinput) | The updated parameters. Only `isRequired` and type-specific fields can be changed. |
CustomFieldDefinitionDeleteData
Data for permanently deleting a custom field definition.
If entities have values for this field, the default behavior is to reject the deletion. Use `onValues: CASCADE` to explicitly allow deletion with all associated values.
Prefer archiving for non-destructive deactivation.
| Field | Type | Description |
| ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- |
| `code` | `Code!` | The code of the field definition to delete. |
| `onValues` | [CustomFieldDefinitionDeleteBehavior](https://www.navixy.com/docs/navixy-repository-api/custom-fields#type-customfielddefinitiondeletebehavior) | What to do when existing entities have values for this field. Defaults to `REJECT` to prevent accidental data loss. |
CustomFieldDefinitionArchiveData
Data for archiving or restoring a custom field definition.
Archiving deactivates the field without data loss:
* The field definition and all its values are preserved.
* The field no longer appears in forms and accepts no new values.
* Existing values remain readable and visible in history/exports.
| Field | Type | Description |
| ------ | ------- | -------------------------------------------- |
| `code` | `Code!` | The code of the field definition to archive. |
CustomFieldDefinitionRestoreData
Data for restoring a previously archived custom field definition.
| Field | Type | Description |
| ------ | ------- | -------------------------------------------- |
| `code` | `Code!` | The code of the field definition to restore. |
**Output types:**
AssetTypePayload
The result of an asset type mutation.
| Field | Type | Description |
| ----------- | ------------------------------------------------------------------------------------------------------- | ---------------------------------- |
| `assetType` | [AssetType](https://www.navixy.com/docs/navixy-repository-api/core-api-reference/types#type-assettype)! | The created or updated asset type. |
AssetType (entity)
A classification type for assets.
**Implements:** [CatalogItem](https://www.navixy.com/docs/navixy-repository-api/catalogs/catalog-items#type-catalogitem), [Node](https://www.navixy.com/docs/navixy-repository-api/common#type-node), [Versioned](https://www.navixy.com/docs/navixy-repository-api/common#type-versioned), [Titled](https://www.navixy.com/docs/navixy-repository-api/common#type-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` | [Catalog](https://www.navixy.com/docs/navixy-repository-api/catalogs/catalog-items#type-catalog)! | The catalog this item belongs to. |
| `organization` | [Organization](https://www.navixy.com/docs/navixy-repository-api/organizations#type-organization) | The organization that owns this item. Null for system items. |
| `meta` | [CatalogItemMeta](https://www.navixy.com/docs/navixy-repository-api/catalogs/catalog-items#type-catalogitemmeta)! | Metadata about this item including description, origin, and display properties. |
| `customFieldDefinitions` | \[[CustomFieldDefinition](https://www.navixy.com/docs/navixy-repository-api/custom-fields#type-customfielddefinition)!]! | Custom field definitions specific to this asset type, ordered by display order. |
***
### assetTypeDelete
Deletes an asset type.
```graphql
assetTypeDelete(
input: CatalogItemDeleteInput!
): DeletePayload
```
**Arguments**
| Name | Type | Description |
| ------- | ------------------------- | --------------------------------------------- |
| `input` | `CatalogItemDeleteInput!` | The input fields for deleting the asset type. |
**Input types:**
CatalogItemDeleteInput
Input for deleting a catalog item.
| Field | Type | Description |
| --------- | ----- | ----------------------------------------------------------------------------------------------- |
| `id` | `ID!` | The catalog item ID to delete. |
| `version` | `Int` | The current version for optimistic locking. If omitted, auto-increments without conflict check. |
**Output types:**
DeletePayload
The result of a delete mutation.
| Field | Type | Description |
| ----------- | ----- | ----------------------------- |
| `deletedId` | `ID!` | The ID of the deleted entity. |
***