Api session items actionmenus: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
← Older editNewer edit →
Frank@tygron.nl (talk | contribs)
Tygron, Tygron_admin, Interface administrators, Administrators
34,718 edits
No edit summary
Tag: Reverted
Replaced content with "Api session items Action Menus Endpoints. Edit items with event: editoractionmenu. Default Query: <syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/actionmenus/?f=JSON&token=API_TOKEN</syntaxhighlight> Example Response: <syntaxhighlight lang="text" copy>[ { "attributeActionIDs" : [ ], "buildable" : { "0" : [ 0 ] }, "color" : null, "eventBundleIDs" : [ ], "functionIDs" : [ 436, 4..."
Tags: Replaced Manual revert
Line 68: Line 68:
ZIPSMILE:  
ZIPSMILE:  
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/actionmenus/?f=ZIPSMILE&token=API_TOKEN</syntaxhighlight>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/actionmenus/?f=ZIPSMILE&token=API_TOKEN</syntaxhighlight>
==Api Model ActionLog==
API Model description of ActionLog
{|class=wikitable
!Name
!Type
!Description
|-
|action
|ParticipantEventType
|
|-
|budget
|double
|
|-
|buildingIDs
|int<nowiki>[]</nowiki>
|
|-
|id
|int
|
|-
|itemID
|int
|
|-
|mapLink
|MapLink
|
|-
|mp
|MultiPolygon
|
|-
|point
|Point
|
|-
|scoreAfter
|Map&lt;int,double&gt;
|
|-
|scoreBefore
|Map&lt;int,double&gt;
|
|-
|simTime
|long
|
|-
|stakeholderID
|int
|[[Stakeholder]] ID
|-
|subject
|String
|
|-
|version
|int
|
|}
==Api Model ActionMenu==
==Api Model ActionMenu==
API Model description of ActionMenu
API Model description of ActionMenu
Line 199: Line 134:
|version
|version
|int
|int
|
|}
==Api Model ActionType==
API Enumeration description of ActionType
{|class=wikitable
!Name
!Description
|-
|CONSTRUCTION_PLAN
|
|-
|CONSTRUCTION_PLAN_CANCEL
|
|}
==Api Model Addition==
API Model description of Addition
{|class=wikitable
!Name
!Type
!Description
|-
|amount
|int
|
|-
|animMultiplier
|double
|
|-
|name
|String
|
|-
|randomScale
|double
|
|-
|show
|Show
|
|}
==Api Model Address==
API Model description of Address
{|class=wikitable
!Name
!Type
!Description
|-
|addition
|String
|
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|id
|int
|
|-
|letter
|String
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|name
|String
|
|-
|number
|int
|
|-
|point
|Point
|
|-
|sourceIDs
|int<nowiki>[]</nowiki>
|[[Source]] ID
|-
|street
|String
|
|-
|surfaceSize
|double
|
|-
|type
|String
|
|-
|version
|int
|
|-
|zipCode
|String
|
|}
==Api Model AddressAttribute==
API Enumeration description of AddressAttribute
{|class=wikitable
!Name
!Description
|-
|ENERGY_LABEL
|
|-
|CADASTRAL_PURPOSE
|
|-
|RESIDENCE_TYPE
|
|-
|INHABITANTS
|
|-
|FLOOR_SPACE_M2
|
|}
==Api Model AeriusOverlay==
API Model description of AeriusOverlay
{|class=wikitable
!Name
!Type
!Description
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|colorMultiplier
|double
|
|-
|colorOffset
|int
|
|-
|customLegend
|boolean
|
|-
|id
|int
|
|-
|imageName
|String
|
|-
|imageVersion
|int
|
|-
|legend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|name
|String
|
|-
|parentID
|int
|[[Overlay]] ID
|-
|sortIndex
|int
|
|-
|type
|OverlayType
|
|-
|version
|int
|
|-
|visible
|boolean
|
|}
==Api Model Alignment==
API Enumeration description of Alignment
{|class=wikitable
!Name
!Description
|-
|ROAD
|
|-
|SPACED
|
|}
==Api Model Answer==
API Model description of Answer
{|class=wikitable
!Name
!Type
!Description
|-
|clientEvents
|CodedEvent<nowiki>[]</nowiki>
|
|-
|contents
|String
|
|-
|events
|CodedEvent<nowiki>[]</nowiki>
|
|-
|id
|int
|
|-
|selected
|boolean
|
|}
==Api Model Area==
API Model description of Area
{|class=wikitable
!Name
!Type
!Description
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|center
|Point
|
|-
|id
|int
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|name
|String
|
|-
|polygons
|MultiPolygon
|
|-
|relations
|Map&lt;Relation,int&gt;
|
|-
|sourceIDs
|int<nowiki>[]</nowiki>
|[[Source]] ID
|-
|version
|int
|
|}
==Api Model AreaAttribute==
API Enumeration description of AreaAttribute
{|class=wikitable
!Name
!Description
|-
|ACTIVE
|
|-
|NATURE_RESERVE
|
|-
|INTEREST_AREA
|
|}
==Api Model AreaOverlay==
API Model description of AreaOverlay
{|class=wikitable
!Name
!Type
!Description
|-
|areaIDs
|int<nowiki>[]</nowiki>
|[[Area]] ID
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|colorMultiplier
|double
|
|-
|colorOffset
|int
|
|-
|customLegend
|boolean
|
|-
|id
|int
|
|-
|imageName
|String
|
|-
|imageVersion
|int
|
|-
|legend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|name
|String
|
|-
|parentID
|int
|[[Overlay]] ID
|-
|remainderColor
|TColor
|
|-
|sortIndex
|int
|
|-
|type
|OverlayType
|
|-
|version
|int
|
|-
|visible
|boolean
|
|}
==Api Model AssetValue==
API Enumeration description of AssetValue
{|class=wikitable
!Name
!Description
|-
|NAME
|
|-
|DESCRIPTION
|
|-
|ID
|
|-
|IMAGELOCATION
|
|-
|ROOF_COLOR
|
|-
|BASEMENT_COLOR
|
|-
|GROUND_COLOR
|
|-
|EXTRA_COLOR
|
|-
|TOP_COLOR
|
|}
==Api Model AttributeItem==
API Model description of AttributeItem
{|class=wikitable
!Name
!Type
!Description
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|id
|int
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|name
|String
|
|-
|version
|int
|
|}
==Api Model AttributeKey==
API Enumeration description of AttributeKey
{|class=wikitable
!Name
!Description
|-
|A
|
|-
|B
|
|-
|C
|
|-
|D
|
|-
|E
|
|-
|F
|
|-
|G
|
|-
|H
|
|-
|I
|
|-
|J
|
|}
==Api Model AttributeOverlay==
API Model description of AttributeOverlay
{|class=wikitable
!Name
!Type
!Description
|-
|attribute
|String
|
|-
|attributeColor
|TColor
|
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|colorAttribute
|String
|
|-
|colorMultiplier
|double
|
|-
|colorOffset
|int
|
|-
|customLegend
|boolean
|
|-
|id
|int
|
|-
|imageName
|String
|
|-
|imageVersion
|int
|
|-
|legend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|mapLink
|MapLink
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|name
|String
|
|-
|parentID
|int
|[[Overlay]] ID
|-
|restColor
|TColor
|
|-
|sortIndex
|int
|
|-
|type
|OverlayType
|
|-
|version
|int
|
|-
|visible
|boolean
|
|}
==Api Model AttributeOverlayPredicate==
API Model description of AttributeOverlayPredicate
{|class=wikitable
!Name
!Type
!Description
|-
|attribute
|String
|
|-
|mapLink
|MapLink
|
|}
==Api Model AvgModelAttribute==
API Enumeration description of AvgModelAttribute
{|class=wikitable
!Name
!Description
|-
|DISTANCE_M
|
|-
|ATTRIBUTE_TIMEFRAMES
|
|-
|DEFAULT_VALUE
|
|-
|SURFACE_ONLY
|
|}
==Api Model AvgOverlay==
API Model description of AvgOverlay
{|class=wikitable
!Name
!Type
!Description
|-
|active
|boolean
|
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|calcTimeMS
|long
|
|-
|colorMultiplier
|double
|
|-
|colorOffset
|int
|
|-
|customLegend
|boolean
|
|-
|diffLegend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|id
|int
|
|-
|imageName
|String
|
|-
|imageVersion
|int
|
|-
|inActiveCellSize
|double
|
|-
|inActiveTimeframes
|int
|
|-
|keys
|Map&lt;String,String&gt;
|
|-
|layerMapLink
|MapLink
|
|-
|legend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|maxValue
|float[]
|
|-
|minValue
|float[]
|
|-
|name
|String
|
|-
|parentID
|int
|[[Overlay]] ID
|-
|prequels
|Map&lt;String,PrequelLink&gt;
|
|-
|rasterization
|Rasterization
|
|-
|resultType
|String
|
|-
|showDifference
|boolean
|
|-
|sortIndex
|int
|
|-
|type
|OverlayType
|
|-
|version
|int
|
|-
|visible
|boolean
|
|-
|warnings
|String
|
|}
==Api Model BGTFunctionLink==
API Model description of BGTFunctionLink
{|class=wikitable
!Name
!Type
!Description
|-
|categories
|Category<nowiki>[]</nowiki>
|
|-
|className
|String
|
|-
|functionID
|int
|[[Function]] ID
|-
|id
|int
|
|-
|layer
|BGTLayer
|
|-
|priority
|int
|
|-
|transmissionTowerFoundations
|int
|
|-
|tree
|boolean
|
|-
|typeName
|String
|
|-
|version
|int
|
|}
==Api Model BGTLayer==
API Enumeration description of BGTLayer
{|class=wikitable
!Name
!Description
|-
|BAK
|
|-
|BEGROEIDTERREINDEEL
|
|-
|BORD
|
|-
|BUURT
|
|-
|FUNCTIONEELGEBIED
|
|-
|GEBOUWINSTALLATIE
|
|-
|INSTALLATIE
|
|-
|KAST
|
|-
|KUNSTWERKDEEL
|
|-
|MAST
|
|-
|ONBEGROEIDTERREINDEEL
|
|-
|ONDERSTEUNENDWATERDEEL
|
|-
|ONDERSTEUNENDWEGDEEL
|
|-
|ONGECLASSIFICEERDOBJECT
|
|-
|OPENBARERUIMTE
|
|-
|OPENBARERUIMTELABEL
|
|-
|OVERBRUGGINGSDEEL
|
|-
|OVERIGBOUWWERK
|
|-
|OVERIGESCHEIDING
|
|-
|PAAL
|
|-
|PUBLIC
|
|-
|PAND
|
|-
|PLAATSBEPALINGSPUNT
|
|-
|PUT
|
|-
|SCHEIDING
|
|-
|SENSOR
|
|-
|SPOOR
|
|-
|STRAATMEUBILAIR
|
|-
|TUNNELDEEL
|
|-
|VEGETATIEOBJECT
|
|-
|WATERDEEL
|
|-
|WATERINRICHTINGSELEMENT
|
|-
|WEGDEEL
|
|-
|WEGINRICHTINGSELEMENT
|
|-
|WIJK
|
|}
==Api Model BGTTerrainLink==
API Model description of BGTTerrainLink
{|class=wikitable
!Name
!Type
!Description
|-
|className
|String
|
|-
|id
|int
|
|-
|layer
|BGTLayer
|
|-
|priority
|int
|
|-
|terrainTypeID
|int
|[[Terrain Type]] ID
|-
|typeName
|String
|
|-
|version
|int
|
|}
==Api Model BaseAttribute==
API Enumeration description of BaseAttribute
{|class=wikitable
!Name
!Description
|-
|COLOR
|
|}
==Api Model BaseFunction==
API Model description of BaseFunction
{|class=wikitable
!Name
!Type
!Description
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|categories
|Category<nowiki>[]</nowiki>
|
|-
|constructionPeriods
|ConstructionPeriod<nowiki>[]</nowiki>
|
|-
|decals
|Map&lt;FaceType,float[]&gt;
|
|-
|defaults
|Type<nowiki>[]</nowiki>
|
|-
|description
|String
|
|-
|dimension
|int
|
|-
|id
|int
|
|-
|imageName
|String
|
|-
|modelSetID
|int
|[[Model Set]] ID
|-
|name
|String
|
|-
|placementType
|PlacementType
|
|-
|regions
|Region<nowiki>[]</nowiki>
|
|-
|textures
|Map&lt;FaceType,String&gt;
|
|-
|version
|int
|
|}
==Api Model BridgeElevation==
API Enumeration description of BridgeElevation
{|class=wikitable
!Name
!Description
|-
|LOWEST
|
|-
|TERRAIN
|
|-
|BRIDGE
|
|}
==Api Model Building==
API Model description of Building
{|class=wikitable
!Name
!Type
!Description
|-
|addressIDs
|int<nowiki>[]</nowiki>
|[[Address]] ID
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|center
|Point
|
|-
|customGeometries
|CGLink<nowiki>[]</nowiki>
|
|-
|demolisherID
|int
|[[Stakeholder]] ID
|-
|functionID
|int
|[[Function]] ID
|-
|id
|int
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|measureID
|int
|[[Measure]] ID
|-
|modelVersion
|int
|
|-
|name
|String
|
|-
|overrideCategories
|Category<nowiki>[]</nowiki>
|
|-
|overrideDecals
|Map&lt;FaceType,float[]&gt;
|
|-
|ownerID
|int
|[[Stakeholder]] ID
|-
|permitReceived
|Map&lt;int,Boolean&gt;
|
|-
|predecessorID
|int
|[[Building]] ID
|-
|sections
|Section<nowiki>[]</nowiki>
|
|-
|sourceIDs
|int<nowiki>[]</nowiki>
|[[Source]] ID
|-
|state
|TimeState
|
|-
|upgradeID
|int
|[[Upgrade Type]] ID
|-
|upgradeOwnerID
|int
|[[Stakeholder]] ID
|-
|version
|int
|
|}
==Api Model BuildingAttribute==
API Enumeration description of BuildingAttribute
{|class=wikitable
!Name
!Description
|-
|CONSTRUCTION_FINISH_DATE
|
|-
|POWER_LINE_BUILDING_ID
|
|-
|MODEL_ANGLE
|
|-
|POPULATION_DENSITY_M2
|
|-
|GEOMETRY_COLOR
|
|-
|VACANT
|
|-
|PRIVATE_YARD
|
|}
==Api Model CGLink==
API Model description of CGLink
{|class=wikitable
!Name
!Type
!Description
|-
|geometryID
|int
|[[Custom Geometry]] ID
|-
|primary
|boolean
|
|}
==Api Model Category==
API Enumeration description of Category
{|class=wikitable
!Name
!Description
|-
|SOCIAL
|
|-
|NORMAL
|
|-
|LUXE
|
|-
|ROAD
|
|-
|PAVED_AREA
|
|-
|EDUCATION
|
|-
|HEALTHCARE
|
|-
|PARK
|
|-
|NATURE
|
|-
|INDUSTRY
|
|-
|OFFICES
|
|-
|OTHER
|
|-
|SENIOR
|
|-
|UNDERGROUND
|
|-
|SHOPPING
|
|-
|AGRICULTURE
|
|-
|LEISURE
|
|-
|STUDENT
|
|-
|GARDEN
|
|-
|INTERSECTION
|
|-
|BRIDGE
|
|}
==Api Model CategoryZone==
API Model description of CategoryZone
{|class=wikitable
!Name
!Type
!Description
|-
|allowedCategories
|Category<nowiki>[]</nowiki>
|
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|center
|Point
|
|-
|excelID
|int
|[[Excel Sheet]] ID
|-
|excelUpdated
|boolean
|
|-
|id
|int
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|name
|String
|
|-
|outline
|Outline
|
|-
|parentZoneID
|int
|[[Zone]] ID
|-
|permitterID
|int
|[[Stakeholder]] ID
|-
|polygons
|MultiPolygon
|
|-
|sourceIDs
|int<nowiki>[]</nowiki>
|[[Source]] ID
|-
|version
|int
|
|}
==Api Model ClimateModel==
API Model description of ClimateModel
{|class=wikitable
!Name
!Type
!Description
|-
|endTemp
|double
|
|-
|endYear
|int
|
|-
|oxidation
|double
|
|-
|soilTempFactor
|double
|
|-
|startTemp
|double
|
|-
|startYear
|int
|
|}
==Api Model CodedEvent==
API Model description of CodedEvent
{|class=wikitable
!Name
!Type
!Description
|-
|id
|int
|
|-
|parameters
|Object<nowiki>[]</nowiki>
|
|}
==Api Model ComboModelAttribute==
API Enumeration description of ComboModelAttribute
{|class=wikitable
!Name
!Description
|-
|ATTRIBUTE_DEFAULT_VALUE
|
|-
|ATTRIBUTE_SURFACE_ONLY
|
|}
==Api Model ComboOverlay==
API Model description of ComboOverlay
{|class=wikitable
!Name
!Type
!Description
|-
|active
|boolean
|
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|calcTimeMS
|long
|
|-
|colorMultiplier
|double
|
|-
|colorOffset
|int
|
|-
|customLegend
|boolean
|
|-
|diffLegend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|formula
|String
|
|-
|id
|int
|
|-
|imageName
|String
|
|-
|imageVersion
|int
|
|-
|inActiveCellSize
|double
|
|-
|inActiveTimeframes
|int
|
|-
|keys
|Map&lt;String,String&gt;
|
|-
|layerMapLink
|MapLink
|
|-
|legend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|maxValue
|float[]
|
|-
|minValue
|float[]
|
|-
|name
|String
|
|-
|parentID
|int
|[[Overlay]] ID
|-
|prequels
|Map&lt;String,PrequelLink&gt;
|
|-
|rasterization
|Rasterization
|
|-
|resultType
|String
|
|-
|showDifference
|boolean
|
|-
|sortIndex
|int
|
|-
|type
|OverlayType
|
|-
|version
|int
|
|-
|visible
|boolean
|
|-
|warnings
|String
|
|}
==Api Model ConstructionPeriod==
API Enumeration description of ConstructionPeriod
{|class=wikitable
!Name
!Description
|-
|ANCIENT
|
|-
|CLASSIC
|
|-
|PRE_WAR
|
|-
|POST_WAR
|
|-
|CONTEMPORARY
|
|-
|FUTURISTIC
|
|}
==Api Model CoreStakeholder==
API Model description of CoreStakeholder
{|class=wikitable
!Name
!Type
!Description
|-
|active
|boolean
|
|-
|client
|ClientData
|
|-
|color
|TColor
|
|-
|id
|int
|
|-
|lastSelected
|long
|
|-
|name
|String
|
|-
|version
|int
|
|-
|webToken
|String
|
|}
==Api Model CostType==
API Enumeration description of CostType
{|class=wikitable
!Name
!Description
|-
|CONSTRUCTION
|
|}
==Api Model CustomColorArea==
API Model description of CustomColorArea
{|class=wikitable
!Name
!Type
!Description
|-
|color
|TColor
|
|-
|name
|String
|
|-
|polygons
|MultiPolygon
|
|-
|zoneID
|int
|
|}
==Api Model CustomGeometry==
API Model description of CustomGeometry
{|class=wikitable
!Name
!Type
!Description
|-
|absoluteHeight
|boolean
|
|-
|backFaceCulling
|boolean
|
|-
|color
|TColor
|
|-
|data
|float[]
|
|-
|id
|int
|
|-
|texture
|String
|
|-
|version
|int
|
|}
==Api Model DataType==
API Enumeration description of DataType
{|class=wikitable
!Name
!Description
|-
|FLOAT
|
|-
|DOUBLE
|
|-
|INT8
|
|-
|INT16
|
|-
|INT32
|
|-
|INT64
|
|-
|BOOL
|
|-
|STRING
|
|-
|UINT8
|
|-
|FLOAT16
|
|-
|BFLOAT16
|
|-
|UNKNOWN
|
|}
==Api Model DefaultAttribute==
API Enumeration description of DefaultAttribute
{|class=wikitable
!Name
!Description
|-
|ATTRIBUTE
|
|}
==Api Model DefaultNeuralNetwork==
API Model description of DefaultNeuralNetwork
{|class=wikitable
!Name
!Type
!Description
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|description
|String
|
|-
|id
|int
|
|-
|legendEntries
|LegendEntry<nowiki>[]</nowiki>
|
|-
|name
|String
|
|-
|override
|boolean
|
|-
|producer
|String
|
|-
|tensors
|Tensor<nowiki>[]</nowiki>
|
|-
|uploadDate
|long
|
|-
|uploaderName
|String
|
|-
|version
|int
|
|-
|warnings
|String
|
|}
==Api Model DefaultOverlay==
API Model description of DefaultOverlay
{|class=wikitable
!Name
!Type
!Description
|-
|active
|boolean
|
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|calcTimeMS
|long
|
|-
|colorMultiplier
|double
|
|-
|colorOffset
|int
|
|-
|customLegend
|boolean
|
|-
|diffLegend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|id
|int
|
|-
|imageName
|String
|
|-
|imageVersion
|int
|
|-
|inActiveCellSize
|double
|
|-
|inActiveTimeframes
|int
|
|-
|keys
|Map&lt;String,String&gt;
|
|-
|legend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|maxValue
|float[]
|
|-
|minValue
|float[]
|
|-
|name
|String
|
|-
|parentID
|int
|[[Overlay]] ID
|-
|prequels
|Map&lt;String,PrequelLink&gt;
|
|-
|resultType
|String
|
|-
|showDifference
|boolean
|
|-
|sortIndex
|int
|
|-
|type
|OverlayType
|
|-
|version
|int
|
|-
|visible
|boolean
|
|-
|warnings
|String
|
|}
==Api Model DefaultRasterizationOverlay==
API Model description of DefaultRasterizationOverlay
{|class=wikitable
!Name
!Type
!Description
|-
|active
|boolean
|
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|calcTimeMS
|long
|
|-
|colorMultiplier
|double
|
|-
|colorOffset
|int
|
|-
|customLegend
|boolean
|
|-
|diffLegend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|id
|int
|
|-
|imageName
|String
|
|-
|imageVersion
|int
|
|-
|inActiveCellSize
|double
|
|-
|inActiveTimeframes
|int
|
|-
|keys
|Map&lt;String,String&gt;
|
|-
|layerMapLink
|MapLink
|
|-
|legend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|maxValue
|float[]
|
|-
|minValue
|float[]
|
|-
|name
|String
|
|-
|parentID
|int
|[[Overlay]] ID
|-
|prequels
|Map&lt;String,PrequelLink&gt;
|
|-
|rasterization
|Rasterization
|
|-
|resultType
|String
|
|-
|showDifference
|boolean
|
|-
|sortIndex
|int
|
|-
|type
|OverlayType
|
|-
|version
|int
|
|-
|visible
|boolean
|
|-
|warnings
|String
|
|}
==Api Model DefaultResult==
API Enumeration description of DefaultResult
{|class=wikitable
!Name
!Description
|-
|DEFAULT
|
|}
==Api Model DefaultSource==
API Model description of DefaultSource
{|class=wikitable
!Name
!Type
!Description
|-
|color
|TColor
|
|-
|date
|long
|
|-
|description
|String
|
|-
|id
|int
|
|-
|infoUrl
|String
|
|-
|name
|String
|
|-
|uploaderName
|String
|
|-
|version
|int
|
|}
==Api Model DesignAttribute==
API Enumeration description of DesignAttribute
{|class=wikitable
!Name
!Description
|-
|BACKYARD_DISTANCE_M
|
|-
|WATER_WIDTH_M
|
|-
|KEEP_EXISTING_ROADS
|
|-
|ROAD_WIDTH_M
|
|-
|ROAD_DISTANCE_Y_M
|
|-
|ROAD_SEARCH_DISTANCE_M
|
|-
|SIDEWALK_WIDTH_M
|
|-
|PARKING_WIDTH_M
|
|-
|PARKING_LENGTH_M
|
|-
|FRACTION_BUILDINGS
|
|-
|FRACTION_ROADS
|
|-
|FRACTION_WATER
|
|-
|FRACTION_PUBLIC_GREEN
|
|-
|FRACTION_GARDENS
|
|-
|FRACTION_PARKING
|
|-
|FRACTION_REMAINDER
|
|}
==Api Model Detail==
API Enumeration description of Detail
{|class=wikitable
!Name
!Description
|-
|CONSTRUCTION_COST
|
|-
|DEMOLISH_COST
|
|-
|BUYOUT_COST
|
|-
|SELL_PRICE
|
|-
|SELLABLE_FLOORSPACE_M2
|
|-
|NUMBER_OF_HOUSES
|
|}
==Api Model DischargeMethod==
API Enumeration description of DischargeMethod
{|class=wikitable
!Name
!Description
|-
|HEIGHT_MINIMA
|
|-
|WATER_TERRAINS
|
|-
|AREAS
|
|}
==Api Model DistanceOverlay==
API Model description of DistanceOverlay
{|class=wikitable
!Name
!Type
!Description
|-
|active
|boolean
|
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|calcTimeMS
|long
|
|-
|colorMultiplier
|double
|
|-
|colorOffset
|int
|
|-
|customLegend
|boolean
|
|-
|diffLegend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|id
|int
|
|-
|imageName
|String
|
|-
|imageVersion
|int
|
|-
|inActiveCellSize
|double
|
|-
|inActiveTimeframes
|int
|
|-
|keys
|Map&lt;String,String&gt;
|
|-
|layerMapLink
|MapLink
|
|-
|legend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|maxValue
|float[]
|
|-
|minValue
|float[]
|
|-
|name
|String
|
|-
|parentID
|int
|[[Overlay]] ID
|-
|prequels
|Map&lt;String,PrequelLink&gt;
|
|-
|rasterization
|Rasterization
|
|-
|resultType
|String
|
|-
|showDifference
|boolean
|
|-
|sortIndex
|int
|
|-
|type
|OverlayType
|
|-
|version
|int
|
|-
|visible
|boolean
|
|-
|warnings
|String
|
|}
==Api Model DistanceResult==
API Enumeration description of DistanceResult
{|class=wikitable
!Name
!Description
|-
|ZONE
|
|-
|SIGHT
|
|}
==Api Model EmptyMultiPolygon==
API Model description of EmptyMultiPolygon
{|class=wikitable
!Name
!Type
!Description
|}
==Api Model EnergyLabel==
API Enumeration description of EnergyLabel
{|class=wikitable
!Name
!Description
|-
|UNKNOWN
|
|-
|G
|
|-
|F
|
|-
|E
|
|-
|D
|
|-
|C
|
|-
|B
|
|-
|A0
|
|-
|A1
|
|-
|A2
|
|-
|A3
|
|-
|A4
|
|-
|A5
|
|}
==Api Model EventBundle==
API Model description of EventBundle
{|class=wikitable
!Name
!Type
!Description
|-
|clientEvents
|CodedEvent<nowiki>[]</nowiki>
|
|-
|compoundEventBundleIDs
|int<nowiki>[]</nowiki>
|[[Event Bundle]] ID
|-
|description
|String
|
|-
|id
|int
|
|-
|imageName
|String
|
|-
|imageVersion
|int
|
|-
|name
|String
|
|-
|serverEvents
|CodedEvent<nowiki>[]</nowiki>
|
|-
|version
|int
|
|}
==Api Model Example==
API Enumeration description of Example
{|class=wikitable
!Name
!Description
|-
|CITY_NEIGHBORHOOD
|
|-
|URBAN_NEIGHBORHOOD
|
|-
|SUBURBAN_NEIGHBORHOOD
|
|-
|WINDMILL_AREA
|
|}
==Api Model ExcelPanel==
API Model description of ExcelPanel
{|class=wikitable
!Name
!Type
!Description
|-
|answers
|Answer<nowiki>[]</nowiki>
|
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|calcTimeMS
|long
|
|-
|contentID
|int
|
|-
|contentMapLink
|MapLink
|
|-
|excelID
|int
|[[Excel Sheet]] ID
|-
|height
|double
|
|-
|id
|int
|
|-
|layoutX
|double
|
|-
|layoutY
|double
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|name
|String
|
|-
|overlayID
|int
|[[Overlay]] ID
|-
|overrideDefaultAnswerID
|int
|
|-
|parentID
|int
|
|-
|point
|Point
|
|-
|polygons
|MultiPolygon
|
|-
|stakeholderID
|int
|[[Stakeholder]] ID
|-
|text
|String
|
|-
|type
|PanelType
|
|-
|updateTiming
|Timing
|
|-
|version
|int
|
|-
|warnings
|String
|
|-
|width
|double
|
|}
==Api Model FaceType==
API Enumeration description of FaceType
{|class=wikitable
!Name
!Description
|-
|BASEMENT
|
|-
|GROUND
|
|-
|EXTRA
|
|-
|TOP
|
|-
|ROOF
|
|}
==Api Model FloodingOverlay==
API Model description of FloodingOverlay
{|class=wikitable
!Name
!Type
!Description
|-
|active
|boolean
|
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|calcInfo
|String
|
|-
|calcTimeMS
|long
|
|-
|colorMultiplier
|double
|
|-
|colorOffset
|int
|
|-
|customLegend
|boolean
|
|-
|diffLegend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|id
|int
|
|-
|imageName
|String
|
|-
|imageVersion
|int
|
|-
|inActiveCellSize
|double
|
|-
|inActiveTimeframes
|int
|
|-
|keys
|Map&lt;String,String&gt;
|
|-
|legend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|maxValue
|float[]
|
|-
|minValue
|float[]
|
|-
|mode
|Mode
|
|-
|name
|String
|
|-
|parentID
|int
|[[Overlay]] ID
|-
|prequels
|Map&lt;String,PrequelLink&gt;
|
|-
|resultType
|String
|
|-
|showAreas
|boolean
|
|-
|showDifference
|boolean
|
|-
|showSystem
|boolean
|
|-
|sortIndex
|int
|
|-
|type
|OverlayType
|
|-
|version
|int
|
|-
|visible
|boolean
|
|-
|warnings
|String
|
|-
|weatherID
|int
|[[Weather]] ID
|}
==Api Model FunctionChangeGeoLink==
API Model description of FunctionChangeGeoLink
{|class=wikitable
!Name
!Type
!Description
|-
|add
|boolean
|
|-
|category
|Category
|
|-
|featureAttributes
|Map&lt;String,java.util.List<java.lang.String>&gt;
|
|-
|functionID
|int
|[[Function]] ID
|-
|id
|int
|
|-
|priority
|int
|
|-
|tree
|boolean
|
|-
|update
|boolean
|
|-
|version
|int
|
|}
==Api Model FunctionOverlay==
API Model description of FunctionOverlay
{|class=wikitable
!Name
!Type
!Description
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|colorMultiplier
|double
|
|-
|colorOffset
|int
|
|-
|customLegend
|boolean
|
|-
|functionIDs
|int<nowiki>[]</nowiki>
|[[Function]] ID
|-
|functionsColor
|TColor
|
|-
|id
|int
|
|-
|imageName
|String
|
|-
|imageVersion
|int
|
|-
|legend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|name
|String
|
|-
|parentID
|int
|[[Overlay]] ID
|-
|remainderColor
|TColor
|
|-
|sortIndex
|int
|
|-
|type
|OverlayType
|
|-
|version
|int
|
|-
|visible
|boolean
|
|}
==Api Model FunctionOverride==
API Model description of FunctionOverride
{|class=wikitable
!Name
!Type
!Description
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|categories
|Category<nowiki>[]</nowiki>
|
|-
|description
|String
|
|-
|id
|int
|
|-
|imageName
|String
|
|-
|imageVersion
|int
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|name
|String
|
|-
|version
|int
|
|}
==Api Model FunctionType==
API Enumeration description of FunctionType
{|class=wikitable
!Name
!Description
|-
|ROAD
|
|-
|WATER
|
|-
|PARKING
|
|-
|SIDEWALK
|
|-
|BUILDING
|
|-
|GARDEN
|
|-
|PUBLIC_GREEN
|
|-
|REMAINDER
|
|}
==Api Model GasType==
API Enumeration description of GasType
{|class=wikitable
!Name
!Description
|-
|NOX
|
|-
|NO2
|
|}
==Api Model GeoFormat==
API Enumeration description of GeoFormat
{|class=wikitable
!Name
!Description
|-
|GEOJSON
|
|-
|GEOPACKAGE
|
|-
|WFS_JSON
|
|-
|WFS_GML
|
|-
|WMS_IMAGE
|
|-
|WCS_TIFF
|
|-
|OSM
|
|-
|BGT_GML
|
|-
|ESRI_JSON
|
|-
|ESRI_IMAGE
|
|-
|CYCLO_IMAGE
|
|-
|I3S
|
|-
|GEOTIFF
|
|-
|DXF
|
|}
==Api Model GeoTiffAttribute==
API Enumeration description of GeoTiffAttribute
{|class=wikitable
!Name
!Description
|-
|BAND
|
|}
==Api Model GeoTiffFeature==
API Model description of GeoTiffFeature
{|class=wikitable
!Name
!Type
!Description
|-
|id
|int
|
|-
|version
|int
|
|}
==Api Model GeoTiffOverlay==
API Model description of GeoTiffOverlay
{|class=wikitable
!Name
!Type
!Description
|-
|active
|boolean
|
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|calcTimeMS
|long
|
|-
|colorMultiplier
|double
|
|-
|colorOffset
|int
|
|-
|customLegend
|boolean
|
|-
|diffLegend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|geoTiffIDs
|int<nowiki>[]</nowiki>
|[[GeoTIFF]] ID
|-
|id
|int
|
|-
|imageName
|String
|
|-
|imageVersion
|int
|
|-
|inActiveCellSize
|double
|
|-
|inActiveTimeframes
|int
|
|-
|keys
|Map&lt;String,String&gt;
|
|-
|legend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|maxValue
|float[]
|
|-
|minValue
|float[]
|
|-
|name
|String
|
|-
|parentID
|int
|[[Overlay]] ID
|-
|prequels
|Map&lt;String,PrequelLink&gt;
|
|-
|resultType
|String
|
|-
|showDifference
|boolean
|
|-
|sortIndex
|int
|
|-
|type
|OverlayType
|
|-
|version
|int
|
|-
|visible
|boolean
|
|-
|warnings
|String
|
|}
==Api Model GeoTiffResult==
API Enumeration description of GeoTiffResult
{|class=wikitable
!Name
!Description
|-
|NEAREST
|
|-
|INTERPOLATED
|
|}
==Api Model GeoTiffSpatial==
API Model description of GeoTiffSpatial
{|class=wikitable
!Name
!Type
!Description
|-
|autoMP
|boolean
|
|-
|geoTiffIDs
|int<nowiki>[]</nowiki>
|[[GeoTIFF]] ID
|-
|id
|int
|
|-
|multiPolygon
|MultiPolygon
|
|-
|terrainTypeID
|int
|
|}
==Api Model GeometryCollection==
API Model description of GeometryCollection
{|class=wikitable
!Name
!Type
!Description
|}
==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 GlobalPanel==
API Model description of GlobalPanel
{|class=wikitable
!Name
!Type
!Description
|-
|answers
|Answer<nowiki>[]</nowiki>
|
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|globalIDs
|int<nowiki>[]</nowiki>
|[[Global]] ID
|-
|height
|double
|
|-
|id
|int
|
|-
|layoutX
|double
|
|-
|layoutY
|double
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|name
|String
|
|-
|overlayID
|int
|[[Overlay]] ID
|-
|overrideDefaultAnswerID
|int
|
|-
|point
|Point
|
|-
|stakeholderID
|int
|[[Stakeholder]] ID
|-
|type
|PanelType
|
|-
|version
|int
|
|-
|width
|double
|
|}
==Api Model GridFeature==
API Model description of GridFeature
{|class=wikitable
!Name
!Type
!Description
|-
|id
|int
|
|-
|version
|int
|
|}
==Api Model GridModelAttribute==
API Enumeration description of GridModelAttribute
{|class=wikitable
!Name
!Description
|-
|ITERATION_ACTIVE
|
|-
|SKIP_NO_DATA
|
|-
|GPU_CLUSTER_INDEX
|
|}
==Api Model GridOverlay==
API Model description of GridOverlay
{|class=wikitable
!Name
!Type
!Description
|-
|active
|boolean
|
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|calcTimeMS
|long
|
|-
|colorMultiplier
|double
|
|-
|colorOffset
|int
|
|-
|customLegend
|boolean
|
|-
|diffLegend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|id
|int
|
|-
|imageName
|String
|
|-
|imageVersion
|int
|
|-
|inActiveCellSize
|double
|
|-
|inActiveTimeframes
|int
|
|-
|keys
|Map&lt;String,String&gt;
|
|-
|legend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|maxValue
|float[]
|
|-
|minValue
|float[]
|
|-
|name
|String
|
|-
|parentID
|int
|[[Overlay]] ID
|-
|prequels
|Map&lt;String,PrequelLink&gt;
|
|-
|resultType
|String
|
|-
|showDifference
|boolean
|
|-
|sortIndex
|int
|
|-
|type
|OverlayType
|
|-
|version
|int
|
|-
|visible
|boolean
|
|-
|warnings
|String
|
|}
==Api Model GridSpatial==
API Model description of GridSpatial
{|class=wikitable
!Name
!Type
!Description
|-
|autoMP
|boolean
|
|-
|id
|int
|
|-
|multiPolygon
|MultiPolygon
|
|-
|overlayIDs
|int<nowiki>[]</nowiki>
|[[Overlay]] ID
|-
|terrainTypeID
|int
|
|}
==Api Model GroundwaterOverlay==
API Model description of GroundwaterOverlay
{|class=wikitable
!Name
!Type
!Description
|-
|active
|boolean
|
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|calcInfo
|String
|
|-
|calcTimeMS
|long
|
|-
|colorMultiplier
|double
|
|-
|colorOffset
|int
|
|-
|customLegend
|boolean
|
|-
|diffLegend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|id
|int
|
|-
|imageName
|String
|
|-
|imageVersion
|int
|
|-
|inActiveCellSize
|double
|
|-
|inActiveTimeframes
|int
|
|-
|keys
|Map&lt;String,String&gt;
|
|-
|legend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|maxValue
|float[]
|
|-
|minValue
|float[]
|
|-
|mode
|Mode
|
|-
|name
|String
|
|-
|parentID
|int
|[[Overlay]] ID
|-
|prequels
|Map&lt;String,PrequelLink&gt;
|
|-
|resultType
|String
|
|-
|showAreas
|boolean
|
|-
|showDifference
|boolean
|
|-
|showSystem
|boolean
|
|-
|sortIndex
|int
|
|-
|type
|OverlayType
|
|-
|version
|int
|
|-
|visible
|boolean
|
|-
|warnings
|String
|
|-
|weatherID
|int
|[[Weather]] ID
|}
==Api Model Group (SpecialOption)==
API Enumeration description of Group
{|class=wikitable
!Name
!Description
|-
|LAND
|
|-
|SCULPTING
|
|-
|FINANCE
|
|-
|DEMOLISH
|
|}
==Api Model HeatDpraAttribute==
API Enumeration description of HeatDpraAttribute
{|class=wikitable
!Name
!Description
|-
|DATES
|
|-
|DAILY_AVG_RADIATION
|
|-
|DAILY_TEMPERATURE_MAX
|
|-
|DAILY_TEMPERATURE_MIN
|
|-
|EXCLUDE_BUILDINGS
|
|-
|EXCLUDE_WATER
|
|-
|EXCLUDE_FOLIAGE_HEIGHT_M
|
|-
|FOLIAGE_AREAS
|
|-
|HOURLY_RADIATION
|
|-
|HOURLY_TEMPERATURE
|
|-
|HOURLY_HUMIDITY
|
|-
|SUN_ALTITUDE
|
|-
|SUN_AZIMUTH
|
|-
|SUN_DAILY_MOTION
|
|-
|WIND_DIRECTION
|
|-
|WIND_SPEED
|
|-
|DAILY_AVG_WIND_SPEED
|
|-
|MAX_SHADOW_DISTANCE
|
|-
|MAX_TRUNK_DISTANCE
|
|-
|WIND_DECLINE_ANGLE
|
|}
==Api Model HeatKey==
API Enumeration description of HeatKey
{|class=wikitable
!Name
!Description
|-
|FOLIAGE_HEIGHT
|
|}
==Api Model HeatModel==
API Enumeration description of HeatModel
{|class=wikitable
!Name
!Description
|-
|UNESCO
|
|-
|DPRA
|
|}
==Api Model HeatOverlay==
API Model description of HeatOverlay
{|class=wikitable
!Name
!Type
!Description
|-
|active
|boolean
|
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|calcInfo
|String
|
|-
|calcTimeMS
|long
|
|-
|colorMultiplier
|double
|
|-
|colorOffset
|int
|
|-
|customLegend
|boolean
|
|-
|diffLegend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|id
|int
|
|-
|imageName
|String
|
|-
|imageVersion
|int
|
|-
|inActiveCellSize
|double
|
|-
|inActiveTimeframes
|int
|
|-
|keys
|Map&lt;String,String&gt;
|
|-
|legend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|maxValue
|float[]
|
|-
|minValue
|float[]
|
|-
|model
|HeatModel
|
|-
|name
|String
|
|-
|parentID
|int
|[[Overlay]] ID
|-
|prequels
|Map&lt;String,PrequelLink&gt;
|
|-
|resultType
|String
|
|-
|showDifference
|boolean
|
|-
|sortIndex
|int
|
|-
|type
|OverlayType
|
|-
|version
|int
|
|-
|visible
|boolean
|
|-
|warnings
|String
|
|}
==Api Model HeatPrequel==
API Enumeration description of HeatPrequel
{|class=wikitable
!Name
!Description
|-
|FOLIAGE_HEIGHT
|
|-
|BUILDING_ELEVATION
|
|-
|TERRAIN_ELEVATION
|
|}
==Api Model HeatResult==
API Enumeration description of HeatResult
{|class=wikitable
!Name
!Description
|-
|BOWEN_RATIO
|
|-
|FOLIAGE
|
|-
|PET
|
|-
|PET_RELATIVE
|
|-
|SHADE
|
|-
|SKY_VIEW
|
|-
|SKY_VIEW_AVG
|
|-
|TEMPERATURE_ATMOSPHERE
|
|-
|UHI
|
|-
|VEGETATION
|
|-
|VEGETATION_AVG
|
|-
|WIND_SPEED
|
|}
==Api Model HeightAttribute==
API Enumeration description of HeightAttribute
{|class=wikitable
!Name
!Description
|-
|ZONING_PERMIT_REQUIRED
|
|}
==Api Model HeightOperator==
API Enumeration description of HeightOperator
{|class=wikitable
!Name
!Description
|-
|AVG
|
|-
|MIN
|
|-
|MAX
|
|-
|VOLUME
|
|-
|STDEV
|
|-
|AREA
|
|}
==Api Model HeightOverlay==
API Model description of HeightOverlay
{|class=wikitable
!Name
!Type
!Description
|-
|active
|boolean
|
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|calcTimeMS
|long
|
|-
|colorMultiplier
|double
|
|-
|colorOffset
|int
|
|-
|customLegend
|boolean
|
|-
|diffLegend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|id
|int
|
|-
|imageName
|String
|
|-
|imageVersion
|int
|
|-
|inActiveCellSize
|double
|
|-
|inActiveTimeframes
|int
|
|-
|keys
|Map&lt;String,String&gt;
|
|-
|legend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|maxValue
|float[]
|
|-
|minValue
|float[]
|
|-
|name
|String
|
|-
|parentID
|int
|[[Overlay]] ID
|-
|prequels
|Map&lt;String,PrequelLink&gt;
|
|-
|resultType
|String
|
|-
|showDifference
|boolean
|
|-
|sortIndex
|int
|
|-
|type
|OverlayType
|
|-
|version
|int
|
|-
|visible
|boolean
|
|-
|warnings
|String
|
|}
==Api Model HeightResult==
API Enumeration description of HeightResult
{|class=wikitable
!Name
!Description
|-
|DSM
|
|-
|DTM
|
|-
|FLOORS
|
|}
==Api Model HeightSector==
API Model description of HeightSector
{|class=wikitable
!Name
!Type
!Description
|-
|changed
|Boolean
|
|-
|envelope
|Envelope
|
|-
|id
|int
|
|-
|name
|String
|
|-
|pointAreaM2
|double
|
|-
|pointWidth
|int[]
|
|-
|sourceIDs
|int<nowiki>[]</nowiki>
|[[Source]] ID
|-
|square
|MultiPolygon
|
|-
|version
|int
|
|}
==Api Model HeightSquare==
API Model description of HeightSquare
{|class=wikitable
!Name
!Type
!Description
|-
|x
|double
|
|-
|xMax
|double
|
|-
|xMin
|double
|
|-
|y
|double
|
|-
|yMax
|double
|
|-
|yMin
|double
|
|}
==Api Model ImageAttribute==
API Enumeration description of ImageAttribute
{|class=wikitable
!Name
!Description
|-
|ALPHA
|
|}
==Api Model ImageOverlay==
API Model description of ImageOverlay
{|class=wikitable
!Name
!Type
!Description
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|colorMultiplier
|double
|
|-
|colorOffset
|int
|
|-
|customLegend
|boolean
|
|-
|id
|int
|
|-
|imageName
|String
|
|-
|imageNames
|String<nowiki>[]</nowiki>
|
|-
|imageVersion
|int
|
|-
|legend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|name
|String
|
|-
|parentID
|int
|[[Overlay]] ID
|-
|sortIndex
|int
|
|-
|type
|OverlayType
|
|-
|version
|int
|
|-
|visible
|boolean
|
|}
==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;
|
|-
|exactTextValues
|Map&lt;MapType,String&gt;
|
|-
|excelID
|int
|[[Excel Sheet]] ID
|-
|excelUpdated
|boolean
|
|-
|id
|int
|
|-
|imageName
|String
|
|-
|imageVersion
|int
|
|-
|isActive
|boolean
|
|-
|mapTypeValues
|Map&lt;MapType,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 IndicatorAttribute==
API Enumeration description of IndicatorAttribute
{|class=wikitable
!Name
!Description
|-
|FINANCE
|
|}
==Api Model InferenceAttribute==
API Enumeration description of InferenceAttribute
{|class=wikitable
!Name
!Description
|-
|MASK_THRESHOLD
|
|-
|SCORE_THRESHOLD
|
|-
|INFERENCE_MODE
|
|-
|STRIDE_FRACTION
|
|-
|BOX_OVERLAP
|
|-
|PRIORITIZE_LABELS
|
|-
|GPU_MEMORY_MB
|
|}
==Api Model InferenceMode==
API Enumeration description of InferenceMode
{|class=wikitable
!Name
!Description
|-
|CLASSIFICATION
|
|-
|BBOX_DETECTION
|
|}
==Api Model InferenceOverlay==
API Model description of InferenceOverlay
{|class=wikitable
!Name
!Type
!Description
|-
|active
|boolean
|
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|calcTimeMS
|long
|
|-
|colorMultiplier
|double
|
|-
|colorOffset
|int
|
|-
|customLegend
|boolean
|
|-
|diffLegend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|id
|int
|
|-
|imageName
|String
|
|-
|imageVersion
|int
|
|-
|inActiveCellSize
|double
|
|-
|inActiveTimeframes
|int
|
|-
|keys
|Map&lt;String,String&gt;
|
|-
|legend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|maxValue
|float[]
|
|-
|minValue
|float[]
|
|-
|name
|String
|
|-
|neuralNetworkID
|int
|[[Neural Network]] ID
|-
|parentID
|int
|[[Overlay]] ID
|-
|prequels
|Map&lt;String,PrequelLink&gt;
|
|-
|resultType
|String
|
|-
|showDifference
|boolean
|
|-
|sortIndex
|int
|
|-
|tensorLinks
|TensorLink<nowiki>[]</nowiki>
|
|-
|type
|OverlayType
|
|-
|version
|int
|
|-
|visible
|boolean
|
|-
|warnings
|String
|
|}
==Api Model InferencePrequel==
API Enumeration description of InferencePrequel
{|class=wikitable
!Name
!Description
|-
|A
|
|-
|B
|
|-
|C
|
|}
==Api Model InferenceResult==
API Enumeration description of InferenceResult
{|class=wikitable
!Name
!Description
|-
|LABELS
|
|-
|SCORES
|
|-
|BOXES
|
|-
|MASKS
|
|-
|DEBUG_GT_INSTANCES
|
|-
|CENTER_POINTS
|
|}
==Api Model Input==
API Enumeration description of Input
{|class=wikitable
!Name
!Description
|-
|A
|
|-
|B
|
|-
|C
|
|-
|D
|
|-
|E
|
|-
|F
|
|-
|G
|
|-
|H
|
|-
|I
|
|-
|J
|
|}
==Api Model InstanceColor==
API Enumeration description of InstanceColor
{|class=wikitable
!Name
!Description
|-
|GRAY
|
|-
|WHITE
|
|-
|VEGIE_GREEN
|
|-
|GRAIN_YELLOW
|
|-
|FLOWERS
|
|}
==Api Model Item==
API Model description of Item
{|class=wikitable
!Name
!Type
!Description
|-
|id
|int
|
|-
|version
|int
|
|}
==Api Model ItemMeasurement==
API Model description of ItemMeasurement
{|class=wikitable
!Name
!Type
!Description
|-
|id
|int
|
|-
|itemID
|int
|
|-
|key
|String
|
|-
|mapLink
|MapLink
|
|-
|maqMax
|double
|
|-
|maqMin
|double
|
|-
|max
|double
|
|-
|min
|double
|
|-
|name
|String
|
|-
|overlayIDs
|int<nowiki>[]</nowiki>
|[[Overlay]] ID
|-
|overlayMaqValues
|Map&lt;int,float[]&gt;
|
|-
|overlayValues
|Map&lt;int,float[]&gt;
|
|-
|point
|Point
|
|-
|save
|boolean
|
|-
|sourceIDs
|int<nowiki>[]</nowiki>
|[[Source]] ID
|-
|sum
|boolean
|
|-
|version
|int
|
|}
==Api Model IterationAttribute==
API Enumeration description of IterationAttribute
{|class=wikitable
!Name
!Description
|-
|MODULUS
|
|-
|TIMEFRAME_TIMES
|
|}
==Api Model IterationOverlay==
API Model description of IterationOverlay
{|class=wikitable
!Name
!Type
!Description
|-
|active
|boolean
|
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|calcTimeMS
|long
|
|-
|colorMultiplier
|double
|
|-
|colorOffset
|int
|
|-
|customLegend
|boolean
|
|-
|diffLegend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|id
|int
|
|-
|imageName
|String
|
|-
|imageVersion
|int
|
|-
|inActiveCellSize
|double
|
|-
|inActiveTimeframes
|int
|
|-
|keys
|Map&lt;String,String&gt;
|
|-
|legend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|maxValue
|float[]
|
|-
|minValue
|float[]
|
|-
|name
|String
|
|-
|parentID
|int
|[[Overlay]] ID
|-
|prequels
|Map&lt;String,PrequelLink&gt;
|
|-
|resultType
|String
|
|-
|showDifference
|boolean
|
|-
|sortIndex
|int
|
|-
|type
|OverlayType
|
|-
|version
|int
|
|-
|visible
|boolean
|
|-
|warnings
|String
|
|}
==Api Model IterationPrequel==
API Enumeration description of IterationPrequel
{|class=wikitable
!Name
!Description
|-
|ITERATION
|
|}
==Api Model Layer==
API Enumeration description of Layer
{|class=wikitable
!Name
!Description
|-
|BRIDGE
|
|-
|SURFACE
|
|-
|UNDERGROUND
|
|}
==Api Model LegendEntry==
API Model description of LegendEntry
{|class=wikitable
!Name
!Type
!Description
|-
|color
|TColor
|
|-
|entryName
|String
|
|-
|id
|int
|
|-
|value
|float
|
|}
==Api Model LeveeFeature==
API Model description of LeveeFeature
{|class=wikitable
!Name
!Type
!Description
|-
|id
|int
|
|-
|version
|int
|
|}
==Api Model LeveeSpatial==
API Model description of LeveeSpatial
{|class=wikitable
!Name
!Type
!Description
|-
|angleOverride
|double
|
|-
|heightOverride
|double
|
|-
|id
|int
|
|-
|isRelativeOverride
|Boolean
|
|-
|leveeID
|int
|[[Levee]] ID
|-
|multiPolygon
|MultiPolygon
|
|-
|sidePolygon
|MultiPolygon
|
|-
|topPolygon
|MultiPolygon
|
|}
==Api Model LimitType==
API Enumeration description of LimitType
{|class=wikitable
!Name
!Description
|-
|DEFAULT
|
|-
|NEIGHBORHOODS
|
|-
|MEASURE_NEIGHBORHOODS
|
|}
==Api Model LineMeasurement==
API Model description of LineMeasurement
{|class=wikitable
!Name
!Type
!Description
|-
|distances
|double[]
|
|-
|id
|int
|
|-
|lineSegment
|LineSegment
|
|-
|lineString
|LineString
|
|-
|maqMax
|double
|
|-
|maqMin
|double
|
|-
|maqValues
|Map&lt;int,java.util.ArrayList<float[]>&gt;
|
|-
|max
|double
|
|-
|min
|double
|
|-
|name
|String
|
|-
|overlayIDs
|int<nowiki>[]</nowiki>
|[[Overlay]] ID
|-
|save
|boolean
|
|-
|sourceIDs
|int<nowiki>[]</nowiki>
|[[Source]] ID
|-
|sum
|boolean
|
|-
|values
|Map&lt;int,java.util.ArrayList<float[]>&gt;
|
|-
|version
|int
|
|}
==Api Model LineString==
API Model description of LineString
{|class=wikitable
!Name
!Type
!Description
|}
==Api Model LoadAttribute==
API Enumeration description of LoadAttribute
{|class=wikitable
!Name
!Description
|-
|CONNECTION_COST
|
|-
|FLOW
|
|-
|POWER
|
|-
|CONNECTION_COUNT
|
|-
|FLOOR_SPACE_M2
|
|-
|TYPE
|
|-
|ROOT_LOAD
|
|-
|LOAD_COUNT
|
|-
|ADDRESS_COUNT
|
|-
|CONNECTION_FRACTION
|
|-
|PRESSURE_M_H2O_SUPPLY
|
|-
|PRESSURE_M_H2O_RETURN
|
|-
|TEMPERATURE_SUPPLY_DEGREES_CELSIUS
|
|}
==Api Model LoadCostSegment==
API Model description of LoadCostSegment
{|class=wikitable
!Name
!Type
!Description
|-
|baseCost
|double
|
|-
|incrCost
|double
|
|-
|minValue
|int
|
|}
==Api Model LoadParameterType==
API Enumeration description of LoadParameterType
{|class=wikitable
!Name
!Description
|-
|FLOW
|
|-
|POWER
|
|-
|CONNECTION_COST
|
|-
|CONNECTION
|
|-
|FLOOR_SPACE_M2
|
|}
==Api Model LoadType==
API Enumeration description of LoadType
{|class=wikitable
!Name
!Description
|-
|UNKNOWN
|
|-
|COLLECTIVE
|
|-
|COLLECTIVE_TAP
|
|-
|COLLECTIVE_RADIATOR
|
|-
|COLLECTIVE_RADIATOR_TAP
|
|-
|INDIVIDUAL
|
|-
|LARGE_SCALE_CONSUMER
|
|}
==Api Model LogicPanel==
API Model description of LogicPanel
{|class=wikitable
!Name
!Type
!Description
|-
|answers
|Answer<nowiki>[]</nowiki>
|
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|calcTimeMS
|long
|
|-
|contentID
|int
|
|-
|contentMapLink
|MapLink
|
|-
|height
|double
|
|-
|id
|int
|
|-
|layoutX
|double
|
|-
|layoutY
|double
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|name
|String
|
|-
|overlayID
|int
|[[Overlay]] ID
|-
|overrideDefaultAnswerID
|int
|
|-
|parentID
|int
|
|-
|point
|Point
|
|-
|stakeholderID
|int
|[[Stakeholder]] ID
|-
|text
|String
|
|-
|type
|PanelType
|
|-
|updateTiming
|Timing
|
|-
|version
|int
|
|-
|warnings
|String
|
|-
|width
|double
|
|}
==Api Model MapMeasure==
API Model description of MapMeasure
{|class=wikitable
!Name
!Type
!Description
|-
|actualHeightChangeM3
|double
|
|-
|buildingIDs
|int<nowiki>[]</nowiki>
|[[Building]] ID
|-
|buildingPermitProcessed
|Set
|
|-
|center
|Point
|
|-
|clientActionEvents
|Map&lt;ActionType,java.util.List<nl.tytech.data.core.item.CodedEvent>&gt;
|
|-
|confirmationsRequired
|boolean
|
|-
|constructionCostsFixed
|double
|
|-
|constructionCostsM3
|double
|
|-
|custom
|boolean
|
|-
|dependencyIDs
|int<nowiki>[]</nowiki>
|[[Measure]] ID
|-
|description
|String
|
|-
|geoTiffSpatials
|GeoTiffSpatial<nowiki>[]</nowiki>
|
|-
|gridSpatials
|GridSpatial<nowiki>[]</nowiki>
|
|-
|id
|int
|
|-
|imageName
|String
|
|-
|imageVersion
|int
|
|-
|incomeFixed
|double
|
|-
|landOwnerPermissions
|Map&lt;int,Boolean&gt;
|
|-
|leveeSpatials
|LeveeSpatial<nowiki>[]</nowiki>
|
|-
|name
|String
|
|-
|ownerID
|int
|[[Stakeholder]] ID
|-
|serverActionEvents
|Map&lt;ActionType,java.util.List<nl.tytech.data.core.item.CodedEvent>&gt;
|
|-
|sourceIDs
|int<nowiki>[]</nowiki>
|[[Source]] ID
|-
|state
|TimeState
|
|-
|terrainSpatials
|TerrainSpatial<nowiki>[]</nowiki>
|
|-
|upgradeSpatials
|UpgradeSpatial<nowiki>[]</nowiki>
|
|-
|version
|int
|
|}
==Api Model MapType==
API Enumeration description of MapType
{|class=wikitable
!Name
!Description
|-
|CURRENT
|
|-
|MAQUETTE
|
|}
==Api Model Measure==
API Model description of Measure
{|class=wikitable
!Name
!Type
!Description
|-
|clientActionEvents
|Map&lt;ActionType,java.util.List<nl.tytech.data.core.item.CodedEvent>&gt;
|
|-
|confirmationsRequired
|boolean
|
|-
|constructionCostsFixed
|double
|
|-
|custom
|boolean
|
|-
|dependencyIDs
|int<nowiki>[]</nowiki>
|[[Measure]] ID
|-
|description
|String
|
|-
|id
|int
|
|-
|imageName
|String
|
|-
|imageVersion
|int
|
|-
|incomeFixed
|double
|
|-
|landOwnerPermissions
|Map&lt;int,Boolean&gt;
|
|-
|name
|String
|
|-
|ownerID
|int
|[[Stakeholder]] ID
|-
|serverActionEvents
|Map&lt;ActionType,java.util.List<nl.tytech.data.core.item.CodedEvent>&gt;
|
|-
|sourceIDs
|int<nowiki>[]</nowiki>
|[[Source]] ID
|-
|state
|TimeState
|
|-
|version
|int
|
|}
==Api Model MeasureEditType==
API Enumeration description of MeasureEditType
{|class=wikitable
!Name
!Description
|-
|BUILDING
|
|-
|RAISE
|
|-
|FLATTEN
|
|-
|WATER
|
|-
|UPGRADE
|
|-
|LEVEE
|
|-
|GEOTIFF
|
|-
|GRID
|
|}
==Api Model Method==
API Enumeration description of Method
{|class=wikitable
!Name
!Description
|-
|GET
|
|-
|POST
|
|}
==Api Model MinMax==
API Enumeration description of MinMax
{|class=wikitable
!Name
!Description
|-
|NEVER
|
|-
|LARGE_CELL
|
|-
|ALWAYS
|
|}
==Api Model Mode==
API Enumeration description of Mode
{|class=wikitable
!Name
!Description
|-
|SPEED
|
|-
|AVERAGE
|
|-
|ACCURACY
|
|}
==Api Model ModelData==
API Model description of ModelData
{|class=wikitable
!Name
!Type
!Description
|-
|additions
|Addition<nowiki>[]</nowiki>
|
|-
|animMultiplier
|double
|
|-
|buffer
|int
|
|-
|dimension
|int
|
|-
|frequency
|int
|
|-
|id
|int
|
|-
|instanceColor
|InstanceColor
|
|-
|isAlpha
|boolean
|
|-
|isShowCloseby
|boolean
|
|-
|modelHeight
|double
|
|-
|modelWidth
|double
|
|-
|name
|String
|
|-
|particleEmitters
|ParticleEmitterCoordinatePair<nowiki>[]</nowiki>
|
|-
|placement
|Placement
|
|-
|randomScale
|double
|
|-
|roots
|boolean
|
|-
|rotation
|Rotation
|
|-
|show
|Show
|
|-
|variation
|int
|
|-
|version
|int
|
|}
==Api Model ModelStyle==
API Enumeration description of ModelStyle
{|class=wikitable
!Name
!Description
|-
|WIREFRAME
|
|-
|PLAIN
|
|-
|COLORED
|
|-
|TEXTURED
|
|-
|DISCO
|
|}
==Api Model MultiLineString==
API Model description of MultiLineString
{|class=wikitable
!Name
!Type
!Description
|}
==Api Model MultiPolygon==
API Model description of MultiPolygon
{|class=wikitable
!Name
!Type
!Description
|}
==Api Model NO2Overlay==
API Model description of NO2Overlay
{|class=wikitable
!Name
!Type
!Description
|-
|active
|boolean
|
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|calcTimeMS
|long
|
|-
|colorMultiplier
|double
|
|-
|colorOffset
|int
|
|-
|customLegend
|boolean
|
|-
|diffLegend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|id
|int
|
|-
|imageName
|String
|
|-
|imageVersion
|int
|
|-
|inActiveCellSize
|double
|
|-
|inActiveTimeframes
|int
|
|-
|keys
|Map&lt;String,String&gt;
|
|-
|legend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|maxValue
|float[]
|
|-
|minValue
|float[]
|
|-
|name
|String
|
|-
|parentID
|int
|[[Overlay]] ID
|-
|prequels
|Map&lt;String,PrequelLink&gt;
|
|-
|resultType
|String
|
|-
|showDifference
|boolean
|
|-
|sortIndex
|int
|
|-
|type
|OverlayType
|
|-
|version
|int
|
|-
|visible
|boolean
|
|-
|warnings
|String
|
|}
==Api Model NO2Result==
API Enumeration description of NO2Result
{|class=wikitable
!Name
!Description
|-
|CONCENTRATION
|
|-
|EMISSION_NO2
|
|-
|EMISSION_NOX
|
|-
|TREEFACTOR
|
|-
|TREES
|
|}
==Api Model NeighborPredicate==
API Model description of NeighborPredicate
{|class=wikitable
!Name
!Type
!Description
|-
|me
|Building
|
|}
==Api Model Neighborhood==
API Model description of Neighborhood
{|class=wikitable
!Name
!Type
!Description
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|center
|Point
|
|-
|id
|int
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|municipalityID
|int
|[[Stakeholder]] ID
|-
|name
|String
|
|-
|polygons
|MultiPolygon
|
|-
|sourceIDs
|int<nowiki>[]</nowiki>
|[[Source]] ID
|-
|version
|int
|
|}
==Api Model NeighborhoodAttribute==
API Enumeration description of NeighborhoodAttribute
{|class=wikitable
!Name
!Description
|-
|URBANIZATION
|
|-
|INHABITANTS
|
|-
|ACTIVE
|
|}
==Api Model NetFunction==
API Model description of NetFunction
{|class=wikitable
!Name
!Type
!Description
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|diameterM
|double
|
|-
|groupName
|String
|
|-
|id
|int
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|name
|String
|
|-
|netType
|NetType
|
|-
|priceM
|double
|
|-
|sourceIDs
|int<nowiki>[]</nowiki>
|[[Source]] ID
|-
|version
|int
|
|}
==Api Model NetLine==
API Model description of NetLine
{|class=wikitable
!Name
!Type
!Description
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|endNodeID
|int
|[[Net Node]] ID
|-
|functionID
|int
|[[Net Function]] ID
|-
|id
|int
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|name
|String
|
|-
|sourceIDs
|int<nowiki>[]</nowiki>
|[[Source]] ID
|-
|startNodeID
|int
|[[Net Node]] ID
|-
|version
|int
|
|}
==Api Model NetLineAttribute==
API Enumeration description of NetLineAttribute
{|class=wikitable
!Name
!Description
|-
|FLOW
|
|-
|DIAMETER_M
|
|-
|ALWAYS_ACTIVE
|
|}
==Api Model NetLineFunctionAttribute==
API Enumeration description of NetLineFunctionAttribute
{|class=wikitable
!Name
!Description
|-
|PRICE_M
|
|-
|VISUALIZATION_DIAMETER_M
|
|-
|DIAMETER_M
|
|-
|COLOR
|
|}
==Api Model NetLoad==
API Model description of NetLoad
{|class=wikitable
!Name
!Type
!Description
|-
|addressIDs
|int<nowiki>[]</nowiki>
|[[Address]] ID
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|buildingID
|int
|[[Building]] ID
|-
|clusterID
|int
|[[Net Cluster]] ID
|-
|connectionState
|TimeState
|
|-
|id
|int
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|name
|String
|
|-
|netType
|NetType
|
|-
|nodeID
|int
|[[Net Node]] ID
|-
|point
|Point
|
|-
|sourceIDs
|int<nowiki>[]</nowiki>
|[[Source]] ID
|-
|version
|int
|
|}
==Api Model NetNode==
API Model description of NetNode
{|class=wikitable
!Name
!Type
!Description
|-
|connectedLineIDs
|int<nowiki>[]</nowiki>
|
|-
|id
|int
|
|-
|loadIDs
|int<nowiki>[]</nowiki>
|
|-
|name
|String
|
|-
|point
|Point
|
|-
|sourceIDs
|int<nowiki>[]</nowiki>
|[[Source]] ID
|-
|version
|int
|
|}
==Api Model NetOverlay==
API Model description of NetOverlay
{|class=wikitable
!Name
!Type
!Description
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|colorMultiplier
|double
|
|-
|colorOffset
|int
|
|-
|customLegend
|boolean
|
|-
|id
|int
|
|-
|imageName
|String
|
|-
|imageVersion
|int
|
|-
|legend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|name
|String
|
|-
|netType
|NetType
|
|-
|parentID
|int
|[[Overlay]] ID
|-
|showActive
|boolean
|
|-
|showNetwork
|boolean
|
|-
|sortIndex
|int
|
|-
|type
|OverlayType
|
|-
|version
|int
|
|-
|visible
|boolean
|
|}
==Api Model NetType==
API Enumeration description of NetType
{|class=wikitable
!Name
!Description
|-
|ELECTRICITY
|
|-
|GAS
|
|-
|HEAT
|
|-
|INTERNET
|
|-
|SEWER
|
|}
==Api Model NeuralNetwork==
API Model description of NeuralNetwork
{|class=wikitable
!Name
!Type
!Description
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|description
|String
|
|-
|id
|int
|
|-
|legendEntries
|LegendEntry<nowiki>[]</nowiki>
|
|-
|name
|String
|
|-
|producer
|String
|
|-
|tensors
|Tensor<nowiki>[]</nowiki>
|
|-
|uploadDate
|long
|
|-
|uploaderName
|String
|
|-
|version
|int
|
|-
|warnings
|String
|
|}
==Api Model NeuralNetworkAttribute==
API Enumeration description of NeuralNetworkAttribute
{|class=wikitable
!Name
!Description
|-
|MIN_CELL_SIZE_M
|
|-
|MAX_CELL_SIZE_M
|
|-
|MAX_GT_INSTANCES
|
|-
|VERSION
|
|}
==Api Model NoPrequel==
API Enumeration description of NoPrequel
{|class=wikitable
!Name
!Description
|}
==Api Model NoiseOverlay==
API Model description of NoiseOverlay
{|class=wikitable
!Name
!Type
!Description
|-
|active
|boolean
|
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|calcTimeMS
|long
|
|-
|colorMultiplier
|double
|
|-
|colorOffset
|int
|
|-
|customLegend
|boolean
|
|-
|diffLegend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|id
|int
|
|-
|imageName
|String
|
|-
|imageVersion
|int
|
|-
|inActiveCellSize
|double
|
|-
|inActiveTimeframes
|int
|
|-
|keys
|Map&lt;String,String&gt;
|
|-
|legend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|maxValue
|float[]
|
|-
|minValue
|float[]
|
|-
|name
|String
|
|-
|parentID
|int
|[[Overlay]] ID
|-
|prequels
|Map&lt;String,PrequelLink&gt;
|
|-
|resultType
|String
|
|-
|showDifference
|boolean
|
|-
|sortIndex
|int
|
|-
|type
|OverlayType
|
|-
|version
|int
|
|-
|visible
|boolean
|
|-
|warnings
|String
|
|}
==Api Model NoiseResult==
API Enumeration description of NoiseResult
{|class=wikitable
!Name
!Description
|-
|NOISE_DB
|
|-
|EMISSION
|
|}
==Api Model Operator (AvgOverlay)==
API Enumeration description of Operator
{|class=wikitable
!Name
!Description
|-
|AVG
|
|-
|AVG_INTERPOLATED
|
|-
|MAX
|
|-
|MIN
|
|}
==Api Model Operator (ComboOverlay)==
API Enumeration description of Operator
{|class=wikitable
!Name
!Description
|-
|SIN
|
|-
|COS
|
|-
|TAN
|
|-
|ASIN
|
|-
|ACOS
|
|-
|ATAN
|
|-
|SQRT
|
|-
|ROUND
|
|-
|FLOOR
|
|-
|CEIL
|
|-
|ABS
|
|-
|EXP
|
|-
|LN
|
|-
|LOG
|
|-
|RANDOM
|
|-
|ERF
|
|-
|GTE
|
|-
|GT
|
|-
|LTE
|
|-
|LT
|
|-
|NEQ
|
|-
|EQ
|
|-
|IF
|
|-
|AND
|
|-
|OR
|
|-
|SWITCH
|
|-
|ADD
|
|-
|MUL
|
|-
|DIV
|
|-
|SUB
|
|-
|MAX
|
|-
|MIN
|
|-
|AVG
|
|-
|POW
|
|-
|PERCENTILE
|
|-
|AVG_GTE_PERCENTILE
|
|-
|AVG_LTE_PERCENTILE
|
|-
|COLOR
|
|-
|RED
|
|-
|GREEN
|
|-
|BLUE
|
|-
|ALPHA
|
|}
==Api Model Outline==
API Enumeration description of Outline
{|class=wikitable
!Name
!Description
|-
|NONE
|
|-
|SIMPLE
|
|-
|DASHED
|
|}
==Api Model Overlay==
API Model description of Overlay
{|class=wikitable
!Name
!Type
!Description
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|colorMultiplier
|double
|
|-
|colorOffset
|int
|
|-
|customLegend
|boolean
|
|-
|id
|int
|
|-
|imageName
|String
|
|-
|imageVersion
|int
|
|-
|legend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|name
|String
|
|-
|parentID
|int
|[[Overlay]] ID
|-
|sortIndex
|int
|
|-
|type
|OverlayType
|
|-
|version
|int
|
|-
|visible
|boolean
|
|}
==Api Model OverlayCategory==
API Enumeration description of OverlayCategory
{|class=wikitable
!Name
!Description
|-
|ADMINISTRATIVE
|
|-
|ENVIRONMENTAL
|
|-
|WATER
|
|-
|GRID_CALCULATION
|
|-
|GEO_DATA
|
|-
|TOPOGRAPHY
|
|-
|NETWORKS
|
|}
==Api Model OverlayType==
API Enumeration description of OverlayType
{|class=wikitable
!Name
!Description
|-
|OWNERSHIP
|
|-
|OWNERSHIP_GRID
|
|-
|ZIP_CODES
|
|-
|ZONING
|
|-
|NEIGHBORHOODS
|
|-
|MUNICIPALITIES
|
|-
|SCENARIO
|
|-
|VACANCY
|
|-
|HEAT_STRESS
|
|-
|SHADOW
|
|-
|TRAFFIC_DENSITY
|
|-
|TRAFFIC_NO2
|
|-
|TRAFFIC_NOISE
|
|-
|LIVABILITY
|
|-
|AERIUS
|
|-
|RAINFALL
|
|-
|FLOODING
|
|-
|GROUNDWATER
|
|-
|WATERSHED
|
|-
|SUBSIDENCE
|
|-
|WATERWIJZER
|
|-
|AVG
|
|-
|COMBO
|
|-
|DISTANCE
|
|-
|SIGHT_DISTANCE
|
|-
|TRAVEL_DISTANCE
|
|-
|INFERENCE
|
|-
|ITERATION
|
|-
|GEO_TIFF
|
|-
|WMS
|
|-
|WCS
|
|-
|IMAGE
|
|-
|AREA
|
|-
|ATTRIBUTE
|
|-
|FUNCTION
|
|-
|SATELLITE
|
|-
|HEIGHTMAP
|
|-
|UNDERGROUND
|
|-
|SOURCE
|
|-
|NETWORK_OWNERSHIP
|
|-
|NETWORK_OVERVIEW
|
|-
|NETWORK_DISTANCE
|
|-
|RESULT_CHILD
|
|-
|TEST
|
|-
|DISTURBANCE_DISTANCE
|
|-
|SAFETY_DISTANCE
|
|-
|DEPRECATED
|
|}
==Api Model PDResult==
API Model description of PDResult
{|class=wikitable
!Name
!Type
!Description
|-
|areaExisting
|Map&lt;FunctionType,double&gt;
|
|-
|bandMPs
|Map&lt;FunctionType,java.util.Map<java.lang.Integer, java.util.List<org.locationtech.jts.geom.MultiPolygon>>&gt;
|
|-
|detailMPs
|Map&lt;FunctionType,java.util.Map<java.lang.Integer, java.util.List<org.locationtech.jts.geom.MultiPolygon>>&gt;
|
|}
==Api Model Panel==
API Model description of Panel
{|class=wikitable
!Name
!Type
!Description
|-
|answers
|Answer<nowiki>[]</nowiki>
|
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|height
|double
|
|-
|id
|int
|
|-
|layoutX
|double
|
|-
|layoutY
|double
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|name
|String
|
|-
|overlayID
|int
|[[Overlay]] ID
|-
|overrideDefaultAnswerID
|int
|
|-
|point
|Point
|
|-
|stakeholderID
|int
|[[Stakeholder]] ID
|-
|type
|PanelType
|
|-
|version
|int
|
|-
|width
|double
|
|}
==Api Model PanelAttribute==
API Enumeration description of PanelAttribute
{|class=wikitable
!Name
!Description
|-
|VISIBLE
|
|-
|REFRESH
|
|-
|VISIBLE_TIMEFRAME
|
|-
|ATTENTION
|
|-
|SCALE
|
|-
|POPUP_TYPE
|
|}
==Api Model PanelTemplate==
API Enumeration description of PanelTemplate
{|class=wikitable
!Name
!Description
|-
|TRAFFIC_NOISE
|
|-
|DANGEROUS_OBJECTS
|
|-
|NETWORK_INTERACTION
|
|-
|WATER_AREAS
|
|-
|WEIRS
|
|}
==Api Model PanelType==
API Enumeration description of PanelType
{|class=wikitable
!Name
!Description
|-
|GLOBAL_PANEL
|
|-
|EXCEL_PANEL
|
|-
|WEB_PANEL
|
|-
|TEXT_PANEL
|
|-
|TEMPLATE_EXCEL_PANEL
|
|-
|TEMPLATE_TEXT_PANEL
|
|}
==Api Model ParametricDesign==
API Model description of ParametricDesign
{|class=wikitable
!Name
!Type
!Description
|-
|alignment
|Alignment
|
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|center
|Point
|
|-
|gardenID
|int
|[[Function]] ID
|-
|id
|int
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|name
|String
|
|-
|parkingID
|int
|[[Function]] ID
|-
|plotDesigns
|PlotDesign<nowiki>[]</nowiki>
|
|-
|polygons
|MultiPolygon
|
|-
|publicGreenID
|int
|[[Function]] ID
|-
|roadID
|int
|[[Function]] ID
|-
|sidewalkID
|int
|[[Function]] ID
|-
|sourceIDs
|int<nowiki>[]</nowiki>
|[[Source]] ID
|-
|version
|int
|
|-
|waterID
|int
|[[Terrain Type]] ID
|}
==Api Model ParticleEmitterCoordinatePair==
API Model description of ParticleEmitterCoordinatePair
{|class=wikitable
!Name
!Type
!Description
|-
|id
|int
|
|-
|offsetCoordinate
|double[]
|
|-
|particleEmitterID
|int
|[[Particle Emitter]] ID
|}
==Api Model Placement==
API Enumeration description of Placement
{|class=wikitable
!Name
!Description
|-
|POINT
|
|-
|EDGE
|
|}
==Api Model PlacementType==
API Enumeration description of PlacementType
{|class=wikitable
!Name
!Description
|-
|WATER
|
|-
|LAND
|
|-
|HYBRID
|
|}
==Api Model Plot==
API Model description of Plot
{|class=wikitable
!Name
!Type
!Description
|-
|center
|Point
|
|-
|id
|int
|
|-
|name
|String
|
|-
|ownerID
|int
|[[Stakeholder]] ID
|-
|polygons
|MultiPolygon
|
|-
|sourceIDs
|int<nowiki>[]</nowiki>
|[[Source]] ID
|-
|version
|int
|
|}
==Api Model PlotDesign==
API Model description of PlotDesign
{|class=wikitable
!Name
!Type
!Description
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|functionID
|int
|[[Function]] ID
|-
|id
|int
|
|-
|multiPolygon
|MultiPolygon
|
|}
==Api Model PlotDesignAttribute==
API Enumeration description of PlotDesignAttribute
{|class=wikitable
!Name
!Description
|-
|AREA_M2
|
|-
|WIDTH_M
|
|-
|SIDE_DISTANCE_M
|
|-
|ROAD_DISTANCE_M
|
|-
|UNITS
|
|-
|FLOORS
|
|-
|FLOOR_HEIGHT_M
|
|-
|FIT_FRACTION
|
|-
|FRACTION
|
|}
==Api Model Point==
API Model description of Point
{|class=wikitable
!Name
!Type
!Description
|}
==Api Model PointMeasurement==
API Model description of PointMeasurement
{|class=wikitable
!Name
!Type
!Description
|-
|id
|int
|
|-
|maqMax
|double
|
|-
|maqMin
|double
|
|-
|max
|double
|
|-
|min
|double
|
|-
|name
|String
|
|-
|overlayIDs
|int<nowiki>[]</nowiki>
|[[Overlay]] ID
|-
|overlayMaqValues
|Map&lt;int,float[]&gt;
|
|-
|overlayValues
|Map&lt;int,float[]&gt;
|
|-
|point
|Point
|
|-
|save
|boolean
|
|-
|sourceIDs
|int<nowiki>[]</nowiki>
|[[Source]] ID
|-
|sum
|boolean
|
|-
|version
|int
|
|}
==Api Model PolygonAttributeItem==
API Model description of PolygonAttributeItem
{|class=wikitable
!Name
!Type
!Description
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|center
|Point
|
|-
|id
|int
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|name
|String
|
|-
|polygons
|MultiPolygon
|
|-
|sourceIDs
|int<nowiki>[]</nowiki>
|[[Source]] ID
|-
|version
|int
|
|}
==Api Model PopupData==
API Model description of PopupData
{|class=wikitable
!Name
!Type
!Description
|-
|answers
|Answer<nowiki>[]</nowiki>
|
|-
|calendar
|long
|
|-
|color
|TColor
|
|-
|id
|int
|
|-
|imageType
|PopupImageType
|
|-
|linkID
|int
|
|-
|linkType
|MapLink
|
|-
|modelDataID
|int
|[[Model Data]] ID
|-
|modelType
|PopupModelType
|
|-
|name
|String
|
|-
|opensAutomatically
|boolean
|
|-
|overrideAttention
|Boolean
|
|-
|point
|Point
|
|-
|polygons
|MultiPolygon
|
|-
|scale
|double
|
|-
|text
|String
|
|-
|title
|String
|
|-
|type
|Type
|
|-
|version
|int
|
|-
|visibleForStakeholderIDs
|int<nowiki>[]</nowiki>
|[[Stakeholder]] ID
|-
|visibleTimeframe
|int
|
|}
==Api Model PopupImageType==
API Enumeration description of PopupImageType
{|class=wikitable
!Name
!Description
|-
|PICK_DATE
|
|-
|REQUEST_PERMIT
|
|-
|RECEIVE_REQUEST
|
|-
|WAITING
|
|-
|DECLINE
|
|-
|APPROVE
|
|-
|WAIT_BUILD
|
|-
|WAIT_DEMOLISH
|
|-
|BUILD_PROGRESS
|
|-
|DEMOLISH_PROGRESS
|
|-
|BUY_LAND
|
|-
|SELL_LAND
|
|}
==Api Model PopupModelType==
API Enumeration description of PopupModelType
{|class=wikitable
!Name
!Description
|-
|APPROVED
|
|-
|ARROW
|
|-
|BUY
|
|-
|CONNECT_ON
|
|-
|CONNECT_OFF
|
|-
|CONSTRUCTING
|
|-
|ELEVATION
|
|-
|DECLINED
|
|-
|DEMOLISHING
|
|-
|WAITING
|
|-
|QUESTION_MARK
|
|-
|TRAFFIC_NOISE
|
|-
|WATER_CRANE
|
|-
|WATER_ARROW
|
|-
|WATER_WEIR
|
|-
|LIGHT_BULB
|
|-
|LIGHTNING
|
|-
|BAR_CHART
|
|-
|EXCLAMATION
|
|}
==Api Model RainOverlay==
API Model description of RainOverlay
{|class=wikitable
!Name
!Type
!Description
|-
|active
|boolean
|
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|calcInfo
|String
|
|-
|calcTimeMS
|long
|
|-
|colorMultiplier
|double
|
|-
|colorOffset
|int
|
|-
|customLegend
|boolean
|
|-
|diffLegend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|id
|int
|
|-
|imageName
|String
|
|-
|imageVersion
|int
|
|-
|inActiveCellSize
|double
|
|-
|inActiveTimeframes
|int
|
|-
|keys
|Map&lt;String,String&gt;
|
|-
|legend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|maxValue
|float[]
|
|-
|minValue
|float[]
|
|-
|mode
|Mode
|
|-
|name
|String
|
|-
|parentID
|int
|[[Overlay]] ID
|-
|prequels
|Map&lt;String,PrequelLink&gt;
|
|-
|resultType
|String
|
|-
|showAreas
|boolean
|
|-
|showDifference
|boolean
|
|-
|showSystem
|boolean
|
|-
|sortIndex
|int
|
|-
|type
|OverlayType
|
|-
|version
|int
|
|-
|visible
|boolean
|
|-
|warnings
|String
|
|-
|weatherID
|int
|[[Weather]] ID
|}
==Api Model Rasterization==
API Enumeration description of Rasterization
{|class=wikitable
!Name
!Description
|-
|FIRST
|
|-
|MIN
|
|-
|MAX
|
|-
|SINGLE_LAYER
|
|-
|GRID
|
|}
==Api Model RasterizationMethod==
API Enumeration description of RasterizationMethod
{|class=wikitable
!Name
!Description
|-
|COMBINED
|
|-
|OUTLINE
|
|-
|CENTER
|
|}
==Api Model RasterizationOverlay==
API Model description of RasterizationOverlay
{|class=wikitable
!Name
!Type
!Description
|-
|active
|boolean
|
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|calcTimeMS
|long
|
|-
|colorMultiplier
|double
|
|-
|colorOffset
|int
|
|-
|customLegend
|boolean
|
|-
|diffLegend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|id
|int
|
|-
|imageName
|String
|
|-
|imageVersion
|int
|
|-
|inActiveCellSize
|double
|
|-
|inActiveTimeframes
|int
|
|-
|keys
|Map&lt;String,String&gt;
|
|-
|layerMapLink
|MapLink
|
|-
|legend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|maxValue
|float[]
|
|-
|minValue
|float[]
|
|-
|name
|String
|
|-
|parentID
|int
|[[Overlay]] ID
|-
|prequels
|Map&lt;String,PrequelLink&gt;
|
|-
|rasterization
|Rasterization
|
|-
|resultType
|String
|
|-
|showDifference
|boolean
|
|-
|sortIndex
|int
|
|-
|type
|OverlayType
|
|-
|version
|int
|
|-
|visible
|boolean
|
|-
|warnings
|String
|
|}
==Api Model RasterizationPrequel==
API Enumeration description of RasterizationPrequel
{|class=wikitable
!Name
!Description
|-
|INPUT
|
|}
==Api Model Region==
API Enumeration description of Region
{|class=wikitable
!Name
!Description
|-
|NORTH_AMERICA
|
|-
|NORTHWESTERN_EUROPE
|
|-
|ASIA
|
|-
|AFRICA
|
|-
|OTHER
|
|}
==Api Model Relation==
API Enumeration description of Relation
{|class=wikitable
!Name
!Description
|-
|OWNER
|
|-
|CONSTRUCTOR
|
|-
|DEMOLISHER
|
|-
|PERMITTER
|
|-
|SENDER
|
|-
|RECEIVER
|
|-
|NETOWNER
|
|-
|BORDER_A
|
|-
|BORDER_B
|
|-
|BUILDING
|
|-
|WEATHER
|
|-
|PARENT
|
|-
|RESULT_PARENT
|
|}
==Api Model ResidenceType (Address)==
API Enumeration description of ResidenceType
{|class=wikitable
!Name
!Description
|-
|UNKNOWN
|
|-
|DETACHED
|
|-
|SEMI_DETACHED
|
|-
|PORCH
|
|-
|TERRACED_BETWEEN
|
|-
|TERRACED_CORNER
|
|-
|TINY
|
|-
|GALLERY_HOUSE
|
|-
|FLAT
|
|-
|APARTMENT
|
|-
|CARAVAN
|
|-
|HOUSE_BOAT_BERTH
|
|-
|HOUSE_BOAT_NEW_BERTH
|
|-
|SHARED_HOUSE
|
|-
|ACCOMMODATION
|
|}
==Api Model ResultChildOverlay==
API Model description of ResultChildOverlay
{|class=wikitable
!Name
!Type
!Description
|-
|active
|boolean
|
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|calcTimeMS
|long
|
|-
|colorMultiplier
|double
|
|-
|colorOffset
|int
|
|-
|customLegend
|boolean
|
|-
|diffLegend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|id
|int
|
|-
|imageName
|String
|
|-
|imageVersion
|int
|
|-
|inActiveCellSize
|double
|
|-
|inActiveTimeframes
|int
|
|-
|keys
|Map&lt;String,String&gt;
|
|-
|legend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|maxValue
|float[]
|
|-
|minValue
|float[]
|
|-
|name
|String
|
|-
|parentID
|int
|[[Overlay]] ID
|-
|prequels
|Map&lt;String,PrequelLink&gt;
|
|-
|resultType
|String
|
|-
|showDifference
|boolean
|
|-
|sortIndex
|int
|
|-
|type
|OverlayType
|
|-
|version
|int
|
|-
|visible
|boolean
|
|-
|warnings
|String
|
|}
==Api Model ResultParentOverlay==
API Model description of ResultParentOverlay
{|class=wikitable
!Name
!Type
!Description
|-
|active
|boolean
|
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|calcTimeMS
|long
|
|-
|colorMultiplier
|double
|
|-
|colorOffset
|int
|
|-
|customLegend
|boolean
|
|-
|diffLegend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|id
|int
|
|-
|imageName
|String
|
|-
|imageVersion
|int
|
|-
|inActiveCellSize
|double
|
|-
|inActiveTimeframes
|int
|
|-
|keys
|Map&lt;String,String&gt;
|
|-
|legend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|maxValue
|float[]
|
|-
|minValue
|float[]
|
|-
|name
|String
|
|-
|parentID
|int
|[[Overlay]] ID
|-
|prequels
|Map&lt;String,PrequelLink&gt;
|
|-
|resultType
|String
|
|-
|showDifference
|boolean
|
|-
|sortIndex
|int
|
|-
|type
|OverlayType
|
|-
|version
|int
|
|-
|visible
|boolean
|
|-
|warnings
|String
|
|}
==Api Model Rotation==
API Enumeration description of Rotation
{|class=wikitable
!Name
!Description
|-
|FIXED
|
|-
|QUARTER
|
|-
|FREE
|
|}
==Api Model SWRC==
API Enumeration description of SWRC
{|class=wikitable
!Name
!Description
|-
|NONE
|
|-
|VAN_GENUCHTEN
|
|}
==Api Model SatelliteOverlay==
API Model description of SatelliteOverlay
{|class=wikitable
!Name
!Type
!Description
|-
|active
|boolean
|
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|calcTimeMS
|long
|
|-
|colorMultiplier
|double
|
|-
|colorOffset
|int
|
|-
|customLegend
|boolean
|
|-
|diffLegend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|id
|int
|
|-
|imageName
|String
|
|-
|imageVersion
|int
|
|-
|inActiveCellSize
|double
|
|-
|inActiveTimeframes
|int
|
|-
|keys
|Map&lt;String,String&gt;
|
|-
|legend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|maxValue
|float[]
|
|-
|minValue
|float[]
|
|-
|name
|String
|
|-
|parentID
|int
|[[Overlay]] ID
|-
|prequels
|Map&lt;String,PrequelLink&gt;
|
|-
|resultType
|String
|
|-
|showDifference
|boolean
|
|-
|sortIndex
|int
|
|-
|type
|OverlayType
|
|-
|version
|int
|
|-
|visible
|boolean
|
|-
|warnings
|String
|
|}
==Api Model Scenario==
API Model description of Scenario
{|class=wikitable
!Name
!Type
!Description
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|description
|String
|
|-
|events
|CodedEvent<nowiki>[]</nowiki>
|
|-
|id
|int
|
|-
|limitNeighborhoodIDs
|int<nowiki>[]</nowiki>
|[[Neighborhood]] ID
|-
|limitType
|LimitType
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|name
|String
|
|-
|restartTestrun
|boolean
|
|-
|version
|int
|
|}
==Api Model ScenarioAttribute==
API Enumeration description of ScenarioAttribute
{|class=wikitable
!Name
!Description
|-
|LIMIT_MARGIN
|
|-
|INDICATORS
|
|}
==Api Model Scope==
API Enumeration description of Scope
{|class=wikitable
!Name
!Description
|-
|MAP
|
|-
|WATER_AREAS
|
|-
|LIMIT_AREAS
|
|-
|OVERRIDE_RAIN_AREAS
|
|}
==Api Model Section==
API Model description of Section
{|class=wikitable
!Name
!Type
!Description
|-
|floors
|int
|
|-
|id
|int
|
|-
|outerLines
|MultiLineString
|
|-
|polygons
|MultiPolygon
|
|-
|roofHeightM
|double
|
|-
|roofPolygons
|GeometryCollection
|
|-
|roofShape
|float[]
|
|-
|skeletonEnd
|Point
|
|-
|skeletonLines
|MultiLineString
|
|-
|skeletonStart
|Point
|
|-
|slantingRoofHeightM
|double
|
|}
==Api Model ServiceOverlay==
API Model description of ServiceOverlay
{|class=wikitable
!Name
!Type
!Description
|-
|active
|boolean
|
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|calcTimeMS
|long
|
|-
|colorMultiplier
|double
|
|-
|colorOffset
|int
|
|-
|crs
|String
|
|-
|customLegend
|boolean
|
|-
|diffLegend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|forceXY
|boolean
|
|-
|id
|int
|
|-
|imageName
|String
|
|-
|imageVersion
|int
|
|-
|inActiveCellSize
|double
|
|-
|inActiveTimeframes
|int
|
|-
|keys
|Map&lt;String,String&gt;
|
|-
|layerName
|String
|
|-
|layerNames
|String<nowiki>[]</nowiki>
|
|-
|legend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|maxValue
|float[]
|
|-
|minValue
|float[]
|
|-
|name
|String
|
|-
|parentID
|int
|[[Overlay]] ID
|-
|prequels
|Map&lt;String,PrequelLink&gt;
|
|-
|resultType
|String
|
|-
|showDifference
|boolean
|
|-
|sortIndex
|int
|
|-
|sourceID
|int
|[[Source]] ID
|-
|type
|OverlayType
|
|-
|version
|int
|
|-
|visible
|boolean
|
|-
|warnings
|String
|
|}
==Api Model ServiceSource==
API Model description of ServiceSource
{|class=wikitable
!Name
!Type
!Description
|-
|color
|TColor
|
|-
|date
|long
|
|-
|description
|String
|
|-
|format
|GeoFormat
|
|-
|id
|int
|
|-
|infoUrl
|String
|
|-
|name
|String
|
|-
|uploaderName
|String
|
|-
|url
|String
|
|-
|version
|int
|
|}
==Api Model ShadowAttribute==
API Enumeration description of ShadowAttribute
{|class=wikitable
!Name
!Description
|-
|DATES
|
|-
|SUN_ALTITUDE
|
|-
|SUN_AZIMUTH
|
|-
|MAX_SHADOW_DISTANCE
|
|-
|MAX_FOLIAGE_RADIUS
|
|}
==Api Model ShadowOverlay==
API Model description of ShadowOverlay
{|class=wikitable
!Name
!Type
!Description
|-
|active
|boolean
|
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|calcInfo
|String
|
|-
|calcTimeMS
|long
|
|-
|colorMultiplier
|double
|
|-
|colorOffset
|int
|
|-
|customLegend
|boolean
|
|-
|diffLegend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|id
|int
|
|-
|imageName
|String
|
|-
|imageVersion
|int
|
|-
|inActiveCellSize
|double
|
|-
|inActiveTimeframes
|int
|
|-
|keys
|Map&lt;String,String&gt;
|
|-
|legend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|maxValue
|float[]
|
|-
|minValue
|float[]
|
|-
|name
|String
|
|-
|parentID
|int
|[[Overlay]] ID
|-
|prequels
|Map&lt;String,PrequelLink&gt;
|
|-
|resultType
|String
|
|-
|showDifference
|boolean
|
|-
|sortIndex
|int
|
|-
|type
|OverlayType
|
|-
|version
|int
|
|-
|visible
|boolean
|
|-
|warnings
|String
|
|}
==Api Model ShadowPrequel==
API Enumeration description of ShadowPrequel
{|class=wikitable
!Name
!Description
|-
|FOLIAGE_HEIGHT
|
|-
|BUILDING_ELEVATION
|
|-
|TERRAIN_ELEVATION
|
|}
==Api Model ShadowResult==
API Enumeration description of ShadowResult
{|class=wikitable
!Name
!Description
|-
|SHADE
|
|-
|FOLIAGE
|
|}
==Api Model Shoreline==
API Enumeration description of Shoreline
{|class=wikitable
!Name
!Description
|-
|NONE
|
|-
|ONE_CELL
|
|-
|TWO_CELLS
|
|}
==Api Model Show==
API Enumeration description of Show
{|class=wikitable
!Name
!Description
|-
|FAR
|
|-
|MIDDLE
|
|-
|CLOSE
|
|}
==Api Model SightDistanceAttribute==
API Enumeration description of SightDistanceAttribute
{|class=wikitable
!Name
!Description
|-
|SOURCE_HEIGHT_M
|
|-
|OBSERVER_HEIGHT_M
|
|-
|ATTRIBUTE_TIMEFRAMES
|
|}
==Api Model SourceOverlay==
API Model description of SourceOverlay
{|class=wikitable
!Name
!Type
!Description
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|colorMultiplier
|double
|
|-
|colorOffset
|int
|
|-
|customLegend
|boolean
|
|-
|id
|int
|
|-
|imageName
|String
|
|-
|imageVersion
|int
|
|-
|legend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|name
|String
|
|-
|parentID
|int
|[[Overlay]] ID
|-
|restColor
|TColor
|
|-
|sortIndex
|int
|
|-
|sources
|Map&lt;int,int&gt;
|
|-
|type
|OverlayType
|
|-
|version
|int
|
|-
|visible
|boolean
|
|}
==Api Model SpecialEffect==
API Model description of SpecialEffect
{|class=wikitable
!Name
!Type
!Description
|-
|active
|boolean
|
|-
|id
|int
|
|-
|name
|String
|
|-
|particleEmitters
|ParticleEmitterCoordinatePair<nowiki>[]</nowiki>
|
|-
|point
|Point
|
|-
|version
|int
|
|}
==Api Model SpecialOption==
API Model description of SpecialOption
{|class=wikitable
!Name
!Type
!Description
|-
|defaults
|Type<nowiki>[]</nowiki>
|
|-
|description
|String
|
|-
|id
|int
|
|-
|imageName
|String
|
|-
|name
|String
|
|-
|version
|int
|
|}
==Api Model Stakeholder==
API Model description of Stakeholder
{|class=wikitable
!Name
!Type
!Description
|-
|active
|boolean
|
|-
|client
|ClientData
|
|-
|color
|TColor
|
|-
|id
|int
|
|-
|imageName
|String
|
|-
|imageVersion
|int
|
|-
|lastSelected
|long
|
|-
|name
|String
|
|-
|shortName
|String
|
|-
|startBudget
|double
|
|-
|startBudgets
|Map&lt;int,double&gt;
|
|-
|startCinematics
|Map&lt;int,int&gt;
|
|-
|startPoint
|Point
|
|-
|type
|Type
|
|-
|version
|int
|
|-
|webToken
|String
|
|}
==Api Model Style==
API Enumeration description of Style
{|class=wikitable
!Name
!Description
|-
|INTERPOLATED
|
|-
|NEAREST
|
|-
|ARROW
|
|-
|COLOR
|
|-
|FLOAT32
|
|-
|DIFFERENCE
|
|}
==Api Model SubsidenceAttribute==
API Enumeration description of SubsidenceAttribute
{|class=wikitable
!Name
!Description
|-
|YEARS
|
|-
|YEARS_PER_TIMEFRAME
|
|-
|START_YEAR
|
|-
|A
|
|-
|B
|
|-
|C
|
|-
|ACTIVE_DRAINAGE_FACTOR
|
|-
|PASSIVE_DRAINAGE_FACTOR
|
|-
|CLIMATE_START_TEMP
|
|-
|CLIMATE_FINAL_TEMP
|
|-
|CLIMATE_START_YEAR
|
|-
|CLIMATE_FINAL_YEAR
|
|-
|CLIMATE_OXIDATION
|
|-
|CLIMATE_SOIL_TEMP_FACTOR
|
|-
|LOW_PASSIVE_DRAINAGE
|
|-
|HI_PASSIVE_DRAINAGE
|
|-
|DEFAULT_PEAT_FRACTION
|
|-
|DEFAULT_TOP_LAYER_THICKNESS
|
|-
|DEFAULT_CLAY_THICKNESS
|
|-
|INUNDATE_LAND_BELOW_WATER_LEVEL
|
|}
==Api Model SubsidenceKey==
API Enumeration description of SubsidenceKey
{|class=wikitable
!Name
!Description
|-
|WATER_LEVEL
|
|-
|WATER_LEVEL_OUTPUT
|
|-
|CLAY_THICKNESS
|
|-
|INDEXATION
|
|-
|PEAT_FRACTION
|
|-
|TOPLAYER_THICKNESS
|
|-
|SUBSIDENCE
|
|-
|DRAINAGE
|
|-
|HI_GROUND_WATER_LEVEL
|
|-
|LOW_GROUND_WATER_LEVEL
|
|}
==Api Model SubsidenceOverlay==
API Model description of SubsidenceOverlay
{|class=wikitable
!Name
!Type
!Description
|-
|active
|boolean
|
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|calcTimeMS
|long
|
|-
|colorMultiplier
|double
|
|-
|colorOffset
|int
|
|-
|customLegend
|boolean
|
|-
|diffLegend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|id
|int
|
|-
|imageName
|String
|
|-
|imageVersion
|int
|
|-
|inActiveCellSize
|double
|
|-
|inActiveTimeframes
|int
|
|-
|keys
|Map&lt;String,String&gt;
|
|-
|legend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|maxValue
|float[]
|
|-
|minValue
|float[]
|
|-
|name
|String
|
|-
|parentID
|int
|[[Overlay]] ID
|-
|prequels
|Map&lt;String,PrequelLink&gt;
|
|-
|resultType
|String
|
|-
|showDifference
|boolean
|
|-
|sortIndex
|int
|
|-
|type
|OverlayType
|
|-
|version
|int
|
|-
|visible
|boolean
|
|-
|warnings
|String
|
|}
==Api Model SubsidencePrequel==
API Enumeration description of SubsidencePrequel
{|class=wikitable
!Name
!Description
|-
|LOW_GROUND_WATER
|
|-
|HIGH_GROUND_WATER
|
|-
|CLAY_THICKNESS
|
|}
==Api Model SubsidenceResult==
API Enumeration description of SubsidenceResult
{|class=wikitable
!Name
!Description
|-
|SUBSIDENCE
|
|-
|OXIDATION
|
|-
|SETTLEMENT
|
|-
|LOW_GROUND_WATER
|
|-
|HI_GROUND_WATER
|
|}
==Api Model SurfaceMode==
API Enumeration description of SurfaceMode
{|class=wikitable
!Name
!Description
|-
|NONE
|
|-
|SHALLOW
|
|-
|AVG_WATERWAY
|
|-
|HYBRID
|
|-
|AVG_TERRAIN
|
|}
==Api Model TColor==
API Model description of TColor
{|class=wikitable
!Name
!Type
!Description
|}
==Api Model TemplateExcelPanel==
API Model description of TemplateExcelPanel
{|class=wikitable
!Name
!Type
!Description
|-
|answers
|Answer<nowiki>[]</nowiki>
|
|-
|attribute
|String
|
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|autoApplied
|boolean
|
|-
|calcTimeMS
|long
|
|-
|contentID
|int
|
|-
|contentMapLink
|MapLink
|
|-
|excelID
|int
|[[Excel Sheet]] ID
|-
|height
|double
|
|-
|id
|int
|
|-
|layoutX
|double
|
|-
|layoutY
|double
|
|-
|mapLink
|MapLink
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|name
|String
|
|-
|overlayID
|int
|[[Overlay]] ID
|-
|overrideDefaultAnswerID
|int
|
|-
|parentID
|int
|
|-
|point
|Point
|
|-
|polygons
|MultiPolygon
|
|-
|relation
|Relation
|
|-
|stakeholderID
|int
|[[Stakeholder]] ID
|-
|text
|String
|
|-
|type
|PanelType
|
|-
|updateTiming
|Timing
|
|-
|useOwner
|boolean
|
|-
|version
|int
|
|-
|warnings
|String
|
|-
|width
|double
|
|}
==Api Model TemplateTextPanel==
API Model description of TemplateTextPanel
{|class=wikitable
!Name
!Type
!Description
|-
|answers
|Answer<nowiki>[]</nowiki>
|
|-
|attribute
|String
|
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|autoApplied
|boolean
|
|-
|calcTimeMS
|long
|
|-
|contentID
|int
|
|-
|contentMapLink
|MapLink
|
|-
|height
|double
|
|-
|id
|int
|
|-
|layoutX
|double
|
|-
|layoutY
|double
|
|-
|mapLink
|MapLink
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|name
|String
|
|-
|overlayID
|int
|[[Overlay]] ID
|-
|overrideDefaultAnswerID
|int
|
|-
|parentID
|int
|
|-
|point
|Point
|
|-
|relation
|Relation
|
|-
|stakeholderID
|int
|[[Stakeholder]] ID
|-
|text
|String
|
|-
|type
|PanelType
|
|-
|updateTiming
|Timing
|
|-
|useOwner
|boolean
|
|-
|version
|int
|
|-
|warnings
|String
|
|-
|width
|double
|
|}
==Api Model Tensor==
API Model description of Tensor
{|class=wikitable
!Name
!Type
!Description
|-
|dimensions
|int[]
|
|-
|input
|boolean
|
|-
|name
|String
|
|-
|normalize
|boolean
|
|-
|type
|DataType
|
|}
==Api Model TensorLink==
API Model description of TensorLink
{|class=wikitable
!Name
!Type
!Description
|-
|coordinate
|int[]
|
|-
|id
|int
|
|-
|normalized
|boolean
|
|-
|prequel
|String
|
|-
|result
|String
|
|-
|tensorName
|String
|
|-
|valueType
|ValueType
|
|}
==Api Model Terrain==
API Model description of Terrain
{|class=wikitable
!Name
!Type
!Description
|-
|current
|MultiPolygon
|
|-
|heightValuesCurrent
|double[]
|
|-
|heightValuesMaquette
|double[]
|
|-
|id
|int
|
|-
|maquette
|MultiPolygon
|
|-
|name
|String
|
|-
|showSatellite
|boolean
|
|-
|sourceIDs
|int<nowiki>[]</nowiki>
|[[Source]] ID
|-
|typeID
|int
|[[Terrain Type]] ID
|-
|version
|int
|
|}
==Api Model TerrainAttribute==
API Enumeration description of TerrainAttribute
{|class=wikitable
!Name
!Description
|-
|ANGLE_OF_REPOSE
|
|-
|WATER_DEPTH_M
|
|-
|BOWEN_RATIO
|
|-
|BUILDABLE
|
|-
|SUBSIDENCE
|
|-
|COLOR
|
|-
|HEAT_EFFECT
|
|-
|LIVABILITY_EFFECT
|
|-
|TERRAIN_MIX
|
|-
|TEXTURE_TYPE
|
|-
|WATER
|
|-
|GROUND_INFILTRATION_MD
|
|-
|HYDRAULIC_CONDUCTIVITY_MD
|
|-
|HYDRAULIC_CONDUCTIVITY_WITH_THICKNESS_MD
|
|-
|VAN_GENUCHTEN_M
|
|-
|ROOT_DEPTH_M
|
|-
|VEGETATION_FRACTION
|
|-
|WATER_STORAGE_PERCENTAGE
|
|-
|WATER_MANNING
|
|-
|WATER_MICRORELIEF_M
|
|-
|WATER_TRANSPIRATION_FACTOR
|
|}
==Api Model TerrainFeature==
API Model description of TerrainFeature
{|class=wikitable
!Name
!Type
!Description
|-
|id
|int
|
|-
|this$0
|TerrainSpatial
|
|-
|version
|int
|
|}
==Api Model TerrainSpatial==
API Model description of TerrainSpatial
{|class=wikitable
!Name
!Type
!Description
|-
|id
|int
|
|-
|innerHeight
|double
|
|-
|innerPolygon
|MultiPolygon
|
|-
|innerPrep
|PreparedGeometry
|
|-
|measureEditType
|MeasureEditType
|
|-
|outerPolygon
|MultiPolygon
|
|-
|outerPrep
|PreparedGeometry
|
|-
|outerRings
|LineString<nowiki>[]</nowiki>
|
|-
|relative
|boolean
|
|-
|terrainTypeID
|int
|
|}
==Api Model TerrainType==
API Model description of TerrainType
{|class=wikitable
!Name
!Type
!Description
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|code
|String
|
|-
|groundLayerType
|Layer
|
|-
|id
|int
|
|-
|imageName
|String
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|name
|String
|
|-
|parentID
|int
|[[Terrain Type]] ID
|-
|version
|int
|
|}
==Api Model TextPanel==
API Model description of TextPanel
{|class=wikitable
!Name
!Type
!Description
|-
|answers
|Answer<nowiki>[]</nowiki>
|
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|calcTimeMS
|long
|
|-
|contentID
|int
|
|-
|contentMapLink
|MapLink
|
|-
|height
|double
|
|-
|id
|int
|
|-
|layoutX
|double
|
|-
|layoutY
|double
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|name
|String
|
|-
|overlayID
|int
|[[Overlay]] ID
|-
|overrideDefaultAnswerID
|int
|
|-
|parentID
|int
|
|-
|point
|Point
|
|-
|stakeholderID
|int
|[[Stakeholder]] ID
|-
|text
|String
|
|-
|type
|PanelType
|
|-
|updateTiming
|Timing
|
|-
|version
|int
|
|-
|warnings
|String
|
|-
|width
|double
|
|}
==Api Model TimeState==
API Enumeration description of TimeState
{|class=wikitable
!Name
!Description
|-
|NOTHING
|
|-
|WAITING_FOR_DATE
|
|-
|REQUEST_PLOT_OWNER_APPROVAL
|
|-
|REQUEST_ZONING_APPROVAL
|
|-
|REQUEST_CONSTRUCTION_APPROVAL
|
|-
|CONSTRUCTION_APPROVED
|
|-
|CONSTRUCTION_DENIED
|
|-
|PENDING_CONSTRUCTION
|
|-
|CONSTRUCTING
|
|-
|READY
|
|-
|PENDING_UPGRADE
|
|-
|WAITING_FOR_DEMOLISH_DATE
|
|-
|REQUEST_DEMOLISH_ZONING_APPROVAL
|
|-
|REQUEST_DEMOLISH_APPROVAL
|
|-
|DEMOLISH_APPROVED
|
|-
|DEMOLISH_DENIED
|
|-
|PENDING_DEMOLISHING
|
|-
|DEMOLISHING
|
|-
|DEMOLISH_FINISHED
|
|}
==Api Model Timing==
API Enumeration description of Timing
{|class=wikitable
!Name
!Description
|-
|BEFORE
|
|-
|AFTER
|
|}
==Api Model TrafficAttribute==
API Enumeration description of TrafficAttribute
{|class=wikitable
!Name
!Description
|-
|HOURS
|
|-
|CARS_ACTIVE
|
|-
|VANS_ACTIVE
|
|-
|TRUCKS_ACTIVE
|
|-
|BUSES_ACTIVE
|
|}
==Api Model TrafficDensityOverlay==
API Model description of TrafficDensityOverlay
{|class=wikitable
!Name
!Type
!Description
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|colorMultiplier
|double
|
|-
|colorOffset
|int
|
|-
|customLegend
|boolean
|
|-
|id
|int
|
|-
|imageName
|String
|
|-
|imageVersion
|int
|
|-
|legend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|name
|String
|
|-
|parentID
|int
|[[Overlay]] ID
|-
|sortIndex
|int
|
|-
|type
|OverlayType
|
|-
|version
|int
|
|-
|visible
|boolean
|
|}
==Api Model TrafficNO2Attribute==
API Enumeration description of TrafficNO2Attribute
{|class=wikitable
!Name
!Description
|-
|BASE_O3
|
|-
|BASE_NO2
|
|-
|EMISSION_CAR_NOX
|
|-
|EMISSION_CAR_NO2
|
|-
|EMISSION_JAM_CAR_NOX
|
|-
|EMISSION_JAM_CAR_NO2
|
|-
|EMISSION_VAN_NOX
|
|-
|EMISSION_VAN_NO2
|
|-
|EMISSION_JAM_VAN_NOX
|
|-
|EMISSION_JAM_VAN_NO2
|
|-
|EMISSION_TRUCK_NOX
|
|-
|EMISSION_TRUCK_NO2
|
|-
|EMISSION_JAM_TRUCK_NOX
|
|-
|EMISSION_JAM_TRUCK_NO2
|
|-
|EMISSION_BUS_NOX
|
|-
|EMISSION_BUS_NO2
|
|-
|EMISSION_JAM_BUS_NOX
|
|-
|EMISSION_JAM_BUS_NO2
|
|-
|ROAD1_30M_A
|
|-
|ROAD1_30M_B
|
|-
|ROAD1_30M_C
|
|-
|ROAD1_60M_ALPHA
|
|-
|ROAD1_60M_POWER
|
|-
|MIN_TREE_HEIGHT_M
|
|}
==Api Model TrafficNoiseAttribute==
API Enumeration description of TrafficNoiseAttribute
{|class=wikitable
!Name
!Description
|-
|BACKGROUND_DB
|
|-
|V0_CAR
|
|-
|V0_VAN
|
|-
|V0_TRUCK
|
|-
|V0_BUS
|
|-
|EMISSION_START_CAR
|
|-
|EMISSION_START_VAN
|
|-
|EMISSION_START_TRUCK
|
|-
|EMISSION_START_BUS
|
|-
|EMISSION_MULT_CAR
|
|-
|EMISSION_MULT_VAN
|
|-
|EMISSION_MULT_TRUCK
|
|-
|EMISSION_MULT_BUS
|
|}
==Api Model TrafficOverlay==
API Model description of TrafficOverlay
{|class=wikitable
!Name
!Type
!Description
|-
|active
|boolean
|
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|calcTimeMS
|long
|
|-
|colorMultiplier
|double
|
|-
|colorOffset
|int
|
|-
|customLegend
|boolean
|
|-
|diffLegend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|id
|int
|
|-
|imageName
|String
|
|-
|imageVersion
|int
|
|-
|inActiveCellSize
|double
|
|-
|inActiveTimeframes
|int
|
|-
|keys
|Map&lt;String,String&gt;
|
|-
|legend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|maxValue
|float[]
|
|-
|minValue
|float[]
|
|-
|name
|String
|
|-
|parentID
|int
|[[Overlay]] ID
|-
|prequels
|Map&lt;String,PrequelLink&gt;
|
|-
|resultType
|String
|
|-
|showDifference
|boolean
|
|-
|sortIndex
|int
|
|-
|type
|OverlayType
|
|-
|version
|int
|
|-
|visible
|boolean
|
|-
|warnings
|String
|
|}
==Api Model TrafficType==
API Enumeration description of TrafficType
{|class=wikitable
!Name
!Description
|-
|CAR
|
|-
|VAN
|
|-
|TRUCK
|
|-
|BUS
|
|-
|BICYCLE
|
|-
|PEDESTRIAN
|
|-
|SHIP
|
|-
|TRAM
|
|-
|TRAIN
|
|-
|AIR
|
|}
==Api Model TravelDistanceAttribute==
API Enumeration description of TravelDistanceAttribute
{|class=wikitable
!Name
!Description
|-
|MAX_TRAVEL_DISTANCE
|
|-
|ROAD_DISTANCE
|
|-
|ROUTE_PEDESTRIANS
|
|-
|ROUTE_BICYCLES
|
|-
|ROUTE_CARS
|
|-
|ROUTE_TRUCKS
|
|-
|ROUTE_TRAMS
|
|-
|ROUTE_TRAINS
|
|-
|ROUTE_SHIPS
|
|-
|DESTINATION_THRESHOLD
|
|-
|BLOCKING_THRESHOLD
|
|-
|TRAVERSABLE_THRESHOLD
|
|}
==Api Model TravelDistanceKey==
API Enumeration description of TravelDistanceKey
{|class=wikitable
!Name
!Description
|-
|DESTINATION_AREA
|
|-
|BLOCKED
|
|}
==Api Model TravelDistanceOverlay==
API Model description of TravelDistanceOverlay
{|class=wikitable
!Name
!Type
!Description
|-
|active
|boolean
|
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|calcTimeMS
|long
|
|-
|colorMultiplier
|double
|
|-
|colorOffset
|int
|
|-
|customLegend
|boolean
|
|-
|diffLegend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|id
|int
|
|-
|imageName
|String
|
|-
|imageVersion
|int
|
|-
|inActiveCellSize
|double
|
|-
|inActiveTimeframes
|int
|
|-
|keys
|Map&lt;String,String&gt;
|
|-
|legend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|maxValue
|float[]
|
|-
|minValue
|float[]
|
|-
|name
|String
|
|-
|parentID
|int
|[[Overlay]] ID
|-
|prequels
|Map&lt;String,PrequelLink&gt;
|
|-
|resultType
|String
|
|-
|showDifference
|boolean
|
|-
|sortIndex
|int
|
|-
|type
|OverlayType
|
|-
|version
|int
|
|-
|visible
|boolean
|
|-
|warnings
|String
|
|}
==Api Model TravelDistancePrequel==
API Enumeration description of TravelDistancePrequel
{|class=wikitable
!Name
!Description
|-
|TRAVERSABLE
|
|-
|BLOCKING
|
|-
|DESTINATION
|
|}
==Api Model TravelDistanceResult==
API Enumeration description of TravelDistanceResult
{|class=wikitable
!Name
!Description
|-
|DESTINATIONS
|
|-
|BASE_TYPES
|
|}
==Api Model Trigger==
API Model description of Trigger
{|class=wikitable
!Name
!Type
!Description
|-
|active
|boolean
|
|-
|calcTimeMS
|long
|
|-
|id
|int
|
|-
|method
|Method
|
|-
|name
|String
|
|-
|timeoutMS
|int
|
|-
|timing
|Timing
|
|-
|type
|Type
|
|-
|url
|String
|
|-
|version
|int
|
|-
|warnings
|String
|
|}
==Api Model Type (PopupData)==
API Enumeration description of Type
{|class=wikitable
!Name
!Description
|-
|STAKEHOLDER_STANDARD
|
|-
|INTERACTION
|
|-
|INTERACTION_WITH_DATE
|
|-
|INFORMATION
|
|-
|LABEL
|
|}
==Api Model Type (SpecialOption)==
API Enumeration description of Type
{|class=wikitable
!Name
!Description
|-
|BUY_LAND
|
|-
|SELL_LAND
|
|-
|DEMOLISH
|
|-
|REVERT
|
|-
|DEMOLISH_UNDERGROUND
|
|-
|RAISE_LAND
|
|-
|SHOW_BUDGETPANEL
|
|-
|SHOW_MONEY_TRANSFER_PANEL
|
|-
|LOWER_LAND
|
|}
==Api Model Type (Stakeholder)==
API Enumeration description of Type
{|class=wikitable
!Name
!Description
|-
|CIVILIAN
|
|-
|COMPANY
|
|-
|EDUCATION
|
|-
|EXPERT
|
|-
|FARMER
|
|-
|HEALTHCARE
|
|-
|HOUSING_CORPORATION
|
|-
|MUNICIPALITY
|
|-
|MEDIA
|
|-
|PROJECT_DEVELOPER
|
|-
|UTILITY_CORPORATION
|
|-
|WATER_AUTHORITY
|
|-
|OTHER_AUTHORITY
|
|-
|OTHER
|
|}
==Api Model Type (Trigger)==
API Enumeration description of Type
{|class=wikitable
!Name
!Description
|-
|TQL
|
|-
|EVENT
|
|}
==Api Model UniqueNamedItem==
API Model description of UniqueNamedItem
{|class=wikitable
!Name
!Type
!Description
|-
|id
|int
|
|-
|name
|String
|
|-
|version
|int
|
|}
==Api Model UnitData==
API Model description of UnitData
{|class=wikitable
!Name
!Type
!Description
|-
|active
|boolean
|
|-
|colors
|TColor<nowiki>[]</nowiki>
|
|-
|fileName
|String
|
|-
|id
|int
|
|-
|isAlpha
|boolean
|
|-
|name
|String
|
|-
|particleEmitters
|ParticleEmitterCoordinatePair<nowiki>[]</nowiki>
|
|-
|proximityWarningM
|double
|
|-
|regions
|Region<nowiki>[]</nowiki>
|
|-
|type
|TrafficType
|
|-
|version
|int
|
|}
==Api Model UnitDataOverride==
API Model description of UnitDataOverride
{|class=wikitable
!Name
!Type
!Description
|-
|active
|Boolean
|
|-
|colors
|TColor<nowiki>[]</nowiki>
|
|-
|id
|int
|
|-
|name
|String
|
|-
|version
|int
|
|}
==Api Model UpgradeFeature==
API Model description of UpgradeFeature
{|class=wikitable
!Name
!Type
!Description
|-
|id
|int
|
|-
|version
|int
|
|}
==Api Model UpgradeSpatial==
API Model description of UpgradeSpatial
{|class=wikitable
!Name
!Type
!Description
|-
|id
|int
|
|-
|multiPolygon
|MultiPolygon
|
|-
|upgradeID
|int
|[[Upgrade Type]] ID
|}
==Api Model ValueType==
API Enumeration description of ValueType
{|class=wikitable
!Name
!Description
|-
|DEFAULT
|
|-
|R
|
|-
|G
|
|-
|B
|
|-
|A
|
|}
==Api Model WCSOverlay==
API Model description of WCSOverlay
{|class=wikitable
!Name
!Type
!Description
|-
|active
|boolean
|
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|calcTimeMS
|long
|
|-
|colorMultiplier
|double
|
|-
|colorOffset
|int
|
|-
|crs
|String
|
|-
|customLegend
|boolean
|
|-
|diffLegend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|forceXY
|boolean
|
|-
|id
|int
|
|-
|imageName
|String
|
|-
|imageVersion
|int
|
|-
|inActiveCellSize
|double
|
|-
|inActiveTimeframes
|int
|
|-
|keys
|Map&lt;String,String&gt;
|
|-
|layerName
|String
|
|-
|layerNames
|String<nowiki>[]</nowiki>
|
|-
|legend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|maxValue
|float[]
|
|-
|minValue
|float[]
|
|-
|name
|String
|
|-
|parentID
|int
|[[Overlay]] ID
|-
|prequels
|Map&lt;String,PrequelLink&gt;
|
|-
|resultType
|String
|
|-
|showDifference
|boolean
|
|-
|sortIndex
|int
|
|-
|sourceID
|int
|[[Source]] ID
|-
|type
|OverlayType
|
|-
|version
|int
|
|-
|visible
|boolean
|
|-
|warnings
|String
|
|}
==Api Model WCSResult==
API Enumeration description of WCSResult
{|class=wikitable
!Name
!Description
|-
|NEAREST
|
|-
|INTERPOLATED
|
|}
==Api Model WMSOverlay==
API Model description of WMSOverlay
{|class=wikitable
!Name
!Type
!Description
|-
|active
|boolean
|
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|calcTimeMS
|long
|
|-
|colorMultiplier
|double
|
|-
|colorOffset
|int
|
|-
|crs
|String
|
|-
|customLegend
|boolean
|
|-
|diffLegend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|forceXY
|boolean
|
|-
|id
|int
|
|-
|imageName
|String
|
|-
|imageVersion
|int
|
|-
|inActiveCellSize
|double
|
|-
|inActiveTimeframes
|int
|
|-
|keys
|Map&lt;String,String&gt;
|
|-
|layerName
|String
|
|-
|layerNames
|String<nowiki>[]</nowiki>
|
|-
|legend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|maxValue
|float[]
|
|-
|minValue
|float[]
|
|-
|name
|String
|
|-
|parentID
|int
|[[Overlay]] ID
|-
|prequels
|Map&lt;String,PrequelLink&gt;
|
|-
|resultType
|String
|
|-
|showDifference
|boolean
|
|-
|sortIndex
|int
|
|-
|sourceID
|int
|[[Source]] ID
|-
|type
|OverlayType
|
|-
|version
|int
|
|-
|visible
|boolean
|
|-
|warnings
|String
|
|}
==Api Model WMSResult==
API Enumeration description of WMSResult
{|class=wikitable
!Name
!Description
|-
|COLOR
|
|-
|FLOAT32
|
|-
|RED
|
|-
|GREEN
|
|-
|BLUE
|
|-
|ALPHA
|
|}
==Api Model WWOverlay==
API Model description of WWOverlay
{|class=wikitable
!Name
!Type
!Description
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|colorMultiplier
|double
|
|-
|colorOffset
|int
|
|-
|customLegend
|boolean
|
|-
|id
|int
|
|-
|imageName
|String
|
|-
|imageVersion
|int
|
|-
|legend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|name
|String
|
|-
|parentID
|int
|[[Overlay]] ID
|-
|sortIndex
|int
|
|-
|type
|OverlayType
|
|-
|version
|int
|
|-
|visible
|boolean
|
|}
==Api Model WaterKey==
API Enumeration description of WaterKey
{|class=wikitable
!Name
!Description
|-
|WATER_LEVEL
|
|-
|WATER_RELATIVE
|
|-
|INLET_Q
|
|-
|INLET_CAPACITY
|
|-
|INLET_AREA
|
|-
|LOWER_THRESHOLD
|
|-
|UPPER_THRESHOLD
|
|-
|UNDERGROUND
|
|-
|INUNDATION_LEVEL
|
|-
|AQUIFER_KD
|
|-
|AQUIFER_DATUM
|
|-
|SEWER_STORAGE
|
|-
|SEWER_PUMP_SPEED
|
|-
|WEIR_HEIGHT
|
|-
|WEIR_WIDTH
|
|-
|WEIR_COEFFICIENT
|
|-
|WEIR_N
|
|-
|WEIR_ANGLE
|
|-
|WEIR_TARGET_LEVEL
|
|-
|CULVERT_DIAMETER
|
|-
|CULVERT_N
|
|-
|CULVERT_THRESHOLD
|
|-
|CULVERT_RECTANGULAR_HEIGHT
|
|-
|PUMP_Q
|
|-
|PUMP_ANGLE
|
|-
|PUMP_AREA
|
|-
|DRAINAGE_Q
|
|-
|DRAINAGE_DATUM
|
|-
|DRAINAGE_OVERFLOW_THRESHOLD
|
|-
|DRAINAGE_ACTIVE
|
|-
|BREACH_SPEED
|
|-
|BREACH_HEIGHT
|
|-
|BREACH_WIDTH
|
|-
|BREACH_ANGLE
|
|-
|BREACH_COEFFICIENT
|
|-
|BREACH_INPUT_AREA
|
|-
|BREACH_LEVEL_AREA
|
|-
|EXTERNAL_SURFACE_LEVEL
|
|-
|EXTERNAL_WATER_LEVEL
|
|-
|EXTERNAL_AREA
|
|-
|SEWER_OVERFLOW
|
|-
|SEWER_OVERFLOW_SPEED
|
|-
|OBJECT_FLOW_OUTPUT
|
|-
|OBJECT_DATUM_OUTPUT_A
|
|-
|OBJECT_DATUM_OUTPUT_B
|
|-
|OBJECT_WIDTH_OUTPUT
|
|-
|OBJECT_HEIGHT_OUTPUT
|
|-
|OBJECT_WATER_AREA_OUTPUT
|
|-
|WEIR_DAM_OUTPUT
|
|-
|TRACER_A
|
|-
|TRACER_B
|
|-
|TRACER_C
|
|-
|TRACER_D
|
|-
|LIMIT_AREA
|
|-
|RAIN_M
|
|}
==Api Model WaterModelAttribute==
API Enumeration description of WaterModelAttribute
{|class=wikitable
!Name
!Description
|-
|ALLOWED_WATER_INCREASE_M
|
|-
|GROUND_WATERTABLE_WITH_SURFACE
|
|-
|DESIGN_FLOOD_ELEVATION_M
|
|-
|GROUND_BOTTOM_DISTANCE_M
|
|-
|GROUND_BOTTOM_PRESSURE_M
|
|-
|GROUND_WATER
|
|-
|GROUND_WATER_DEPTH_M
|
|-
|HYDRAULIC_CONDUCTIVITY_WITH_THICKNESS
|
|-
|SOIL_WATER_RETENTION_CURVE
|
|-
|UNSATURATED_FRACTION
|
|-
|IMPACT_FLOOD_THRESHOLD_M
|
|-
|IMPACT_RANGE_M
|
|-
|CULVERT_DEM_THRESHOLD_M
|
|-
|QCELL
|
|-
|INCREASED_RESOLUTION
|
|-
|SHORELINE
|
|-
|OBJECT_ENTRY_CORRECTION
|
|-
|SEWER_OVERFLOW_THRESHOLD
|
|-
|DURATION_MIN_LEVEL_M
|
|-
|RISE_RATE_DISTANCE_M
|
|-
|SURFACE_WATER_EVAPORATION_FACTOR
|
|-
|TIMEFRAMES
|
|-
|TIMEFRAME_TIMES
|
|-
|LIMIT_AREA
|
|-
|LIMIT_RAIN
|
|-
|MAX_WATER_BOTTOM_M
|
|-
|START_DATE_MS
|
|-
|AVG_SHORE_WIDTH_M
|
|-
|AVG_TERRAIN_WIDTH_M
|
|-
|AVG_TERRAIN_STORAGE_M
|
|-
|SURFACE_WATER
|
|-
|PREQUEL_SURFACE_LEVEL_RELATIVE
|
|-
|MICRORELIEF_STORAGE_FRACTION
|
|-
|MIN_MAX_ELEVATION
|
|-
|BRIDGE_ELEVATION
|
|-
|MAX_INFILTRATION_M
|
|-
|MIN_DRAIN_SURFACE_DISTANCE_M
|
|-
|INFILTRATION_FACTOR_S
|
|-
|WEIR_DAM_MULTIPLIER
|
|-
|WEIR_DAM_SURPLUS_HEIGHT_M
|
|-
|BREACH_MEASUREMENT_DISTANCE_M
|
|-
|STABILIZER_ANGLE
|
|-
|WEIR_MOVE_INTERVAL_S
|
|-
|WEIR_MOVE_STEP_M
|
|-
|WEIR_MOVE_RANGE_M
|
|-
|PARTIAL_START_SEC
|
|-
|PARTIAL_END_SEC
|
|-
|TRIM_MANNING
|
|-
|TRIM_EVAPOTRANSPIRATION
|
|-
|TRIM_ROOT_DEPTH
|
|-
|TRIM_GROUND_INFILTRATION
|
|-
|TRIM_GROUND_CONDUCTIVITY
|
|-
|TRIM_SHORELINE_CONDUCTIVITY
|
|-
|TRIM_GROUND_STORAGE_FRACTION
|
|}
==Api Model WaterOverlay==
API Model description of WaterOverlay
{|class=wikitable
!Name
!Type
!Description
|-
|active
|boolean
|
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|calcInfo
|String
|
|-
|calcTimeMS
|long
|
|-
|colorMultiplier
|double
|
|-
|colorOffset
|int
|
|-
|customLegend
|boolean
|
|-
|diffLegend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|id
|int
|
|-
|imageName
|String
|
|-
|imageVersion
|int
|
|-
|inActiveCellSize
|double
|
|-
|inActiveTimeframes
|int
|
|-
|keys
|Map&lt;String,String&gt;
|
|-
|legend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|maxValue
|float[]
|
|-
|minValue
|float[]
|
|-
|mode
|Mode
|
|-
|name
|String
|
|-
|parentID
|int
|[[Overlay]] ID
|-
|prequels
|Map&lt;String,PrequelLink&gt;
|
|-
|resultType
|String
|
|-
|showAreas
|boolean
|
|-
|showDifference
|boolean
|
|-
|showSystem
|boolean
|
|-
|sortIndex
|int
|
|-
|type
|OverlayType
|
|-
|version
|int
|
|-
|visible
|boolean
|
|-
|warnings
|String
|
|-
|weatherID
|int
|[[Weather]] ID
|}
==Api Model WaterPrequel==
API Enumeration description of WaterPrequel
{|class=wikitable
!Name
!Description
|-
|TERRAIN_ELEVATION
|
|-
|SURFACE_LEVEL
|
|-
|SURFACE_U
|
|-
|SURFACE_V
|
|-
|SURFACE_INFILTRATION
|
|-
|GROUND_WATER_DEPTH
|
|-
|GROUND_WATER_DATUM
|
|-
|GROUND_CONDUCTIVITY
|
|-
|GROUND_INFILTRATION
|
|-
|GROUND_STORAGE_FRACTION
|
|-
|UNSATURATED_FRACTION
|
|-
|BOTTOM_DISTANCE
|
|-
|BOTTOM_RESISTANCE
|
|-
|BOTTOM_PRESSURE
|
|-
|MAX_INFILTRATION
|
|-
|MANNING
|
|-
|MICRORELIEF
|
|-
|SEWER_LEVEL
|
|}
==Api Model WaterResult==
API Enumeration description of WaterResult
{|class=wikitable
!Name
!Description
|-
|WATER_STRESS
|
|-
|SURFACE_LAST_DIRECTION
|
|-
|SURFACE_AVG_DIRECTION
|
|-
|SURFACE_DURATION
|
|-
|SURFACE_ELEVATION
|
|-
|SURFACE_FLOW
|
|-
|SURFACE_LAST_FLOW
|
|-
|SURFACE_LAST_SPEED
|
|-
|SURFACE_LAST_VALUE
|
|-
|SURFACE_LAST_DATUM
|
|-
|SURFACE_MAX_SPEED
|
|-
|SURFACE_MAX_VALUE
|
|-
|SURFACE_EVAPORATION
|
|-
|SURFACE_LAST_EVAPORATION
|
|-
|BUILDING_LAST_STORAGE
|
|-
|FLOOD_ARRIVAL_TIME
|
|-
|FLOOD_RISE_RATE
|
|-
|LAST_RAIN
|
|-
|RAIN
|
|-
|GROUND_LAST_STORAGE
|
|-
|GROUND_LAST_VALUE
|
|-
|GROUND_LAST_DIRECTION
|
|-
|GROUND_FLOW
|
|-
|GROUND_MAX_STORAGE
|
|-
|GROUND_MAX_VALUE
|
|-
|GROUND_WATERTABLE
|
|-
|GROUND_BOTTOM_FLOW
|
|-
|GROUND_LAST_UNSATURATED_STORAGE
|
|-
|GROUND_LAST_UNSATURATED_FRACTION
|
|-
|GROUND_TRANSPIRATION
|
|-
|GROUND_LAST_TRANSPIRATION
|
|-
|SEWER_LAST_VALUE
|
|-
|SEWER_MAX_VALUE
|
|-
|LAST_EVAPORATED
|
|-
|LAST_EVAPOTRANSPIRATION
|
|-
|EVAPORATED
|
|-
|EVAPOTRANSPIRATION
|
|-
|IMPACTED_BUILDINGS
|
|-
|TRACER_A
|
|-
|TRACER_B
|
|-
|TRACER_C
|
|-
|TRACER_D
|
|-
|BASE_TYPES
|
|-
|SURFACE_DIFFERENCE
|
|-
|DEBUG_UV
|
|-
|GPU_OVERVIEW
|
|-
|DEBUG_AVG_AREAS
|
|-
|DEBUG_UV_DIRECTION
|
|-
|DEBUG_WATERWAYS
|
|-
|SURFACE_LAST_U
|
|-
|SURFACE_LAST_V
|
|}
==Api Model WaterSystem==
API Enumeration description of WaterSystem
{|class=wikitable
!Name
!Description
|-
|OBJECTS
|
|-
|AREAS
|
|}
==Api Model WaterType==
API Enumeration description of WaterType
{|class=wikitable
!Name
!Description
|-
|NONE
|
|-
|WATERWAY
|
|-
|WATERBODY
|
|-
|SEA
|
|}
==Api Model WatershedKey==
API Enumeration description of WatershedKey
{|class=wikitable
!Name
!Description
|-
|DISCHARGE_AREA
|
|}
==Api Model WatershedModelAttribute==
API Enumeration description of WatershedModelAttribute
{|class=wikitable
!Name
!Description
|-
|FILL_DISTANCE
|
|-
|DISCHARGE_REMAINING_WATER
|
|-
|CULVERT_FLOW_DIRECTION
|
|-
|MIN_AREA
|
|-
|LIMIT_ROAD
|
|}
==Api Model WatershedOverlay==
API Model description of WatershedOverlay
{|class=wikitable
!Name
!Type
!Description
|-
|active
|boolean
|
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|calcTimeMS
|long
|
|-
|colorMultiplier
|double
|
|-
|colorOffset
|int
|
|-
|customLegend
|boolean
|
|-
|diffLegend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|id
|int
|
|-
|imageName
|String
|
|-
|imageVersion
|int
|
|-
|inActiveCellSize
|double
|
|-
|inActiveTimeframes
|int
|
|-
|keys
|Map&lt;String,String&gt;
|
|-
|legend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|maxValue
|float[]
|
|-
|method
|DischargeMethod
|
|-
|minValue
|float[]
|
|-
|name
|String
|
|-
|parentID
|int
|[[Overlay]] ID
|-
|prequels
|Map&lt;String,PrequelLink&gt;
|
|-
|resultType
|String
|
|-
|showDifference
|boolean
|
|-
|sortIndex
|int
|
|-
|type
|OverlayType
|
|-
|version
|int
|
|-
|visible
|boolean
|
|-
|warnings
|String
|
|}
==Api Model WatershedPrequel==
API Enumeration description of WatershedPrequel
{|class=wikitable
!Name
!Description
|-
|DIRECTION
|
|}
==Api Model WatershedResult==
API Enumeration description of WatershedResult
{|class=wikitable
!Name
!Description
|-
|WATERSHEDS
|
|-
|DISCHARGE_AREAS
|
|-
|DIRECTION
|
|-
|BASE_TYPES
|
|}
==Api Model WebPanel==
API Model description of WebPanel
{|class=wikitable
!Name
!Type
!Description
|-
|answers
|Answer<nowiki>[]</nowiki>
|
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|height
|double
|
|-
|id
|int
|
|-
|layoutX
|double
|
|-
|layoutY
|double
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|name
|String
|
|-
|overlayID
|int
|[[Overlay]] ID
|-
|overrideDefaultAnswerID
|int
|
|-
|point
|Point
|
|-
|stakeholderID
|int
|[[Stakeholder]] ID
|-
|type
|PanelType
|
|-
|url
|String
|
|-
|version
|int
|
|-
|width
|double
|
|}
==Api Model ZipCode==
API Model description of ZipCode
{|class=wikitable
!Name
!Type
!Description
|-
|color
|TColor
|
|-
|id
|int
|
|-
|name
|String
|
|-
|polygons
|MultiPolygon
|
|-
|sourceIDs
|int<nowiki>[]</nowiki>
|[[Source]] ID
|-
|version
|int
|
|}
==Api Model Zone==
API Model description of Zone
{|class=wikitable
!Name
!Type
!Description
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|center
|Point
|
|-
|excelID
|int
|[[Excel Sheet]] ID
|-
|excelUpdated
|boolean
|
|-
|id
|int
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|name
|String
|
|-
|outline
|Outline
|
|-
|parentZoneID
|int
|[[Zone]] ID
|-
|permitterID
|int
|[[Stakeholder]] ID
|-
|polygons
|MultiPolygon
|
|-
|sourceIDs
|int<nowiki>[]</nowiki>
|[[Source]] ID
|-
|version
|int
|
|}
==Api Model ZoneAttribute==
API Enumeration description of ZoneAttribute
{|class=wikitable
!Name
!Description
|-
|MAX_BUILDING_HEIGHT
|
|-
|MAX_ROOF_GUTTER_HEIGHT
|
|-
|MAX_FLOORS
|
|-
|MIN_FLOORS
|
|-
|AMOUNT_FLOORS
|
|-
|MAX_BUILDING_PCT
|
|-
|MONUMENTAL
|
|}
==Api Model ZoneDistanceAttribute==
API Enumeration description of ZoneDistanceAttribute
{|class=wikitable
!Name
!Description
|-
|ATTRIBUTE_TIMEFRAMES
|
|-
|HIT_COUNT
|
|
|}
|}

