archiveCategoryAttributeDefinition

Requires permission biddesk:assembly:manage.

Archives a category attribute. Its key can be restored by saving it again in the same category. Refused with VERSION_CONFLICT when someone saved first. Requires Bid Desk and permission to manage assemblies.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

mutation ArchiveCategoryAttributeDefinition($expectedVersion: Int!, $id: ID!) {
  archiveCategoryAttributeDefinition(expectedVersion: $expectedVersion, id: $id) {
    id
    type
    createdAt
    archived
    categoryId
    key
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation ArchiveCategoryAttributeDefinition($expectedVersion: Int!, $id: ID!) {\n  archiveCategoryAttributeDefinition(expectedVersion: $expectedVersion, id: $id) {\n    id\n    type\n    createdAt\n    archived\n    categoryId\n    key\n  }\n}",
  "variables": {
    "expectedVersion": 0,
    "id": "id"
  }
}
EOF

Variables:

{
  "expectedVersion": 0,
  "id": "id"
}

Response:

{
  "data": {
    "archiveCategoryAttributeDefinition": {
      "id": "id",
      "type": "BOOLEAN",
      "createdAt": "2025-01-15T00:00:00Z",
      "archived": true,
      "categoryId": "id",
      "key": "string"
    }
  }
}

archiveCategoryAttributeDefinition(
  expectedVersion: Int!
  id: ID!
): CategoryAttributeDefinition!

Arguments

archiveCategoryAttributeDefinition.expectedVersion ● Int! non-null scalar

The version the archive is based on.

archiveCategoryAttributeDefinition.id ● ID! non-null scalar

The attribute to archive.

Type

CategoryAttributeDefinition object

One typed technical attribute of a category (for example power or voltage), with an optional unit, a required flag, its choices and its bounds.