Api session event editor overlay remove attribute: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 31: | Line 31: | ||
|} | |} | ||
===Example POST=== | ===Example POST=== | ||
Example POST: | Curl Example POST: | ||
<syntaxhighlight lang="text" copy>curl 'https://development.tygron.com/api/session/event/editoroverlay/remove_attribute/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 1, "Attributes to remove 1" ]' | |||
< | </syntaxhighlight> | ||
</ | Curl Example multi item POST: | ||
<syntaxhighlight lang="text" copy>curl 'https://development.tygron.com/api/session/event/editoroverlay/remove_attribute/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ [ 1, 2, 3 ], [ "Attributes to remove 1", "Attributes to remove 2", "Attributes to remove 3" ] ]' | |||
</syntaxhighlight> | |||
JavaScript Example POST: | |||
<syntaxhighlight lang="text" copy>var options = { | |||
method: "POST", | |||
headers: { "Content-Type": "application/json", "Authorization": "Bearer 31410104zAuxtcJo8WGhL6iYlCDnU5hd" }, | |||
body: '[ 1, "Attributes to remove 1" ]' | |||
}; | |||
fetch("https://development.tygron.com/api/session/event/editoroverlay/remove_attribute/", options) | |||
.then(response => response.text()) | |||
.then(result => console.log(result)) | |||
.catch(error => console.log('error', error)); | |||
</syntaxhighlight> | |||
{{article end|seealso=*[[Api session event editor overlay]] | {{article end|seealso=*[[Api session event editor overlay]] | ||
*[[Api session items overlays]] | *[[Api session items overlays]] | ||
Revision as of 15:27, 8 April 2026
API Event to Remove the specified attributes of the specified Overlay. The attributes, including attributes which are added to an Overlay by default, are removed entirely.
| Name | Importance | Type | Description | Values |
|---|---|---|---|---|
| 0 | REQUIRED | (OVERLAY Integer ID or multiple values in array [1, 2, 3]) | Overlay ID | |
| 1 | REQUIRED | (String or multiple values in array ["a", "b", "c"]) | Attributes to remove |
Response Codes
| Response Code: | Description |
|---|---|
| 204 | No Content |
| 300-600 | Codes Overview |
Example POST
Curl Example POST:
curl 'https://development.tygron.com/api/session/event/editoroverlay/remove_attribute/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 1, "Attributes to remove 1" ]'Curl Example multi item POST:
curl 'https://development.tygron.com/api/session/event/editoroverlay/remove_attribute/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ [ 1, 2, 3 ], [ "Attributes to remove 1", "Attributes to remove 2", "Attributes to remove 3" ] ]'JavaScript Example POST:
var options = {
method: "POST",
headers: { "Content-Type": "application/json", "Authorization": "Bearer 31410104zAuxtcJo8WGhL6iYlCDnU5hd" },
body: '[ 1, "Attributes to remove 1" ]'
};
fetch("https://development.tygron.com/api/session/event/editoroverlay/remove_attribute/", options)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));