categoryAttributeDefinitions

Requires permission biddesk:assembly:read.

Lists one category's technical attributes in display order, archived ones too when asked. Requires Bid Desk and permission to read 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

query CategoryAttributeDefinitions($categoryId: ID!) {
  categoryAttributeDefinitions(categoryId: $categoryId) {
    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": "query CategoryAttributeDefinitions($categoryId: ID!) {\n  categoryAttributeDefinitions(categoryId: $categoryId) {\n    id\n    type\n    createdAt\n    archived\n    categoryId\n    key\n  }\n}",
  "variables": {
    "categoryId": "id"
  }
}
EOF

Variables:

{
  "categoryId": "id"
}

Response:

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

categoryAttributeDefinitions(
  categoryId: ID!
  includeArchived: Boolean
): [CategoryAttributeDefinition!]!

Arguments

categoryAttributeDefinitions.categoryId ● ID! non-null scalar

The category whose attributes to list.

categoryAttributeDefinitions.includeArchived ● Boolean scalar

Include archived attributes. Default false.

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.