Api session items scenarios: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| (19 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
API Endpoint: /api/session/items/scenarios/ | |||
Edit items with | Edit items with events described at [[Api session event editor scenario]]. | ||
Default Query: | Default Query: | ||
| Line 21: | Line 21: | ||
version=100: | version=100: | ||
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/scenarios/?version=100&token=API_TOKEN</syntaxhighlight> | <syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/scenarios/?version=100&token=API_TOKEN</syntaxhighlight> | ||
== | ==Get Queries== | ||
attributes: | |||
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/scenarios/attributes/?token=API_TOKEN</syntaxhighlight> | |||
max version: | max version: | ||
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/scenarios/version/?token=API_TOKEN</syntaxhighlight> | <syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/scenarios/version/?token=API_TOKEN</syntaxhighlight> | ||
count: | |||
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/scenarios/ | <syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/scenarios/count/?token=API_TOKEN</syntaxhighlight> | ||
==Formats== | ==Formats== | ||
HTML: | HTML: | ||
| Line 43: | Line 43: | ||
ZIPSMILE: | ZIPSMILE: | ||
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/scenarios/?f=ZIPSMILE&token=API_TOKEN</syntaxhighlight> | <syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/scenarios/?f=ZIPSMILE&token=API_TOKEN</syntaxhighlight> | ||
==Api Model CodedEvent== | |||
API Model description of CodedEvent | |||
{|class=wikitable | |||
!Name | |||
!Type | |||
!Description | |||
|- | |||
| id | |||
| int | |||
| | |||
|- | |||
| parameters | |||
| Object<nowiki>[]</nowiki> | |||
| | |||
|} | |||
==Api Model LimitType== | |||
API Enumeration description of LimitType | |||
{|class=wikitable | |||
!Name | |||
!Description | |||
|- | |||
| DEFAULT | |||
| | |||
|- | |||
| NEIGHBORHOODS | |||
| | |||
|- | |||
| MEASURE_NEIGHBORHOODS | |||
| | |||
|} | |||
==Api Model Scenario== | ==Api Model Scenario== | ||
API Model description of Scenario | API Model description of Scenario | ||
| Line 51: | Line 85: | ||
!Description | !Description | ||
|- | |- | ||
|attributes | | attributes | ||
|Map<String,double[]> | | Map<String,double[]> | ||
| | | | ||
|- | |- | ||
|description | | description | ||
|String | | String | ||
| | | | ||
|- | |- | ||
|events | | events | ||
|CodedEvent<nowiki>[]</nowiki> | | CodedEvent<nowiki>[]</nowiki> | ||
| | | | ||
|- | |- | ||
|id | | id | ||
|int | | int | ||
| | | | ||
|- | |- | ||
|limitNeighborhoodIDs | | limitNeighborhoodIDs | ||
|int<nowiki>[]</nowiki> | | int<nowiki>[]</nowiki> | ||
|[[Neighborhood]] ID | | [[Neighborhood]]s ID | ||
|- | |- | ||
|limitType | | limitType | ||
|LimitType | | LimitType | ||
| | | | ||
|- | |- | ||
|maquetteOverride | | maquetteOverride | ||
|Map<String,double[]> | | Map<String,double[]> | ||
| | | | ||
|- | |- | ||
|name | | name | ||
|String | | String | ||
| | | | ||
|- | |- | ||
|restartTestrun | | restartTestrun | ||
|boolean | | boolean | ||
| | | | ||
|- | |- | ||
|version | | version | ||
|int | | int | ||
| | | | ||
|} | |} | ||
| Line 97: | Line 131: | ||
[[Category:API]] | [[Category:API]] | ||
[[Category:Items]] | |||
Latest revision as of 07:14, 7 July 2026
API Endpoint: /api/session/items/scenarios/
Edit items with events described at Api session event editor scenario.
Default Query:
https://engine.tygron.com/api/session/items/scenarios/?f=JSON&token=API_TOKENExample Response:
[ {
"attributes" : null,
"description" : "",
"events" : [ ],
"id" : 0,
"limitNeighborhoodIDs" : [ ],
"limitType" : "DEFAULT",
"maquetteOverride" : null,
"name" : "Scenario",
"restartTestrun" : true,
"version" : 2
} ]Limit Queries
version=100:
https://engine.tygron.com/api/session/items/scenarios/?version=100&token=API_TOKENGet Queries
attributes:
https://engine.tygron.com/api/session/items/scenarios/attributes/?token=API_TOKENmax version:
https://engine.tygron.com/api/session/items/scenarios/version/?token=API_TOKENcount:
https://engine.tygron.com/api/session/items/scenarios/count/?token=API_TOKENFormats
HTML:
https://engine.tygron.com/api/session/items/scenarios/?f=HTML&token=API_TOKENJSON:
https://engine.tygron.com/api/session/items/scenarios/?f=JSON&token=API_TOKENCSV:
https://engine.tygron.com/api/session/items/scenarios/?f=CSV&token=API_TOKENSSV:
https://engine.tygron.com/api/session/items/scenarios/?f=SSV&token=API_TOKENSMILE:
https://engine.tygron.com/api/session/items/scenarios/?f=SMILE&token=API_TOKENZIPJSON:
https://engine.tygron.com/api/session/items/scenarios/?f=ZIPJSON&token=API_TOKENZIPSMILE:
https://engine.tygron.com/api/session/items/scenarios/?f=ZIPSMILE&token=API_TOKENApi Model CodedEvent
API Model description of CodedEvent
| Name | Type | Description |
|---|---|---|
| id | int | |
| parameters | Object[] |
Api Model LimitType
API Enumeration description of LimitType
| Name | Description |
|---|---|
| DEFAULT | |
| NEIGHBORHOODS | |
| MEASURE_NEIGHBORHOODS |
Api Model Scenario
API Model description of Scenario
| Name | Type | Description |
|---|---|---|
| attributes | Map<String,double[]> | |
| description | String | |
| events | CodedEvent[] | |
| id | int | |
| limitNeighborhoodIDs | int[] | Neighborhoods ID |
| limitType | LimitType | |
| maquetteOverride | Map<String,double[]> | |
| name | String | |
| restartTestrun | boolean | |
| version | int |