Cancel matching job
Request accessPurpose
Cancel a matching job that has not finished yet. Only jobs with status REQUESTED or IN_PROGRESS can be canceled.
Request data
HTTP method: PATCH
- Constants and parameters enclosed in curly brackets
{}must be replaced with their values. - See the following Path parameters and Request body sections with the required and optional parameters tables for these values.
URL format
patch
URL format
https://api.tomtom.com/maps/orbis/platform/gem/jobs/{job_id}URL example
patch
URL example
https://api.tomtom.com/maps/orbis/platform/gem/jobs/123456789curl command example
patch
curl command example
curl -X PATCH "https://api.tomtom.com/maps/orbis/platform/gem/jobs/123456789" \ -H "tomtom-api-key: YOUR_API_KEY" \ -H "Authorization: Bearer YOUR_AUTH_TOKEN" \ -H "Content-Type: application/json" \ -d '{ "action": "CANCEL" }'Request headers
| Header | Required | Description |
|---|---|---|
tomtom-api-key | Yes | Your TomTom API key |
Authorization | Yes | Bearer token from Azure CLI |
Content-Type | Yes | Must be application/json |
Path parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
job_id | integer | Yes | The unique identifier of the job |
Request body
{ "action": "CANCEL"}Request body parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
action | string | Yes | Action to perform on the job. Supported value: CANCEL |
Response data
The request is accepted with HTTP status 202 and the endpoint returns the job details with status CANCELED. Canceling a job that was already canceled has no effect and returns the job details unchanged.
Response example
{ "job_type": "ROAD_MATCHING", "overture_release": "2026-01-21.0", "input_filename": "test_data.parquet", "job_id": 123456789, "requested_at": "2026-02-18T10:38:59.031762Z", "result_filename": null, "statistics": null, "error_messages": null, "status": "CANCELED", "storage_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479"}Response fields
| Field | Type | Description |
|---|---|---|
job_id | integer (int64) | Unique identifier for the job |
storage_id | string (uuid) | Storage where input/output files are located |
input_filename | string | Name of the input file |
result_filename | string | Name of the output file. null until status is SUCCESS |
job_type | string | Type of matching performed |
overture_release | string | Overture Maps release version for ROAD_MATCHING jobs, see Releases |
status | string | Current job status. CANCELED after a successful cancellation |
requested_at | string | ISO 8601 timestamp of job creation |
statistics | object | Matching statistics. null unless status is SUCCESS |
error_messages | string[] | List of error messages describing why the job failed. null unless status is FAILED |
Error responses
| HTTP Status | Error | Cause | Solution |
|---|---|---|---|
| 400 | Bad Request | Invalid request body or unsupported action | Use {"action": "CANCEL"} as the request body |
| 401 | Unauthorized | Invalid credentials | Refresh API key or token |
| 404 | Not Found | Job not found | Verify job ID |
| 409 | Conflict | Job already finished (SUCCESS or FAILED) and cannot be canceled | Only jobs with status REQUESTED or IN_PROGRESS can be canceled |
| 500 | Internal Server Error | Server-side issue | Retry the request |