Skip to content

Retrieve document routing with given id

Request

Security
OAuth2(Required scopes: routings.read)
Path
idstring(Routing identifier)required
Example:6295dcd39db1ab740c3e296c
curl -i -X GET \
  https://api.cloud.hypatos.ai/v2/routings/6295dcd39db1ab740c3e296c \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Successful Response

Bodyapplication/json
namestring, [ 1 .. 200 ] characters(Routing name)required
Example:"Document routing name"
fromProjectIdstring(Identifier of a project where routings evaluation will happen)required
Example:"263e6663823b4c1f5287398bb"
toProjectIdstring(Identifier of a project where documents will be moved to if routings evaluation passes)required
Example:"263e6663823b4c1f5287398bb"
postRoutingActionstring(Action done after document is routed)

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

Default:"reprocess"
Enum:"none""refresh""reprocess""merge"
Example:"reprocess"
activeboolean(Only active routings will be evaluated)required
Example:true
routingNodeobject(Routing node evaluation definition)required
idstring(Routing identifier)required
Example:"63e6663823b4c1f5287398bb"
modifiedAtstring(Routing last modification date)
Example:"2023-02-10T15:46:19.384990Z"
modifiedBystring(Routing last modification by)
Example:"671f771235cd520084dd655f"
createdBystring(Routing last creation by)
Example:"671f771235cd520084dd655f"
createdAtstring(Routing last creation date)
Example:"2023-02-10T15:46:19.384990Z"
orderinteger(Routing order)required
Example:0
routingActionany(RoutingAction)required
Response
{
  "name": "Document routing name",
  "fromProjectId": "263e6663823b4c1f5287398bb",
  "toProjectId": "263e6663823b4c1f5287398bb",
  "postRoutingAction": "reprocess",
  "active": true,
  "routingNode": {
    "evaluation": { … },
    "edges": []
  },
  "id": "63e6663823b4c1f5287398bb",
  "modifiedAt": "2023-02-10T15:46:19.384990Z",
  "modifiedBy": "671f771235cd520084dd655f",
  "createdBy": "671f771235cd520084dd655f",
  "createdAt": "2023-02-10T15:46:19.384990Z",
  "order": 0,
  "routingAction": {
    "type": "move",
    "postMoveAction": "reprocess"
  }
}