Api session items indicators

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:

[ {
  "absolute" : true,
  "attributes" : null,
  "calcTimeMS" : 0,
  "currentExplanation" : "Simple dummy Indicator",
  "description" : "",
  "exactNumberValues" : { },
  "exactTextValues" : { },
  "excelID" : 12,
  "id" : 0,
  "imageName" : "excel.png",
  "imageVersion" : 0,
  "isActive" : true,
  "mapTypeValues" : {
    "MAQUETTE" : 0.0,
    "CURRENT" : 0.0
  },
  "maquetteExplanation" : "",
  "maquetteOverride" : null,
  "name" : "Indicator",
  "parentID" : -1,
  "shortName" : "Indicator",
  "sortIndex" : 51,
  "stakeholderID" : -1,
  "targetDescriptions" : [ ],
  "targets" : { },
  "updateTiming" : "BEFORE",
  "version" : 17,
  "warnings" : ""
} ]

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>	Map<Map Type,double>
exactTextValues	Map<MapType,String>	Map<Map Type,String>
excelID	int	Excel Sheet ID
excelUpdated	boolean
id	int
imageName	String
imageVersion	int
isActive	boolean
mapTypeValues	Map<MapType,double>	Map<Map Type,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

• Api Content Items
• Api session event editor indicator