How to cancel a job

The user wants to stop a job and download the partial results. The lines that have been processed until the job was stopped will be charged.

The results processed until the job was stopped are available for download.

It is the customer's choice to delete right away. By stopping the job first, the results are available.

It is also possible to delete the job right away (see Delete a job). In this case it is not possible to download the results.

The lines that have been processed until deleted will still be charged.

Request

This PUT request stops a job based on the jobId from an earlier request. You need to use the jobId from your own request.

PUT https://batch.search.hereapi.com/v7/batch/jobs/<jobId>/stop

With cURL assuming jobId is in environment from earlier request. Variable YOUR_API_KEY has also to be set:

curl --request 'PUT' \
  "https://batch.search.hereapi.com/v7/batch/jobs/${jobId}/stop?apiKey=${YOUR_API_KEY}" \
  --header 'accept: application/json"

Response

{
  "id": "<jobId>",
  "serviceHrn": "hrn:here:service::olp-here:search-revgeocode-7",
  "billingTags": [],
  "status": "stopped",
  "href": "https://batch.search.hereapi.com/v7/batch/jobs/<jobId>"
}

Request

Response

Related information