Api session event editor indicator set target: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 10: 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 39: Line 39:
!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_target/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 1, 1, 1, 47 ]'
<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, 44 ]'
</syntaxhighlight>
</syntaxhighlight>
Curl example multi item POST:
Curl example multi item 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, 93 ]'
<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, 80 ]'
</syntaxhighlight>
</syntaxhighlight>
JavaScript example POST:
JavaScript example POST:
Line 59: Line 59:
 method: "POST",
 method: "POST",
 headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" },
 headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" },
 body: '[ 1, 1, 1, 47 ]'
 body: '[ 1, 1, 1, 44 ]'
};
};
fetch("https://engine.tygron.com/api/session/event/editorindicator/set_target/", options)
fetch("https://engine.tygron.com/api/session/event/editorindicator/set_target/", options)

Revision as of 11:39, 8 June 2026

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

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

Name 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, 44 ]'

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, 80 ]'

JavaScript example POST:

var options = {
 method: "POST",
 headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" },
 body: '[ 1, 1, 1, 44 ]'
};
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));