Geovisualization 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 are therefore exposed asynchronously by the Geovisualization 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 you can fetch. You can also cancel jobs.

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

Table 1. Jobs Endpoints
Endpoint Description Method Response
/jobs Fetch all jobs created by the current user in descending date order. By default only the last 30 jobs are returned. GET 200 OK if successful with a response objects containing a list of jobs.
/jobs?limit={value} Fetch the specified number of jobs created by the current user in descending date order. GET 200 OK if successful with a response object containing a list of jobs reflecting the filter criteria.
/jobs?dataset={DATASET_ID}&status=<status> Fetch all jobs that match the dataset IDs or statuses you specify in the URL. These can be multiple combined values.

Valid values for status are pending, running, canceling, canceled, completed, aborted, failed

GET 200 OK if successful with a response body containing a list of jobs matching the filters set in the URL.
/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.