Job
A job is a request against the HERE Batch API v7 resource /jobs. A job consists of records.
Each record represents a single call to a backend API and includes a set of input parameters.
HERE Batch API v7 supports multiple backend APIs: geocode, reverse geocode, and lookup.
Each job must contain records for only one backend API; mixing APIs in a single job isn't supported because each service uses different input and output formats.
Use a column-oriented format for input. Each line represents one record, which corresponds to a single call to the backend API.
Provide the header line either as a query parameter (inputColumns) or as the first line of the request body. If both are provided,
the service uses the query parameter.
Each output line corresponds to one object in the backend API response. The line includes the record id (recid) to link it to the input,
a sequence number (seqNumber) that indexes the returned objects for the request, and the total number of returned objects (seqLength).
and the number of objects that have been returned for each request (seqLength).
Note
At the moment, there is no sequence number or sequence length for Lookup-By-ID as both would always be 1
A batch geocoding job requires input data, which is a collection of street addresses to be converted to geographic coordinates.
The input data for a batch reverse geoocoding job is a set of locations that must be converted to street addresses. The locations are captured as pairs of geographic coordinates, latitude and longitude.
Lookup jobs are used, if the Geocoder id of an object is known. This id is the only required input. (See also Input data and related Geocoder documentation).
The API supports requests that allow you to monitor the status of a job (see Job status) and to retrieve the output when a job is completed (see Reading batch request output) and a report about errors (see Reading batch request errors).
In addition to the API endpoints to 'pull' the status of a job, notifications can be used to 'push' the information of a status update from a job.
To create a job, send a POST request to /jobs. The response doesn't include the result immediately, but it does return a jobId, among other fields.
You can use this jobId to check the job status and, once completed, retrieve the results and any errors.
Additional endpoints are available to start, stop, delete, or list jobs.
Related information
Updated this month