Skip to content

Get a list of processes

Request

Security
bearerAuth
Query
range-fromany, (date-time)required
range-toany, (date-time)required
range-typeanyrequired
Enum:"INGESTION""PROCESS_FINISHED""LAST_ACTIVITY"
page-sizenumber, (int64), [ 0 .. 100 ]
Default:100
page-nonumber, (int64), >= 0
Default:0
ai-pipeline-codeany
process-statusArray of any
Default:[]
Items Enum:"RECEIVED""PROCESSING""VALIDATION""HITL_QUEUE""HITL_PROCESSING""EXPORTED""REJECTED""PARKED"
download-ackanydeprecated
result-processed-ackany
curl -i -X GET \
  'https://developers.retarus.com/_mock/idp/integration-gateway-openapi/get-process-list?range-from=%7Brange-from%7D&range-to=%7Brange-to%7D&range-type=INGESTION&page-size=100&page-no=0&ai-pipeline-code=%7Bai-pipeline-code%7D&process-status=%5B%5D&download-ack=%7Bdownload-ack%7D&result-processed-ack=%7Bresult-processed-ack%7D' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Body*/*
metadataobject(Metadata)
resultListArray of objects(Process)
Response
{
  "metadata": {
    "timestamp": null,
    "resultCount": null,
    "resultPage": null,
    "resultNumberOfPages": null
  },
  "resultList": [
    {
      "processId": null,
      "processStep": null,
      "latestActivity": null
    }
  ]
}