Data Lens Developer's Guide

Jobs

Use this resource to retrieve a job status or cancel a job.

The following operations on datasets can take a considerable amount of time, and they are therefore exposed asynchronously by the Data Lens REST API:

  • ingestion of a data file via a URL
  • ingestion of a data folder by SFTP, for datasets or layers
  • geocoding
  • georeferencing

Each of these processes creates a job object whose status can be fetched. Jobs can also be canceled.

The table below summarizes the available endpoints supported by the jobs resource along with their HTTP methods and responses.

Table 1. Jobs Endpoints
Endpoint Description Method Response
/jobs/<job_id> Fetch a job's status. You can check the status of the following types of job: geocoding, georeferencing, data import by URL, data import by SFTP, layer import by SFTP. GET 200 OK if successful and a response object for the job status
Cancel a job. Note that data import by SFTP jobs cannot be canceled. DELETE 200 OK if successful and a response object for the job status

Request Parameters

The table below documents the mandatory request parameters required by this resource.

Note: All the parameters below are required for authentication. For more information about authentication and authorization in general, see the authentication related topics under Getting Started.
Table 2. Request Parameters
Parameter Datatype Description
app_id String A 20-byte Base64 URL-safe encoded string used for the authentication of the client application
app_code String A 20-byte Base64 URL-safe encoded string used for the authentication of the client application
access_token String A temporary string used for authentication. Tokens are valid for one hour.

We recommend that the token be included in the HTTP Header when sending requests. For more information on setting up the access_token in the HTTP Header, see Authentication with Postman.

You cannot use this account to purchase a commercial plan on Developer Portal, as it is already associated to plans with different payment methods.

To purchase a commercial plan on Developer Portal, please register for or sign in with a different HERE Account.

Something took longer than expected.

The project should be available soon under your projects page.

Sorry, our services are not available in this region.

Something seems to have gone wrong. Please try again later.

We've detected that your account is set to Australian Dollars (AUD).
Unfortunately, we do not offer checkouts in AUD anymore.
You can continue using your current plan as normal, but to subscribe to one of our new plans,
please register for a new HERE account or contact us for billing questions on selfservesupport@here.com.