Api session event logic scenario set attribute: Difference between revisions
Jump to navigation
Jump to search
Created page with "API Endpoint: api/session/event/logic/scenario_set_attribute/ Description: Set Scenario Attribute to given number Value. {|class=wikitable !Name !Importance !Type !Description !Values |- |0 |REQUIRED |(SCENARIO Integer ID or multiple values in array [1, 2, 3]) |Scenario ID | |- |1 |REQUIRED |(String) |Attribute Name | |- |2 |REQUIRED |(Floating point number or multiple values in array [1.0, 2.0, 3.0]) |Value | |- |3 |OPTIONAL |(true, false) |Update [[Indicator]..." |
No edit summary |
||
| (6 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
API Endpoint: api/session/event/logic/scenario_set_attribute/ | API Endpoint: api/session/event/logic/scenario_set_attribute/ | ||
Description: Set [[Scenario]] Attribute to | Description: Set the [[Scenario]] [[Attribute]] to the specified numeric value | ||
{|class=wikitable | {|class=wikitable | ||
! | !Index | ||
!Importance | !Importance | ||
!Type | !Type | ||
| Line 10: | Line 10: | ||
!Values | !Values | ||
|- | |- | ||
|0 | | 0 | ||
|REQUIRED | | REQUIRED | ||
|(SCENARIO Integer ID or multiple values in array [1, 2, 3]) | | (SCENARIO Integer ID or multiple integer values in array [1, 2, 3]) | ||
|[[Scenario]] | | [[Scenario]]s | ||
| | | | ||
|- | |- | ||
|1 | | 1 | ||
|REQUIRED | | REQUIRED | ||
|(String) | | (String) | ||
|Attribute | | [[Attribute]] | ||
| | | | ||
|- | |- | ||
|2 | | 2 | ||
|REQUIRED | | REQUIRED | ||
|(Floating point number or multiple values in array [1.0, 2.0, 3.0]) | | (Floating point number or multiple values in array [1.0, 2.0, 3.0]) | ||
|Value | | Value Array | ||
| | | | ||
|- | |- | ||
|3 | | 3 | ||
|OPTIONAL | | OPTIONAL | ||
|(true, false) | | (true, false) | ||
|Update [[Indicator]] (optional) | | Update [[Indicator]]s (optional) | ||
| | | | ||
|} | |} | ||
===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/logic/scenario_set_attribute/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 1, "Attribute", 1.0 ]' | |||
<syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/event/logic/scenario_set_attribute/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 1, "Attribute | |||
</syntaxhighlight> | </syntaxhighlight> | ||
Curl example multi item POST | Curl example multi item POST | ||
<syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/event/logic/scenario_set_attribute/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ [ 1, 2, 3 ], "Attribute", [ 1.0, 2.0, 3.0 ] ]' | |||
<syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/event/logic/scenario_set_attribute/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ [ 1, 2, 3 ], "Attribute | |||
</syntaxhighlight> | </syntaxhighlight> | ||
JavaScript example POST | JavaScript example POST | ||
<syntaxhighlight lang="text" copy>var options = { | <syntaxhighlight lang="text" copy>var options = { | ||
method: "POST", | method: "POST", | ||
headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" }, | headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" }, | ||
body: '[ 1, "Attribute | body: '[ 1, "Attribute", 1.0 ]' | ||
}; | }; | ||
fetch("https://engine.tygron.com/api/session/event/logic/scenario_set_attribute/", options) | fetch("https://engine.tygron.com/api/session/event/logic/scenario_set_attribute/", options) | ||
Latest revision as of 14:55, 11 November 2026
API Endpoint: api/session/event/logic/scenario_set_attribute/
Description: Set the Scenario Attribute to the specified numeric value
| Index | Importance | Type | Description | Values |
|---|---|---|---|---|
| 0 | REQUIRED | (SCENARIO Integer ID or multiple integer values in array [1, 2, 3]) | Scenarios | |
| 1 | REQUIRED | (String) | Attribute | |
| 2 | REQUIRED | (Floating point number or multiple values in array [1.0, 2.0, 3.0]) | Value Array | |
| 3 | OPTIONAL | (true, false) | Update Indicators (optional) |
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/logic/scenario_set_attribute/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 1, "Attribute", 1.0 ]'Curl example multi item POST
curl 'https://engine.tygron.com/api/session/event/logic/scenario_set_attribute/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ [ 1, 2, 3 ], "Attribute", [ 1.0, 2.0, 3.0 ] ]'JavaScript example POST
var options = {
method: "POST",
headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" },
body: '[ 1, "Attribute", 1.0 ]'
};
fetch("https://engine.tygron.com/api/session/event/logic/scenario_set_attribute/", options)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));