Api session items panels: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
← Older editNewer edit →
Frank@tygron.nl (talk | contribs)
Tygron, Tygron_admin, Interface administrators, Administrators
34,718 edits
No edit summary
No edit summary
Line 34: Line 34:
   "type" : "EXCEL_PANEL",
   "type" : "EXCEL_PANEL",
   "updateTiming" : "BEFORE",
   "updateTiming" : "BEFORE",
   "version" : 7,
   "version" : 1,
   "warnings" : "",
   "warnings" : "",
   "width" : null
   "width" : null
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 ExcelPanel==
API Model description of ExcelPanel
{|class=wikitable
!Name
!Type
!Description
|-
|answers
|Answer<nowiki>[]</nowiki>
|
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|calcTimeMS
|long
|
|-
|contentID
|int
|
|-
|contentMapLink
|MapLink
|
|-
|excelID
|int
|[[Excel Sheet]] ID
|-
|height
|double
|
|-
|id
|int
|
|-
|layoutX
|double
|
|-
|layoutY
|double
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|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 GlobalPanel==
API Model description of GlobalPanel
{|class=wikitable
!Name
!Type
!Description
|-
|answers
|Answer<nowiki>[]</nowiki>
|
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|globalIDs
|int<nowiki>[]</nowiki>
|[[Global]] ID
|-
|height
|double
|
|-
|id
|int
|
|-
|layoutX
|double
|
|-
|layoutY
|double
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|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
{|class=wikitable
!Name
!Type
!Description
|-
|answers
|Answer<nowiki>[]</nowiki>
|
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|calcTimeMS
|long
|
|-
|contentID
|int
|
|-
|contentMapLink
|MapLink
|
|-
|height
|double
|
|-
|id
|int
|
|-
|layoutX
|double
|
|-
|layoutY
|double
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|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 Panel==
API Model description of Panel
{|class=wikitable
!Name
!Type
!Description
|-
|answers
|Answer<nowiki>[]</nowiki>
|
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|height
|double
|
|-
|id
|int
|
|-
|layoutX
|double
|
|-
|layoutY
|double
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|name
|String
|
|-
|overlayID
|int
|[[Overlay]] ID
|-
|overrideDefaultAnswerID
|int
|
|-
|point
|Point
|
|-
|stakeholderID
|int
|[[Stakeholder]] ID
|-
|type
|PanelType
|
|-
|version
|int
|
|-
|width
|double
|
|}
==Api Model TemplateExcelPanel==
API Model description of TemplateExcelPanel
{|class=wikitable
!Name
!Type
!Description
|-
|answers
|Answer<nowiki>[]</nowiki>
|
|-
|attribute
|String
|
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|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&lt;String,double[]&gt;
|
|-
|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
{|class=wikitable
!Name
!Type
!Description
|-
|answers
|Answer<nowiki>[]</nowiki>
|
|-
|attribute
|String
|
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|autoApplied
|boolean
|
|-
|calcTimeMS
|long
|
|-
|contentID
|int
|
|-
|contentMapLink
|MapLink
|
|-
|height
|double
|
|-
|id
|int
|
|-
|layoutX
|double
|
|-
|layoutY
|double
|
|-
|mapLink
|MapLink
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|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
{|class=wikitable
!Name
!Type
!Description
|-
|answers
|Answer<nowiki>[]</nowiki>
|
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|calcTimeMS
|long
|
|-
|contentID
|int
|
|-
|contentMapLink
|MapLink
|
|-
|height
|double
|
|-
|id
|int
|
|-
|layoutX
|double
|
|-
|layoutY
|double
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|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 WebPanel==
API Model description of WebPanel
{|class=wikitable
!Name
!Type
!Description
|-
|answers
|Answer<nowiki>[]</nowiki>
|
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|height
|double
|
|-
|id
|int
|
|-
|layoutX
|double
|
|-
|layoutY
|double
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|name
|String
|
|-
|overlayID
|int
|[[Overlay]] ID
|-
|overrideDefaultAnswerID
|int
|
|-
|point
|Point
|
|-
|stakeholderID
|int
|[[Stakeholder]] ID
|-
|type
|PanelType
|
|-
|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]]

Revision as of 11:52, 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_TOKEN

Example 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" : 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" : 6,
  "warnings" : "",
  "width" : null
} ]

Limit Queries

version=100: 

https://engine.tygron.com/api/session/items/panels/?version=100&token=API_TOKEN

Show Queries

max version: 

https://engine.tygron.com/api/session/items/panels/version/?token=API_TOKEN

size: 

https://engine.tygron.com/api/session/items/panels/size/?token=API_TOKEN

Formats

HTML: 

https://engine.tygron.com/api/session/items/panels/?f=HTML&token=API_TOKEN

JSON: 

https://engine.tygron.com/api/session/items/panels/?f=JSON&token=API_TOKEN

CSV: 

https://engine.tygron.com/api/session/items/panels/?f=CSV&token=API_TOKEN

SSV: 

https://engine.tygron.com/api/session/items/panels/?f=SSV&token=API_TOKEN

SMILE: 

https://engine.tygron.com/api/session/items/panels/?f=SMILE&token=API_TOKEN

ZIPJSON: 

https://engine.tygron.com/api/session/items/panels/?f=ZIPJSON&token=API_TOKEN

ZIPSMILE: 

https://engine.tygron.com/api/session/items/panels/?f=ZIPSMILE&token=API_TOKEN

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 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 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 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 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

See also

Retrieved from "https://support.tygron.com/w/index.php?title=Api_session_items_panels&oldid=78111"