Create matching job

Purpose

Submit a new matching job to process your uploaded data and align it with GERS identifiers.

Request data

HTTP method: POST

  • 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

post
URL format
https://api.tomtom.com/maps/orbis/platform/gem/jobs

URL example

post
URL example
https://api.tomtom.com/maps/orbis/platform/gem/jobs

curl command example

post
curl command example
1curl -X POST "https://api.tomtom.com/maps/orbis/platform/gem/jobs" \
2 -H "tomtom-api-key: YOUR_API_KEY" \
3 -H "Authorization: Bearer YOUR_AUTH_TOKEN" \
4 -H "Content-Type: application/json" \
5 -H "X-Version: 1" \
6 -d '{
7 "storageId": "storage-001",
8 "inputFileName": "your_data.parquet",
9 "matchingType": "road"
10 }'

Request headers

HeaderRequiredDescription
tomtom-api-keyYesYour TomTom API key
AuthorizationYesBearer token from Azure CLI
Content-TypeYesMust be application/json
X-VersionYesAPI version (use 1)

Request body

1{
2 "storageId": "storage-001",
3 "inputFileName": "your_data.parquet",
4 "matchingType": "road"
5}

Request body parameters

ParameterTypeRequiredDescription
storageIdstringYesID of the storage containing your data
inputFileNamestringYesName of the uploaded Parquet file (including .parquet extension)
matchingTypestringYesType of matching to perform (currently only road)
overtureReleasestringNoOverture Maps release version (defaults to latest)

Response data

Response example

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": "queued",
8 "createdAt": "2026-01-26T10:30:00Z"
9}

Response fields

FieldTypeDescription
jobRunIdstringUnique identifier for the job
storageIdstringStorage where input/output files are located
inputFileNamestringName of the input file
matchingTypestringType of matching performed
overtureReleasestringOverture Maps release version used
statusstringCurrent job status (queued)
createdAtstringISO 8601 timestamp of job creation

Error responses

HTTP StatusErrorCauseSolution
400Bad RequestInvalid request bodyCheck JSON format and required fields
401UnauthorizedInvalid credentialsRefresh API key or token
404Not FoundStorage not foundVerify storage ID
422Unprocessable EntityInvalid parametersCheck input file name and matching type