Api session event editor area remove relations: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(17 intermediate revisions by the same user not shown)
Line 1: Line 1:
API Event to Remove [[Relation]]s
API Endpoint: api/session/event/editorarea/remove_relations/
 
Description: Remove [[Relation]]s
 
{|class=wikitable
{|class=wikitable
!Name
!Index
!Importance
!Importance
!Type
!Type
Line 7: Line 10:
!Values
!Values
|-
|-
|0
| 0
|REQUIRED
| REQUIRED
|(AREA Integer ID)
| (AREA Integer ID)
|[[Area]]
| [[Area]]s
|
|  
|-
|-
|1
| 1
|REQUIRED
| REQUIRED
|(Relation or multiple values in array [a, b, c])
| (Relation or multiple values in array [a, b, c])
|[[Relation]][]
| [[Relation]][]
|
|  
|}
|}
===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/editorarea/remove_relations/?f=HTML&token=API_TOKEN
Curl example POST
 
<syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/event/editorarea/remove_relations/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 1, "OWNER" ]'
with content:
</syntaxhighlight>
<pre>[ 14, [ "BORDER_B", "CONSTRUCTOR", "BORDER_A" ] ]
Curl example multi item POST
</pre>
<syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/event/editorarea/remove_relations/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 1, [ "OWNER", "CONSTRUCTOR", "DEMOLISHER" ] ]'
{{article end|seealso=*[[api session event editor area]]}}
</syntaxhighlight>
JavaScript example POST
<syntaxhighlight lang="text" copy>var options = {
 method: "POST",
 headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" },
 body: '[ 1, "OWNER" ]'
};
fetch("https://engine.tygron.com/api/session/event/editorarea/remove_relations/", options)
 .then(response => response.text())
 .then(result => console.log(result))
 .catch(error => console.log('error', error));
</syntaxhighlight>
{{article end|seealso=*[[Api session event editor area]]
*[[Api session items areas]]
}}


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

Latest revision as of 12:01, 15 June 2026

API Endpoint: api/session/event/editorarea/remove_relations/

Description: Remove Relations

Index Importance Type Description Values
0 REQUIRED (AREA Integer ID) Areas
1 REQUIRED (Relation or multiple values in array [a, b, c]) Relation[]

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/editorarea/remove_relations/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 1, "OWNER" ]'

Curl example multi item POST

curl 'https://engine.tygron.com/api/session/event/editorarea/remove_relations/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 1, [ "OWNER", "CONSTRUCTOR", "DEMOLISHER" ] ]'

JavaScript example POST

var options = {
 method: "POST",
 headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" },
 body: '[ 1, "OWNER" ]'
};
fetch("https://engine.tygron.com/api/session/event/editorarea/remove_relations/", options)
 .then(response => response.text())
 .then(result => console.log(result))
 .catch(error => console.log('error', error));