[POST] .../v1/report/seterror
Sets an error for a report request Use this method to set the error state when a report processor fails to generate a queued report. Access requires the Introspection authentication scheme with policy regos.api.report; the method validates request_uuid, api_login and message, truncates message to the 1024-character database field, marks the request as Error and emits webhook and notification side effects for the original request user. Missing body, missing fields, unknown or non-InProcess request_uuid, concurrent status changes, 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 error must be set. |
| message | String | Required | Error text. |
| request_uuid | String | Required | Report request UUID. |
Request Example
{
"request_uuid": "f20c8f37-8bcb-4f7c-8dc5-8b0b2f4f0c11",
"api_login": "DEMO",
"message": "Report worker failed to build the file."
}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
}
}