Api session items panels: Difference between revisions
No edit summary |
No edit summary |
||
| Line 94: | Line 94: | ||
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 EmptyMultiPolygon== | |||
API Model description of EmptyMultiPolygon | |||
{|class=wikitable | |||
!Name | |||
!Type | |||
!Description | |||
|} | |||
==Api Model ExcelPanel== | ==Api Model ExcelPanel== | ||
API Model description of ExcelPanel | API Model description of ExcelPanel | ||
| Line 197: | Line 252: | ||
|double | |double | ||
| | | | ||
|} | |||
==Api Model GeometryCollection== | |||
API Model description of GeometryCollection | |||
{|class=wikitable | |||
!Name | |||
!Type | |||
!Description | |||
|} | |} | ||
| Line 367: | Line 431: | ||
|double | |double | ||
| | | | ||
|} | |||
==Api Model MultiPolygon== | |||
API Model description of MultiPolygon | |||
{|class=wikitable | |||
!Name | |||
!Type | |||
!Description | |||
|} | |} | ||
| Line 435: | Line 508: | ||
|width | |width | ||
|double | |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 | |||
|} | |||
==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 | |||
| | | | ||
|} | |} | ||
| Line 774: | Line 929: | ||
|width | |width | ||
|double | |double | ||
| | |||
|} | |||
==Api Model Timing== | |||
API Enumeration description of Timing | |||
{|class=wikitable | |||
!Name | |||
!Description | |||
|- | |||
|BEFORE | |||
| | |||
|- | |||
|AFTER | |||
| | | | ||
|} | |} | ||
Revision as of 14:06, 20 April 2026
Api session items Panel Endpoints.
Edit items with event: editorpanel.
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" : 9,
"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" : 4,
"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" : 6,
"warnings" : "",
"width" : null
} ]Limit Queries
version=100:
https://engine.tygron.com/api/session/items/panels/?version=100&token=API_TOKENShow Queries
max version:
https://engine.tygron.com/api/session/items/panels/version/?token=API_TOKENsize:
https://engine.tygron.com/api/session/items/panels/size/?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 EmptyMultiPolygon
API Model description of EmptyMultiPolygon
| Name | Type | Description |
|---|
Api Model ExcelPanel
API Model description of ExcelPanel
| Name | Type | Description |
|---|---|---|
| answers | Answer[] | |
| attributes | Map<String,double[]> | |
| calcTimeMS | long | |
| contentID | int | |
| contentMapLink | 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 | |
| polygons | MultiPolygon | |
| stakeholderID | int | Stakeholder ID |
| text | String | |
| type | 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[] | |
| attributes | Map<String,double[]> | |
| globalIDs | int[] | Global ID |
| height | double | |
| id | int | |
| layoutX | double | |
| layoutY | double | |
| maquetteOverride | Map<String,double[]> | |
| name | String | |
| overlayID | int | Overlay ID |
| overrideDefaultAnswerID | int | |
| point | Point | |
| stakeholderID | int | Stakeholder ID |
| type | PanelType | |
| version | int | |
| width | double |
Api Model LogicPanel
API Model description of LogicPanel
| Name | Type | Description |
|---|---|---|
| answers | Answer[] | |
| attributes | Map<String,double[]> | |
| calcTimeMS | long | |
| contentID | int | |
| contentMapLink | 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 | |
| stakeholderID | int | Stakeholder ID |
| text | String | |
| type | PanelType | |
| updateTiming | Timing | |
| version | int | |
| warnings | String | |
| width | double |
Api Model MultiPolygon
API Model description of MultiPolygon
| Name | Type | Description |
|---|
Api Model Panel
API Model description of Panel
| Name | Type | Description |
|---|---|---|
| answers | Answer[] | |
| 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 | |
| stakeholderID | int | Stakeholder ID |
| type | 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 |
|---|
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 |
Api Model TemplateExcelPanel
API Model description of TemplateExcelPanel
| Name | Type | Description |
|---|---|---|
| answers | Answer[] | |
| attribute | String | |
| attributes | Map<String,double[]> | |
| autoApplied | boolean | |
| calcTimeMS | long | |
| contentID | int | |
| contentMapLink | MapLink | |
| excelID | int | Excel Sheet ID |
| height | double | |
| id | int | |
| layoutX | double | |
| layoutY | double | |
| mapLink | MapLink | |
| maquetteOverride | Map<String,double[]> | |
| name | String | |
| overlayID | int | Overlay ID |
| overrideDefaultAnswerID | int | |
| parentID | int | |
| point | Point | |
| polygons | MultiPolygon | |
| relation | Relation | |
| stakeholderID | int | Stakeholder ID |
| text | String | |
| type | PanelType | |
| updateTiming | Timing | |
| useOwner | boolean | |
| version | int | |
| warnings | String | |
| width | double |
Api Model TemplateTextPanel
API Model description of TemplateTextPanel
| Name | Type | Description |
|---|---|---|
| answers | Answer[] | |
| attribute | String | |
| attributes | Map<String,double[]> | |
| autoApplied | boolean | |
| calcTimeMS | long | |
| contentID | int | |
| contentMapLink | MapLink | |
| height | double | |
| id | int | |
| layoutX | double | |
| layoutY | double | |
| mapLink | MapLink | |
| maquetteOverride | Map<String,double[]> | |
| name | String | |
| overlayID | int | Overlay ID |
| overrideDefaultAnswerID | int | |
| parentID | int | |
| point | Point | |
| relation | Relation | |
| stakeholderID | int | Stakeholder ID |
| text | String | |
| type | PanelType | |
| updateTiming | Timing | |
| useOwner | boolean | |
| version | int | |
| warnings | String | |
| width | double |
Api Model TextPanel
API Model description of TextPanel
| Name | Type | Description |
|---|---|---|
| answers | Answer[] | |
| attributes | Map<String,double[]> | |
| calcTimeMS | long | |
| contentID | int | |
| contentMapLink | 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 | |
| stakeholderID | int | Stakeholder ID |
| text | String | |
| type | 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[] | |
| 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 | |
| stakeholderID | int | Stakeholder ID |
| type | PanelType | |
| url | String | |
| version | int | |
| width | double |