Api session event editor indicator set target: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
← Older edit
Frank@tygron.nl (talk | contribs)
Tygron, Tygron_admin, Bureaucrats, Interface administrators, Administrators
46,429 edits
No edit summary
No edit summary
 
(13 intermediate revisions by the same user not shown)
Line 1: Line 1:
API Event to Set a target value of an [[Indicator]] for a Sceanrio. A target index value is required.
API Endpoint: api/session/event/editorindicator/set_target/
 
Description: Set a target value of an [[Indicator]] for a [[Scenario]]. A target index value is required.
 
{|class=wikitable
{|class=wikitable
!Name
!Index
!Importance
!Importance
!Type
!Type
Line 7: Line 10:
!Values
!Values
|-
|-
|0
| 0
|REQUIRED
| REQUIRED
|(SCENARIO Integer ID)
| (SCENARIO Integer ID)
|[[Scenario]] ID
| [[Scenario]] ID
|
|  
|-
|-
|1
| 1
|REQUIRED
| REQUIRED
|(INDICATOR Integer ID)
| (INDICATOR Integer ID)
|[[Indicator]] ID
| [[Indicator]] ID
|
|  
|-
|-
|2
| 2
|REQUIRED
| REQUIRED
|(Integer number)
| (Integer number)
|Target index
| Target index
|
|  
|-
|-
|3
| 3
|REQUIRED
| REQUIRED
|(Floating point number)
| (Floating point number)
|Target value
| Target value
|
|  
|}
|}
===Response Codes===
===Response Codes===
Line 36: Line 39:
!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/editorindicator/set_target/?f=JSON&token=API_TOKEN
Curl example POST
 
<syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/event/editorindicator/set_target/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 1, 1, 1, 79 ]'
with content:  
</syntaxhighlight>
<pre>[ 45, 76, 77, 49 ]
Curl example multi item POST
</pre>
<syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/event/editorindicator/set_target/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 1, 1, 1, 46 ]'
{{article end|seealso=*[[api session event editor indicator]]}}
</syntaxhighlight>
JavaScript example POST
<syntaxhighlight lang="text" copy>var options = {
 method: "POST",
 headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" },
 body: '[ 1, 1, 1, 79 ]'
};
fetch("https://engine.tygron.com/api/session/event/editorindicator/set_target/", options)
 .then(response => response.text())
 .then(result => console.log(result))
 .catch(error => console.log('error', error));
</syntaxhighlight>
{{article end|seealso=*[[Api session event editor indicator]]
*[[Api session items indicators]]
}}


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

Latest revision as of 09:59, 13 July 2026

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

Description: Set a target value of an Indicator for a Scenario. A target index value is required.

Index Importance Type Description Values
0 REQUIRED (SCENARIO Integer ID) Scenario ID
1 REQUIRED (INDICATOR Integer ID) Indicator ID
2 REQUIRED (Integer number) Target index
3 REQUIRED (Floating point number) Target value

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

Curl example multi item POST 

curl 'https://engine.tygron.com/api/session/event/editorindicator/set_target/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 1, 1, 1, 46 ]'

JavaScript example POST 

var options = {
 method: "POST",
 headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" },
 body: '[ 1, 1, 1, 79 ]'
};
fetch("https://engine.tygron.com/api/session/event/editorindicator/set_target/", 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_indicator_set_target&oldid=90811"