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, Bureaucrats, Interface administrators, Administrators
43,073 edits
No edit summary
No edit summary
 
(11 intermediate revisions by the same user not shown)
Line 6: Line 6:
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/indicators/?f=JSON&token=API_TOKEN</syntaxhighlight>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/indicators/?f=JSON&token=API_TOKEN</syntaxhighlight>
Example Response:
Example Response:
<syntaxhighlight lang="text" copy>[ ]</syntaxhighlight>
<syntaxhighlight lang="text" copy>[ {
  "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" : ""
} ]</syntaxhighlight>
==Limit Queries==
==Limit Queries==
version=100:  
version=100:  
Line 40: Line 69:
!Description
!Description
|-
|-
|absolute
| absolute
|boolean
| boolean
|
|  
|-
|-
|attributes
| attributes
|Map&lt;String,double[]&gt;
| Map&lt;String,double[]&gt;
|
|  
|-
|-
|calcTimeMS
| calcTimeMS
|long
| long
|
|  
|-
|-
|currentExplanation
| currentExplanation
|String
| String
|
|  
|-
|-
|description
| description
|String
| String
|
|  
|-
|-
|exactNumberValues
| exactNumberValues
|Map&lt;MapType,double&gt;
| Map&lt;MapType,double&gt;
|
| Map&lt;[[Map Type]],double&gt;
|-
|-
|exactTextValues
| exactTextValues
|Map&lt;MapType,String&gt;
| Map&lt;MapType,String&gt;
|
| Map&lt;[[Map Type]],String&gt;
|-
|-
|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&lt;MapType,double&gt;
| Map&lt;MapType,double&gt;
|
| Map&lt;[[Map Type]],double&gt;
|-
|-
|maquetteExplanation
| maquetteExplanation
|String
| String
|
|  
|-
|-
|maquetteOverride
| maquetteOverride
|Map&lt;String,double[]&gt;
| Map&lt;String,double[]&gt;
|
|  
|-
|-
|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 181:
!Description
!Description
|-
|-
|CURRENT
| CURRENT
|
|  
|-
|-
|MAQUETTE
| MAQUETTE
|
|  
|}
|}


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


Latest revision as of 07:43, 22 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: 

[ {
  "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

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