Api session items globals: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
← Older edit
Frank@tygron.nl (talk | contribs)
Tygron, Tygron_admin, Interface administrators, Administrators
34,718 edits
No edit summary
No edit summary
 
(10 intermediate revisions by the same user not shown)
Line 1: Line 1:
Api session items [[Global]] Endpoints.
Api session items [[Global]] Endpoints.


Manipulate items with event: [[Api session event editor |Api session event editor ]].
Edit items with event: [[Api session event editor global|editorglobal]].


Default Query:
Default Query:
Line 17: Line 17:
   "queryTiming" : "AFTER",
   "queryTiming" : "AFTER",
   "startValue" : [ 1.0, 2.0 ],
   "startValue" : [ 1.0, 2.0 ],
   "version" : 1,
   "version" : 2,
   "visualisationName" : ""
   "visualisationName" : ""
}, {
}, {
Line 30: Line 30:
   "queryTiming" : "AFTER",
   "queryTiming" : "AFTER",
   "startValue" : [ 3.0, 4.0 ],
   "startValue" : [ 3.0, 4.0 ],
   "version" : 2,
   "version" : 1,
   "visualisationName" : ""
   "visualisationName" : ""
} ]</syntaxhighlight>
} ]</syntaxhighlight>
==Limit Queries==
==Limit Queries==
version=100:  
version=100:  
<pre>https://engine.tygron.com/api/session/items/globals/?version=100&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/globals/?version=100&token=API_TOKEN</syntaxhighlight>
Pseudo-Mercator:  
Pseudo-Mercator:  
<pre>https://engine.tygron.com/api/session/items/globals/?crs=3857&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/globals/?crs=3857&token=API_TOKEN</syntaxhighlight>
Degrees:  
Degrees:  
<pre>https://engine.tygron.com/api/session/items/globals/?crs=4326&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/globals/?crs=4326&token=API_TOKEN</syntaxhighlight>
Amersfoort / RD New:  
Amersfoort / RD New:  
<pre>https://engine.tygron.com/api/session/items/globals/?crs=28992&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/globals/?crs=28992&token=API_TOKEN</syntaxhighlight>
Local Coordinates:  
Local Coordinates:  
<pre>https://engine.tygron.com/api/session/items/globals/?crs=LOCAL&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/globals/?crs=LOCAL&token=API_TOKEN</syntaxhighlight>
bbox=658636.7618515313,6798649.869141218,659042.7958749933,6799055.882798785:  
bbox=658636.7618515313,6798649.869141218,659042.7958749933,6799055.882798785:  
<pre>https://engine.tygron.com/api/session/items/globals/?crs=3857&bbox=658636.7618515313,6798649.869141218,659042.7958749933,6799055.882798785&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/globals/?crs=3857&bbox=658636.7618515313,6798649.869141218,659042.7958749933,6799055.882798785&token=API_TOKEN</syntaxhighlight>
FOO:  
FOO:  
<pre>https://engine.tygron.com/api/session/items/globals-foo/?crs=3857&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/globals-foo/?crs=3857&token=API_TOKEN</syntaxhighlight>
==Show Queries==
==Show Queries==
max version:  
max version:  
<pre>https://engine.tygron.com/api/session/items/globals/version/?token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/globals/version/?token=API_TOKEN</syntaxhighlight>
size:  
size:  
<pre>https://engine.tygron.com/api/session/items/globals/size/?token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/globals/size/?token=API_TOKEN</syntaxhighlight>
==Formats==
==Formats==
HTML:  
HTML:  
<pre>https://engine.tygron.com/api/session/items/globals/?f=HTML&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/globals/?f=HTML&token=API_TOKEN</syntaxhighlight>
JSON:  
JSON:  
<pre>https://engine.tygron.com/api/session/items/globals/?f=JSON&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/globals/?f=JSON&token=API_TOKEN</syntaxhighlight>
GEOJSON:  
GEOJSON:  
<pre>https://engine.tygron.com/api/session/items/globals/?f=GEOJSON&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/globals/?f=GEOJSON&token=API_TOKEN</syntaxhighlight>
GPKG:  
GPKG:  
<pre>https://engine.tygron.com/api/session/items/globals/?f=GPKG&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/globals/?f=GPKG&token=API_TOKEN</syntaxhighlight>
DXF:  
DXF:  
<pre>https://engine.tygron.com/api/session/items/globals/?f=DXF&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/globals/?f=DXF&token=API_TOKEN</syntaxhighlight>
CSV:  
CSV:  
<pre>https://engine.tygron.com/api/session/items/globals/?f=CSV&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/globals/?f=CSV&token=API_TOKEN</syntaxhighlight>
SSV:  
SSV:  
<pre>https://engine.tygron.com/api/session/items/globals/?f=SSV&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/globals/?f=SSV&token=API_TOKEN</syntaxhighlight>
SMILE:  
SMILE:  
<pre>https://engine.tygron.com/api/session/items/globals/?f=SMILE&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/globals/?f=SMILE&token=API_TOKEN</syntaxhighlight>
ZIPJSON:  
ZIPJSON:  
<pre>https://engine.tygron.com/api/session/items/globals/?f=ZIPJSON&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/globals/?f=ZIPJSON&token=API_TOKEN</syntaxhighlight>
ZIPSMILE:  
ZIPSMILE:  
<pre>https://engine.tygron.com/api/session/items/globals/?f=ZIPSMILE&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/globals/?f=ZIPSMILE&token=API_TOKEN</syntaxhighlight>
==Api Model Global==
API Model description of Global
 
