Starts a new long-running job
Request
POST https://www.activityinfo.org/resources/jobs
Request body
application/json
| object | |||
| descriptor | object | required | |
| locale | string | required | |
Successful response
application/json
| object | |||
| id | string | The job's id | required |
| userId | string | The id of the user who started the job | required |
| descriptor | object | The job descriptor used to start this job | required |
| state | string | The job's current stateValues:
|
required |
| jobResult | object | required | |
| filename | string | The filename of the export. | required |
| downloadUrl | string | The URL that can be used to download the result. | required |
| percentComplete | float | required | |
| error | object | If the job state is FAILED, the reason for the failure. | optional |
| code | string | required | |
| message | string | required | |
| localizedMessage | string | required | |
Error responses
| Status Code | Error Code | Description |
|---|---|---|
| 401 | AUTHENTICATION_ |
The request must be authenticated |