{"_id":"5b3f9e2f0c1d5b00036fe156","project":"55faeacad0e22017005b8265","version":{"_id":"55faeacad0e22017005b8268","project":"55faeacad0e22017005b8265","__v":37,"createdAt":"2015-09-17T16:31:06.800Z","releaseDate":"2015-09-17T16:31:06.800Z","categories":["55faeacbd0e22017005b8269","55faf550764f50210095078e","55faf5b5626c341700fd9e96","55faf8a7825d5f19001fa386","560052f91503430d007cc88f","560054f73aa0520d00da0b1a","56005aaf6932a00d00ba7c62","56005c273aa0520d00da0b3f","5601ae7681a9670d006d164d","5601ae926811d00d00ceb487","5601aeb064866b1900f4768d","5601aee850ee460d0002224c","5601afa02499c119000faf19","5601afd381a9670d006d1652","561d4c78281aec0d00eb27b6","561d588d8ca8b90d00210219","563a5f934cc3621900ac278c","5665c5763889610d0008a29e","566710a36819320d000c2e93","56ddf6df8a5ae10e008e3926","56e1c96b2506700e00de6e83","56e1ccc4e416450e00b9e48c","56e1ccdfe63f910e00e59870","56e1cd10bc46be0e002af26a","56e1cd21e416450e00b9e48e","56e3139a51857d0e008e77be","573b4f62ef164e2900a2b881","57c9d1335fd8ca0e006308ed","57e2bd9d1e7b7220000d7fa5","57f2b992ac30911900c7c2b6","58adb5c275df0f1b001ed59b","58c81b5c6dc7140f003c3c46","595412446ed4d9001b3e7b37","59e76ce41938310028037295","5a009de510890d001c2aabfe","5a96f89c89442e002041144b","5b3f9b7267cbc90003d283a5"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"v1","version_clean":"1.0.0","version":"1"},"category":{"_id":"5b3f9b7267cbc90003d283a5","project":"55faeacad0e22017005b8265","version":"55faeacad0e22017005b8268","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2018-07-06T16:40:18.797Z","from_sync":false,"order":20,"slug":"vector-tile-generation-and-export","title":"Vector Export Service"},"user":"56267741db1eda0d001c3dbb","__v":2,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-07-06T16:51:59.277Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"settings":"56e2c496d64add20007dceba","results":{"codes":[{"name":"","code":"{\n    \"request_id\": \"0e157a1a1434f000\",\n    \"parameters\": {\n        \"request_id\": \"0e157a1a1434f000\",\n        \"index\": \"read-vector-gbdx-*-catalog-v2-2*\",\n        \"request_type\": [\n            \"zip\"\n        ],\n        ...\n    },\n    \"state\": \"FINISHED\",\n    \"submitted_time\": \"2018-07-05T12:40:37.725Z\",\n    \"start_time\": \"2018-07-05T12:41:26.000Z\",\n    \"end_time\": \"2018-07-05T12:41:34.000Z\",\n    \"success\": true,\n    \"duration_seconds\": 8,\n    \"duration_str\": \"0:00:08\",\n    \"query_duration_seconds\": 3,\n    \"query_duration_str\": \"0:00:03\",\n    \"zip_duration_str\": \"0:00:00\",\n    \"zip_files\": [\n        \"000002.vectors.zip\",\n        \"000008.vectors.zip\",\n        \"000004.vectors.zip\",\n        \"000000.vectors.zip\",\n        \"000003.vectors.zip\",\n        \"000009.vectors.zip\",\n        \"000007.vectors.zip\",\n        \"000006.vectors.zip\",\n        \"000005.vectors.zip\",\n        \"000001.vectors.zip\"\n    ],\n    \"upload_duration_seconds\": 1,\n    \"upload_duration_str\": \"0:00:01\",\n    \"vectors_retrieved\": 10,\n    \"tileset_url\": \".../{z}/{x}/{y}.pbf\"\n}","language":"json","status":200}]},"method":"get","examples":{"codes":[{"code":"https://vector.geobigdata.io/insight-vector/api/export/0e157a1a1434f000/status","language":"json"},{"code":"Request:\n  GET /insight-vector/api/export/:request_id/status\n\nHeaders:\n  Authorization: Bearer {token}\n  \n\nResponse (success):\n  200 OK","language":"text"}]},"auth":"required","params":[{"_id":"56e31309cb6ef20e0084f252","ref":"","in":"path","required":true,"desc":"The Request ID generated on export, used to track export.","default":"","type":"string","name":"request_id"}],"url":"/insight-vector/api/export/:request_id/status"},"isReference":false,"order":5,"body":"**Fields in the response**\n\n- `request_id`: The client-provided string from the original tile generation request.\n\n- `state`: One of \"submitted\", \"running\", or \"finished\".\n\n- `start_time`: The ISO-8601-formatted string representing the date the tile generation process began.\n\n- `end_time`: The ISO-8601-formatted string representing the date the tile generation process completed.\n\n- `success`: A boolean reporting whether or not the tile generation process was successful.\n\n- `duration_seconds`: The number of seconds passed from start to finish for the entire process.\n\n- `duration_str`: The hour:minute:seconds string representation of the duration.\n\n- `query_duration_seconds`: The number of seconds passed from the start of the data-retrieval phase to the end of the data-retrieval phase.\n\n- `query_duration_str`: The hour:minute:seconds string representation of the data-retrieval duration.\n\n- `vectors_retrieved`: The number of features retrieved from the vector indexes.\n\n- `retrieval_errors`: Any errors reported by the data retrieval process.\n\n- `tiler`: Provides the output of the tiling process and whether or not it completed successfully.  Note, for large data sets, this output field can be extremely long.\n\n- `tiler_duration_seconds`: The number of seconds passed from the start of the tiling process to the end of the tiling process.\n\n- `tiler_duration_str`: The hour:minute:seconds string representation of the tiler duration.\n\n- `upload_duration_seconds`: The number of seconds passed from the start of the tile upload process to the end of the tile upload process.\n\n- `upload_duration_str`: The hour:minute:seconds string representation of the upload duration.\n\n- `upload_errors`: Any errors reported by the tile upload process.\n\n- `tileset_url`: The URL template which can be used to retrieve tiles in JS libraries like mapbox-gl and Leaflet","excerpt":"The Retrieve Vector API is used to retrieve an item from the vector index by ID.","slug":"view-export-status","type":"endpoint","title":"View Export Status"}

