{"__v":0,"_id":"54db9d9bc6a4d40d0034b97b","category":{"__v":7,"_id":"54fdad6e660db63700c23b82","pages":["55fbef82af72eb0d0007df93","55fbf623e013770d008fcba8","5617bd3a26e3db230054fba4","5617c4a6f8c9632100ac74f5","561ed6fd0a04340d00d8a0b0","562156adf4e0352100cbf268","562a5c846049f20d0032520b"],"project":"54d0fd1d095c470d00d1646d","version":"54d0fd1e095c470d00d16470","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-03-09T14:25:50.133Z","from_sync":false,"order":2,"slug":"api-reference","title":"API Reference"},"editedParams":true,"editedParams2":true,"project":"54d0fd1d095c470d00d1646d","user":"54db5301eb78f13900cf108b","version":{"__v":20,"_id":"54d0fd1e095c470d00d16470","project":"54d0fd1d095c470d00d1646d","createdAt":"2015-02-03T16:53:50.090Z","releaseDate":"2015-02-03T16:53:50.090Z","categories":["54d0fd1e095c470d00d16471","54d8b5e68934140d00496544","54db6361c6a4d40d0034b8f7","54db638208ea010d00ab1fdd","54db639008ea010d00ab1fde","54db6547c6a4d40d0034b8fd","54db83482092743700ea6ee1","54db84afc6a4d40d0034b93c","54db8805c6a4d40d0034b93f","54db8de9c6a4d40d0034b961","54db931ac6a4d40d0034b96d","54e49219e4365521006fd9ee","54e74fcc652d7c1900cbe737","54e74ffd3c1e111700d05762","54e77e0a523b1b2f00e6f313","54e784affdabe62500fcddcf","54e784fa523b1b2f00e6f319","54e785de8ae8911900cd42c5","54fdad6e660db63700c23b82","54fdff31f7b1202100a25e06"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-02-11T18:21:15.285Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"","code":"{\n  \"id\": \"80099356-0a2a-4f58-8b0b-44c6ab732798\",\n  \"name\": \"thematic_map_1\",\n  \"description\": \"My first thematic map UPDATE!\",\n  \"database\": \"db1\",\n  \"column\": \"tax_collection\",\n  \"legend\": {\n      \"0\": {\n          \"color\": \"#0571B0\",\n          \"min\": \"250000\",\n          \"max\": \"500000\"\n      },\n      \"1\": {\n          \"color\": \"#92C5DE\",\n          \"min\": \"650000\",\n          \"max\": \"750000\"\n      },\n                        .\n                        .\n                        .","language":"json","status":200}]},"auth":"required","params":[{"_id":"54db8b9e9f8ef11900f4df35","ref":"","in":"path","required":true,"desc":"Database name.","default":"","type":"string","name":"database_name"},{"_id":"54db8b9e9f8ef11900f4df34","ref":"","in":"path","required":true,"desc":"Collection name.","default":"","type":"string","name":"collection_name"},{"_id":"54db8b9e9f8ef11900f4df33","ref":"","in":"body","required":true,"desc":"Your mapkey.","default":"","type":"string","name":"mapkey"},{"_id":"54db8b9e9f8ef11900f4df32","ref":"","in":"path","required":true,"desc":"Thematic map name or id.","default":"","type":"string","name":"thematic_name_or_id"},{"_id":"54db9d9bc6a4d40d0034b981","ref":"","in":"body","required":true,"desc":"Column to create a thematic map.","default":"","type":"string","name":"column"},{"_id":"54db9d9bc6a4d40d0034b980","ref":"","in":"body","required":false,"desc":"The number of intervals size the thematic map (min_size: 3, max_size: 11).","default":"5","type":"int","name":"intervals"},{"_id":"54db9d9bc6a4d40d0034b97f","ref":"","in":"body","required":false,"desc":"Description to your thematic map.","default":"","type":"string","name":"description"},{"_id":"54db9d9bc6a4d40d0034b97e","ref":"","in":"body","required":false,"desc":"Relational restriction in ElasticSearch query-string format.","default":"","type":"string","name":"q"},{"_id":"54db9d9bc6a4d40d0034b97d","ref":"","in":"body","required":false,"desc":"List of colors to create a legend and style.","default":"","type":"array_string","name":"colors"},{"_id":"54db9d9bc6a4d40d0034b97c","ref":"","in":"body","required":false,"desc":"Spatial restriction in GeoJSON format. JSON Object (types supported: Point, LineString or Polygon).","default":"","type":"string","name":"geom"}],"url":"/thematic/:database_name/:collection_name/:thematic_name_or_id"},"isReference":false,"order":39,"body":"Update a specific thematic map of a collection and returns a JSON object informing the result of the operation.\n\n### Sample Request\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"\\ncurl -k -H \\\"Content-Type: application/json\\\" -XPUT \\\\\\n\\\"https://api.gogeo.io/1.0/thematic/my_database/my_collection/thematic_map_1?mapkey=YOUR_MAP_KEY\\\" -d '\\n{\\n  \\\"intervals\\\": 6,\\n  \\\"description\\\": \\\"My first thematic map UPDATE!\\\"\\n}'\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n### Sample Response\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"id\\\": \\\"80099356-0a2a-4f58-8b0b-44c6ab732798\\\",\\n  \\\"name\\\": \\\"thematic_map_1\\\",\\n  \\\"description\\\": \\\"My first thematic map UPDATE!\\\",\\n  \\\"database\\\": \\\"db1\\\",\\n  \\\"column\\\": \\\"tax_collection\\\",\\n  \\\"legend\\\": {\\n    \\\"0\\\": {\\n      \\\"color\\\": \\\"#0571B0\\\",\\n      \\\"min\\\": \\\"250000\\\",\\n      \\\"max\\\": \\\"500000\\\"\\n    },\\n    \\\"1\\\": {\\n      \\\"color\\\": \\\"#92C5DE\\\",\\n      \\\"min\\\": \\\"650000\\\",\\n      \\\"max\\\": \\\"750000\\\"\\n    },\\n    ...\\n  }\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\nAs you can see the thematic map description was updated (line 3 on sample response above). Pay attention for attributes that have default values, because if you do not inform the desired value it will be changed to the default. On example above if the attribute *intervals* is not informed as parameter, it would be set to 5 (its default value).\n[block:html]\n{\n  \"html\": \"<div class=\\\"panel panel-info teste\\\" >\\n  <div class=\\\"panel-body\\\">\\n    This endpoint requires a MAP key. See <a href=\\\"basic-auth\\\">Basic Authentication</a> for more information about the goGeo authentication system.\\n    <br><br>\\n    If you don't have an access key yet, <a href=\\\"https://console.gogeo.io/signup\\\">sign up</a> and grab yours!\\n  </div>\\n</div>\"\n}\n[/block]\n---\n[block:html]\n{\n  \"html\": \"<div class='div-middle'> \\n  <a href='#'>\\n    Top page &spades; </div>\\n  </a>\\n</div>\\n\\n<div class='div-back'> \\n  <a href='/v1.0/docs/retrieve-thematic-map-meta-data'>\\n    &laquo; Back \\n  </a>\\n</div>\\n\\n<div class='div-forward'> \\n  <a href='/v1.0/docs/thematic-map-deletion'>\\n    Next &raquo; </div>\\n  </a>\\n</div>\\n\\n<style>\\n\\t.div-back {\\n  \\tpadding-left: 15px;\\n\\t\\tmargin-top: -20px;\\n  }\\n  \\n  .div-middle {\\n  \\ttext-align: center;\\n\\t\\tmargin-top: -15px;\\n  }\\n  \\n  .div-forward {\\n  \\tfloat: right;\\n    padding-right: 15px;\\n\\t\\tmargin-top: -20px;\\n  }\\n</style>\"\n}\n[/block]","excerpt":"Update a specific thematic map of a collection.","slug":"thematic-map-updating","type":"put","title":"Update a thematic map"}

