Async
speccustomimplproposalThis helper building block provides async job operations to other building blocks. It cannot be configured and is automatically enabled when needed.
Scope
Operations
| Resource | Path | Methods | Media Types | Description |
|---|---|---|---|---|
Job Status | jobs/{jobId} | GET | HTML, JSON | Returns the status information of a specific job. |
Dismiss Job | jobs/{jobId} | DELETE | HTML, JSON | Dismiss a job. If the job is currently in the accepted or running state, it is cancelled. Then the job and its results are removed. The response is the status info of the dismissed job. |
Results (full) | jobs/{jobId}/results | GET | Any, JSON | Retrieve all requested job results. If the result of the job is a single document, e.g. the result of a search or of a transaction, it is returned in the media type in which it is stored, regardless of the Accept header; the parameter f is not supported. |
Results (specific) | jobs/{jobId}/results/{outputId} | GET | JSON | Retrieve a specific result from the requested job results |
Results (index) | jobs/{jobId}/results/{outputId}/{N} | GET | JSON | Retrieve the Nth value of a specific multivalued job result |
Path Parameters
| Name | Resources | Description |
|---|---|---|
jobId | jobs/{jobId}, jobs/{jobId}/results, jobs/{jobId}/results/{outputId}, jobs/{jobId}/results/{outputId}/{N} | The local identifier of a job, unique within the API. |
outputId | jobs/{jobId}/results/{outputId}, jobs/{jobId}/results/{outputId}/{N} | The identifier of a specific result of a job. For processes these are described in the outputs section of the executed process description. |
Index N | jobs/{jobId}/results/{outputId}/{N} | The zero-based index to access a value of a multi-valued result. |
Query Parameters
| Name | Resources | Description |
|---|---|---|
f | jobs/{jobId} | Select the output format of the response. If no value is provided, the standard HTTP rules apply, i.e., the "Accept" header will be used to determine the format. |
outputs | jobs/{jobId}/results | The outputs of the process that should be included in the results. The parameter value is a comma-separated list of output identifiers. By default, all outputs that were requested in the execute request are included. The parameter does not apply to a job whose result is a single document, e.g. the result of a search or of a transaction. |
Configuration
This building block has no configuration options.
This building block does not require or support any additional configuration files.