Api session items parametricdesigns: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| (18 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
Api session items [[Parametric Design]]s Endpoint: /api/session/items/parametricdesigns/ | |||
Edit items with events described at [[Api session event editor parametric]]. | |||
==Limit Queries==version=100: | Default Query: | ||
< | <syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/parametricdesigns/?f=JSON&token=API_TOKEN</syntaxhighlight> | ||
== | Example Response: | ||
< | <syntaxhighlight lang="text" copy>[ ]</syntaxhighlight> | ||
==Limit Queries== | |||
version=100: | |||
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/parametricdesigns/?version=100&token=API_TOKEN</syntaxhighlight> | |||
==Show Queries== | |||
max version: | |||
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/parametricdesigns/version/?token=API_TOKEN</syntaxhighlight> | |||
size: | size: | ||
< | <syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/parametricdesigns/size/?token=API_TOKEN</syntaxhighlight> | ||
== | ==Formats== | ||
< | HTML: | ||
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/parametricdesigns/?f=HTML&token=API_TOKEN</syntaxhighlight> | |||
JSON: | JSON: | ||
< | <syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/parametricdesigns/?f=JSON&token=API_TOKEN</syntaxhighlight> | ||
CSV: | CSV: | ||
< | <syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/parametricdesigns/?f=CSV&token=API_TOKEN</syntaxhighlight> | ||
SSV: | SSV: | ||
< | <syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/parametricdesigns/?f=SSV&token=API_TOKEN</syntaxhighlight> | ||
SMILE: | SMILE: | ||
< | <syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/parametricdesigns/?f=SMILE&token=API_TOKEN</syntaxhighlight> | ||
ZIPJSON: | ZIPJSON: | ||
< | <syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/parametricdesigns/?f=ZIPJSON&token=API_TOKEN</syntaxhighlight> | ||
ZIPSMILE: | ZIPSMILE: | ||
< | <syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/parametricdesigns/?f=ZIPSMILE&token=API_TOKEN</syntaxhighlight> | ||
{{article end|seealso=*[[Api Content Items]]}} | ==Api Model Alignment== | ||
API Enumeration description of Alignment | |||
{|class=wikitable | |||
!Name | |||
!Description | |||
|- | |||
|ROAD | |||
| | |||
|- | |||
|SPACED | |||
| | |||
|} | |||
==Api Model GeometryCollection== | |||
API Model description of GeometryCollection | |||
{|class=wikitable | |||
!Name | |||
!Type | |||
!Description | |||
|} | |||
==Api Model MultiPolygon== | |||
API Model description of MultiPolygon | |||
{|class=wikitable | |||
!Name | |||
!Type | |||
!Description | |||
|- | |||
|type | |||
|String | |||
|[[#Api Model MultiPolygon|MultiPolygon]] | |||
|- | |||
|coordinates | |||
|double[][][][] | |||
|array of polygons; polygon is array of outer and optional inner rings; rings is array of coordinates; coordinates is array of [x,y,(optional) z] | |||
|} | |||
==Api Model ParametricDesign== | |||
API Model description of ParametricDesign | |||
{|class=wikitable | |||
!Name | |||
!Type | |||
!Description | |||
|- | |||
|alignment | |||
|Alignment | |||
| | |||
|- | |||
|attributes | |||
|Map<String,double[]> | |||
| | |||
|- | |||
|center | |||
|Point | |||
| | |||
|- | |||
|gardenID | |||
|int | |||
|[[Function]] ID | |||
|- | |||
|id | |||
|int | |||
| | |||
|- | |||
|maquetteOverride | |||
|Map<String,double[]> | |||
| | |||
|- | |||
|name | |||
|String | |||
| | |||
|- | |||
|parkingID | |||
|int | |||
|[[Function]] ID | |||
|- | |||
|plotDesigns | |||
|PlotDesign<nowiki>[]</nowiki> | |||
| | |||
|- | |||
|polygons | |||
|MultiPolygon | |||
| | |||
|- | |||
|publicGreenID | |||
|int | |||
|[[Function]] ID | |||
|- | |||
|roadID | |||
|int | |||
|[[Function]] ID | |||
|- | |||
|sidewalkID | |||
|int | |||
|[[Function]] ID | |||
|- | |||
|sourceIDs | |||
|int<nowiki>[]</nowiki> | |||
|[[Source]] ID | |||
|- | |||
|version | |||
|int | |||
| | |||
|- | |||
|waterID | |||
|int | |||
|[[Terrain Type]] ID | |||
|} | |||
==Api Model PlotDesign== | |||
API Model description of PlotDesign | |||
{|class=wikitable | |||
!Name | |||
!Type | |||
!Description | |||
|- | |||
|attributes | |||
|Map<String,double[]> | |||
| | |||
|- | |||
|functionID | |||
|int | |||
|[[Function]] ID | |||
|- | |||
|id | |||
|int | |||
| | |||
|- | |||
|multiPolygon | |||
|MultiPolygon | |||
| | |||
|} | |||
==Api Model Point== | |||
API Model description of Point | |||
{|class=wikitable | |||
!Name | |||
!Type | |||
!Description | |||
|- | |||
|type | |||
|String | |||
|[[#Api Model Point|Point]] | |||
|- | |||
|coordinates | |||
|double[] | |||
|x, y, (optional) z | |||
|} | |||
{{article end|seealso=*[[Api Content Items]] | |||
*[[Api session event editor parametric]] | |||
}} | |||
[[Category:API]] | [[Category:API]] | ||
[[Category:Items]] | |||
Latest revision as of 12:14, 29 May 2026
Api session items Parametric Designs Endpoint: /api/session/items/parametricdesigns/
Edit items with events described at Api session event editor parametric.
Default Query:
https://engine.tygron.com/api/session/items/parametricdesigns/?f=JSON&token=API_TOKENExample Response:
[ ]Limit Queries
version=100:
https://engine.tygron.com/api/session/items/parametricdesigns/?version=100&token=API_TOKENShow Queries
max version:
https://engine.tygron.com/api/session/items/parametricdesigns/version/?token=API_TOKENsize:
https://engine.tygron.com/api/session/items/parametricdesigns/size/?token=API_TOKENFormats
HTML:
https://engine.tygron.com/api/session/items/parametricdesigns/?f=HTML&token=API_TOKENJSON:
https://engine.tygron.com/api/session/items/parametricdesigns/?f=JSON&token=API_TOKENCSV:
https://engine.tygron.com/api/session/items/parametricdesigns/?f=CSV&token=API_TOKENSSV:
https://engine.tygron.com/api/session/items/parametricdesigns/?f=SSV&token=API_TOKENSMILE:
https://engine.tygron.com/api/session/items/parametricdesigns/?f=SMILE&token=API_TOKENZIPJSON:
https://engine.tygron.com/api/session/items/parametricdesigns/?f=ZIPJSON&token=API_TOKENZIPSMILE:
https://engine.tygron.com/api/session/items/parametricdesigns/?f=ZIPSMILE&token=API_TOKENApi Model Alignment
API Enumeration description of Alignment
| Name | Description |
|---|---|
| ROAD | |
| SPACED |
Api Model GeometryCollection
API Model description of GeometryCollection
| Name | Type | Description |
|---|
Api Model MultiPolygon
API Model description of MultiPolygon
| Name | Type | Description |
|---|---|---|
| type | String | MultiPolygon |
| coordinates | double[][][][] | array of polygons; polygon is array of outer and optional inner rings; rings is array of coordinates; coordinates is array of [x,y,(optional) z] |
Api Model ParametricDesign
API Model description of ParametricDesign
| Name | Type | Description |
|---|---|---|
| alignment | Alignment | |
| attributes | Map<String,double[]> | |
| center | Point | |
| gardenID | int | Function ID |
| id | int | |
| maquetteOverride | Map<String,double[]> | |
| name | String | |
| parkingID | int | Function ID |
| plotDesigns | PlotDesign[] | |
| polygons | MultiPolygon | |
| publicGreenID | int | Function ID |
| roadID | int | Function ID |
| sidewalkID | int | Function ID |
| sourceIDs | int[] | Source ID |
| version | int | |
| waterID | int | Terrain Type ID |
Api Model PlotDesign
API Model description of PlotDesign
| Name | Type | Description |
|---|---|---|
| attributes | Map<String,double[]> | |
| functionID | int | Function ID |
| id | int | |
| multiPolygon | MultiPolygon |
Api Model Point
API Model description of Point
| Name | Type | Description |
|---|---|---|
| type | String | Point |
| coordinates | double[] | x, y, (optional) z |