getView Export Status

The Retrieve Vector API is used to retrieve an item from the vector index by ID.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

request_id:
required
string
The Request ID generated on export, used to track export.

Examples


Result Format


Documentation

**Fields in the response** - `request_id`: The client-provided string from the original tile generation request. - `state`: One of "submitted", "running", or "finished". - `start_time`: The ISO-8601-formatted string representing the date the tile generation process began. - `end_time`: The ISO-8601-formatted string representing the date the tile generation process completed. - `success`: A boolean reporting whether or not the tile generation process was successful. - `duration_seconds`: The number of seconds passed from start to finish for the entire process. - `duration_str`: The hour:minute:seconds string representation of the duration. - `query_duration_seconds`: The number of seconds passed from the start of the data-retrieval phase to the end of the data-retrieval phase. - `query_duration_str`: The hour:minute:seconds string representation of the data-retrieval duration. - `vectors_retrieved`: The number of features retrieved from the vector indexes. - `retrieval_errors`: Any errors reported by the data retrieval process. - `tiler`: Provides the output of the tiling process and whether or not it completed successfully. Note, for large data sets, this output field can be extremely long. - `tiler_duration_seconds`: The number of seconds passed from the start of the tiling process to the end of the tiling process. - `tiler_duration_str`: The hour:minute:seconds string representation of the tiler duration. - `upload_duration_seconds`: The number of seconds passed from the start of the tile upload process to the end of the tile upload process. - `upload_duration_str`: The hour:minute:seconds string representation of the upload duration. - `upload_errors`: Any errors reported by the tile upload process. - `tileset_url`: The URL template which can be used to retrieve tiles in JS libraries like mapbox-gl and Leaflet

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}