Get job details

Purpose

Retrieve detailed information about a specific matching job, including its current status, progress, and results.

Request data

HTTP method: GET

• Constants and parameters enclosed in curly brackets {} must be replaced with their values.
• See the following Request parameters section with the required and optional parameters tables for these values.

URL format

https://api.tomtom.com/maps/orbis/platform/gem/jobs/{jobRunId}

URL example

https://api.tomtom.com/maps/orbis/platform/gem/jobs/job-abc123-def456

curl command example

1curl -X GET "https://api.tomtom.com/maps/orbis/platform/gem/jobs/job-abc123-def456" \
2  -H "tomtom-api-key: YOUR_API_KEY" \
3  -H "Authorization: Bearer YOUR_AUTH_TOKEN" \
4  -H "X-Version: 1"

Request headers

Request parameters

Response data

Response example (completed job)

1{
2  "jobRunId": "job-abc123-def456",
3  "storageId": "storage-001",
4  "inputFileName": "your_data.parquet",
5  "outputFileName": "your_data_matched.parquet",
6  "matchingType": "road",
7  "overtureRelease": "<latest-overture-release>",
8  "status": "finished",
9  "createdAt": "2026-01-20T10:00:00Z",
10  "modifiedAt": "2026-01-20T10:25:00Z",
11  "statistics": {
12    "totalRecords": 50000,
13    "matchedRecords": 47500,
14    "unmatchedRecords": 2500,
15    "matchRate": 95.0
16  }
17}

Response example (running job)

1{
2  "jobRunId": "job-abc123-def456",
3  "storageId": "storage-001",
4  "inputFileName": "your_data.parquet",
5  "matchingType": "road",
6  "overtureRelease": "<latest-overture-release>",
7  "status": "running",
8  "progress": 65,
9  "createdAt": "2026-01-20T10:00:00Z",
10  "modifiedAt": "2026-01-20T10:15:00Z"
11}

Response fields

Job status values

Output file

When a job completes successfully, the output file is available in your storage location. The output filename follows this pattern:

{original_filename}_matched.parquet

For example, if you submitted roads_data.parquet, the output file will be roads_data_matched.parquet.

Output file structure

The output Parquet file contains all original columns plus additional columns with GERS matching results:

Error responses