Api session items panels: 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 15: | Line 15: | ||
"VISIBLE_TIMEFRAME" : [ 0.0 ] | "VISIBLE_TIMEFRAME" : [ 0.0 ] | ||
}, | }, | ||
"calcTimeMS" : | "calcTimeMS" : 1, | ||
"contentID" : null, | "contentID" : null, | ||
"contentMapLink" : null, | "contentMapLink" : null, | ||
| Line 34: | Line 34: | ||
"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 | ||
| 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 150: | Line 152: | ||
| answers | | answers | ||
| Answer<nowiki>[]</nowiki> | | Answer<nowiki>[]</nowiki> | ||
| | | [[Answer (Panel)]]<nowiki>[]</nowiki> | ||
|- | |- | ||
| attributes | | attributes | ||
| Line 166: | Line 168: | ||
| contentMapLink | | contentMapLink | ||
| MapLink | | MapLink | ||
| | | [[Maplink]] | ||
|- | |- | ||
| excelID | | excelID | ||
| Line 210: | Line 212: | ||
| point | | point | ||
| Point | | Point | ||
| | | [[Point]] | ||
|- | |- | ||
| polygons | | polygons | ||
| MultiPolygon | | MultiPolygon | ||
| | | [[MultiPolygon]] | ||
|- | |- | ||
| stakeholderID | | stakeholderID | ||
| Line 226: | Line 228: | ||
| type | | type | ||
| PanelType | | PanelType | ||
| | | [[Panel]]Type | ||
|- | |- | ||
| updateTiming | | updateTiming | ||
| Line 264: | Line 266: | ||
| answers | | answers | ||
| Answer<nowiki>[]</nowiki> | | Answer<nowiki>[]</nowiki> | ||
| | | [[Answer (Panel)]]<nowiki>[]</nowiki> | ||
|- | |- | ||
| attributes | | attributes | ||
| Line 308: | Line 310: | ||
| point | | point | ||
| Point | | Point | ||
| | | [[Point]] | ||
|- | |- | ||
| stakeholderID | | stakeholderID | ||
| Line 316: | Line 318: | ||
| type | | type | ||
| PanelType | | PanelType | ||
| | | [[Panel]]Type | ||
|- | |- | ||
| version | | version | ||
| Line 337: | Line 339: | ||
| answers | | answers | ||
| Answer<nowiki>[]</nowiki> | | Answer<nowiki>[]</nowiki> | ||
| | | [[Answer (Panel)]]<nowiki>[]</nowiki> | ||
|- | |- | ||
| attributes | | attributes | ||
| Line 353: | Line 355: | ||
| contentMapLink | | contentMapLink | ||
| MapLink | | MapLink | ||
| | | [[Maplink]] | ||
|- | |- | ||
| height | | height | ||
| Line 393: | Line 395: | ||
| point | | point | ||
| Point | | Point | ||
| | | [[Point]] | ||
|- | |- | ||
| stakeholderID | | stakeholderID | ||
| Line 405: | Line 407: | ||
| type | | type | ||
| PanelType | | PanelType | ||
| | | [[Panel]]Type | ||
|- | |- | ||
| updateTiming | | updateTiming | ||
| Line 434: | Line 436: | ||
| type | | type | ||
| String | | String | ||
| [[ | | [[MultiPolygon]] | ||
|- | |- | ||
| coordinates | | coordinates | ||
| double[][][][] | | double[][][][] | ||
| array of [[ | | 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 451: | Line 453: | ||
| answers | | answers | ||
| Answer<nowiki>[]</nowiki> | | Answer<nowiki>[]</nowiki> | ||
| | | [[Answer (Panel)]]<nowiki>[]</nowiki> | ||
|- | |- | ||
| attributes | | attributes | ||
| Line 491: | Line 493: | ||
| point | | point | ||
| Point | | Point | ||
| | | [[Point]] | ||
|- | |- | ||
| stakeholderID | | stakeholderID | ||
| Line 499: | Line 501: | ||
| type | | type | ||
| PanelType | | PanelType | ||
| | | [[Panel]]Type | ||
|- | |- | ||
| version | | version | ||
| Line 546: | Line 548: | ||
| type | | type | ||
| String | | String | ||
| [[ | | [[Point]] | ||
|- | |- | ||
| coordinates | | coordinates | ||
| Line 613: | Line 615: | ||
| answers | | answers | ||
| Answer<nowiki>[]</nowiki> | | Answer<nowiki>[]</nowiki> | ||
| | | [[Answer (Panel)]]<nowiki>[]</nowiki> | ||
|- | |- | ||
| attribute | | attribute | ||
| Line 637: | Line 639: | ||
| contentMapLink | | contentMapLink | ||
| MapLink | | MapLink | ||
| | | [[Maplink]] | ||
|- | |- | ||
| excelID | | excelID | ||
| Line 661: | Line 663: | ||
| mapLink | | mapLink | ||
| MapLink | | MapLink | ||
| | | [[Maplink]] | ||
|- | |- | ||
| maquetteOverride | | maquetteOverride | ||
| Line 685: | Line 687: | ||
| point | | point | ||
| Point | | Point | ||
| | | [[Point]] | ||
|- | |- | ||
| polygons | | polygons | ||
| MultiPolygon | | MultiPolygon | ||
| | | [[MultiPolygon]] | ||
|- | |- | ||
| relation | | relation | ||
| Relation | | Relation | ||
| | | [[Relation]] | ||
|- | |- | ||
| stakeholderID | | stakeholderID | ||
| Line 705: | Line 707: | ||
| type | | type | ||
| PanelType | | PanelType | ||
| | | [[Panel]]Type | ||
|- | |- | ||
| updateTiming | | updateTiming | ||
| Line 738: | Line 740: | ||
| answers | | answers | ||
| Answer<nowiki>[]</nowiki> | | Answer<nowiki>[]</nowiki> | ||
| | | [[Answer (Panel)]]<nowiki>[]</nowiki> | ||
|- | |- | ||
| attribute | | attribute | ||
| Line 762: | Line 764: | ||
| contentMapLink | | contentMapLink | ||
| MapLink | | MapLink | ||
| | | [[Maplink]] | ||
|- | |- | ||
| height | | height | ||
| Line 782: | Line 784: | ||
| mapLink | | mapLink | ||
| MapLink | | MapLink | ||
| | | [[Maplink]] | ||
|- | |- | ||
| maquetteOverride | | maquetteOverride | ||
| Line 806: | Line 808: | ||
| point | | point | ||
| Point | | Point | ||
| | | [[Point]] | ||
|- | |- | ||
| relation | | relation | ||
| Relation | | Relation | ||
| | | [[Relation]] | ||
|- | |- | ||
| stakeholderID | | stakeholderID | ||
| Line 822: | Line 824: | ||
| type | | type | ||
| PanelType | | PanelType | ||
| | | [[Panel]]Type | ||
|- | |- | ||
| updateTiming | | updateTiming | ||
| Line 855: | Line 857: | ||
| answers | | answers | ||
| Answer<nowiki>[]</nowiki> | | Answer<nowiki>[]</nowiki> | ||
| | | [[Answer (Panel)]]<nowiki>[]</nowiki> | ||
|- | |- | ||
| attributes | | attributes | ||
| Line 871: | Line 873: | ||
| contentMapLink | | contentMapLink | ||
| MapLink | | MapLink | ||
| | | [[Maplink]] | ||
|- | |- | ||
| height | | height | ||
| Line 911: | Line 913: | ||
| point | | point | ||
| Point | | Point | ||
| | | [[Point]] | ||
|- | |- | ||
| stakeholderID | | stakeholderID | ||
| Line 923: | Line 925: | ||
| type | | type | ||
| PanelType | | PanelType | ||
| | | [[Panel]]Type | ||
|- | |- | ||
| updateTiming | | updateTiming | ||
| Line 966: | Line 968: | ||
| answers | | answers | ||
| Answer<nowiki>[]</nowiki> | | Answer<nowiki>[]</nowiki> | ||
| | | [[Answer (Panel)]]<nowiki>[]</nowiki> | ||
|- | |- | ||
| attributes | | attributes | ||
| Line 1,006: | Line 1,008: | ||
| point | | point | ||
| Point | | Point | ||
| | | [[Point]] | ||
|- | |- | ||
| stakeholderID | | stakeholderID | ||
| Line 1,014: | Line 1,016: | ||
| type | | type | ||
| PanelType | | PanelType | ||
| | | [[Panel]]Type | ||
|- | |- | ||
| url | | url | ||
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 |