UpsertCheckCategories

UpsertCheckCategories sets (or replaces) the explicit category for one or more checks. Each entry is the complete state for its check — both dimensions — so an empty category / governance_category means “no explicit value for that dimension”.

POST /api/entities/checks/v1/categories:upsert

UpsertCheckCategories

cURL

curl --request POST \
  --url https://developer.synq.io/api/entities/checks/v1/categories:upsert \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "categories": [
    {
      "checkPath": "<string>",
      "category": "<string>",
      "governanceCategory": "<string>",
      "actorIdentity": "<string>",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ]
}
'

200

{
  "categories": [
    {
      "checkPath": "<string>",
      "category": "<string>",
      "governanceCategory": "<string>",
      "actorIdentity": "<string>",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

categories · CheckCategory · object[]

Minimum array length: 1

Show child attributes

Response

200 - application/json

Success

categories · CheckCategory · object[]

Echoed categories with server-set actor_identity / updated_at.

Show child attributes