Api session items globals: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Tag: Manual revert
 
(16 intermediate revisions by the same user not shown)
Line 4: Line 4:


Default Query:
Default Query:
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/globals/?f=JSON&token=API_TOKEN</syntaxhighlight>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/globals/?token=API_TOKEN</syntaxhighlight>
Example Response:
Example Response:
<syntaxhighlight lang="text" copy>[ {
<syntaxhighlight lang="text" copy>[ {
Line 17: Line 17:
   "queryTiming" : "AFTER",
   "queryTiming" : "AFTER",
   "startValue" : [ 1.0, 2.0 ],
   "startValue" : [ 1.0, 2.0 ],
   "version" : 2,
   "version" : 1,
   "visualisationName" : ""
   "visualisationName" : ""
}, {
}, {
Line 30: Line 30:
   "queryTiming" : "AFTER",
   "queryTiming" : "AFTER",
   "startValue" : [ 3.0, 4.0 ],
   "startValue" : [ 3.0, 4.0 ],
   "version" : 1,
   "version" : 2,
   "visualisationName" : ""
   "visualisationName" : ""
} ]</syntaxhighlight>
} ]</syntaxhighlight>
==Limit Queries==
==Limit Queries==
version=100:  
Version=100:  
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/globals/?version=100&token=API_TOKEN</syntaxhighlight>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/globals/?version=100&token=API_TOKEN</syntaxhighlight>
Pseudo-Mercator:  
Pseudo-Mercator:  
Line 44: Line 44:
Local Coordinates:  
Local Coordinates:  
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/globals/?crs=LOCAL&token=API_TOKEN</syntaxhighlight>
<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:  
<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>
<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:  
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/globals-foo/?crs=3857&token=API_TOKEN</syntaxhighlight>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/globals-foo/?crs=3857&token=API_TOKEN</syntaxhighlight>
==Show Queries==
==Get Queries==
max version:  
Attributes:
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/globals/attributes/?token=API_TOKEN</syntaxhighlight>
Max version:  
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/globals/version/?token=API_TOKEN</syntaxhighlight>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/globals/version/?token=API_TOKEN</syntaxhighlight>
size:  
Count:  
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/globals/size/?token=API_TOKEN</syntaxhighlight>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/globals/count/?token=API_TOKEN</syntaxhighlight>
Specific Item by ID:
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/globals/{id}/?token=API_TOKEN</syntaxhighlight>
==Formats==
==Formats==
HTML:  
HTML:  
Line 88: Line 92:
| bookValueStakeholderID
| bookValueStakeholderID
| int
| int
|  
| [[Stakeholder]] ID
|-
|-
| calcTimeMS
| calcTimeMS
Line 104: Line 108:
| point
| point
| Point
| Point
| [[#Api Model Point|Point]]
| [[Point]]
|-
|-
| previousValue
| previousValue
Line 141: Line 145:
| type
| type
| String
| String
|  
| [[Point]]
|-
|-
| coordinates
| coordinates
| double[]
| double[]
|  
| x, y, (optional) z
|}
|}



Latest revision as of 15:33, 10 November 2026

API 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/?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

Get Queries

Attributes:

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

Max version:

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

Count:

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

Specific Item by ID:

https://engine.tygron.com/api/session/items/globals/{id}/?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 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