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
46,429 edits
No edit summary
No edit summary
 
(35 intermediate revisions by the same user not shown)
Line 1: Line 1:
Api session items [[Indicator]] Endpoints.
API Endpoint: /api/session/items/indicators/


Manipulate items with event: [[Api session event editor indicator|editorindicator]].
Edit items with events described at [[Api session event editor indicator]].


Default Query:
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/indicators/?f=JSON&token=API_TOKEN</syntaxhighlight>
Example Response:
<syntaxhighlight lang="text" copy>[ {
  "absolute" : true,
  "attributes" : null,
  "calcTimeMS" : 1,
  "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" : 5,
  "warnings" : ""
} ]</syntaxhighlight>
==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==
==Get Queries==
attributes:
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/indicators/attributes/?token=API_TOKEN</syntaxhighlight>
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:  
count:  
<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/count/?token=API_TOKEN</syntaxhighlight>
Indicators (GeoJSON):
<pre>https://engine.tygron.com/web/indicators.geojson?token=API_TOKEN</pre>
==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;
| Map&lt;[[Map Type]],double&gt;
|-
| exactTextValues
| Map&lt;MapType,String&gt;
| Map&lt;[[Map Type]],String&gt;
|-
| excelID
| int
| [[Excel Sheet]] ID
|-
| excelUpdated
| boolean
|
|-
| id
| int
|
|-
| imageName
| String
|
|-
| imageVersion
| int
|
|-
| isActive
| boolean
|
|-
| mapTypeValues
| Map&lt;MapType,double&gt;
| Map&lt;[[Map Type]],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 33: Line 207:


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

Latest revision as of 07:06, 14 July 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" : 1,
  "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" : 5,
  "warnings" : ""
} ]

Limit Queries

version=100: 

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

Get Queries

attributes: 

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

max version: 

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

count: 

https://engine.tygron.com/api/session/items/indicators/count/?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=91280"