GetRequest

[POST] .../v1/report/getrequest

Returns a list of queued report requests. Use this method to check the processing state of queued report requests created by Report/AddRequest. The response returns ReportRequest records with UUID, report metadata, request user, date and status; the request supports filters by user_id, status and request_uuid and if status is omitted the current implementation returns only InProcess and Error requests. The caller must have report-request read permission 349 and missing body, denied access, invalid filters, translation lookup errors or database failures are returned as HTTP 200 ErrorResult business errors.

Request Parameters

Name Type Required Description
filters Array of Filter Optional Optional filters by fields available for this API method.

Filterable Fields

Field Type Description
request_uuid string UUID of a specific report request.
status int
statuses int Request status values.
user_id int IDs of users who submitted requests.

Request Example

{
  "filters": [
    {
      "Field": "request_uuid",
      "Operator": "Equal",
      "Value": "f20c8f37-8bcb-4f7c-8dc5-8b0b2f4f0c11"
    },
    {
      "Field": "status",
      "Operator": "In",
      "Value": "0,2"
    },
    {
      "Field": "user_id",
      "Operator": "Equal",
      "Value": "5"
    }
  ]
}

Response Parameters

Name Type Description
ok Boolean Indicates whether the request completed successfully.
result Array of ReportRequest Result object.

Response Example

{
  "ok": true,
  "result": [
    {
      "uuid": "f20c8f37-8bcb-4f7c-8dc5-8b0b2f4f0c11",
      "date": 1771922400,
      "status": 0,
      "report": {
        "id": 5,
        "group": {
          "id": 2,
          "parent_id": 0,
          "name": "Sales reports",
          "name_var": "REPORT_GROUP_SALES",
          "last_update": 1772527200
        },
        "name": "Retail sales by item",
        "name_var": "REPORT_RETAIL_SALES_BY_ITEM",
        "last_update": 1772527200
      },
      "user_id": 5,
      "description": null,
      "warnings": null
    }
  ]
}