controlCustomFacts

Requires permission settings:controls:manage.

Lists the organization's own fields an approval rule can test (yes/no, select and number fields on the checked document and its customer or vendor), for one checkpoint or all, archived ones included and flagged so existing rules still read. 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

query ControlCustomFacts {
  controlCustomFacts {
    id
    type
    archived
    checkpoints
    entity
    key
    options {
      archived
      labels
      value
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query ControlCustomFacts {\n  controlCustomFacts {\n    id\n    type\n    archived\n    checkpoints\n    entity\n    key\n    options {\n      archived\n      labels\n      value\n    }\n  }\n}"
}
EOF

Response:

{
  "data": {
    "controlCustomFacts": [
      {
        "id": "string",
        "type": "string",
        "archived": true,
        "checkpoints": [
          "string"
        ],
        "entity": "string",
        "key": "string",
        "options": [
          {
            "archived": true,
            "labels": {},
            "value": "string"
          }
        ]
      }
    ]
  }
}

controlCustomFacts(
  checkpoint: String
): [ControlCustomFact!]!

Arguments

controlCustomFacts.checkpoint ● String scalar

Only fields a rule at this checkpoint can test, e.g. order.confirm; omitted, every field. An unknown checkpoint lists none.

Type

ControlCustomFact object

One of the organization's own fields an approval rule can test: a yes/no, select or number field on the checked document or its customer or vendor.