Api session event editor overlay remove attribute: Difference between revisions
Jump to navigation
Jump to search
Created page with "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. {|class=wikitable !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=== {|class=wikitable !Respo..." |
No edit summary |
||
| (4 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
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. | 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. | ||
{|class=wikitable | {|class=wikitable | ||
!Name | !Name | ||
| Line 31: | Line 31: | ||
|} | |} | ||
===Example POST=== | ===Example POST=== | ||
Example POST: https://engine.tygron.com/api/session/event/editoroverlay/remove_attribute/?f= | Example POST: https://engine.tygron.com/api/session/event/editoroverlay/remove_attribute/?f=JSON&token=API_TOKEN | ||
with content: | with content: | ||
<pre>[ [ 1, 2, 3 ], [ "Attributes to remove 1", "Attributes to remove 2", "Attributes to remove 3" ] ] | <pre>[ [ 1, 2, 3 ], [ "Attributes to remove 1", "Attributes to remove 2", "Attributes to remove 3" ] ] | ||
</pre> | </pre> | ||
{{article end|seealso=*[[ | {{article end|seealso=*[[Api session event editor overlay]] | ||
*[[Api session items overlays]] | |||
}} | |||
[[Category:API]] | [[Category:API]] | ||
Latest revision as of 12:12, 1 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
Example POST: https://engine.tygron.com/api/session/event/editoroverlay/remove_attribute/?f=JSON&token=API_TOKEN
with content:
[ [ 1, 2, 3 ], [ "Attributes to remove 1", "Attributes to remove 2", "Attributes to remove 3" ] ]