catalogBatch

Requires permission catalog:copilot:chat.

Returns one catalog batch that the copilot applied. Fails if the batch does not exist. A batch whose run stopped without finishing is recovered first. Needs the catalog copilot feature on the plan and permission to chat with the copilot.

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 CatalogBatch($id: ID!) {
  catalogBatch(id: $id) {
    id
    status
    appliedAt
    entities
    kind
    rolledBackAt
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query CatalogBatch($id: ID!) {\n  catalogBatch(id: $id) {\n    id\n    status\n    appliedAt\n    entities\n    kind\n    rolledBackAt\n  }\n}",
  "variables": {
    "id": "id"
  }
}
EOF

Variables:

{
  "id": "id"
}

Response:

{
  "data": {
    "catalogBatch": {
      "id": "id",
      "status": "APPLIED",
      "appliedAt": 0,
      "entities": {},
      "kind": "BROADCAST",
      "rolledBackAt": 0
    }
  }
}

catalogBatch(
  id: ID!
): CatalogBatchType!

Arguments

catalogBatch.id ● ID! non-null scalar

The ID of the catalog batch.

Type

CatalogBatchType object

A batch of catalog changes made by the copilot.