Api session event editor overlay remove attribute: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
Frank@tygron.nl (talk | contribs)
Tygron, Tygron_admin, Bureaucrats, Interface administrators, Administrators
46,429 edits
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
 
(15 intermediate revisions by 2 users 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 Endpoint: api/session/event/editoroverlay/remove_attribute/
 
Description: Remove the specified [[Attribute]]s of the specified [[Overlay]]. The [[Attribute]]s, including [[Attribute]]s which are added to an [[Overlay]] by default, are removed entirely.
 
{|class=wikitable
{|class=wikitable
!Name
!Index
!Importance
!Importance
!Type
!Type
Line 7: Line 10:
!Values
!Values
|-
|-
|0
| 0
|REQUIRED
| REQUIRED
|(OVERLAY Integer ID or multiple values in array [1, 2, 3])
| (OVERLAY Integer ID or multiple integer values in array [1, 2, 3])
|[[Overlay]] ID
| [[Overlay]] ID
|
|  
|-
|-
|1
| 1
|REQUIRED
| REQUIRED
|(String or multiple values in array ["a", "b", "c"])
| (String or multiple values in array ["a", "b", "c"])
|Attributes to remove
| [[Attribute]]s to remove
|
|  
|}
|}
===Response Codes===
===Response Codes===
Line 24: Line 27:
!Description
!Description
|-
|-
|204
| 204
|No Content
| No Content
|-
|-
|300-600
| 300-600
|Codes Overview
| Codes Overview
|}
|}
===Example POST===
===Example POST===
Example POST: https://engine.tygron.com/api/session/event/editoroverlay/remove_attribute/?f=HTML&token=API_TOKEN
Curl example POST
 
<syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/event/editoroverlay/remove_attribute/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 1, "Attributes to remove 1" ]'
with content:
</syntaxhighlight>
<pre>[ [ 1, 2, 3 ], [ "Attributes to remove 1", "Attributes to remove 2", "Attributes to remove 3" ] ]
Curl example multi item POST
</pre>
<syntaxhighlight lang="text" copy>curl 'https://engine.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" ] ]'
{{article end|seealso=*[[api session event editor overlay]]}}
</syntaxhighlight>
JavaScript example POST
<syntaxhighlight lang="text" copy>var options = {
 method: "POST",
 headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" },
 body: '[ 1, "Attributes to remove 1" ]'
};
fetch("https://engine.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]]
*[[Api session items overlays]]
}}


[[Category:API]]
[[Category:API]]

Latest revision as of 12:22, 17 June 2026

API Endpoint: api/session/event/editoroverlay/remove_attribute/

Description: Remove the specified Attributes of the specified Overlay. The Attributes, including Attributes which are added to an Overlay by default, are removed entirely.

Index Importance Type Description Values
0 REQUIRED (OVERLAY Integer ID or multiple integer 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://engine.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://engine.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 API_TOKEN" },
 body: '[ 1, "Attributes to remove 1" ]'
};
fetch("https://engine.tygron.com/api/session/event/editoroverlay/remove_attribute/", options)
 .then(response => response.text())
 .then(result => console.log(result))
 .catch(error => console.log('error', error));

See also

Retrieved from "https://support.tygron.com/w/index.php?title=Api_session_event_editor_overlay_remove_attribute&oldid=86807"