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, Bureaucrats, Interface administrators, Administrators
37,736 edits
No edit summary
No edit summary
 
(24 intermediate revisions by the same user not shown)
Line 1: Line 1:
api session items [[Global]] Endpoints.
Api session items [[Global]] Endpoint: /api/session/items/globals/
Manipulate items with event: [[editorglobal]].
 
==Limit Queries==version=100:  
Edit items with events described at [[Api session event editor global]].
<pre>https://engine.tygron.com/api/session/items/globals/?version=100&token=API_TOKEN</pre>
 
Default Query:
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/globals/?f=JSON&token=API_TOKEN</syntaxhighlight>
Example Response:
<syntaxhighlight lang="text" copy>[ {
  "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" : 1,
  "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" : 2,
  "visualisationName" : ""
} ]</syntaxhighlight>
==Limit Queries==
version=100:  
<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>
==Limit Queries==max version:  
==Show Queries==
<pre>https://engine.tygron.com/api/session/items/globals/version/?token=API_TOKEN</pre>
max version:  
<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>
==Limit Queries==HTML:  
==Formats==
<pre>https://engine.tygron.com/api/session/items/globals/?f=HTML&token=API_TOKEN</pre>
HTML:  
<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>
{{article end|seealso=*[[Api Content Items]]}}
==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
|-
|type
|String
|[[#Api Model Point|Point]]
|-
|coordinates
|double[]
|x, y, (optional) z
|}
 
==Api Model Timing==
API Enumeration description of Timing
 
{|class=wikitable
!Name
!Description
|-
|BEFORE
|
|-
|AFTER
|
|}
 
{{article end|seealso=*[[Api Content Items]]
*[[Api session event editor global]]
}}


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

Latest revision as of 12:14, 29 May 2026

Api session items Global Endpoint: /api/session/items/globals/

Edit items with events described at Api session event editor global.

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" : 1,
  "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" : 2,
  "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
type String Point
coordinates double[] x, y, (optional) z

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=81879"