Routing Plans (DOMS)

Endpoints to get information out of the brain of our Distributed Order Management System (DOMS).

List reroute descriptions

get

This part of the API is in Beta status. For details please check the api-release-life-cycle documentationarrow-up-right.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
startAfterIdstringOptional

all entities after given Id

sizeintegerOptional

number of entities to show

Default: 25
Responses
chevron-right
200

RerouteDescription were found & you were allowed to access it. The result is in the body.

application/json

RerouteDescriptions

get
/api/reroutedescriptions

Create reroute description

post

This part of the API is in Beta status. For details please check the api-release-life-cycle documentationarrow-up-right.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body

RerouteDescriptionForCreation

Responses
post
/api/reroutedescriptions

Trigger reroute

post

This part of the API is in Beta status. For details please check the api-release-life-cycle documentationarrow-up-right.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body

RerouteRoutingPlan

allReroutablebooleanOptional

if set to true every reroutable routing plan is rerouted. overrules every other identifier

orderRefsstring[] · max: 10Optional
routingPlanIdsstring[] · max: 10Optional
tenantOrderIdsstring[] · max: 10Optional
Responses
chevron-right
200

Rerouting was successfully triggered

No content

post
/api/routing/commands/reroute

No content

List routing plans

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
orderRefstringOptional

Reference to the order you want to get the corresponding routing plan.

Responses
chevron-right
200

Routing plan was found & you were allowed to access it. The result is in the body.

application/json

RoutingPlans

totalintegerOptional

Total number of found entities for this query

Example: 42
get
/api/routingplans

Get routing plan

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
routingplanIdstringRequired

ID of the routing plan want to get

Responses
chevron-right
200

Routing plan was found & you were allowed to access it. The result is in the body.

application/json

RoutingPlan

get
/api/routingplans/{routingplanId}

Update routing plan

patch
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
routingplanIdstringRequired

ID of routing plan you want to patch

Body

RoutingPlanPatchActions

versioninteger · int64Required

The version of the document to be used in optimistic locking mechanisms.

Example: 42
Responses
chevron-right
200

Routing plan was found & patch-set has been applied. The patched entity is in the body.

application/json

RoutingPlan

patch
/api/routingplans/{routingplanId}

List routing plan decision log

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
routingplanIdstringRequired

ID of the routing plan you want to get it's decision log

routingRunintegerRequired

ID of the decision log you want to get

Responses
chevron-right
200

Decision log was found.

application/json

DecisionLog

get
/api/routingplans/{routingplanId}/decisionlogs/{routingRun}

List routing plans (search)

post

This part of the API is in Alpha status. For details please check the api-release-life-cycle documentationarrow-up-right. Search for RoutingPlan

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body

RoutingPlanSearchPayload

afterstringOptional

The cursor to start after for forward pagination. The value is provided in the pageInfo.endCursor field of the response. Cannot be used with before or last.

beforestringOptional

The cursor to start before for backward pagination. The value is provided in the pageInfo.startCursor field of the response. Cannot be used with after or size (first).

lastnumber · min: 1 · max: 250Optional

Number of items to return for backward pagination. Cannot be used with 'size' (first). Default: 20.

sizenumber · min: 1 · max: 250Optional

Number of items to return for forward pagination. Cannot be used with 'last'. Default: 20.

startAfterIdstringOptionalDeprecated

The ID to start after. Deprecated, use after with the value provided in pageInfo.endCursor instead.

Responses
chevron-right
200

Your search result

application/json

RoutingPlanPaginatedResult

totalnumberOptional

The total number of items matching the search criteria. Only filled, if withTotal is set to true in the search options.

post
/api/routingplans/search

List routing plans graphs

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
processRefstringOptional

Reference to the process you want to get the corresponding routing plans graph.

Responses
chevron-right
200

Routing plans graph was found & you were allowed to access it. The result is in the body.

application/json

A graph representation of the routing plans. The nodes are the routing plans and the edges are the rerouting reasons.

get
/api/routingplansgraph

Last updated