Api session items indicators: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
← Older edit
Frank@tygron.nl (talk | contribs)
Tygron, Tygron_admin, Interface administrators, Administrators
34,718 edits
No edit summary
No edit summary
 
(7 intermediate revisions by the same user not shown)
Line 9: Line 9:
==Limit Queries==
==Limit Queries==
version=100:  
version=100:  
<pre>https://engine.tygron.com/api/session/items/indicators/?version=100&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/indicators/?version=100&token=API_TOKEN</syntaxhighlight>
==Show Queries==
==Show Queries==
max version:  
max version:  
<pre>https://engine.tygron.com/api/session/items/indicators/version/?token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/indicators/version/?token=API_TOKEN</syntaxhighlight>
size:  
size:  
<pre>https://engine.tygron.com/api/session/items/indicators/size/?token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/indicators/size/?token=API_TOKEN</syntaxhighlight>
Indicators (GeoJSON):  
Indicators (GeoJSON):  
<pre>https://engine.tygron.com/web/indicators.geojson?token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/web/indicators.geojson?token=API_TOKEN</syntaxhighlight>
==Formats==
==Formats==
HTML:  
HTML:  
<pre>https://engine.tygron.com/api/session/items/indicators/?f=HTML&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/indicators/?f=HTML&token=API_TOKEN</syntaxhighlight>
JSON:  
JSON:  
<pre>https://engine.tygron.com/api/session/items/indicators/?f=JSON&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/indicators/?f=JSON&token=API_TOKEN</syntaxhighlight>
CSV:  
CSV:  
<pre>https://engine.tygron.com/api/session/items/indicators/?f=CSV&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/indicators/?f=CSV&token=API_TOKEN</syntaxhighlight>
SSV:  
SSV:  
<pre>https://engine.tygron.com/api/session/items/indicators/?f=SSV&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/indicators/?f=SSV&token=API_TOKEN</syntaxhighlight>
SMILE:  
SMILE:  
<pre>https://engine.tygron.com/api/session/items/indicators/?f=SMILE&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/indicators/?f=SMILE&token=API_TOKEN</syntaxhighlight>
ZIPJSON:  
ZIPJSON:  
<pre>https://engine.tygron.com/api/session/items/indicators/?f=ZIPJSON&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/indicators/?f=ZIPJSON&token=API_TOKEN</syntaxhighlight>
ZIPSMILE:  
ZIPSMILE:  
<pre>https://engine.tygron.com/api/session/items/indicators/?f=ZIPSMILE&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/indicators/?f=ZIPSMILE&token=API_TOKEN</syntaxhighlight>
==Api Model Indicator==
API Model description of Indicator
 
{|class=wikitable
!Name
!Type
!Description
|-
|absolute
|boolean
|
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|calcTimeMS
|long
|
|-
|currentExplanation
|String
|
|-
|description
|String
|
|-
|exactNumberValues
|Map&lt;MapType,double&gt;
|
|-
|exactTextValues
|Map&lt;MapType,String&gt;
|
|-
|excelID
|int
|[[Excel Sheet]] ID
|-
|excelUpdated
|boolean
|
|-
|id
|int
|
|-
|imageName
|String
|
|-
|imageVersion
|int
|
|-
|isActive
|boolean
|
|-
|mapTypeValues
|Map&lt;MapType,double&gt;
|
|-
|maquetteExplanation
|String
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|name
|String
|
|-
|parentID
|int
|[[Indicator]] ID
|-
|shortName
|String
|
|-
|sortIndex
|int
|
|-
|stakeholderID
|int
|[[Stakeholder]] ID
|-
|targetDescriptions
|String<nowiki>[]</nowiki>
|
|-
|targets
|Map&lt;int,double[]&gt;
|
|-
|updateTiming
|Timing
|
|-
|version
|int
|
|-
|warnings
|String
|
|}
 
==Api Model MapType==
API Enumeration description of MapType
 
{|class=wikitable
!Name
!Description
|-
|CURRENT
|
|-
|MAQUETTE
|
|}
 
==Api Model Timing==
API Enumeration description of Timing
 
{|class=wikitable
!Name
!Description
|-
|BEFORE
|
|-
|AFTER
|
|}
 
{{article end|seealso=*[[Api Content Items]]
{{article end|seealso=*[[Api Content Items]]
*[[Api session event editor indicator]]
*[[Api session event editor indicator]]
Line 37: Line 178:


[[Category:API]]
[[Category:API]]
[[Category:Items]]

Latest revision as of 14:13, 24 April 2026

Api session items Indicator Endpoints.

Edit items with event: editorindicator.

Default Query: 

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

Example Response: 

[ ]

Limit Queries

version=100: 

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

Show Queries

max version: 

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

size: 

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

Indicators (GeoJSON): 

https://engine.tygron.com/web/indicators.geojson?token=API_TOKEN

Formats

HTML: 

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

JSON: 

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

CSV: 

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

SSV: 

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

SMILE: 

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

ZIPJSON: 

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

ZIPSMILE: 

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

Api Model Indicator

API Model description of Indicator

Name Type Description
absolute boolean
attributes Map<String,double[]>
calcTimeMS long
currentExplanation String
description String
exactNumberValues Map<MapType,double>
exactTextValues Map<MapType,String>
excelID int Excel Sheet ID
excelUpdated boolean
id int
imageName String
imageVersion int
isActive boolean
mapTypeValues Map<MapType,double>
maquetteExplanation String
maquetteOverride Map<String,double[]>
name String
parentID int Indicator ID
shortName String
sortIndex int
stakeholderID int Stakeholder ID
targetDescriptions String[]
targets Map<int,double[]>
updateTiming Timing
version int
warnings String

Api Model MapType

API Enumeration description of MapType

Name Description
CURRENT
MAQUETTE

Api Model Timing

API Enumeration description of Timing

Name Description
BEFORE
AFTER

See also

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