configModel

Requires permission biddesk:assembly:read.

One configuration model with its versions newest first, or null. 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 ConfigModel($id: ID!) {
  configModel(id: $id) {
    id
    name
    createdAt
    assemblyProductId
    updatedAt
    version
    versions {
      id
      status
      createdAt
      baseBomVersionId
      definition
      definitionHash
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query ConfigModel($id: ID!) {\n  configModel(id: $id) {\n    id\n    name\n    createdAt\n    assemblyProductId\n    updatedAt\n    version\n    versions {\n      id\n      status\n      createdAt\n      baseBomVersionId\n      definition\n      definitionHash\n    }\n  }\n}",
  "variables": {
    "id": "id"
  }
}
EOF

Variables:

{
  "id": "id"
}

Response:

{
  "data": {
    "configModel": {
      "id": "id",
      "name": "string",
      "createdAt": "2025-01-15T00:00:00Z",
      "assemblyProductId": "id",
      "updatedAt": "2025-01-15T00:00:00Z",
      "version": 0,
      "versions": [
        {
          "id": "id",
          "status": "DRAFT",
          "createdAt": "2025-01-15T00:00:00Z",
          "baseBomVersionId": "id",
          "definition": {},
          "definitionHash": "string"
        }
      ]
    }
  }
}

configModel(
  id: ID!
): ConfigModel

Arguments

configModel.id ● ID! non-null scalar

The model's id.

Type

ConfigModel object

An assembly's configuration model (at most one per assembly) and its live versions, newest first.