Api session event editor overlay set key value
Jump to navigation
Jump to search
API Endpoint: editoroverlay/set_key_value.
Description: Change a key for a specified Overlay. The Overlay must be an Overlay which makes use of keys to read attributes of geographical items, as input for its calculation.
| Name | Importance | Type | Description | Values |
|---|---|---|---|---|
| 0 | REQUIRED | (OVERLAY Integer ID) | Overlay ID (must relate to a grid Overlay). Note: to change attribute values use set_attribute instead. | |
| 1 | REQUIRED | (String) | Key name | |
| 2 | REQUIRED | (String) | Attribute name to look for |
Response Codes
| Response Code: | Description |
|---|---|
| 204 | No Content |
| 300-600 | Codes Overview |
Example POST
Curl example POST:
curl 'https://engine.tygron.com/api/session/event/editoroverlay/set_key_value/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 1, "Key name", "Attribute name to look for" ]'JavaScript example POST:
var options = {
method: "POST",
headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" },
body: '[ 1, "Key name", "Attribute name to look for" ]'
};
fetch("https://engine.tygron.com/api/session/event/editoroverlay/set_key_value/", options)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));