waitForRoutingTaskResult

post

https://rz3.aeb.de/demo1routing/rest/RoutingBFBean/waitForRoutingTaskResult

Waits for the task calculation to finish and returns a sorted list of proposals for the provided task id and its current calculation state.

If the calculation takes longer than the set waiting time limit, the list of proposals will be returned in its current unfinished calculation state as soon as the limit is reached.

The final list of proposals is ranked according to a rating profile. A rating profile uses supplements for score calculation and ranking.

Possible states of calculation are:
- INPROGRESS: entries (and ordering) might change in future calls.
- RANKED: ordering and entries fixed, at least one supplement missing.
- COMPLETE: ordering and entries fixed, all supplements are calculated.

A new routing task can be created by using createRoutingTask(CreateRoutingTaskRequestDTO).

Body Params

clientSystemId

string

Id of the sending client system.

e.g. Installation ID of the sending host or ERP system.

Maximum length: 20

clientIdentCode

string

Client identification code.

Maximum length: 10

userName

string

User who initiated the request from the client system.

If the user is found either in the system's user management or in a connected LDAP directory, the request runs under this user's roles.

If the user is not found, the request is only granted the basic 'I_EVERYONE' role. The user name may be used for logging purposes in this case.

Actual authentication is handled separately via the request's headers, so no password is required in the request's data.

resultLanguageIsoCodes

array of strings

2-letter ISO codes of the languages in which texts will be returned.

English ('en') and German ('de') are typically supported by default. Other languages may be supported.

Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.

resultLanguageIsoCodes

taskId

string

required

The task id is a unique value that was generated for requesting the results of the according routing task. It is returned when the the routing task is created.

length=50

waitingTimeoutInSeconds

int32

required

Waiting timeout in seconds.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Response

defaultdefault response