SetPrepared

[POST] .../v1/report/setprepared

Sets the prepared report status and saves the result file Use this method after a report processor has generated a report file for an in-process request. Access requires the Introspection authentication scheme with policy regos.api.report; the method validates request_uuid, api_login and base64 file data, stores the file as a protected system file for the original request user, marks the request as Prepared, writes or updates the prepared-report row and emits webhook and notification side effects. Missing body, missing fields, invalid base64 file, unknown or non-InProcess request_uuid, file-storage errors, transaction failures and database errors are returned as HTTP 200 ErrorResult business errors.

Request Parameters

Name Type Required Description
api_login String Required ApiLogin of the account where the result is saved.
file String Required Report file data in base64.
request_uuid String Required Report request UUID.

Request Example

{
  "request_uuid": "f20c8f37-8bcb-4f7c-8dc5-8b0b2f4f0c11",
  "api_login": "DEMO",
  "file": "H4sIAAAAAAAACqtWykxRslJQ8nXLyU9JrQUA"
}

Response Parameters

Name Type Description
ok Boolean Indicates whether the request completed successfully.
result Update Update operation result.

Response Example

{
  "ok": true,
  "result": {
    "row_affected": 1
  }
}