rollbackCatalogBatch

Requires permission catalog:copilot:rollback.

"Undo this import": restores the exact prior state of an applied batch.

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 RollbackCatalogBatch($batchId: ID!) {
  rollbackCatalogBatch(batchId: $batchId) {
    status
    batchId
    deleted
    details
    failed
    restored
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation RollbackCatalogBatch($batchId: ID!) {\n  rollbackCatalogBatch(batchId: $batchId) {\n    status\n    batchId\n    deleted\n    details\n    failed\n    restored\n  }\n}",
  "variables": {
    "batchId": "id"
  }
}
EOF

Variables:

{
  "batchId": "id"
}

Response:

{
  "data": {
    "rollbackCatalogBatch": {
      "status": "string",
      "batchId": "string",
      "deleted": 0,
      "details": [
        "string"
      ],
      "failed": 0,
      "restored": 0
    }
  }
}

rollbackCatalogBatch(
  batchId: ID!
): RollbackBatchResult!

Arguments

rollbackCatalogBatch.batchId ● ID! non-null scalar

The ID of the batch.

Type

RollbackBatchResult object

The result of rolling back a batch of changes.