Api session items indicators: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 40: Line 40:
!Description
!Description
|-
|-
|absolute
| absolute
|boolean
| boolean
|
|  
|-
|-
|attributes
| attributes
|Map<String,double[]>
| Map<String,double[]>
|
|  
|-
|-
|calcTimeMS
| calcTimeMS
|long
| long
|
|  
|-
|-
|currentExplanation
| currentExplanation
|String
| String
|
|  
|-
|-
|description
| description
|String
| String
|
|  
|-
|-
|exactNumberValues
| exactNumberValues
|Map<MapType,double>
| Map<MapType,double>
|
|  
|-
|-
|exactTextValues
| exactTextValues
|Map<MapType,String>
| Map<MapType,String>
|
|  
|-
|-
|excelID
| excelID
|int
| int
|[[Excel Sheet]] ID  
| [[Excel Sheet]] ID  
|-
|-
|excelUpdated
| excelUpdated
|boolean
| boolean
|
|  
|-
|-
|id
| id
|int
| int
|
|  
|-
|-
|imageName
| imageName
|String
| String
|
|  
|-
|-
|imageVersion
| imageVersion
|int
| int
|
|  
|-
|-
|isActive
| isActive
|boolean
| boolean
|
|  
|-
|-
|mapTypeValues
| mapTypeValues
|Map<MapType,double>
| Map<MapType,double>
|
|  
|-
|-
|maquetteExplanation
| maquetteExplanation
|String
| String
|
|  
|-
|-
|maquetteOverride
| maquetteOverride
|Map<String,double[]>
| Map<String,double[]>
|
|  
|-
|-
|name
| name
|String
| String
|
|  
|-
|-
|parentID
| parentID
|int
| int
|[[Indicator]] ID  
| [[Indicator]] ID  
|-
|-
|shortName
| shortName
|String
| String
|
|  
|-
|-
|sortIndex
| sortIndex
|int
| int
|
|  
|-
|-
|stakeholderID
| stakeholderID
|int
| int
|[[Stakeholder]] ID  
| [[Stakeholder]] ID  
|-
|-
|targetDescriptions
| targetDescriptions
|String<nowiki>[]</nowiki>
| String<nowiki>[]</nowiki>
|
|  
|-
|-
|targets
| targets
|Map&lt;int,double[]&gt;
| Map&lt;int,double[]&gt;
|
|  
|-
|-
|updateTiming
| updateTiming
|Timing
| Timing
|
|  
|-
|-
|version
| version
|int
| int
|
|  
|-
|-
|warnings
| warnings
|String
| String
|
|  
|}
|}


Line 152: Line 152:
!Description
!Description
|-
|-
|CURRENT
| CURRENT
|
|  
|-
|-
|MAQUETTE
| MAQUETTE
|
|  
|}
|}


Line 166: Line 166:
!Description
!Description
|-
|-
|BEFORE
| BEFORE
|
|  
|-
|-
|AFTER
| AFTER
|
|  
|}
|}



Revision as of 11:44, 8 June 2026

API Endpoint: /api/session/items/indicators/

Edit items with events described at Api session event editor indicator.

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