POST/v1/workspace/compliance/reports/{id}/run

Run a compliance report now

Admin only. Evaluates every check the report names in one transaction and answers the run together with its findings. A run cannot be edited or re-run — asking again writes a new run — so its counts, its outcome and the checks it ran are fixed at this moment. The first run of a report carrying the seat-review check fails it for every seat, because nothing has been signed off yet; signing that run off is the review, and the next run passes.

Access class: workspace:admin.

Send request

Use the documented inputs to call this endpoint directly.

API serverbase URL

Bearer tokensessionoptional

Stored only in this browser for the session security scheme and reused on every API page in this group.

Parameters

Values are applied to the request and the example on the right.

idpath · stringrequired

Request body

application/jsonrequired

bodyobjectoptional

paramsoptional

queryobjectoptional

Responses

201application/json

the action's answer

{
  "data": {
    "findings": [
      {
        "checkKey": "string",
        "createdAt": "string",
        "id": "",
        "outcome": "string",
        "reason": "string",
        "subjectKind": "string",
        "subjectLabel": "string",
        "subjectRowId": ""
      }
    ],
    "run": {
      "checksRun": [
        "string"
      ],
      "decisions": [
        {
          "decidedAt": "string",
          "decision": "string",
          "id": "",
          "note": "string",
          "signerName": "string",
          "signerUserId": ""
        }
      ],
      "failed": 1,
      "id": "",
      "outcome": "string",
      "passed": 1,
      "ranAt": "string",
      "ranBy": 1,
      "reportId": "",
      "reportName": "string",
      "standing": "string",
      "subjects": 1
    }
  }
}

dataoptional

defaultapplication/json

a refusal: {"error": "<what a person needs to read>"}. 401 no credential, 402 the plan does not include this, 403 the seat does not, 404 the thing does not exist or is not yours to see.

{
  "error": "string"
}

errorstringrequired

curl --request POST \ 'https://neo-app-api-prod-836053680024.us-central1.run.app/v1/workspace/compliance/reports/{id}/run' \ --header 'Content-Type: application/json' \ --data '{ "body": {}, "params": { ":id": "string" }, "query": {}}'

{ "data": { "findings": [ { "checkKey": "string", "createdAt": "string", "id": "", "outcome": "string", "reason": "string", "subjectKind": "string", "subjectLabel": "string", "subjectRowId": "" } ], "run": { "checksRun": [ "string" ], "decisions": [ { "decidedAt": "string", "decision": "string", "id": "", "note": "string", "signerName": "string", "signerUserId": "" } ], "failed": 1, "id": "", "outcome": "string", "passed": 1, "ranAt": "string", "ranBy": 1, "reportId": "", "reportName": "string", "standing": "string", "subjects": 1 } }}