Powered by Redocly

Document Routing

Retrieve document routing with given id

SecurityOAuth2
Request
path Parameters
id
required
string (Routing identifier)
Example: 6295dcd39db1ab740c3e296c
Responses
200

Successful Response

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

Validation Error

500

Internal Server Error

get/routings/{id}
Request samples 
curl -i -X GET \
  'https://api.cloud.hypatos.ai/v2/routings/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
Response samples
application/json
{
  • "name": "Document routing name",
  • "fromProjectId": "263e6663823b4c1f5287398bb",
  • "toProjectId": "263e6663823b4c1f5287398bb",
  • "postRoutingAction": "reprocess",
  • "active": true,
  • "routingNode": {
    },
  • "id": "63e6663823b4c1f5287398bb",
  • "modifiedAt": "2023-02-10T15:46:19.384990Z",
  • "modifiedBy": "671f771235cd520084dd655f",
  • "createdBy": "671f771235cd520084dd655f",
  • "createdAt": "2023-02-10T15:46:19.384990Z",
  • "order": 0
}

Update document routing

SecurityOAuth2
Request
path Parameters
id
required
string (Routing identifier 6295dcd39db1ab740c3e296c)
Request Body schema: application/json
required
name
string (Routing name) [ 1 .. 200 ] characters
fromProjectId
string (Identifier of a project where routings evaluation will happen)
toProjectId
string (Identifier of a project where documents will be moved to if routings evaluation passes)
postRoutingAction
string (Action done after document is routed)
Default: "reprocess reprocess"

Defines the action to be executed for the routed document in the target project.

Enum: "none" "refresh" "reprocess"
active
boolean (Only active routings will be evaluated)
object (Routing node evaluation definition)
modifiedBy
string (Routing modifier)
Responses
200

Successful Response

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

Validation Error

500

Internal Server Error

put/routings/{id}
Request samples
application/json
{
  • "name": "Document routing name",
  • "fromProjectId": "63e6663823b4c1f5287398bb",
  • "toProjectId": "63e6663823b4c1f5287398bb",
  • "postRoutingAction": "reprocess reprocess",
  • "active": true,
  • "routingNode": {
    },
  • "modifiedBy": "671f771235cd520084dd655f"
}
Response samples
application/json
{
  • "name": "Document routing name",
  • "fromProjectId": "263e6663823b4c1f5287398bb",
  • "toProjectId": "263e6663823b4c1f5287398bb",
  • "postRoutingAction": "reprocess",
  • "active": true,
  • "routingNode": {
    },
  • "id": "63e6663823b4c1f5287398bb",
  • "modifiedAt": "2023-02-10T15:46:19.384990Z",
  • "modifiedBy": "671f771235cd520084dd655f",
  • "createdBy": "671f771235cd520084dd655f",
  • "createdAt": "2023-02-10T15:46:19.384990Z",
  • "order": 0
}

Delete document routing

SecurityOAuth2
Request
path Parameters
id
required
string (Routing identifier 6295dcd39db1ab740c3e296c)
Responses
204

Successful Response

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

Validation Error

500

Internal Server Error

delete/routings/{id}
Request samples 
curl -i -X DELETE \
  'https://api.cloud.hypatos.ai/v2/routings/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
Response samples
application/json
{
  • "status": 400,
  • "title": "Routing project does not exists",
  • "detail": "Error details"
}

Retrieve document routings list

SecurityOAuth2
Request
query Parameters
limit
integer (The limit used for this page of results.) >= 0
Default: 20
offset
integer (The offset used for this page of results.) >= 0
Default: 0
Responses
200

Successful Response

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

Validation Error

500

Internal Server Error

get/routings
Request samples 
curl -i -X GET \
  'https://api.cloud.hypatos.ai/v2/routings?limit=20&offset=0' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
Response samples
application/json
{
  • "data": [
    ],
  • "totalCount": 0,
  • "limit": 0,
  • "offset": 0
}

Create document routing

SecurityOAuth2
Request
Request Body schema: application/json
required
name
string (Routing name) [ 1 .. 200 ] characters
fromProjectId
string (Identifier of a project where routings evaluation will happen)
toProjectId
string (Identifier of a project where documents will be moved to if routings evaluation passes)
postRoutingAction
string (Action done after document is routed)
Default: "reprocess reprocess"

Defines the action to be executed for the routed document in the target project.

Enum: "none" "refresh" "reprocess"
active
boolean (Only active routings will be evaluated)
object (Routing node evaluation definition)
createdBy
string (Routing creator)
Responses
201

Successful Response

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

Validation Error

500

Internal Server Error

post/routings
Request samples
application/json
{
  • "name": "Document routing name",
  • "fromProjectId": "63e6663823b4c1f5287398bb",
  • "toProjectId": "63e6663823b4c1f5287398bb",
  • "postRoutingAction": "reprocess reprocess",
  • "active": true,
  • "routingNode": {
    },
  • "createdBy": "671f771235cd520084dd655f"
}
Response samples
application/json
{
  • "name": "Document routing name",
  • "fromProjectId": "263e6663823b4c1f5287398bb",
  • "toProjectId": "263e6663823b4c1f5287398bb",
  • "postRoutingAction": "reprocess",
  • "active": true,
  • "routingNode": {
    },
  • "id": "63e6663823b4c1f5287398bb",
  • "modifiedAt": "2023-02-10T15:46:19.384990Z",
  • "modifiedBy": "671f771235cd520084dd655f",
  • "createdBy": "671f771235cd520084dd655f",
  • "createdAt": "2023-02-10T15:46:19.384990Z",
  • "order": 0
}

Change document routing order

SecurityOAuth2
Request
path Parameters
id
required
string (Routing identifier 6295dcd39db1ab740c3e296c)
Request Body schema: application/json
required
direction
required
string (Moving order direction)

An enumeration.

Enum: "up" "down"
count
required
integer (Moving order count in given direction)
Responses
204

Successful Response

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

Validation Error

500

Internal Server Error

post/routings/{id}/order
Request samples
application/json
{
  • "direction": "down",
  • "count": 2
}
Response samples
application/json
{
  • "status": 401,
  • "title": "Invalid token",
  • "detail": "Error details"
}
➔ Next to Users