Api session items panels: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| (2 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]]. | Edit items with events described at [[Api session event editor panel]]. | ||
| Line 15: | Line 15: | ||
"VISIBLE_TIMEFRAME" : [ 0.0 ] | "VISIBLE_TIMEFRAME" : [ 0.0 ] | ||
}, | }, | ||
"calcTimeMS" : | "calcTimeMS" : 0, | ||
"contentID" : null, | "contentID" : null, | ||
"contentMapLink" : null, | "contentMapLink" : null, | ||
| Line 170: | Line 170: | ||
|excelID | |excelID | ||
|int | |int | ||
|[[Excel Sheet]] | |[[Excel Sheet]] ID | ||
|- | |- | ||
|height | |height | ||
| Line 198: | Line 198: | ||
|overlayID | |overlayID | ||
|int | |int | ||
|[[Overlay]] | |[[Overlay]] ID | ||
|- | |- | ||
|overrideDefaultAnswerID | |overrideDefaultAnswerID | ||
| Line 218: | Line 218: | ||
|stakeholderID | |stakeholderID | ||
|int | |int | ||
|[[Stakeholder]] | |[[Stakeholder]] ID | ||
|- | |- | ||
|text | |text | ||
| Line 300: | Line 300: | ||
|overlayID | |overlayID | ||
|int | |int | ||
|[[Overlay]] | |[[Overlay]] ID | ||
|- | |- | ||
|overrideDefaultAnswerID | |overrideDefaultAnswerID | ||
| Line 312: | Line 312: | ||
|stakeholderID | |stakeholderID | ||
|int | |int | ||
|[[Stakeholder]] | |[[Stakeholder]] ID | ||
|- | |- | ||
|type | |type | ||
| Line 381: | Line 381: | ||
|overlayID | |overlayID | ||
|int | |int | ||
|[[Overlay]] | |[[Overlay]] ID | ||
|- | |- | ||
|overrideDefaultAnswerID | |overrideDefaultAnswerID | ||
| Line 397: | Line 397: | ||
|stakeholderID | |stakeholderID | ||
|int | |int | ||
|[[Stakeholder]] | |[[Stakeholder]] ID | ||
|- | |- | ||
|text | |text | ||
| Line 483: | Line 483: | ||
|overlayID | |overlayID | ||
|int | |int | ||
|[[Overlay]] | |[[Overlay]] ID | ||
|- | |- | ||
|overrideDefaultAnswerID | |overrideDefaultAnswerID | ||
| Line 495: | Line 495: | ||
|stakeholderID | |stakeholderID | ||
|int | |int | ||
|[[Stakeholder]] | |[[Stakeholder]] ID | ||
|- | |- | ||
|type | |type | ||
| Line 638: | Line 638: | ||
|excelID | |excelID | ||
|int | |int | ||
|[[Excel Sheet]] | |[[Excel Sheet]] ID | ||
|- | |- | ||
|height | |height | ||
| Line 670: | Line 670: | ||
|overlayID | |overlayID | ||
|int | |int | ||
|[[Overlay]] | |[[Overlay]] ID | ||
|- | |- | ||
|overrideDefaultAnswerID | |overrideDefaultAnswerID | ||
| Line 694: | Line 694: | ||
|stakeholderID | |stakeholderID | ||
|int | |int | ||
|[[Stakeholder]] | |[[Stakeholder]] ID | ||
|- | |- | ||
|text | |text | ||
| Line 791: | Line 791: | ||
|overlayID | |overlayID | ||
|int | |int | ||
|[[Overlay]] | |[[Overlay]] ID | ||
|- | |- | ||
|overrideDefaultAnswerID | |overrideDefaultAnswerID | ||
| Line 811: | Line 811: | ||
|stakeholderID | |stakeholderID | ||
|int | |int | ||
|[[Stakeholder]] | |[[Stakeholder]] ID | ||
|- | |- | ||
|text | |text | ||
| Line 896: | Line 896: | ||
|overlayID | |overlayID | ||
|int | |int | ||
|[[Overlay]] | |[[Overlay]] ID | ||
|- | |- | ||
|overrideDefaultAnswerID | |overrideDefaultAnswerID | ||
| Line 912: | Line 912: | ||
|stakeholderID | |stakeholderID | ||
|int | |int | ||
|[[Stakeholder]] | |[[Stakeholder]] ID | ||
|- | |- | ||
|text | |text | ||
| Line 995: | Line 995: | ||
|overlayID | |overlayID | ||
|int | |int | ||
|[[Overlay]] | |[[Overlay]] ID | ||
|- | |- | ||
|overrideDefaultAnswerID | |overrideDefaultAnswerID | ||
| Line 1,007: | Line 1,007: | ||
|stakeholderID | |stakeholderID | ||
|int | |int | ||
|[[Stakeholder]] | |[[Stakeholder]] ID | ||
|- | |- | ||
|type | |type | ||
Latest revision as of 09:05, 3 June 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" : 0,
"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" : 5,
"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 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[] | Globals 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 |
|---|---|---|
| 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[] | |
| 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 |
|---|---|---|
| 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 |
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 |