API

API description

The API is implemented as a long poll API.

api/v1/asynchronous/request

returns an object with an job id:

{"scenario": [[job_id]]}

post the job id object to

api/v1/asynchronous/status

returns:

{"status": [["waiting" | "running" | "finished" | "not found"]], "complete": [[integer]]}

"complete" shows the progress in percent.

{"status": "running", "complete": 100}

is not sufficient. please wait for

{"status": "finished", "complete": 100}

post the job id object to:

api/v1/asynchronous/result

returns:

{"scenario": {...},
 "config_expanded": {...},
 "creation time": "..."}