Api session event editor overlay remove attribute: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
← Older editNewer edit →
Frank@tygron.nl (talk | contribs)
Tygron, Tygron_admin, Interface administrators, Administrators
34,718 edits
No edit summary
No edit summary
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 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 33: Line 33:
Curl 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 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" ]'
</syntaxhighlight>
</syntaxhighlight>
Curl Example multi item POST:
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 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" ] ]'
</syntaxhighlight>
</syntaxhighlight>
JavaScript Example POST:
JavaScript Example POST:
Line 46: Line 46:
 body: '[ 1, "Attributes to remove 1" ]'
 body: '[ 1, "Attributes to remove 1" ]'
};
};
fetch("https://development.tygron.com/api/session/event/editoroverlay/remove_attribute/", options)
fetch("https://engine.tygron.com/api/session/event/editoroverlay/remove_attribute/", options)
 .then(response => response.text())
 .then(response => response.text())
 .then(result => console.log(result))
 .then(result => console.log(result))

Revision as of 09:08, 10 April 2026

API Endpoint 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://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=73181"