POST /v2/run/url
This API asynchronously runs a map or flow whose package has been started.
The result contains an href that gives information on the status of the run when a GET request is sent to it and an id for a run instance which can be used with the map and flow instance APIs defined in this table:
Map and flow APIs | Description |
---|---|
GET /v2/instances/{id} | Get the status of an asynchronous map or flow run. The id is the one returned from running a map or flow asynchronously. |
DELETE /v2/instances/{id} | Delete the instance of an asynchronous map or flow run, these instances will persist until this API is invoked. The id is the one returned from running a map or flow asynchronously |
GET /v2/instances/{id}/outputs/{output_number} | Get the data for an output card or output flow terminal of an asynchronous map or flow run. The id is the one returned from running a map or flow asynchronously, and the ouput_number is the number of the output to get the data for. |
/v2/instances/{id}/log | Get the log of an asynchronous map or flow run. The id is the one returned from running a map or flow asynchronously |
/v2/instances/{id}/trace | Get the trace of an asynchronous map run. The id is the one returned from running a map asynchronously |
It is important to note that status and log can also be specified as values for the return query parameter for both maps and flows, which return a status message about the run and the audit for a map, respectively.
For a flow, status and log both return a status message, but with log specified, that status message contains the flow audit. Maps can also use the value trace which returns the map trace. Multiple values for the return parameter can be specified at the same time.
Each REST input and output for maps or flow input and output terminal for flows, can be overridden by specifying the input and output query parameters. The accepted values for these parameters are in the form <card/terminal-number>;<adapter-name>;<adapter-cmd>. Multiple overrides can be provided by separating each with a comma.