Close Data

Description

Retire an existing job and store any pending results.

Definition

http://localhost:8080/engine/v2/data/<jobId>/close
jobId:The identifier of the job to be retired.

Method

POST

Returns

Status code 200 (Ok). This command should also change the job’s status to CLOSED.

Errors

See the Error Codes documentation for the full list of errors that may be returned by the API.

EXAMPLE RESPONSE

For example, using the cURL command line client, the command to close the job is:

curl -X POST http://localhost:8080/engine/v2/data/<jobId>/close

If successful the API acknowledges the close action:

{
  "acknowledged":true
}

Note

The job should not be explicitly closed if more data for analysis is expected to arrive soon. It is possible to make multiple POSTs to the same job whilst it is running.