{"_id":"56e1cb0fe416450e00b9e485","__v":5,"parentDoc":null,"project":"55faeacad0e22017005b8265","user":"56267741db1eda0d001c3dbb","version":{"_id":"55faeacad0e22017005b8268","project":"55faeacad0e22017005b8265","__v":33,"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"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"v1","version_clean":"1.0.0","version":"1"},"category":{"_id":"56e1ccdfe63f910e00e59870","version":"55faeacad0e22017005b8268","project":"55faeacad0e22017005b8265","__v":5,"pages":["56e311b0cb6ef20e0084f24b","56e312096e602e0e00700b2d","56e312bcd46bc30e007bb99a","56e31309cb6ef20e0084f250","56e31357cb6ef20e0084f254"],"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-03-10T19:37:03.043Z","from_sync":false,"order":18,"slug":"write-ingest-vector-services-guide","title":"Write & Ingest Vector Services Guide"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-03-10T19:29:19.996Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":false,"order":3,"body":"| Table of Contents |\n| --- |\n| [Write Vector Services API Parameters](#section-api-parameters) |\n| [Associated API Calls for Write Vector Services](#section-associated-api-calls-for-write-vector-services) |\n\nThese endpoints work in any application.\n\n#API Parameters#\n| Parameter | Data Type | Parameter Type | Description | Required? |\n| --- | --- | --- | --- | --- |\n| id | String | Query | The ID of the item. | Required; generated on vector item creation |\n| index | String | Query | The index to which items will be written/are stored. The index is generated during the POST call. Note: All indicies generated through the API will be of the format vector-{user defined index name} if using the asynchronous upload method. Users may define the index name via other methods as well, and it will follow the same vector-{user defined index name} format; if the index name is not specified by the user, the format will be vector-web-{geohash}. | Optional on creation, required after |\n| itemArray | String | Query | JSON array of items to write. Reference example in itemJson. | Required for multiple vector item ingest |\n| itemJson  | String | Query | GeoJSON of item to write. Example: ```{ \"type\": \"Feature\", \"geometry\": { \"type\": \"Point\", \"coordinates\": [1.0,1.0] }, \"properties\": { \"text\" : \"elementary school\", \"name\" : \"foo\", \"item_type\" : [“Building”,”School\"], \"ingest_source\" : \"REST API test source\", \"access\" : { \"users\" : [ \"_ALL_\" ], \"groups\" : [ \"_ALL_\" ] }, \"attributes\" : { \"latitude\" : 1, \"institute.founded\" : \"2015-07-17\", \"mascot \" : \"moth\" } } }``` | Required for single vector item ingest |\n\nIn order for all Vector Services and ESRI Vector Services APIs to retrieve the vectors generated through this API, GeoJSON must include the following:\n - Within the geometry: `coordinates` and `type`\n - Within the properties: `ingest_source`, `item_type`, and `text`\n\nThe index is generated one of two ways, depending on the API call used:\n - Via user input when using the asynchronous or other write API\n - Automatically chosen based on the coordinates given in the GeoJSON when using other write APIs when no index is specified\n\nSee [Vector Services Elasticsearch Index Name Templates](doc:vs-elasticsearch-index-name-templates) for information on user defined index name generation.\n\n#Associated API Calls for Write Vector Services#\n[Adding Multiple Vector Items](doc:adding-multiple-vectors-to-an-index)\n[Adding Single Vector Item](doc:adding-single-vector-to-an-index) \n[Batch Deleting Vectors via item ID](doc:batch-delete-vectors-via-item-id)\n[Deleting Single Vector Item](doc:deleting-a-vector-via-item-id)\n[Retrieving Single Vector Item](doc:retrieving-a-vector-via-item-id)\n[Updating Single Vector Item](doc:updating-a-vector-in-an-index)","excerpt":"Overview of the Generating Vectors API","slug":"vector-services-write-vectors-reference-overview","type":"basic","title":"Vector Services Write Vectors Reference Overview"}

Vector Services Write Vectors Reference Overview

Overview of the Generating Vectors API

| Table of Contents | | --- | | [Write Vector Services API Parameters](#section-api-parameters) | | [Associated API Calls for Write Vector Services](#section-associated-api-calls-for-write-vector-services) | These endpoints work in any application. #API Parameters# | Parameter | Data Type | Parameter Type | Description | Required? | | --- | --- | --- | --- | --- | | id | String | Query | The ID of the item. | Required; generated on vector item creation | | index | String | Query | The index to which items will be written/are stored. The index is generated during the POST call. Note: All indicies generated through the API will be of the format vector-{user defined index name} if using the asynchronous upload method. Users may define the index name via other methods as well, and it will follow the same vector-{user defined index name} format; if the index name is not specified by the user, the format will be vector-web-{geohash}. | Optional on creation, required after | | itemArray | String | Query | JSON array of items to write. Reference example in itemJson. | Required for multiple vector item ingest | | itemJson | String | Query | GeoJSON of item to write. Example: ```{ "type": "Feature", "geometry": { "type": "Point", "coordinates": [1.0,1.0] }, "properties": { "text" : "elementary school", "name" : "foo", "item_type" : [“Building”,”School"], "ingest_source" : "REST API test source", "access" : { "users" : [ "_ALL_" ], "groups" : [ "_ALL_" ] }, "attributes" : { "latitude" : 1, "institute.founded" : "2015-07-17", "mascot " : "moth" } } }``` | Required for single vector item ingest | In order for all Vector Services and ESRI Vector Services APIs to retrieve the vectors generated through this API, GeoJSON must include the following: - Within the geometry: `coordinates` and `type` - Within the properties: `ingest_source`, `item_type`, and `text` The index is generated one of two ways, depending on the API call used: - Via user input when using the asynchronous or other write API - Automatically chosen based on the coordinates given in the GeoJSON when using other write APIs when no index is specified See [Vector Services Elasticsearch Index Name Templates](doc:vs-elasticsearch-index-name-templates) for information on user defined index name generation. #Associated API Calls for Write Vector Services# [Adding Multiple Vector Items](doc:adding-multiple-vectors-to-an-index) [Adding Single Vector Item](doc:adding-single-vector-to-an-index) [Batch Deleting Vectors via item ID](doc:batch-delete-vectors-via-item-id) [Deleting Single Vector Item](doc:deleting-a-vector-via-item-id) [Retrieving Single Vector Item](doc:retrieving-a-vector-via-item-id) [Updating Single Vector Item](doc:updating-a-vector-in-an-index)