createConfigModelDraft

Requires permission biddesk:assembly:manage.

Opens a configuration model's next draft as a copy of its latest released version (definition, hash and base). Refused with CONFIG_MODEL_DRAFT_EXISTS (and draftId) when the model already has a draft and CONFIG_MODEL_NOTHING_RELEASED when no version is released. 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 CreateConfigModelDraft($modelId: ID!) {
  createConfigModelDraft(modelId: $modelId) {
    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": "mutation CreateConfigModelDraft($modelId: ID!) {\n  createConfigModelDraft(modelId: $modelId) {\n    id\n    status\n    createdAt\n    baseBomVersionId\n    definition\n    definitionHash\n  }\n}",
  "variables": {
    "modelId": "id"
  }
}
EOF

Variables:

{
  "modelId": "id"
}

Response:

{
  "data": {
    "createConfigModelDraft": {
      "id": "id",
      "status": "DRAFT",
      "createdAt": "2025-01-15T00:00:00Z",
      "baseBomVersionId": "id",
      "definition": {},
      "definitionHash": "string"
    }
  }
}

createConfigModelDraft(
  modelId: ID!
): ConfigModelVersion!

Arguments

createConfigModelDraft.modelId ● ID! non-null scalar

The model's id.

Type

ConfigModelVersion object

One numbered version of a configuration model: one validated definition built on a released bill-of-materials version. Only a DRAFT can be changed; RELEASED and OBSOLETE versions are fixed.