IDP Integration API

Download OpenAPI description
integration-gateway-openapi.json
integration-gateway-openapi.yaml
Languages
Servers
Mock server
https://developers.retarus.com/_mock/idp/integration-gateway-openapi/
Local
http://null:18300/

process-content-controller

Operations

process-search-controller

Operations

process-administration-controller

Operations

Get a list of processes

Request

Query
range-fromstring(date-time)required
range-tostring(date-time)required
range-typestringrequired
Enum"INGESTION""PROCESS_FINISHED""LAST_ACTIVITY"
page-sizeinteger(int64)[ 0 .. 100 ]
Default 100
page-nointeger(int64)>= 0
Default 0
ai-pipeline-codestring
process-statusArray of strings
Default []
Items Enum"RECEIVED""PROCESSING""VALIDATION""HITL_QUEUE""HITL_PROCESSING""EXPORTED""REJECTED"
download-ackboolean
curl -i -X GET \
  https://developers.retarus.com/_mock/idp/integration-gateway-openapi/get-process-list \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Body*/*
metadataobject(Metadata)
resultListArray of objects(Process)

Update download acknowledge count

Request

Bodyapplication/jsonrequired
processIdstringrequired
curl -i -X POST \
  https://developers.retarus.com/_mock/idp/integration-gateway-openapi/acknowledge-result-download \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "processId": "string"
  }'

Responses

OK

Body*/*
string

common-upload-controller

Operations

import-api-controller

Operations