Geovisualization Developer's Guide

Download

The download response body is a JSON object returned by the Geovisualization REST API in response to a request for a dataset download progress status.

Table 1. Download Response Elements
Element Data Type Description
bytes_total Number The total number of bytes to be downloaded
bytes_transferred Number The number of bytes already transferred
created_at ISO Datetime The date and time at which the dataset was created, in ISO 8601 format with the Z indicating that the time is in UTC
dataset String The ID of the downloading dataset
id String The job ID of the running process
kind String Type of response: the value is datalens#download when the request is successful
status String The job status: one of running, error or aborted
updated_at ISO Datetime The date and time at which the dataset was last modified, in ISO 8601 format with the Z indicating that the time is in UTC

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

{
        "status": "running",
        "bytes_total": 190218152,
        "kind": "datalens#download",
        "bytes_transferred": 8633,
        "created_at": "2016-06-23T15:23:51Z",
        "updated_at": "2016-06-23T15:38:06Z",
        "dataset": "7238af9870754323bbe6fbed6796c3d9",
        "id": "6d24601c-a761-43fb-bd8e-f0f7b5d75d3f"
}