bidConfigurationTree

Requires permission biddesk:bid:read.

A configuration's tree: the frozen snapshot with its hash and node ids, or a fresh preview of a draft (no hash, no node ids). Refused with CONFIGURATION_INVALID when a draft does not build. Requires Bid Desk and permission to read bids.

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 BidConfigurationTree($id: ID!) {
  bidConfigurationTree(id: $id) {
    status
    configurationId
    hash
    lineCount
    tree
    nodes {
      id
      path
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query BidConfigurationTree($id: ID!) {\n  bidConfigurationTree(id: $id) {\n    status\n    configurationId\n    hash\n    lineCount\n    tree\n    nodes {\n      id\n      path\n    }\n  }\n}",
  "variables": {
    "id": "id"
  }
}
EOF

Variables:

{
  "id": "id"
}

Response:

{
  "data": {
    "bidConfigurationTree": {
      "status": "DRAFT",
      "configurationId": "id",
      "hash": "string",
      "lineCount": 0,
      "tree": {},
      "nodes": [
        {
          "id": "id",
          "path": "string"
        }
      ]
    }
  }
}

bidConfigurationTree(
  id: ID!
): BidConfigurationTree!

Arguments

bidConfigurationTree.id ● ID! non-null scalar

The configuration.

Type

BidConfigurationTree object

A configuration's tree: its frozen snapshot, or a fresh preview of a draft.