{|class=wikitable
!Name
!Type
!Description
|-
|actualValue
|double[]
|
|-
|bookValueStakeholderID
|int
|[[Stakeholder]] ID
|-
|calcTimeMS
|long
|
|-
|id
|int
|
|-
|name
|String
|
|-
|point
|Point
|
|-
|previousValue
|double[]
|
|-
|query
|String
|
|-
|queryTiming
|Timing
|
|-
|startValue
|double[]
|
|-
|version
|int
|
|-
|visualisationName
|String
|
|}
 
==Api Model Point==
API Model description of Point
 
{|class=wikitable
!Name
!Type
!Description
|}
 
==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 ]]
*[[Api session event editor global]]
}}
}}


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

Latest revision as of 14:13, 24 April 2026

Api session items Global Endpoints.

Edit items with event: editorglobal.

Default Query: 

https://engine.tygron.com/api/session/items/globals/?f=JSON&token=API_TOKEN

Example Response: 

[ {
  "actualValue" : [ 1.0, 2.0 ],
  "bookValueStakeholderID" : -1,
  "calcTimeMS" : 0,
  "id" : 2,
  "name" : "HELLO",
  "point" : null,
  "previousValue" : [ 1.0, 2.0 ],
  "query" : "",
  "queryTiming" : "AFTER",
  "startValue" : [ 1.0, 2.0 ],
  "version" : 2,
  "visualisationName" : ""
}, {
  "actualValue" : [ 3.0, 4.0 ],
  "bookValueStakeholderID" : -1,
  "calcTimeMS" : 0,
  "id" : 3,
  "name" : "HELLO2",
  "point" : null,
  "previousValue" : [ 3.0, 4.0 ],
  "query" : "",
  "queryTiming" : "AFTER",
  "startValue" : [ 3.0, 4.0 ],
  "version" : 1,
  "visualisationName" : ""
} ]

Limit Queries

version=100: 

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

Pseudo-Mercator: 

https://engine.tygron.com/api/session/items/globals/?crs=3857&token=API_TOKEN

Degrees: 

https://engine.tygron.com/api/session/items/globals/?crs=4326&token=API_TOKEN

Amersfoort / RD New: 

https://engine.tygron.com/api/session/items/globals/?crs=28992&token=API_TOKEN

Local Coordinates: 

https://engine.tygron.com/api/session/items/globals/?crs=LOCAL&token=API_TOKEN

bbox=658636.7618515313,6798649.869141218,659042.7958749933,6799055.882798785: 

https://engine.tygron.com/api/session/items/globals/?crs=3857&bbox=658636.7618515313,6798649.869141218,659042.7958749933,6799055.882798785&token=API_TOKEN

FOO: 

https://engine.tygron.com/api/session/items/globals-foo/?crs=3857&token=API_TOKEN

Show Queries

max version: 

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

size: 

https://engine.tygron.com/api/session/items/globals/size/?token=API_TOKEN

Formats

HTML: 

https://engine.tygron.com/api/session/items/globals/?f=HTML&token=API_TOKEN

JSON: 

https://engine.tygron.com/api/session/items/globals/?f=JSON&token=API_TOKEN

GEOJSON: 

https://engine.tygron.com/api/session/items/globals/?f=GEOJSON&token=API_TOKEN

GPKG: 

https://engine.tygron.com/api/session/items/globals/?f=GPKG&token=API_TOKEN

DXF: 

https://engine.tygron.com/api/session/items/globals/?f=DXF&token=API_TOKEN

CSV: 

https://engine.tygron.com/api/session/items/globals/?f=CSV&token=API_TOKEN

SSV: 

https://engine.tygron.com/api/session/items/globals/?f=SSV&token=API_TOKEN

SMILE: 

https://engine.tygron.com/api/session/items/globals/?f=SMILE&token=API_TOKEN

ZIPJSON: 

https://engine.tygron.com/api/session/items/globals/?f=ZIPJSON&token=API_TOKEN

ZIPSMILE: 

https://engine.tygron.com/api/session/items/globals/?f=ZIPSMILE&token=API_TOKEN

Api Model Global

API Model description of Global

Name Type Description
actualValue double[]
bookValueStakeholderID int Stakeholder ID
calcTimeMS long
id int
name String
point Point
previousValue double[]
query String
queryTiming Timing
startValue double[]
version int
visualisationName String

Api Model Point

API Model description of Point

Name Type Description

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_globals&oldid=78798"