Geovisualization Developer's Guide

Job Status

The job status response body is a JSON object returned by the Geovisualization REST API in response to a request to determine the status of a job.

Table 1. Job Status Response Elements
Element Data Type Description
id String The unique job ID
kind String Type of response.

Possible values include:

  • datalens#geocode_job for geocoding jobs
  • datalens#georeference_job for georeferencing jobs
  • datalens#sftp_job for data upload (dataset or layer) by SFTP
  • datalens#download_job for data upload via URL
status String Status of the job.

Possible values include:

  • pending
  • running
  • canceling
  • canceled
  • completed
  • aborted
  • failed
created_at ISO Datetime Date and time the job was started, in ISO 8601 format, with the Z indicating that the time is in UTC
updated_at ISO Datetime Date and time the job was last modified, in ISO 8601 format, with the Z indicating that the time is in UTC
dataset_id String The unique dataset ID (if applicable) or None
layer_id String The unique layer ID (if applicable) or None

The code example below illustrates a typical response to a successful job status request.

{
      "id": "b791ae0a-1afe-44a8-949e-5b0e8318122e",
    "kind": "datalens#geocode_job",
    "status": "canceling",
    "created_at": "2015-06-23T16:52:46Z",
    "updated_at": "2015-06-23T16:52:46Z",
    "dataset_id": "87354ed28a66441385942f62e94282ea",
    "layer_id": "None"
      ...
}