Api session event editor indicator set parent: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(5 intermediate revisions by the same user not shown)
Line 1: Line 1:
API Endpoint: editorindicator/set_parent.
API Endpoint: api/session/event/editorindicator/set_parent/


API Endpoint name is Api session event editor indicator set parent.
Description: Set a parent [[Indicator]] for a specified [[Indicator]], making it a subselectable [[Indicator]]. An [[Indicator]] that already has a parent cannot be assigned as a parent to another [[Indicator]].
 
Use this endpoint to Set a parent [[Indicator]] for a specified [[Indicator]]. This will cause the specified [[Indicator]] to be a subselectable [[Indicator]] of the parent. It is not possible to set an [[Indicator]] which has a parent itself as a parent of another [[Indicator]].


{|class=wikitable
{|class=wikitable
!Name
!Index
!Importance
!Importance
!Type
!Type
Line 12: Line 10:
!Values
!Values
|-
|-
|0
| 0
|REQUIRED
| REQUIRED
|(INDICATOR Integer ID)
| (INDICATOR Integer ID)
|[[Indicator]] ID
| [[Indicator]] ID
|
|  
|-
|-
|1
| 1
|REQUIRED
| REQUIRED
|(Integer number)
| (Integer number)
|[[Indicator]] ID of parent ([[Indicator]] without a parent should have their parent [[Indicator]] ID set to -1)
| Parent [[Indicator]] ID (use -1 if no parent exists)
|
|  
|}
|}
===Response Codes===
===Response Codes===
Line 29: Line 27:
!Description
!Description
|-
|-
|204
| 204
|No Content
| No Content
|-
|-
|300-600
| 300-600
|Codes Overview
| Codes Overview
|}
|}
===Example POST===
===Example POST===
Curl example POST:
Curl example POST
 
<syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/event/editorindicator/set_parent/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 1, 1 ]'
<syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/event/editorindicator/set_parent/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 1, 1 ]'
</syntaxhighlight>
</syntaxhighlight>
JavaScript example POST:
JavaScript example POST
 
<syntaxhighlight lang="text" copy>var options = {
<syntaxhighlight lang="text" copy>var options = {
 method: "POST",
 method: "POST",

Latest revision as of 09:59, 13 July 2026

API Endpoint: api/session/event/editorindicator/set_parent/

Description: Set a parent Indicator for a specified Indicator, making it a subselectable Indicator. An Indicator that already has a parent cannot be assigned as a parent to another Indicator.

Index Importance Type Description Values
0 REQUIRED (INDICATOR Integer ID) Indicator ID
1 REQUIRED (Integer number) Parent Indicator ID (use -1 if no parent exists)

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

JavaScript example POST

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