Asset groups
Complete reference for asset groups: group types, groups, memberships, and history.
Asset groups allow organizing assets into logical collections for easier management and reporting.
Queries
assetGroupTypes
Lists asset group types in the caller's workspace.
assetGroupTypes(
filter: CatalogItemFilter
first: Int
after: String
last: Int
before: String
orderBy: CatalogItemOrder = { field: ORDER, direction: ASC }
): AssetGroupTypeConnection!Arguments
filter
CatalogItemFilter
Filtering options for the returned asset group types.
orderBy
CatalogItemOrder
The ordering options for the returned asset group types.
Input types:
Output types:
assetGroup (query)
Retrieves an asset group by its ID.
Arguments
id
ID!
The ID of the asset group to retrieve.
Output types:
assetGroups
Lists asset groups in the caller's workspace.
Arguments
filter
AssetGroupFilter
Filtering options for the returned asset groups.
orderBy
AssetGroupOrder
The ordering options for the returned asset groups.
Input types:
Output types:
Mutations
assetGroupCreate
Creates a new asset group.
Arguments
input
AssetGroupCreateInput!
The input fields for creating the asset group.
Input types:
Output types:
assetGroupUpdate
Updates an existing asset group.
Arguments
input
AssetGroupUpdateInput!
The input fields for updating the asset group.
Input types:
Output types:
assetGroupDelete
Deletes an asset group.
Refused with IN_USE while another live entity points at it through one of its own fields, custom-field values and field definitions included; the error's blockers name them.
Arguments
input
AssetGroupDeleteInput!
The input fields for deleting the asset group.
Input types:
Output types:
assetGroupItemsAdd
Adds assets to a group.
Arguments
input
AssetGroupItemsAddInput!
The input fields for adding assets to the group.
Input types:
Output types:
assetGroupItemsRemove
Removes assets from a group.
Arguments
input
AssetGroupItemsRemoveInput!
The input fields for removing assets from the group.
Input types:
Output types:
assetGroupTypeCreate
Creates a new asset group type.
Arguments
input
AssetGroupTypeCreateInput!
The input fields for creating the asset group type.
Input types:
Output types:
assetGroupTypeUpdate
Updates an asset group type.
Arguments
input
AssetGroupTypeUpdateInput!
The input fields for updating the asset group type.
Input types:
Output types:
assetGroupTypeDelete
Deletes an asset group type.
Refused with IN_USE while another live entity points at it through one of its own fields, custom-field values and field definitions included; the error's blockers name them.
Arguments
input
CatalogItemDeleteInput!
The input fields for deleting the asset group type.
Input types:
Output types:
Objects
AssetGroupType
A catalog item that classifies asset groups.
Implements: CatalogItem, Node, Versioned, Titled
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 for a given workspace. A workspace item may reuse the code of the system item it overrides.
order
Int!
The display order within the same level or category.
allowedAssetTypes
The asset types that groups of this type are meant to hold, each with an optional maxItems. The API stores and returns them but doesn't check them when assets are added.
AssetGroupTypeConstraint
One entry of an asset group type's allowedAssetTypes list.
maxItems
Int
How many assets of this type one group is meant to hold. Stored and returned, but not checked when assets are added. Null means no number is set.
AssetGroup
A group of assets.
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. 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.
AssetGroupItem
A record of an asset's membership in a group.
Implements: Node
id
ID!
A globally unique identifier. This ID is opaque and should not be parsed by clients.
detachedAt
The date and time when the asset was removed from the group. Null means the asset is currently attached.
AssetGroupPayload
The result of an asset group mutation.
AssetGroupTypePayload
The result of an asset group type mutation.
Inputs
AssetGroupFilter
Filtering options for asset groups.
typeIds
[ID!]
Filter by group types (OR within field).
titleContains
String
Partial match on title (case-insensitive contains).
AssetGroupOrder
Ordering options for asset groups.
AssetGroupItemFilter
Filtering options for asset group items.
activeOnly
Boolean
If true, return only currently attached items.
AssetGroupItemOrder
Ordering options for asset group items.
AssetGroupCreateInput
Input for creating a new asset group.
typeId
ID
The group type ID. Immutable after creation.
title
String!
The group display name.
assetIds
[ID!]
Initial list of asset IDs to add to the group.
AssetGroupUpdateInput
Input for updating an existing asset group.
id
ID!
The asset group ID to update.
version
Int
The current version for optimistic locking. If omitted, auto-increments without conflict check.
title
String
The new display name.
assetIds
[ID!]
Full replacement list of asset IDs in the group. If provided, replaces all current memberships.
AssetGroupDeleteInput
Input for deleting an asset group.
id
ID!
The asset group ID to delete.
version
Int
The current version for optimistic locking. If omitted, auto-increments without conflict check.
AssetGroupItemsAddInput
Input for adding assets to a group.
groupId
ID!
The group ID.
assetIds
[ID!]!
The asset IDs to add.
AssetGroupItemsRemoveInput
Input for removing assets from a group.
groupId
ID!
The group ID.
assetIds
[ID!]!
The asset IDs to remove.
AssetGroupTypeCreateInput
Input for creating an asset group type.
title
String!
The display name.
order
Int
The display order. Auto-calculated as last position if omitted.
allowedAssetTypes
The asset types that groups of this type are meant to hold. The API stores the list but doesn't check it when assets are added. Naming an asset type twice returns DUPLICATE.
AssetGroupTypeUpdateInput
Input for updating an asset group type.
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.
allowedAssetTypes
Replaces the whole stored list. Null means no change, and an empty list clears it. Naming an asset type twice returns DUPLICATE.
AssetGroupTypeConstraintInput
One entry of an asset group type's allowedAssetTypes list.
assetTypeId
ID!
The asset type ID.
maxItems
Int
How many assets of this type one group is meant to hold. Stored and returned, but not checked when assets are added. Null means no number is set.
Enums
AssetGroupOrderField
Fields available for ordering asset groups.
TITLE
Order by title.
AssetGroupItemOrderField
Fields available for ordering asset group items.
ATTACHED_AT
Order by attachment date.
Pagination types
AssetGroupConnection
A paginated list of AssetGroup items.
Implements: Connection
AssetGroupEdge
An edge in the AssetGroup connection.
Implements: Edge
cursor
String!
An opaque cursor for this edge.
AssetGroupItemConnection
A paginated list of AssetGroupItem items.
Implements: Connection
AssetGroupItemEdge
An edge in the AssetGroupItem connection.
Implements: Edge
cursor
String!
An opaque cursor for this edge.
AssetGroupTypeConnection
A paginated list of AssetGroupType items.
Implements: Connection
AssetGroupTypeEdge
An edge in the AssetGroupType connection.
Implements: Edge
cursor
String!
An opaque cursor for this edge.
See also
Last updated
Was this helpful?