Mutations

circle-exclamation

assetGroupCreate

Creates a new asset group.

assetGroupCreate(
    input: AssetGroupCreateInput!
  ): AssetGroupPayload

Arguments

Name
Type
Description

input

AssetGroupCreateInput!

The input fields for creating the asset group.

Input types:

chevron-rightAssetGroupCreateInputhashtag

Input for creating a new asset group.

Field
Type
Description

organizationId

ID!

The organization that will own the group.

typeId

ID!

The group type ID.

title

String!

The group display name.

color

HexColorCode

The color for UI display.

Output types:

chevron-rightAssetGroupPayloadhashtag

The result of an asset group mutation.

Field
Type
Description

assetGroup

The created or updated asset group.

chevron-rightAssetGroup (entity)hashtag

A group of assets.

Implements: Node, Versioned, Titled

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. Must be provided in update/delete mutations to prevent lost updates.

title

String!

The human-readable display name.

organization

The organization that owns this group.

type

The group type with membership constraints.

color

HexColorCode

The color for UI display in hexadecimal format.

currentAssets

The assets currently in this group.

history

The full membership history for this group.


assetGroupUpdate

Updates an existing asset group.

Arguments

Name
Type
Description

input

AssetGroupUpdateInput!

The input fields for updating the asset group.

Input types:

chevron-rightAssetGroupUpdateInputhashtag

Input for updating an existing asset group.

Field
Type
Description

id

ID!

The asset group ID to update.

version

Int!

The current version for optimistic locking.

title

String

The new display name.

color

HexColorCode

The new color.

Output types:

chevron-rightAssetGroupPayloadhashtag

The result of an asset group mutation.

Field
Type
Description

assetGroup

The created or updated asset group.

chevron-rightAssetGroup (entity)hashtag

A group of assets.

Implements: Node, Versioned, Titled

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. Must be provided in update/delete mutations to prevent lost updates.

title

String!

The human-readable display name.

organization

The organization that owns this group.

type

The group type with membership constraints.

color

HexColorCode

The color for UI display in hexadecimal format.

currentAssets

The assets currently in this group.

history

The full membership history for this group.


assetGroupDelete

Deletes an asset group.

Arguments

Name
Type
Description

input

AssetGroupDeleteInput!

The input fields for deleting the asset group.

Input types:

chevron-rightAssetGroupDeleteInputhashtag

Input for deleting an asset group.

Field
Type
Description

id

ID!

The asset group ID to delete.

version

Int!

The current version for optimistic locking.

Output types:

chevron-rightDeletePayloadhashtag

The result of a delete mutation.

Field
Type
Description

deletedId

ID!

The ID of the deleted entity.


assetGroupItemAdd

Adds an asset to a group.

Arguments

Name
Type
Description

input

AssetGroupItemAddInput!

The input fields for adding the asset to the group.

Input types:

chevron-rightAssetGroupItemAddInputhashtag

Input for adding an asset to a group.

Field
Type
Description

groupId

ID!

The group ID.

assetId

ID!

The asset ID to add.

Output types:

chevron-rightAssetGroupItemPayloadhashtag

The result of an asset group item mutation.

Field
Type
Description

assetGroupItem

The created group membership record.

chevron-rightAssetGroupItem (entity)hashtag

A record of an asset's membership in a group.

Implements: Node

Field
Type
Description

id

ID!

A globally unique identifier. This ID is opaque and should not be parsed by clients.

group

The group containing the asset.

asset

The asset in the group.

attachedAt

DateTime!

The date and time when the asset was added to the group.

detachedAt

DateTime

The date and time when the asset was removed from the group. Null means the asset is currently attached.


assetGroupItemRemove

Removes an asset from a group.

Arguments

Name
Type
Description

input

AssetGroupItemRemoveInput!

The input fields for removing the asset from the group.

Input types:

chevron-rightAssetGroupItemRemoveInputhashtag

Input for removing an asset from a group.

Field
Type
Description

groupId

ID!

The group ID.

assetId

ID!

The asset ID to remove.

Output types:

chevron-rightDeletePayloadhashtag

The result of a delete mutation.

Field
Type
Description

deletedId

ID!

The ID of the deleted entity.


assetGroupTypeCreate

Creates a new asset group type.

Arguments

Name
Type
Description

input

AssetGroupTypeCreateInput!

The input fields for creating the asset group type.

Input types:

chevron-rightAssetGroupTypeCreateInputhashtag

Input for creating an asset group type.

Field
Type
Description

organizationId

ID!

The organization that will own the item.

code

Code!

The machine-readable code.

title

String!

The display name.

order

Int

The display order.

allowedAssetTypes

The allowed asset types with optional limits.

meta

The display properties.

chevron-rightAssetGroupTypeConstraintInputhashtag

Input for a constraint defining allowed asset types in an asset group type.

Field
Type
Description

assetTypeId

ID!

The asset type ID.

maxItems

Int

The maximum assets of this type. Null means unlimited.

chevron-rightCatalogItemMetaInputhashtag

Display properties for catalog items.

Field
Type
Description

description

String

The description.

hidden

Boolean

Whether the item is hidden from regular UI lists.

textColor

HexColorCode

The text color for UI display.

backgroundColor

HexColorCode

The background color for UI display.

icon

String

A relative URL to the icon.

Output types:

chevron-rightAssetGroupTypePayloadhashtag

The result of an asset group type mutation.

Field
Type
Description

assetGroupType

The created or updated asset group type.

chevron-rightAssetGroupType (entity)hashtag

A type for asset groups with membership constraints.

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.

allowedAssetTypes

The asset types allowed in groups of this type, with optional quantity limits.


assetGroupTypeUpdate

Updates an asset group type.

Arguments

Name
Type
Description

input

AssetGroupTypeUpdateInput!

The input fields for updating the asset group type.

Input types:

chevron-rightAssetGroupTypeUpdateInputhashtag

Input for updating an asset group type.

Field
Type
Description

id

ID!

The item ID to update.

version

Int!

The current version for optimistic locking.

title

String

The new display name.

order

Int

The new display order.

allowedAssetTypes

Replace allowed asset types. Null means no change.

meta

The display properties.

chevron-rightAssetGroupTypeConstraintInputhashtag

Input for a constraint defining allowed asset types in an asset group type.

Field
Type
Description

assetTypeId

ID!

The asset type ID.

maxItems

Int

The maximum assets of this type. Null means unlimited.

chevron-rightCatalogItemMetaInputhashtag

Display properties for catalog items.

Field
Type
Description

description

String

The description.

hidden

Boolean

Whether the item is hidden from regular UI lists.

textColor

HexColorCode

The text color for UI display.

backgroundColor

HexColorCode

The background color for UI display.

icon

String

A relative URL to the icon.

Output types:

chevron-rightAssetGroupTypePayloadhashtag

The result of an asset group type mutation.

Field
Type
Description

assetGroupType

The created or updated asset group type.

chevron-rightAssetGroupType (entity)hashtag

A type for asset groups with membership constraints.

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.

allowedAssetTypes

The asset types allowed in groups of this type, with optional quantity limits.


assetGroupTypeDelete

Deletes an asset group type.

Arguments

Name
Type
Description

input

CatalogItemDeleteInput!

The input fields for deleting the asset group type.

Input types:

chevron-rightCatalogItemDeleteInputhashtag

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.

Output types:

chevron-rightDeletePayloadhashtag

The result of a delete mutation.

Field
Type
Description

deletedId

ID!

The ID of the deleted entity.


Last updated

Was this helpful?