Api session items indicators: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
Api [[Session]] [[Item]]s [[Indicator]]s Endpoint: /api/session/items/indicators/
API Endpoint: /api/session/items/indicators/


Edit items with events described at [[Api session event editor indicator]].
Edit items with events described at [[Api session event editor indicator]].
Line 70: Line 70:
|excelID
|excelID
|int
|int
|[[Excel Sheet]]s ID  
|[[Excel Sheet]] ID  
|-
|-
|excelUpdated
|excelUpdated
Line 110: Line 110:
|parentID
|parentID
|int
|int
|[[Indicator]]s ID  
|[[Indicator]] ID  
|-
|-
|shortName
|shortName
Line 122: Line 122:
|stakeholderID
|stakeholderID
|int
|int
|[[Stakeholder]]s ID  
|[[Stakeholder]] ID  
|-
|-
|targetDescriptions
|targetDescriptions

Latest revision as of 09:05, 3 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