{"_id":"56e3086251857d0e008e778d","user":"562654b6f3adc80d0048611b","__v":1,"editedParams":true,"editedParams2":true,"version":{"_id":"55faeacad0e22017005b8268","project":"55faeacad0e22017005b8265","__v":32,"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"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"v1","version_clean":"1.0.0","version":"1"},"category":{"_id":"56e1c96b2506700e00de6e83","version":"55faeacad0e22017005b8268","__v":38,"pages":["56e1ca17cd6a8d0e00d12163","56e1cb0fe416450e00b9e485","56e1cba3cd6a8d0e00d1216c","56e1cc1ae63f910e00e5986b","56e1d0b0cd6a8d0e00d1217f","56e1d15ce416450e00b9e4a3","56e1d23292bf640e00b55663","56e1d296bc46be0e002af287","56e1d305cd6a8d0e00d1218c","56e1d373e416450e00b9e4ab","56e1d38a92bf640e00b55669","56e1d44dbc46be0e002af28e","56e2cb174cd67e220032d655","56e2cf9c1067950e006a16c8","56e2d5ff3987d729008695a0","56e2ddea8ffe6020004c53b2","56e2df768ffe6020004c53bd","56e2e1201067950e006a16f1","56e2e3888ffe6020004c53c5","56e2e53f1067950e006a1702","56e2e9773987d729008695cf","56e2ec731bffb72b00d0562e","56e2ed25b9c88f2900864aab","56e2f0314cd67e220032d6b9","56e2f3c43987d729008695ed","56e2fc3fb9c88f2900864ad7","56e2fe0d3987d7290086960b","56e30180f1ad030e00e72fa7","56e302c228f99e2000a5ffa6","56e3040c6e602e0e00700af6","56e304c5d46bc30e007bb958","56e30650d46bc30e007bb965","56e307456e602e0e00700b08","56e3086251857d0e008e778d","56e3096251857d0e008e7796","56e30a16d46bc30e007bb973","56e30aafd46bc30e007bb97c","56e30aeb51857d0e008e779f"],"project":"55faeacad0e22017005b8265","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-03-10T19:22:19.658Z","from_sync":false,"order":15,"slug":"read-query-vector-services-guide","title":"Read & Query Vector Services Guide"},"parentDoc":null,"project":"55faeacad0e22017005b8265","updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-03-11T18:03:14.355Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"","code":"[\n  {\n    \"properties\": {\n      \"source\": null,\n      \"name\": null,\n      \"access\": {\n        \"users\": [\n          \"_ALL_\"\n        ],\n        \"groups\": [\n          \"_ALL_\"\n        ]\n      }\n    },\n    \"type\": \"Feature\",\n    \"geometry\": {\n      \"type\": \"Polygon\",\n      \"coordinates\": [\n        [\n          [\n            33.91048206130908,\n            35.14200437885478\n          ],\n          [\n            33.91048206130908,\n            35.14290574111164\n          ],\n          [\n            33.91157939869091,\n            35.14290574111164\n          ],\n          [\n            33.91157939869091,\n            35.14200437885478\n          ],\n          [\n            33.91048206130908,\n            35.14200437885478\n          ]\n        ]\n      ]\n    }\n  },\n  {\n    \"properties\": {\n      \"source\": null,\n      \"name\": null,\n      \"access\": {\n        \"users\": [\n          \"_ALL_\"\n        ],\n        \"groups\": [\n          \"_ALL_\"\n        ]\n      }\n    },\n    \"type\": \"Feature\",\n    \"geometry\": {\n      \"type\": \"Polygon\",\n      \"coordinates\": [\n        [\n          [\n            33.18488840848069,\n            34.90559980126386\n          ],\n          [\n            33.18488840848069,\n            34.90650119870265\n          ],\n          [\n            33.185982591519306,\n            34.90650119870265\n          ],\n          [\n            33.185982591519306,\n            34.90559980126386\n          ],\n          [\n            33.18488840848069,\n            34.90559980126386\n          ]\n        ]\n      ]\n    }\n  },\n  {\n    \"properties\": {\n      \"source\": null,\n      \"name\": null,\n      \"access\": {\n        \"users\": [\n          \"_ALL_\"\n        ],\n        \"groups\": [\n          \"_ALL_\"\n        ]\n      }\n    },\n    \"type\": \"Feature\",\n    \"geometry\": {\n      \"type\": \"Polygon\",\n      \"coordinates\": [\n        [\n          [\n            35.82935881913493,\n            40.65127874092147\n          ],\n          [\n            35.82935881913493,\n            40.65217925904331\n          ],\n          [\n            35.83054118086507,\n            40.65217925904331\n          ],\n          [\n            35.83054118086507,\n            40.65127874092147\n          ],\n          [\n            35.82935881913493,\n            40.65127874092147\n          ]\n        ]\n      ]\n    }\n  },\n  {\n    \"properties\": {\n      \"source\": null,\n      \"name\": null,\n      \"access\": {\n        \"users\": [\n          \"_ALL_\"\n        ],\n        \"groups\": [\n          \"_ALL_\"\n        ]\n      }\n    },\n    \"type\": \"Feature\",\n    \"geometry\": {\n      \"type\": \"Polygon\",\n      \"coordinates\": [\n        [\n          [\n            35.320738275913264,\n            36.99954945878385\n          ],\n          [\n            35.320738275913264,\n            37.00045054118187\n          ],\n          [\n            35.32186172408674,\n            37.00045054118187\n          ],\n          [\n            35.32186172408674,\n            36.99954945878385\n          ],\n          [\n            35.320738275913264,\n            36.99954945878385\n          ]\n        ]\n      ]\n    }\n  },\n  {\n    \"properties\": {\n      \"source\": null,\n      \"name\": null,\n      \"access\": {\n        \"users\": [\n          \"_ALL_\"\n        ],\n        \"groups\": [\n          \"_ALL_\"\n        ]\n      }\n    },\n    \"type\": \"Feature\",\n    \"geometry\": {\n      \"type\": \"Polygon\",\n      \"coordinates\": [\n        [\n          [\n            32.81177323539601,\n            39.910651683104504\n          ],\n          [\n            32.81177323539601,\n            39.91155231686043\n          ],\n          [\n            32.812942764604,\n            39.91155231686043\n          ],\n          [\n            32.812942764604,\n            39.910651683104504\n          ],\n          [\n            32.81177323539601,\n            39.910651683104504\n          ]\n        ]\n      ]\n    }\n  },\n  {\n    \"properties\": {\n      \"source\": null,\n      \"name\": null,\n      \"access\": {\n        \"users\": [\n          \"_ALL_\"\n        ],\n        \"groups\": [\n          \"_ALL_\"\n        ]\n      }\n    },\n    \"type\": \"Feature\",\n    \"geometry\": {\n      \"type\": \"Polygon\",\n      \"coordinates\": [\n        [\n          [\n            32.608527834548056,\n            39.957736686772684\n          ],\n          [\n            32.608527834548056,\n            39.95863731319223\n          ],\n          [\n            32.609698165451945,\n            39.95863731319223\n          ],\n          [\n            32.609698165451945,\n            39.957736686772684\n          ],\n          [\n            32.608527834548056,\n            39.957736686772684\n          ]\n        ]\n      ]\n    }\n  },\n  {\n    \"properties\": {\n      \"source\": null,\n      \"name\": null,\n      \"access\": {\n        \"users\": [\n          \"_ALL_\"\n        ],\n        \"groups\": [\n          \"_ALL_\"\n        ]\n      }\n    },\n    \"type\": \"Feature\",\n    \"geometry\": {\n      \"type\": \"Polygon\",\n      \"coordinates\": [\n        [\n          [\n            32.608527834548056,\n            39.957736686772684\n          ],\n          [\n            32.608527834548056,\n            39.95863731319223\n          ],\n          [\n            32.609698165451945,\n            39.95863731319223\n          ],\n          [\n            32.609698165451945,\n            39.957736686772684\n          ],\n          [\n            32.608527834548056,\n            39.957736686772684\n          ]\n        ]\n      ]\n    }\n  },\n  {\n    \"properties\": {\n      \"source\": null,\n      \"name\": null,\n      \"access\": {\n        \"users\": [\n          \"_ALL_\"\n        ],\n        \"groups\": [\n          \"_ALL_\"\n        ]\n      }\n    },\n    \"type\": \"Feature\",\n    \"geometry\": {\n      \"type\": \"Polygon\",\n      \"coordinates\": [\n        [\n          [\n            32.81779692343018,\n            39.88852618138116\n          ],\n          [\n            32.81779692343018,\n            39.88942681858378\n          ],\n          [\n            32.81896607656982,\n            39.88942681858378\n          ],\n          [\n            32.81896607656982,\n            39.88852618138116\n          ],\n          [\n            32.81779692343018,\n            39.88852618138116\n          ]\n        ]\n      ]\n    }\n  },\n  {\n    \"properties\": {\n      \"source\": null,\n      \"name\": null,\n      \"access\": {\n        \"users\": [\n          \"_ALL_\"\n        ],\n        \"groups\": [\n          \"_ALL_\"\n        ]\n      }\n    },\n    \"type\": \"Feature\",\n    \"geometry\": {\n      \"type\": \"Polygon\",\n      \"coordinates\": [\n        [\n          [\n            32.74795460155804,\n            39.86754367974708\n          ],\n          [\n            32.74795460155804,\n            39.86844432021787\n          ],\n          [\n            32.74912339844197,\n            39.86844432021787\n          ],\n          [\n            32.74912339844197,\n            39.86754367974708\n          ],\n          [\n            32.74795460155804,\n            39.86754367974708\n          ]\n        ]\n      ]\n    }\n  },\n  {\n    \"properties\": {\n      \"source\": null,\n      \"name\": null,\n      \"access\": {\n        \"users\": [\n          \"_ALL_\"\n        ],\n        \"groups\": [\n          \"_ALL_\"\n        ]\n      }\n    },\n    \"type\": \"Feature\",\n    \"geometry\": {\n      \"type\": \"Polygon\",\n      \"coordinates\": [\n        [\n          [\n            36.17231696581786,\n            36.21086739901879\n          ],\n          [\n            36.17231696581786,\n            36.21176860094719\n          ],\n          [\n            36.173429034182156,\n            36.21176860094719\n          ],\n          [\n            36.173429034182156,\n            36.21086739901879\n          ],\n          [\n            36.17231696581786,\n            36.21086739901879\n          ]\n        ]\n      ]\n    }\n  }\n]","language":"json","status":200}]},"settings":"56e2c496d64add20007dceba","examples":{"codes":[{"code":"https://vector.geobigdata.io/insight-vector/api/vectors/query/items/name%2Csource?q=building&left=32.3964&right=37.2633&upper=42.631&lower=34.7208&count=100","language":"http"}]},"method":"get","auth":"required","params":[{"_id":"56e6ca41145b943600c939dd","ref":"","in":"path","required":true,"desc":"A comma-delimited list of fields to include. Example: item_date,source,item_type","default":"name%2Csource","type":"string","name":"fields"},{"_id":"56e6ca41145b943600c939dc","ref":"","in":"path","required":true,"desc":"The Elasticsearch query string to constrain the document set.","default":"building","type":"string","name":"q"},{"_id":"56e6ca41145b943600c939db","ref":"","in":"path","required":true,"desc":"Longitude in decimal degrees of the lower left bounding box corner","default":"32.3964","type":"string","name":"left"},{"_id":"56e6ca41145b943600c939da","ref":"","in":"path","required":true,"desc":"Longitude in decimal degrees of the upper right bounding box corner","default":"37.2633","type":"string","name":"right"},{"_id":"56e6ca41145b943600c939d9","ref":"","in":"path","required":true,"desc":"Latitude in decimal degrees of the upper right bounding box corner","default":"42.631","type":"string","name":"upper"},{"_id":"56e6ca41145b943600c939d8","ref":"","in":"path","required":true,"desc":"Latitude in decimal degrees of the lower left bounding box corner","default":"34.7208","type":"string","name":"lower"},{"_id":"56e6ca41145b943600c939d7","ref":"","in":"path","required":false,"desc":"The number of records to return per shard per page request.","default":"10","type":"int","name":"count"}],"url":"/insight-vector/api/vectors/query/items/:fields?q=:q&left=:left&right=:right&upper=:upper&lower=:lower&count=:count"},"isReference":false,"order":16,"body":"","excerpt":"The List Vector Items via Query Selected Fields API is used to retrieve only the specified fields associated with the available vector items for a given query, ingestion source, geometry, vector type, and bounding box.\nNote: Geometry is returned by default, no matter what fields are selected.\nNote: Fields can be discovered using [Facets List call](doc:facets-fields).","slug":"vs-query-list-vector-items-returns-selected-fields","type":"endpoint","title":"Query: List Vector Items (Returns Selected Fields)"}

getQuery: List Vector Items (Returns Selected Fields)

The List Vector Items via Query Selected Fields API is used to retrieve only the specified fields associated with the available vector items for a given query, ingestion source, geometry, vector type, and bounding box. Note: Geometry is returned by default, no matter what fields are selected. Note: Fields can be discovered using [Facets List call](doc:facets-fields).

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

fields:
required
stringname%2Csource
A comma-delimited list of fields to include. Example: item_date,source,item_type
q:
required
stringbuilding
The Elasticsearch query string to constrain the document set.
left:
required
string32.3964
Longitude in decimal degrees of the lower left bounding box corner
right:
required
string37.2633
Longitude in decimal degrees of the upper right bounding box corner
upper:
required
string42.631
Latitude in decimal degrees of the upper right bounding box corner
lower:
required
string34.7208
Latitude in decimal degrees of the lower left bounding box corner
count:
integer10
The number of records to return per shard per page request.

Examples


Result Format


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 }}