Api session items panels: Difference between revisions
No edit summary |
No edit summary |
||
| (43 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
API Endpoint: /api/session/items/panels/ | |||
Edit items with events described at [[Api session event editor panel]]. | |||
Default Query: | Default Query: | ||
< | <syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/panels/?f=JSON&token=API_TOKEN</syntaxhighlight> | ||
Example Response: | Example Response: | ||
< | <syntaxhighlight lang="text" copy>[ { | ||
"answers" : [ ], | "answers" : [ ], | ||
"attributes" : { | "attributes" : { | ||
| Line 15: | Line 15: | ||
"VISIBLE_TIMEFRAME" : [ 0.0 ] | "VISIBLE_TIMEFRAME" : [ 0.0 ] | ||
}, | }, | ||
"calcTimeMS" : | "calcTimeMS" : 1, | ||
"contentID" : null, | "contentID" : null, | ||
"contentMapLink" : null, | "contentMapLink" : null, | ||
| Line 31: | Line 31: | ||
"polygons" : null, | "polygons" : null, | ||
"stakeholderID" : -1, | "stakeholderID" : -1, | ||
"text" : "", | "text" : "Hello World!", | ||
"type" : "EXCEL_PANEL", | "type" : "EXCEL_PANEL", | ||
"updateTiming" : "BEFORE", | "updateTiming" : "BEFORE", | ||
"version" : | "version" : 1, | ||
"warnings" : "", | "warnings" : "", | ||
"width" : null | "width" : null | ||
| Line 67: | Line 67: | ||
"type" : "TEXT_PANEL", | "type" : "TEXT_PANEL", | ||
"updateTiming" : "BEFORE", | "updateTiming" : "BEFORE", | ||
"version" : | "version" : 4, | ||
"warnings" : "", | "warnings" : "", | ||
"width" : null | "width" : null | ||
} ]</ | } ]</syntaxhighlight> | ||
==Limit Queries== | ==Limit Queries== | ||
version=100: | version=100: | ||
< | <syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/panels/?version=100&token=API_TOKEN</syntaxhighlight> | ||
== | ==Get Queries== | ||
attributes: | |||
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/panels/attributes/?token=API_TOKEN</syntaxhighlight> | |||
max version: | max version: | ||
< | <syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/panels/version/?token=API_TOKEN</syntaxhighlight> | ||
count: | |||
< | <syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/panels/count/?token=API_TOKEN</syntaxhighlight> | ||
==Formats== | ==Formats== | ||
HTML: | HTML: | ||
< | <syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/panels/?f=HTML&token=API_TOKEN</syntaxhighlight> | ||
JSON: | JSON: | ||
< | <syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/panels/?f=JSON&token=API_TOKEN</syntaxhighlight> | ||
CSV: | CSV: | ||
< | <syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/panels/?f=CSV&token=API_TOKEN</syntaxhighlight> | ||
SSV: | SSV: | ||
< | <syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/panels/?f=SSV&token=API_TOKEN</syntaxhighlight> | ||
SMILE: | SMILE: | ||
< | <syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/panels/?f=SMILE&token=API_TOKEN</syntaxhighlight> | ||
ZIPJSON: | ZIPJSON: | ||
< | <syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/panels/?f=ZIPJSON&token=API_TOKEN</syntaxhighlight> | ||
ZIPSMILE: | ZIPSMILE: | ||
< | <syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/panels/?f=ZIPSMILE&token=API_TOKEN</syntaxhighlight> | ||
==Api Model Answer== | |||
API Model description of Answer | |||
{|class=wikitable | |||
!Name | |||
!Type | |||
!Description | |||
|- | |||
| clientEvents | |||
| CodedEvent<nowiki>[]</nowiki> | |||
| | |||
|- | |||
| contents | |||
| String | |||
| | |||
|- | |||
| events | |||
| CodedEvent<nowiki>[]</nowiki> | |||
| | |||
|- | |||
| id | |||
| int | |||
| | |||
|- | |||
| selected | |||
| boolean | |||
| | |||
|} | |||
==Api Model CodedEvent== | |||
API Model description of CodedEvent | |||
{|class=wikitable | |||
!Name | |||
!Type | |||
!Description | |||
|- | |||
| id | |||
| int | |||
| | |||
|- | |||
| parameters | |||
| Object<nowiki>[]</nowiki> | |||
| | |||
|} | |||
==Api Model ExcelPanel== | |||
API Model description of ExcelPanel | |||
{|class=wikitable | |||
!Name | |||
!Type | |||
!Description | |||
|- | |||
| answers | |||
| Answer<nowiki>[]</nowiki> | |||
| [[Answer (Panel)]]<nowiki>[]</nowiki> | |||
|- | |||
| attributes | |||
| Map<String,double[]> | |||
| | |||
|- | |||
| calcTimeMS | |||
| long | |||
| | |||
|- | |||
| contentID | |||
| int | |||
| | |||
|- | |||
| contentMapLink | |||
| MapLink | |||
| [[Maplink]] | |||
|- | |||
| excelID | |||
| int | |||
| [[Excel Sheet]] ID | |||
|- | |||
| height | |||
| double | |||
| | |||
|- | |||
| id | |||
| int | |||
| | |||
|- | |||
| layoutX | |||
| double | |||
| | |||
|- | |||
| layoutY | |||
| double | |||
| | |||
|- | |||
| maquetteOverride | |||
| Map<String,double[]> | |||
| | |||
|- | |||
| name | |||
| String | |||
| | |||
|- | |||
| overlayID | |||
| int | |||
| [[Overlay]] ID | |||
|- | |||
| overrideDefaultAnswerID | |||
| int | |||
| | |||
|- | |||
| parentID | |||
| int | |||
| | |||
|- | |||
| point | |||
| Point | |||
| [[Point]] | |||
|- | |||
| polygons | |||
| MultiPolygon | |||
| [[MultiPolygon]] | |||
|- | |||
| stakeholderID | |||
| int | |||
| [[Stakeholder]] ID | |||
|- | |||
| text | |||
| String | |||
| | |||
|- | |||
| type | |||
| PanelType | |||
| [[Panel]]Type | |||
|- | |||
| updateTiming | |||
| Timing | |||
| | |||
|- | |||
| version | |||
| int | |||
| | |||
|- | |||
| warnings | |||
| String | |||
| | |||
|- | |||
| width | |||
| double | |||
| | |||
|} | |||
==Api Model GeometryCollection== | |||
API Model description of GeometryCollection | |||
{|class=wikitable | |||
!Name | |||
!Type | |||
!Description | |||
|} | |||
==Api Model GlobalPanel== | |||
API Model description of GlobalPanel | |||
{|class=wikitable | |||
!Name | |||
!Type | |||
!Description | |||
|- | |||
| answers | |||
| Answer<nowiki>[]</nowiki> | |||
| [[Answer (Panel)]]<nowiki>[]</nowiki> | |||
|- | |||
| attributes | |||
| Map<String,double[]> | |||
| | |||
|- | |||
| globalIDs | |||
| int<nowiki>[]</nowiki> | |||
| [[Global]]s ID | |||
|- | |||
| height | |||
| double | |||
| | |||
|- | |||
| id | |||
| int | |||
| | |||
|- | |||
| layoutX | |||
| double | |||
| | |||
|- | |||
| layoutY | |||
| double | |||
| | |||
|- | |||
| maquetteOverride | |||
| Map<String,double[]> | |||
| | |||
|- | |||
| name | |||
| String | |||
| | |||
|- | |||
| overlayID | |||
| int | |||
| [[Overlay]] ID | |||
|- | |||
| overrideDefaultAnswerID | |||
| int | |||
| | |||
|- | |||
| point | |||
| Point | |||
| [[Point]] | |||
|- | |||
| stakeholderID | |||
| int | |||
| [[Stakeholder]] ID | |||
|- | |||
| type | |||
| PanelType | |||
| [[Panel]]Type | |||
|- | |||
| version | |||
| int | |||
| | |||
|- | |||
| width | |||
| double | |||
| | |||
|} | |||
==Api Model LogicPanel== | |||
API Model description of LogicPanel | |||
{|class=wikitable | |||
!Name | |||
!Type | |||
!Description | |||
|- | |||
| answers | |||
| Answer<nowiki>[]</nowiki> | |||
| [[Answer (Panel)]]<nowiki>[]</nowiki> | |||
|- | |||
| attributes | |||
| Map<String,double[]> | |||
| | |||
|- | |||
| calcTimeMS | |||
| long | |||
| | |||
|- | |||
| contentID | |||
| int | |||
| | |||
|- | |||
| contentMapLink | |||
| MapLink | |||
| [[Maplink]] | |||
|- | |||
| height | |||
| double | |||
| | |||
|- | |||
| id | |||
| int | |||
| | |||
|- | |||
| layoutX | |||
| double | |||
| | |||
|- | |||
| layoutY | |||
| double | |||
| | |||
|- | |||
| maquetteOverride | |||
| Map<String,double[]> | |||
| | |||
|- | |||
| name | |||
| String | |||
| | |||
|- | |||
| overlayID | |||
| int | |||
| [[Overlay]] ID | |||
|- | |||
| overrideDefaultAnswerID | |||
| int | |||
| | |||
|- | |||
| parentID | |||
| int | |||
| | |||
|- | |||
| point | |||
| Point | |||
| [[Point]] | |||
|- | |||
| stakeholderID | |||
| int | |||
| [[Stakeholder]] ID | |||
|- | |||
| text | |||
| String | |||
| | |||
|- | |||
| type | |||
| PanelType | |||
| [[Panel]]Type | |||
|- | |||
| updateTiming | |||
| Timing | |||
| | |||
|- | |||
| version | |||
| int | |||
| | |||
|- | |||
| warnings | |||
| String | |||
| | |||
|- | |||
| width | |||
| double | |||
| | |||
|} | |||
==Api Model MultiPolygon== | |||
API Model description of MultiPolygon | |||
{|class=wikitable | |||
!Name | |||
!Type | |||
!Description | |||
|- | |||
| type | |||
| String | |||
| [[MultiPolygon]] | |||
|- | |||
| coordinates | |||
| double[][][][] | |||
| array of [[Polygon]]s; [[Polygon]] is array of outer and optional inner rings; rings is array of coordinates; coordinates is array of [x,y,(optional) z] | |||
|} | |||
==Api Model Panel== | |||
API Model description of Panel | |||
{|class=wikitable | |||
!Name | |||
!Type | |||
!Description | |||
|- | |||
| answers | |||
| Answer<nowiki>[]</nowiki> | |||
| [[Answer (Panel)]]<nowiki>[]</nowiki> | |||
|- | |||
| attributes | |||
| Map<String,double[]> | |||
| | |||
|- | |||
| height | |||
| double | |||
| | |||
|- | |||
| id | |||
| int | |||
| | |||
|- | |||
| layoutX | |||
| double | |||
| | |||
|- | |||
| layoutY | |||
| double | |||
| | |||
|- | |||
| maquetteOverride | |||
| Map<String,double[]> | |||
| | |||
|- | |||
| name | |||
| String | |||
| | |||
|- | |||
| overlayID | |||
| int | |||
| [[Overlay]] ID | |||
|- | |||
| overrideDefaultAnswerID | |||
| int | |||
| | |||
|- | |||
| point | |||
| Point | |||
| [[Point]] | |||
|- | |||
| stakeholderID | |||
| int | |||
| [[Stakeholder]] ID | |||
|- | |||
| type | |||
| PanelType | |||
| [[Panel]]Type | |||
|- | |||
| version | |||
| int | |||
| | |||
|- | |||
| width | |||
| double | |||
| | |||
|} | |||
==Api Model PanelType== | |||
API Enumeration description of PanelType | |||
{|class=wikitable | |||
!Name | |||
!Description | |||
|- | |||
| GLOBAL_PANEL | |||
| | |||
|- | |||
| EXCEL_PANEL | |||
| | |||
|- | |||
| WEB_PANEL | |||
| | |||
|- | |||
| TEXT_PANEL | |||
| | |||
|- | |||
| TEMPLATE_EXCEL_PANEL | |||
| | |||
|- | |||
| TEMPLATE_TEXT_PANEL | |||
| | |||
|} | |||
==Api Model Point== | |||
API Model description of Point | |||
{|class=wikitable | |||
!Name | |||
!Type | |||
!Description | |||
|- | |||
| type | |||
| String | |||
| [[Point]] | |||
|- | |||
| coordinates | |||
| double[] | |||
| x, y, (optional) z | |||
|} | |||
==Api Model Relation== | |||
API Enumeration description of Relation | |||
{|class=wikitable | |||
!Name | |||
!Description | |||
|- | |||
| OWNER | |||
| | |||
|- | |||
| CONSTRUCTOR | |||
| | |||
|- | |||
| DEMOLISHER | |||
| | |||
|- | |||
| PERMITTER | |||
| | |||
|- | |||
| SENDER | |||
| | |||
|- | |||
| RECEIVER | |||
| | |||
|- | |||
| NETOWNER | |||
| | |||
|- | |||
| BORDER_A | |||
| | |||
|- | |||
| BORDER_B | |||
| | |||
|- | |||
| BUILDING | |||
| | |||
|- | |||
| WEATHER | |||
| | |||
|- | |||
| PARENT | |||
| | |||
|- | |||
| RESULT_PARENT | |||
| | |||
|- | |||
| CONTENT | |||
| | |||
|} | |||
==Api Model TemplateExcelPanel== | |||
API Model description of TemplateExcelPanel | |||
{|class=wikitable | |||
!Name | |||
!Type | |||
!Description | |||
|- | |||
| answers | |||
| Answer<nowiki>[]</nowiki> | |||
| [[Answer (Panel)]]<nowiki>[]</nowiki> | |||
|- | |||
| attribute | |||
| String | |||
| | |||
|- | |||
| attributes | |||
| Map<String,double[]> | |||
| | |||
|- | |||
| autoApplied | |||
| boolean | |||
| | |||
|- | |||
| calcTimeMS | |||
| long | |||
| | |||
|- | |||
| contentID | |||
| int | |||
| | |||
|- | |||
| contentMapLink | |||
| MapLink | |||
| [[Maplink]] | |||
|- | |||
| excelID | |||
| int | |||
| [[Excel Sheet]] ID | |||
|- | |||
| height | |||
| double | |||
| | |||
|- | |||
| id | |||
| int | |||
| | |||
|- | |||
| layoutX | |||
| double | |||
| | |||
|- | |||
| layoutY | |||
| double | |||
| | |||
|- | |||
| mapLink | |||
| MapLink | |||
| [[Maplink]] | |||
|- | |||
| maquetteOverride | |||
| Map<String,double[]> | |||
| | |||
|- | |||
| name | |||
| String | |||
| | |||
|- | |||
| overlayID | |||
| int | |||
| [[Overlay]] ID | |||
|- | |||
| overrideDefaultAnswerID | |||
| int | |||
| | |||
|- | |||
| parentID | |||
| int | |||
| | |||
|- | |||
| point | |||
| Point | |||
| [[Point]] | |||
|- | |||
| polygons | |||
| MultiPolygon | |||
| [[MultiPolygon]] | |||
|- | |||
| relation | |||
| Relation | |||
| [[Relation]] | |||
|- | |||
| stakeholderID | |||
| int | |||
| [[Stakeholder]] ID | |||
|- | |||
| text | |||
| String | |||
| | |||
|- | |||
| type | |||
| PanelType | |||
| [[Panel]]Type | |||
|- | |||
| updateTiming | |||
| Timing | |||
| | |||
|- | |||
| useOwner | |||
| boolean | |||
| | |||
|- | |||
| version | |||
| int | |||
| | |||
|- | |||
| warnings | |||
| String | |||
| | |||
|- | |||
| width | |||
| double | |||
| | |||
|} | |||
==Api Model TemplateTextPanel== | |||
API Model description of TemplateTextPanel | |||
{|class=wikitable | |||
!Name | |||
!Type | |||
!Description | |||
|- | |||
| answers | |||
| Answer<nowiki>[]</nowiki> | |||
| [[Answer (Panel)]]<nowiki>[]</nowiki> | |||
|- | |||
| attribute | |||
| String | |||
| | |||
|- | |||
| attributes | |||
| Map<String,double[]> | |||
| | |||
|- | |||
| autoApplied | |||
| boolean | |||
| | |||
|- | |||
| calcTimeMS | |||
| long | |||
| | |||
|- | |||
| contentID | |||
| int | |||
| | |||
|- | |||
| contentMapLink | |||
| MapLink | |||
| [[Maplink]] | |||
|- | |||
| height | |||
| double | |||
| | |||
|- | |||
| id | |||
| int | |||
| | |||
|- | |||
| layoutX | |||
| double | |||
| | |||
|- | |||
| layoutY | |||
| double | |||
| | |||
|- | |||
| mapLink | |||
| MapLink | |||
| [[Maplink]] | |||
|- | |||
| maquetteOverride | |||
| Map<String,double[]> | |||
| | |||
|- | |||
| name | |||
| String | |||
| | |||
|- | |||
| overlayID | |||
| int | |||
| [[Overlay]] ID | |||
|- | |||
| overrideDefaultAnswerID | |||
| int | |||
| | |||
|- | |||
| parentID | |||
| int | |||
| | |||
|- | |||
| point | |||
| Point | |||
| [[Point]] | |||
|- | |||
| relation | |||
| Relation | |||
| [[Relation]] | |||
|- | |||
| stakeholderID | |||
| int | |||
| [[Stakeholder]] ID | |||
|- | |||
| text | |||
| String | |||
| | |||
|- | |||
| type | |||
| PanelType | |||
| [[Panel]]Type | |||
|- | |||
| updateTiming | |||
| Timing | |||
| | |||
|- | |||
| useOwner | |||
| boolean | |||
| | |||
|- | |||
| version | |||
| int | |||
| | |||
|- | |||
| warnings | |||
| String | |||
| | |||
|- | |||
| width | |||
| double | |||
| | |||
|} | |||
==Api Model TextPanel== | |||
API Model description of TextPanel | |||
{|class=wikitable | |||
!Name | |||
!Type | |||
!Description | |||
|- | |||
| answers | |||
| Answer<nowiki>[]</nowiki> | |||
| [[Answer (Panel)]]<nowiki>[]</nowiki> | |||
|- | |||
| attributes | |||
| Map<String,double[]> | |||
| | |||
|- | |||
| calcTimeMS | |||
| long | |||
| | |||
|- | |||
| contentID | |||
| int | |||
| | |||
|- | |||
| contentMapLink | |||
| MapLink | |||
| [[Maplink]] | |||
|- | |||
| height | |||
| double | |||
| | |||
|- | |||
| id | |||
| int | |||
| | |||
|- | |||
| layoutX | |||
| double | |||
| | |||
|- | |||
| layoutY | |||
| double | |||
| | |||
|- | |||
| maquetteOverride | |||
| Map<String,double[]> | |||
| | |||
|- | |||
| name | |||
| String | |||
| | |||
|- | |||
| overlayID | |||
| int | |||
| [[Overlay]] ID | |||
|- | |||
| overrideDefaultAnswerID | |||
| int | |||
| | |||
|- | |||
| parentID | |||
| int | |||
| | |||
|- | |||
| point | |||
| Point | |||
| [[Point]] | |||
|- | |||
| stakeholderID | |||
| int | |||
| [[Stakeholder]] ID | |||
|- | |||
| text | |||
| String | |||
| | |||
|- | |||
| type | |||
| PanelType | |||
| [[Panel]]Type | |||
|- | |||
| updateTiming | |||
| Timing | |||
| | |||
|- | |||
| version | |||
| int | |||
| | |||
|- | |||
| warnings | |||
| String | |||
| | |||
|- | |||
| width | |||
| double | |||
| | |||
|} | |||
==Api Model Timing== | |||
API Enumeration description of Timing | |||
{|class=wikitable | |||
!Name | |||
!Description | |||
|- | |||
| BEFORE | |||
| | |||
|- | |||
| AFTER | |||
| | |||
|} | |||
==Api Model WebPanel== | |||
API Model description of WebPanel | |||
{|class=wikitable | |||
!Name | |||
!Type | |||
!Description | |||
|- | |||
| answers | |||
| Answer<nowiki>[]</nowiki> | |||
| [[Answer (Panel)]]<nowiki>[]</nowiki> | |||
|- | |||
| attributes | |||
| Map<String,double[]> | |||
| | |||
|- | |||
| height | |||
| double | |||
| | |||
|- | |||
| id | |||
| int | |||
| | |||
|- | |||
| layoutX | |||
| double | |||
| | |||
|- | |||
| layoutY | |||
| double | |||
| | |||
|- | |||
| maquetteOverride | |||
| Map<String,double[]> | |||
| | |||
|- | |||
| name | |||
| String | |||
| | |||
|- | |||
| overlayID | |||
| int | |||
| [[Overlay]] ID | |||
|- | |||
| overrideDefaultAnswerID | |||
| int | |||
| | |||
|- | |||
| point | |||
| Point | |||
| [[Point]] | |||
|- | |||
| stakeholderID | |||
| int | |||
| [[Stakeholder]] ID | |||
|- | |||
| type | |||
| PanelType | |||
| [[Panel]]Type | |||
|- | |||
| url | |||
| String | |||
| | |||
|- | |||
| version | |||
| int | |||
| | |||
|- | |||
| width | |||
| double | |||
| | |||
|} | |||
{{article end|seealso=*[[Api Content Items]] | {{article end|seealso=*[[Api Content Items]] | ||
*[[Api session event editor panel]] | *[[Api session event editor panel]] | ||
| Line 99: | Line 1,036: | ||
[[Category:API]] | [[Category:API]] | ||
[[Category:Items]] | |||
Latest revision as of 07:06, 14 July 2026
API Endpoint: /api/session/items/panels/
Edit items with events described at Api session event editor panel.
Default Query:
https://engine.tygron.com/api/session/items/panels/?f=JSON&token=API_TOKENExample Response:
[ {
"answers" : [ ],
"attributes" : {
"ATTENTION" : [ 1.0 ],
"POPUP_TYPE" : [ 0.0 ],
"SCALE" : [ 1.0 ],
"VISIBLE" : [ 1.0 ],
"VISIBLE_TIMEFRAME" : [ 0.0 ]
},
"calcTimeMS" : 1,
"contentID" : null,
"contentMapLink" : null,
"excelID" : 1,
"height" : null,
"id" : 0,
"layoutX" : null,
"layoutY" : null,
"maquetteOverride" : null,
"name" : "Excel Panel",
"overlayID" : -1,
"overrideDefaultAnswerID" : -1,
"parentID" : null,
"point" : null,
"polygons" : null,
"stakeholderID" : -1,
"text" : "Hello World!",
"type" : "EXCEL_PANEL",
"updateTiming" : "BEFORE",
"version" : 1,
"warnings" : "",
"width" : null
}, {
"answers" : [ ],
"attributes" : {
"ATTENTION" : [ 1.0 ],
"COLOR" : [ -6704129.0 ],
"POPUP_TYPE" : [ 7.0 ],
"SCALE" : [ 1.0 ],
"VISIBLE" : [ 1.0 ],
"VISIBLE_TIMEFRAME" : [ 0.0 ]
},
"calcTimeMS" : 0,
"contentID" : null,
"contentMapLink" : null,
"height" : null,
"id" : 1,
"layoutX" : null,
"layoutY" : null,
"maquetteOverride" : null,
"name" : "Text Panel",
"overlayID" : -1,
"overrideDefaultAnswerID" : -1,
"parentID" : null,
"point" : {
"type" : "Point",
"coordinates" : [ 658907.9990757483, 6798948.801026824 ]
},
"stakeholderID" : -1,
"text" : "Point of interest",
"type" : "TEXT_PANEL",
"updateTiming" : "BEFORE",
"version" : 4,
"warnings" : "",
"width" : null
} ]Limit Queries
version=100:
https://engine.tygron.com/api/session/items/panels/?version=100&token=API_TOKENGet Queries
attributes:
https://engine.tygron.com/api/session/items/panels/attributes/?token=API_TOKENmax version:
https://engine.tygron.com/api/session/items/panels/version/?token=API_TOKENcount:
https://engine.tygron.com/api/session/items/panels/count/?token=API_TOKENFormats
HTML:
https://engine.tygron.com/api/session/items/panels/?f=HTML&token=API_TOKENJSON:
https://engine.tygron.com/api/session/items/panels/?f=JSON&token=API_TOKENCSV:
https://engine.tygron.com/api/session/items/panels/?f=CSV&token=API_TOKENSSV:
https://engine.tygron.com/api/session/items/panels/?f=SSV&token=API_TOKENSMILE:
https://engine.tygron.com/api/session/items/panels/?f=SMILE&token=API_TOKENZIPJSON:
https://engine.tygron.com/api/session/items/panels/?f=ZIPJSON&token=API_TOKENZIPSMILE:
https://engine.tygron.com/api/session/items/panels/?f=ZIPSMILE&token=API_TOKENApi Model Answer
API Model description of Answer
| Name | Type | Description |
|---|---|---|
| clientEvents | CodedEvent[] | |
| contents | String | |
| events | CodedEvent[] | |
| id | int | |
| selected | boolean |
Api Model CodedEvent
API Model description of CodedEvent
| Name | Type | Description |
|---|---|---|
| id | int | |
| parameters | Object[] |
Api Model ExcelPanel
API Model description of ExcelPanel
| Name | Type | Description |
|---|---|---|
| answers | Answer[] | Answer (Panel)[] |
| attributes | Map<String,double[]> | |
| calcTimeMS | long | |
| contentID | int | |
| contentMapLink | MapLink | Maplink |
| excelID | int | Excel Sheet ID |
| height | double | |
| id | int | |
| layoutX | double | |
| layoutY | double | |
| maquetteOverride | Map<String,double[]> | |
| name | String | |
| overlayID | int | Overlay ID |
| overrideDefaultAnswerID | int | |
| parentID | int | |
| point | Point | Point |
| polygons | MultiPolygon | MultiPolygon |
| stakeholderID | int | Stakeholder ID |
| text | String | |
| type | PanelType | PanelType |
| updateTiming | Timing | |
| version | int | |
| warnings | String | |
| width | double |
Api Model GeometryCollection
API Model description of GeometryCollection
| Name | Type | Description |
|---|
Api Model GlobalPanel
API Model description of GlobalPanel
| Name | Type | Description |
|---|---|---|
| answers | Answer[] | Answer (Panel)[] |
| attributes | Map<String,double[]> | |
| globalIDs | int[] | Globals ID |
| height | double | |
| id | int | |
| layoutX | double | |
| layoutY | double | |
| maquetteOverride | Map<String,double[]> | |
| name | String | |
| overlayID | int | Overlay ID |
| overrideDefaultAnswerID | int | |
| point | Point | Point |
| stakeholderID | int | Stakeholder ID |
| type | PanelType | PanelType |
| version | int | |
| width | double |
Api Model LogicPanel
API Model description of LogicPanel
| Name | Type | Description |
|---|---|---|
| answers | Answer[] | Answer (Panel)[] |
| attributes | Map<String,double[]> | |
| calcTimeMS | long | |
| contentID | int | |
| contentMapLink | MapLink | Maplink |
| height | double | |
| id | int | |
| layoutX | double | |
| layoutY | double | |
| maquetteOverride | Map<String,double[]> | |
| name | String | |
| overlayID | int | Overlay ID |
| overrideDefaultAnswerID | int | |
| parentID | int | |
| point | Point | Point |
| stakeholderID | int | Stakeholder ID |
| text | String | |
| type | PanelType | PanelType |
| updateTiming | Timing | |
| version | int | |
| warnings | String | |
| width | double |
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 Panel
API Model description of Panel
| Name | Type | Description |
|---|---|---|
| answers | Answer[] | Answer (Panel)[] |
| attributes | Map<String,double[]> | |
| height | double | |
| id | int | |
| layoutX | double | |
| layoutY | double | |
| maquetteOverride | Map<String,double[]> | |
| name | String | |
| overlayID | int | Overlay ID |
| overrideDefaultAnswerID | int | |
| point | Point | Point |
| stakeholderID | int | Stakeholder ID |
| type | PanelType | PanelType |
| version | int | |
| width | double |
Api Model PanelType
API Enumeration description of PanelType
| Name | Description |
|---|---|
| GLOBAL_PANEL | |
| EXCEL_PANEL | |
| WEB_PANEL | |
| TEXT_PANEL | |
| TEMPLATE_EXCEL_PANEL | |
| TEMPLATE_TEXT_PANEL |
Api Model Point
API Model description of Point
| Name | Type | Description |
|---|---|---|
| type | String | Point |
| coordinates | double[] | x, y, (optional) z |
Api Model Relation
API Enumeration description of Relation
| Name | Description |
|---|---|
| OWNER | |
| CONSTRUCTOR | |
| DEMOLISHER | |
| PERMITTER | |
| SENDER | |
| RECEIVER | |
| NETOWNER | |
| BORDER_A | |
| BORDER_B | |
| BUILDING | |
| WEATHER | |
| PARENT | |
| RESULT_PARENT | |
| CONTENT |
Api Model TemplateExcelPanel
API Model description of TemplateExcelPanel
| Name | Type | Description |
|---|---|---|
| answers | Answer[] | Answer (Panel)[] |
| attribute | String | |
| attributes | Map<String,double[]> | |
| autoApplied | boolean | |
| calcTimeMS | long | |
| contentID | int | |
| contentMapLink | MapLink | Maplink |
| excelID | int | Excel Sheet ID |
| height | double | |
| id | int | |
| layoutX | double | |
| layoutY | double | |
| mapLink | MapLink | Maplink |
| maquetteOverride | Map<String,double[]> | |
| name | String | |
| overlayID | int | Overlay ID |
| overrideDefaultAnswerID | int | |
| parentID | int | |
| point | Point | Point |
| polygons | MultiPolygon | MultiPolygon |
| relation | Relation | Relation |
| stakeholderID | int | Stakeholder ID |
| text | String | |
| type | PanelType | PanelType |
| updateTiming | Timing | |
| useOwner | boolean | |
| version | int | |
| warnings | String | |
| width | double |
Api Model TemplateTextPanel
API Model description of TemplateTextPanel
| Name | Type | Description |
|---|---|---|
| answers | Answer[] | Answer (Panel)[] |
| attribute | String | |
| attributes | Map<String,double[]> | |
| autoApplied | boolean | |
| calcTimeMS | long | |
| contentID | int | |
| contentMapLink | MapLink | Maplink |
| height | double | |
| id | int | |
| layoutX | double | |
| layoutY | double | |
| mapLink | MapLink | Maplink |
| maquetteOverride | Map<String,double[]> | |
| name | String | |
| overlayID | int | Overlay ID |
| overrideDefaultAnswerID | int | |
| parentID | int | |
| point | Point | Point |
| relation | Relation | Relation |
| stakeholderID | int | Stakeholder ID |
| text | String | |
| type | PanelType | PanelType |
| updateTiming | Timing | |
| useOwner | boolean | |
| version | int | |
| warnings | String | |
| width | double |
Api Model TextPanel
API Model description of TextPanel
| Name | Type | Description |
|---|---|---|
| answers | Answer[] | Answer (Panel)[] |
| attributes | Map<String,double[]> | |
| calcTimeMS | long | |
| contentID | int | |
| contentMapLink | MapLink | Maplink |
| height | double | |
| id | int | |
| layoutX | double | |
| layoutY | double | |
| maquetteOverride | Map<String,double[]> | |
| name | String | |
| overlayID | int | Overlay ID |
| overrideDefaultAnswerID | int | |
| parentID | int | |
| point | Point | Point |
| stakeholderID | int | Stakeholder ID |
| text | String | |
| type | PanelType | PanelType |
| updateTiming | Timing | |
| version | int | |
| warnings | String | |
| width | double |
Api Model Timing
API Enumeration description of Timing
| Name | Description |
|---|---|
| BEFORE | |
| AFTER |
Api Model WebPanel
API Model description of WebPanel
| Name | Type | Description |
|---|---|---|
| answers | Answer[] | Answer (Panel)[] |
| attributes | Map<String,double[]> | |
| height | double | |
| id | int | |
| layoutX | double | |
| layoutY | double | |
| maquetteOverride | Map<String,double[]> | |
| name | String | |
| overlayID | int | Overlay ID |
| overrideDefaultAnswerID | int | |
| point | Point | Point |
| stakeholderID | int | Stakeholder ID |
| type | PanelType | PanelType |
| url | String | |
| version | int | |
| width | double |