archiveControl

Requires permission settings:controls:manage.

Archives a control: it switches off and stays in the history. Requires settings:controls:manage.

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 ArchiveControl($input: ArchiveControlInput!) {
  archiveControl(input: $input) {
    id
    name
    archived
    checkpoint
    invalid
    invalidReason
    conditions {
      number
      fact
      flag
      list
      op
      text
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation ArchiveControl($input: ArchiveControlInput!) {\n  archiveControl(input: $input) {\n    id\n    name\n    archived\n    checkpoint\n    invalid\n    invalidReason\n    conditions {\n      number\n      fact\n      flag\n      list\n      op\n      text\n    }\n  }\n}",
  "variables": {
    "input": {
      "id": "id",
      "reason": "string"
    }
  }
}
EOF

Variables:

{
  "input": {
    "id": "id",
    "reason": "string"
  }
}

Response:

{
  "data": {
    "archiveControl": {
      "id": "id",
      "name": "string",
      "archived": true,
      "checkpoint": "string",
      "invalid": true,
      "invalidReason": "string",
      "conditions": [
        {
          "number": 0,
          "fact": "string",
          "flag": true,
          "list": [
            "string"
          ],
          "op": "string",
          "text": "string"
        }
      ]
    }
  }
}

archiveControl(
  input: ArchiveControlInput!
): ControlRuleType!

Arguments

archiveControl.input ● ArchiveControlInput! non-null input

The control to archive and why.

Type

ControlRuleType object

A control: one rule checked at one checkpoint, with its mode and recent decisions.