Revision as of 12:43, 20 April 2026

Api session items Action Menus Endpoints.

Edit items with event: editoractionmenu.

Default Query: 

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

Example Response: 

[ {
  "attributeActionIDs" : [ ],
  "buildable" : {
    "0" : [ 0 ]
  },
  "color" : null,
  "eventBundleIDs" : [ ],
  "functionIDs" : [ 436, 438 ],
  "id" : 0,
  "imageName" : "category_road.png",
  "imageVersion" : 0,
  "leveeIDs" : [ ],
  "measureIDs" : [ ],
  "name" : "Roads",
  "sortIndex" : 1,
  "specialOptions" : [ ],
  "upgradeIDs" : [ ],
  "version" : 16
}, {
  "attributeActionIDs" : [ ],
  "buildable" : {
    "0" : [ 0 ]
  },
  "color" : null,
  "eventBundleIDs" : [ ],
  "functionIDs" : [ 77 ],
  "id" : 1,
  "imageName" : "category_heart.png",
  "imageVersion" : 0,
  "leveeIDs" : [ ],
  "measureIDs" : [ ],
  "name" : "Leisure",
  "sortIndex" : 2,
  "specialOptions" : [ ],
  "upgradeIDs" : [ ],
  "version" : 17
} ]

Limit Queries

version=100: 

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

Show Queries

max version: 

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

size: 

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

Action Menus (GeoJSON): 

https://engine.tygron.com/web/actionmenus.geojson?token=API_TOKEN

Formats

HTML: 

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

JSON: 

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

CSV: 

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

SSV: 

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

SMILE: 

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

ZIPJSON: 

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

ZIPSMILE: 

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

Api Model ActionMenu

API Model description of ActionMenu

Name Type Description
attributeActionIDs int[] Attribute Action ID
buildable Map<int,java.util.List<java.lang.Integer>>
color TColor
eventBundleIDs int[] Event Bundle ID
functionIDs int[] Function ID
id int
imageName String
imageVersion int
leveeIDs int[] Levee ID
measureIDs int[] Measure ID
name String
sortIndex int
specialOptions Type[]
upgradeIDs int[] Upgrade Type ID
version int

See also

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