Api session items scenarios: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 51: | Line 51: | ||
!Description | !Description | ||
|- | |- | ||
|id | | id | ||
|int | | int | ||
| | | | ||
|- | |- | ||
|parameters | | parameters | ||
|Object<nowiki>[]</nowiki> | | Object<nowiki>[]</nowiki> | ||
| | | | ||
|} | |} | ||
| Line 67: | Line 67: | ||
!Description | !Description | ||
|- | |- | ||
|DEFAULT | | DEFAULT | ||
| | | | ||
|- | |- | ||
|NEIGHBORHOODS | | NEIGHBORHOODS | ||
| | | | ||
|- | |- | ||
|MEASURE_NEIGHBORHOODS | | MEASURE_NEIGHBORHOODS | ||
| | | | ||
|} | |} | ||
| Line 85: | 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]]s 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 | ||
| | | | ||
|} | |} | ||
Revision as of 11:45, 8 June 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_TOKENShow Queries
max version:
https://engine.tygron.com/api/session/items/scenarios/version/?token=API_TOKENsize:
https://engine.tygron.com/api/session/items/scenarios/size/?token=API_TOKENScenarios (GeoJSON):
https://engine.tygron.com/web/scenarios.geojson?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 |