Api session items panels: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| (37 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
API Endpoint: /api/session/items/panels/ | |||
Edit items with | Edit items with events described at [[Api session event editor panel]]. | ||
Default Query: | Default Query: | ||
| Line 15: | Line 15: | ||
"VISIBLE_TIMEFRAME" : [ 0.0 ] | "VISIBLE_TIMEFRAME" : [ 0.0 ] | ||
}, | }, | ||
"calcTimeMS" : | "calcTimeMS" : 1, | ||
"contentID" : null, | "contentID" : null, | ||
"contentMapLink" : null, | "contentMapLink" : null, | ||
| Line 67: | Line 67: | ||
"type" : "TEXT_PANEL", | "type" : "TEXT_PANEL", | ||
"updateTiming" : "BEFORE", | "updateTiming" : "BEFORE", | ||
"version" : | "version" : 4, | ||
"warnings" : "", | "warnings" : "", | ||
"width" : null | "width" : null | ||
| Line 74: | Line 74: | ||
version=100: | version=100: | ||
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/panels/?version=100&token=API_TOKEN</syntaxhighlight> | <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> | <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/ | <syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/panels/count/?token=API_TOKEN</syntaxhighlight> | ||
==Formats== | ==Formats== | ||
HTML: | HTML: | ||
| Line 94: | Line 96: | ||
ZIPSMILE: | ZIPSMILE: | ||
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/panels/?f=ZIPSMILE&token=API_TOKEN</syntaxhighlight> | <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 ExcelPanel== | ||
API Model description of ExcelPanel | API Model description of ExcelPanel | ||
| Line 102: | Line 150: | ||
!Description | !Description | ||
|- | |- | ||
|answers | | answers | ||
|Answer<nowiki>[]</nowiki> | | Answer<nowiki>[]</nowiki> | ||
| | | [[Answer (Panel)]]<nowiki>[]</nowiki> | ||
|- | |- | ||
|attributes | | attributes | ||
|Map<String,double[]> | | Map<String,double[]> | ||
| | | | ||
|- | |- | ||
|calcTimeMS | | calcTimeMS | ||
|long | | long | ||
| | | | ||
|- | |- | ||
|contentID | | contentID | ||
|int | | int | ||
| | | | ||
|- | |- | ||
|contentMapLink | | contentMapLink | ||
|MapLink | | MapLink | ||
| | | [[Maplink]] | ||
|- | |- | ||
|excelID | | excelID | ||
|int | | int | ||
|[[Excel Sheet]] ID | | [[Excel Sheet]] ID | ||
|- | |- | ||
|height | | height | ||
|double | | double | ||
| | | | ||
|- | |- | ||
|id | | id | ||
|int | | int | ||
| | | | ||
|- | |- | ||
|layoutX | | layoutX | ||
|double | | double | ||
| | | | ||
|- | |- | ||
|layoutY | | layoutY | ||
|double | | double | ||
| | | | ||
|- | |- | ||
|maquetteOverride | | maquetteOverride | ||
|Map<String,double[]> | | Map<String,double[]> | ||
| | | | ||
|- | |- | ||
|name | | name | ||
|String | | String | ||
| | | | ||
|- | |- | ||
|overlayID | | overlayID | ||
|int | | int | ||
|[[Overlay]] ID | | [[Overlay]] ID | ||
|- | |- | ||
|overrideDefaultAnswerID | | overrideDefaultAnswerID | ||
|int | | int | ||
| | | | ||
|- | |- | ||
|parentID | | parentID | ||
|int | | int | ||
| | | | ||
|- | |- | ||
|point | | point | ||
|Point | | Point | ||
| | | [[Point]] | ||
|- | |- | ||
|polygons | | polygons | ||
|MultiPolygon | | MultiPolygon | ||
| | | [[MultiPolygon]] | ||
|- | |- | ||
|stakeholderID | | stakeholderID | ||
|int | | int | ||
|[[Stakeholder]] ID | | [[Stakeholder]] ID | ||
|- | |- | ||
|text | | text | ||
|String | | String | ||
| | | | ||
|- | |- | ||
|type | | type | ||
|PanelType | | PanelType | ||
| | | [[Panel]]Type | ||
|- | |- | ||
|updateTiming | | updateTiming | ||
|Timing | | Timing | ||
| | | | ||
|- | |- | ||
|version | | version | ||
|int | | int | ||
| | | | ||
|- | |- | ||
|warnings | | warnings | ||
|String | | String | ||
| | | | ||
|- | |- | ||
|width | | width | ||
|double | | double | ||
| | | | ||
|} | |||
==Api Model GeometryCollection== | |||
API Model description of GeometryCollection | |||
{|class=wikitable | |||
!Name | |||
!Type | |||
!Description | |||
|} | |} | ||
| Line 207: | Line 264: | ||
!Description | !Description | ||
|- | |- | ||
|answers | | answers | ||
|Answer<nowiki>[]</nowiki> | | Answer<nowiki>[]</nowiki> | ||
| | | [[Answer (Panel)]]<nowiki>[]</nowiki> | ||
|- | |- | ||
|attributes | | attributes | ||
|Map<String,double[]> | | Map<String,double[]> | ||
| | | | ||
|- | |- | ||
|globalIDs | | globalIDs | ||
|int<nowiki>[]</nowiki> | | int<nowiki>[]</nowiki> | ||
|[[Global]] ID | | [[Global]]s ID | ||
|- | |- | ||
|height | | height | ||
|double | | double | ||
| | | | ||
|- | |- | ||
|id | | id | ||
|int | | int | ||
| | | | ||
|- | |- | ||
|layoutX | | layoutX | ||
|double | | double | ||
| | | | ||
|- | |- | ||
|layoutY | | layoutY | ||
|double | | double | ||
| | | | ||
|- | |- | ||
|maquetteOverride | | maquetteOverride | ||
|Map<String,double[]> | | Map<String,double[]> | ||
| | | | ||
|- | |- | ||
|name | | name | ||
|String | | String | ||
| | | | ||
|- | |- | ||
|overlayID | | overlayID | ||
|int | | int | ||
|[[Overlay]] ID | | [[Overlay]] ID | ||
|- | |- | ||
|overrideDefaultAnswerID | | overrideDefaultAnswerID | ||
|int | | int | ||
| | | | ||
|- | |- | ||
|point | | point | ||
|Point | | Point | ||
| | | [[Point]] | ||
|- | |- | ||
|stakeholderID | | stakeholderID | ||
|int | | int | ||
|[[Stakeholder]] ID | | [[Stakeholder]] ID | ||
|- | |- | ||
|type | | type | ||
|PanelType | | PanelType | ||
| | | [[Panel]]Type | ||
|- | |- | ||
|version | | version | ||
|int | | int | ||
| | | | ||
|- | |- | ||
|width | | width | ||
|double | | double | ||
| | | | ||
|} | |} | ||
| Line 280: | Line 337: | ||
!Description | !Description | ||
|- | |- | ||
|answers | | answers | ||
|Answer<nowiki>[]</nowiki> | | Answer<nowiki>[]</nowiki> | ||
| | | [[Answer (Panel)]]<nowiki>[]</nowiki> | ||
|- | |- | ||
|attributes | | attributes | ||
|Map<String,double[]> | | Map<String,double[]> | ||
| | | | ||
|- | |- | ||
|calcTimeMS | | calcTimeMS | ||
|long | | long | ||
| | | | ||
|- | |- | ||
|contentID | | contentID | ||
|int | | int | ||
| | | | ||
|- | |- | ||
|contentMapLink | | contentMapLink | ||
|MapLink | | MapLink | ||
| | | [[Maplink]] | ||
|- | |- | ||
|height | | height | ||
|double | | double | ||
| | | | ||
|- | |- | ||
|id | | id | ||
|int | | int | ||
| | | | ||
|- | |- | ||
|layoutX | | layoutX | ||
|double | | double | ||
| | | | ||
|- | |- | ||
|layoutY | | layoutY | ||
|double | | double | ||
| | | | ||
|- | |- | ||
|maquetteOverride | | maquetteOverride | ||
|Map<String,double[]> | | Map<String,double[]> | ||
| | | | ||
|- | |- | ||
|name | | name | ||
|String | | String | ||
| | | | ||
|- | |- | ||
|overlayID | | overlayID | ||
|int | | int | ||
|[[Overlay]] ID | | [[Overlay]] ID | ||
|- | |- | ||
|overrideDefaultAnswerID | | overrideDefaultAnswerID | ||
|int | | int | ||
| | | | ||
|- | |- | ||
|parentID | | parentID | ||
|int | | int | ||
| | | | ||
|- | |- | ||
|point | | point | ||
|Point | | Point | ||
| | | [[Point]] | ||
|- | |- | ||
|stakeholderID | | stakeholderID | ||
|int | | int | ||
|[[Stakeholder]] ID | | [[Stakeholder]] ID | ||
|- | |- | ||
|text | | text | ||
|String | | String | ||
| | | | ||
|- | |- | ||
|type | | type | ||
|PanelType | | PanelType | ||
| | | [[Panel]]Type | ||
|- | |- | ||
|updateTiming | | updateTiming | ||
|Timing | | Timing | ||
| | | | ||
|- | |- | ||
|version | | version | ||
|int | | int | ||
| | | | ||
|- | |- | ||
|warnings | | warnings | ||
|String | | String | ||
| | | | ||
|- | |- | ||
|width | | width | ||
|double | | 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] | |||
|} | |} | ||
| Line 377: | Line 451: | ||
!Description | !Description | ||
|- | |- | ||
|answers | | answers | ||
|Answer<nowiki>[]</nowiki> | | 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 | |||
| | |||
|} | |} | ||
| Line 446: | Line 613: | ||
!Description | !Description | ||
|- | |- | ||
|answers | | answers | ||
|Answer<nowiki>[]</nowiki> | | Answer<nowiki>[]</nowiki> | ||
| | | [[Answer (Panel)]]<nowiki>[]</nowiki> | ||
|- | |- | ||
|attribute | | attribute | ||
|String | | String | ||
| | | | ||
|- | |- | ||
|attributes | | attributes | ||
|Map<String,double[]> | | Map<String,double[]> | ||
| | | | ||
|- | |- | ||
|autoApplied | | autoApplied | ||
|boolean | | boolean | ||
| | | | ||
|- | |- | ||
|calcTimeMS | | calcTimeMS | ||
|long | | long | ||
| | | | ||
|- | |- | ||
|contentID | | contentID | ||
|int | | int | ||
| | | | ||
|- | |- | ||
|contentMapLink | | contentMapLink | ||
|MapLink | | MapLink | ||
| | | [[Maplink]] | ||
|- | |- | ||
|excelID | | excelID | ||
|int | | int | ||
|[[Excel Sheet]] ID | | [[Excel Sheet]] ID | ||
|- | |- | ||
|height | | height | ||
|double | | double | ||
| | | | ||
|- | |- | ||
|id | | id | ||
|int | | int | ||
| | | | ||
|- | |- | ||
|layoutX | | layoutX | ||
|double | | double | ||
| | | | ||
|- | |- | ||
|layoutY | | layoutY | ||
|double | | double | ||
| | | | ||
|- | |- | ||
|mapLink | | mapLink | ||
|MapLink | | MapLink | ||
| | | [[Maplink]] | ||
|- | |- | ||
|maquetteOverride | | maquetteOverride | ||
|Map<String,double[]> | | Map<String,double[]> | ||
| | | | ||
|- | |- | ||
|name | | name | ||
|String | | String | ||
| | | | ||
|- | |- | ||
|overlayID | | overlayID | ||
|int | | int | ||
|[[Overlay]] ID | | [[Overlay]] ID | ||
|- | |- | ||
|overrideDefaultAnswerID | | overrideDefaultAnswerID | ||
|int | | int | ||
| | | | ||
|- | |- | ||
|parentID | | parentID | ||
|int | | int | ||
| | | | ||
|- | |- | ||
|point | | point | ||
|Point | | Point | ||
| | | [[Point]] | ||
|- | |- | ||
|polygons | | polygons | ||
|MultiPolygon | | MultiPolygon | ||
| | | [[MultiPolygon]] | ||
|- | |- | ||
|relation | | relation | ||
|Relation | | Relation | ||
| | | [[Relation]] | ||
|- | |- | ||
|stakeholderID | | stakeholderID | ||
|int | | int | ||
|[[Stakeholder]] ID | | [[Stakeholder]] ID | ||
|- | |- | ||
|text | | text | ||
|String | | String | ||
| | | | ||
|- | |- | ||
|type | | type | ||
|PanelType | | PanelType | ||
| | | [[Panel]]Type | ||
|- | |- | ||
|updateTiming | | updateTiming | ||
|Timing | | Timing | ||
| | | | ||
|- | |- | ||
|useOwner | | useOwner | ||
|boolean | | boolean | ||
| | | | ||
|- | |- | ||
|version | | version | ||
|int | | int | ||
| | | | ||
|- | |- | ||
|warnings | | warnings | ||
|String | | String | ||
| | | | ||
|- | |- | ||
|width | | width | ||
|double | | double | ||
| | | | ||
|} | |} | ||
| Line 571: | Line 738: | ||
!Description | !Description | ||
|- | |- | ||
|answers | | answers | ||
|Answer<nowiki>[]</nowiki> | | Answer<nowiki>[]</nowiki> | ||
| | | [[Answer (Panel)]]<nowiki>[]</nowiki> | ||
|- | |- | ||
|attribute | | attribute | ||
|String | | String | ||
| | | | ||
|- | |- | ||
|attributes | | attributes | ||
|Map<String,double[]> | | Map<String,double[]> | ||
| | | | ||
|- | |- | ||
|autoApplied | | autoApplied | ||
|boolean | | boolean | ||
| | | | ||
|- | |- | ||
|calcTimeMS | | calcTimeMS | ||
|long | | long | ||
| | | | ||
|- | |- | ||
|contentID | | contentID | ||
|int | | int | ||
| | | | ||
|- | |- | ||
|contentMapLink | | contentMapLink | ||
|MapLink | | MapLink | ||
| | | [[Maplink]] | ||
|- | |- | ||
|height | | height | ||
|double | | double | ||
| | | | ||
|- | |- | ||
|id | | id | ||
|int | | int | ||
| | | | ||
|- | |- | ||
|layoutX | | layoutX | ||
|double | | double | ||
| | | | ||
|- | |- | ||
|layoutY | | layoutY | ||
|double | | double | ||
| | | | ||
|- | |- | ||
|mapLink | | mapLink | ||
|MapLink | | MapLink | ||
| | | [[Maplink]] | ||
|- | |- | ||
|maquetteOverride | | maquetteOverride | ||
|Map<String,double[]> | | Map<String,double[]> | ||
| | | | ||
|- | |- | ||
|name | | name | ||
|String | | String | ||
| | | | ||
|- | |- | ||
|overlayID | | overlayID | ||
|int | | int | ||
|[[Overlay]] ID | | [[Overlay]] ID | ||
|- | |- | ||
|overrideDefaultAnswerID | | overrideDefaultAnswerID | ||
|int | | int | ||
| | | | ||
|- | |- | ||
|parentID | | parentID | ||
|int | | int | ||
| | | | ||
|- | |- | ||
|point | | point | ||
|Point | | Point | ||
| | | [[Point]] | ||
|- | |- | ||
|relation | | relation | ||
|Relation | | Relation | ||
| | | [[Relation]] | ||
|- | |- | ||
|stakeholderID | | stakeholderID | ||
|int | | int | ||
|[[Stakeholder]] ID | | [[Stakeholder]] ID | ||
|- | |- | ||
|text | | text | ||
|String | | String | ||
| | | | ||
|- | |- | ||
|type | | type | ||
|PanelType | | PanelType | ||
| | | [[Panel]]Type | ||
|- | |- | ||
|updateTiming | | updateTiming | ||
|Timing | | Timing | ||
| | | | ||
|- | |- | ||
|useOwner | | useOwner | ||
|boolean | | boolean | ||
| | | | ||
|- | |- | ||
|version | | version | ||
|int | | int | ||
| | | | ||
|- | |- | ||
|warnings | | warnings | ||
|String | | String | ||
| | | | ||
|- | |- | ||
|width | | width | ||
|double | | double | ||
| | | | ||
|} | |} | ||
| Line 688: | Line 855: | ||
!Description | !Description | ||
|- | |- | ||
|answers | | answers | ||
|Answer<nowiki>[]</nowiki> | | Answer<nowiki>[]</nowiki> | ||
| | | [[Answer (Panel)]]<nowiki>[]</nowiki> | ||
|- | |- | ||
|attributes | | attributes | ||
|Map<String,double[]> | | Map<String,double[]> | ||
| | | | ||
|- | |- | ||
|calcTimeMS | | calcTimeMS | ||
|long | | long | ||
| | | | ||
|- | |- | ||
|contentID | | contentID | ||
|int | | int | ||
| | | | ||
|- | |- | ||
|contentMapLink | | contentMapLink | ||
|MapLink | | MapLink | ||
| | | [[Maplink]] | ||
|- | |- | ||
|height | | height | ||
|double | | double | ||
| | | | ||
|- | |- | ||
|id | | id | ||
|int | | int | ||
| | | | ||
|- | |- | ||
|layoutX | | layoutX | ||
|double | | double | ||
| | | | ||
|- | |- | ||
|layoutY | | layoutY | ||
|double | | double | ||
| | | | ||
|- | |- | ||
|maquetteOverride | | maquetteOverride | ||
|Map<String,double[]> | | Map<String,double[]> | ||
| | | | ||
|- | |- | ||
|name | | name | ||
|String | | String | ||
| | | | ||
|- | |- | ||
|overlayID | | overlayID | ||
|int | | int | ||
|[[Overlay]] ID | | [[Overlay]] ID | ||
|- | |- | ||
|overrideDefaultAnswerID | | overrideDefaultAnswerID | ||
|int | | int | ||
| | | | ||
|- | |- | ||
|parentID | | parentID | ||
|int | | int | ||
| | | | ||
|- | |- | ||
|point | | point | ||
|Point | | Point | ||
| | | [[Point]] | ||
|- | |- | ||
|stakeholderID | | stakeholderID | ||
|int | | int | ||
|[[Stakeholder]] ID | | [[Stakeholder]] ID | ||
|- | |- | ||
|text | | text | ||
|String | | String | ||
| | | | ||
|- | |- | ||
|type | | type | ||
|PanelType | | PanelType | ||
| | | [[Panel]]Type | ||
|- | |- | ||
|updateTiming | | updateTiming | ||
|Timing | | Timing | ||
| | | | ||
|- | |- | ||
|version | | version | ||
|int | | int | ||
| | | | ||
|- | |||
| warnings | |||
| String | |||
| | |||
|- | |||
| width | |||
| double | |||
| | |||
|} | |||
==Api Model Timing== | |||
API Enumeration description of Timing | |||
{|class=wikitable | |||
!Name | |||
!Description | |||
|- | |- | ||
| | | BEFORE | ||
| | |||
| | |||
|- | |- | ||
| | | AFTER | ||
| | |||
| | |||
|} | |} | ||
| Line 785: | Line 966: | ||
!Description | !Description | ||
|- | |- | ||
|answers | | answers | ||
|Answer<nowiki>[]</nowiki> | | Answer<nowiki>[]</nowiki> | ||
| | | [[Answer (Panel)]]<nowiki>[]</nowiki> | ||
|- | |- | ||
|attributes | | attributes | ||
|Map<String,double[]> | | Map<String,double[]> | ||
| | | | ||
|- | |- | ||
|height | | height | ||
|double | | double | ||
| | | | ||
|- | |- | ||
|id | | id | ||
|int | | int | ||
| | | | ||
|- | |- | ||
|layoutX | | layoutX | ||
|double | | double | ||
| | | | ||
|- | |- | ||
|layoutY | | layoutY | ||
|double | | double | ||
| | | | ||
|- | |- | ||
|maquetteOverride | | maquetteOverride | ||
|Map<String,double[]> | | Map<String,double[]> | ||
| | | | ||
|- | |- | ||
|name | | name | ||
|String | | String | ||
| | | | ||
|- | |- | ||
|overlayID | | overlayID | ||
|int | | int | ||
|[[Overlay]] ID | | [[Overlay]] ID | ||
|- | |- | ||
|overrideDefaultAnswerID | | overrideDefaultAnswerID | ||
|int | | int | ||
| | | | ||
|- | |- | ||
|point | | point | ||
|Point | | Point | ||
| | | [[Point]] | ||
|- | |- | ||
|stakeholderID | | stakeholderID | ||
|int | | int | ||
|[[Stakeholder]] ID | | [[Stakeholder]] ID | ||
|- | |- | ||
|type | | type | ||
|PanelType | | PanelType | ||
| | | [[Panel]]Type | ||
|- | |- | ||
|url | | url | ||
|String | | String | ||
| | | | ||
|- | |- | ||
|version | | version | ||
|int | | int | ||
| | | | ||
|- | |- | ||
|width | | width | ||
|double | | double | ||
| | | | ||
|} | |} | ||
| Line 855: | 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 |