putUpdate a thematic map

Update a specific thematic map of a collection.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

database_name:
required
string
Database name.
collection_name:
required
string
Collection name.
thematic_name_or_id:
required
string
Thematic map name or id.

Body Params

mapkey:
required
string
Your mapkey.
column:
required
string
Column to create a thematic map.
intervals:
integer5
The number of intervals size the thematic map (min_size: 3, max_size: 11).
description:
string
Description to your thematic map.
q:
string
Relational restriction in ElasticSearch query-string format.
colors:
array of strings
List of colors to create a legend and style.
geom:
string
Spatial restriction in GeoJSON format. JSON Object (types supported: Point, LineString or Polygon).

Result Format


Documentation

Update a specific thematic map of a collection and returns a JSON object informing the result of the operation. ### Sample Request [block:code] { "codes": [ { "code": "\ncurl -k -H \"Content-Type: application/json\" -XPUT \\\n\"https://api.gogeo.io/1.0/thematic/my_database/my_collection/thematic_map_1?mapkey=YOUR_MAP_KEY\" -d '\n{\n \"intervals\": 6,\n \"description\": \"My first thematic map UPDATE!\"\n}'", "language": "json" } ] } [/block] ### Sample Response [block:code] { "codes": [ { "code": "{\n \"id\": \"80099356-0a2a-4f58-8b0b-44c6ab732798\",\n \"name\": \"thematic_map_1\",\n \"description\": \"My first thematic map UPDATE!\",\n \"database\": \"db1\",\n \"column\": \"tax_collection\",\n \"legend\": {\n \"0\": {\n \"color\": \"#0571B0\",\n \"min\": \"250000\",\n \"max\": \"500000\"\n },\n \"1\": {\n \"color\": \"#92C5DE\",\n \"min\": \"650000\",\n \"max\": \"750000\"\n },\n ...\n }\n}", "language": "json" } ] } [/block] As you can see the thematic map description was updated (line 3 on sample response above). Pay attention for attributes that have default values, because if you do not inform the desired value it will be changed to the default. On example above if the attribute *intervals* is not informed as parameter, it would be set to 5 (its default value). [block:html] { "html": "<div class=\"panel panel-info teste\" >\n <div class=\"panel-body\">\n This endpoint requires a MAP key. See <a href=\"basic-auth\">Basic Authentication</a> for more information about the goGeo authentication system.\n <br><br>\n If you don't have an access key yet, <a href=\"https://console.gogeo.io/signup\">sign up</a> and grab yours!\n </div>\n</div>" } [/block] --- [block:html] { "html": "<div class='div-middle'> \n <a href='#'>\n Top page &spades; </div>\n </a>\n</div>\n\n<div class='div-back'> \n <a href='/v1.0/docs/retrieve-thematic-map-meta-data'>\n &laquo; Back \n </a>\n</div>\n\n<div class='div-forward'> \n <a href='/v1.0/docs/thematic-map-deletion'>\n Next &raquo; </div>\n </a>\n</div>\n\n<style>\n\t.div-back {\n \tpadding-left: 15px;\n\t\tmargin-top: -20px;\n }\n \n .div-middle {\n \ttext-align: center;\n\t\tmargin-top: -15px;\n }\n \n .div-forward {\n \tfloat: right;\n padding-right: 15px;\n\t\tmargin-top: -20px;\n }\n</style>" } [/block]

User Information

Try It Out

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