Processes

Create a new process

Starts a process. `cache` recalculates reports asynchronously: the request records the process and queues the recompute; the process `code` stays empty until the recompute finishes, then becomes `0` (success) or `3` (failure) together with `time` and `version`. Only one `cache` process can be queued or running at a time; another request meanwhile gets `409`.

POST
/processes

Authorization

appToken write
AuthorizationBearer <token>

App access token issued by POST /tokens (client credentials). Full-access Apps hold the read and write scopes, read-only Apps hold read only. Send it as Authorization: Bearer <token>.

In: header

Scope: write

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/processes" \  -H "Content-Type: application/json" \  -d '{}'
{  "processId": "string",  "pid": 0,  "name": "string",  "arguments": "string",  "messages": 0,  "memory": 0,  "time": 0,  "code": 0,  "version": "string",  "createTime": "2019-08-24T14:15:22Z",  "updateTime": "2019-08-24T14:15:22Z"}
{  "message": "string",  "code": "string",  "errors": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "details": [    {      "field": "string",      "issue": "string"    }  ]}
{  "message": "string",  "code": "string",  "errors": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "details": [    {      "field": "string",      "issue": "string"    }  ]}
{  "error": {    "message": "This App is read-only and cannot perform this operation.",    "code": "insufficient_scope"  }}
{  "error": {    "message": "A reports recalculation is already queued or running. Wait for it to finish before starting another one.",    "code": "reports_recalculation_in_progress"  }}
{  "message": "string",  "code": "string",  "errors": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "details": [    {      "field": "string",      "issue": "string"    }  ]}
{  "message": "string",  "code": "string",  "errors": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "details": [    {      "field": "string",      "issue": "string"    }  ]}