# ArcGIS Urban API — GraphQL SDL # Source: https://urban-api.arcgis.com/graphql (anonymous introspection, HTTP 200) # Docs: https://developers.arcgis.com/arcgis-urban-api/ schema { query: Query mutation: Mutation } """ **Organization**: All members of the organization have access. **Private**: Owner of the item has access. **Public**: People outside the organization have access. **Shared**: People of specific groups have access. **Unknown**: Access level is unknown. """ enum AccessLevel { Organization Private Public Shared Unknown } """JSON object with space use type reference and target distribution.""" type AllowedSpaceUseType { """ID of the space use type that is allowed in the zoning type.""" spaceUseTypeID: GlobalID! """Target distribution of the space use type.""" targetDistribution: Float } input AllowedSpaceUseTypeInput { """ID of the space use type that is allowed in the zoning type.""" spaceUseTypeID: GlobalID! """ Target distribution of the space use type. Minimum value: 0.001 Maximum value: 1 """ targetDistribution: Float } type Analysis { attributes: AnalysisAttributes! } type AnalysisAttributes { """Unique identifier (UUID) of the feature.""" GlobalID: GlobalID! """Custom ID of the feature. Used to join fields in the data manager.""" CustomID: String """Name of the Analysis.""" AnalysisName: String! """Description""" Description: String """Parameters that need to be configured to perform the analysis, related to the calculation as well as map interactions.""" Parameters: AnalysisParameter! """ID of the urban event (plan or project) the analysis belongs to.""" UrbanEventID: GlobalID """The order in which the model is displayed in the UI.""" DisplayOrder: Int! """URL of the thumbnail image for the analysis, or null if there isn't one.'""" Thumbnail: String } input AnalysisFilterInput { globalIDs: [GlobalID!] } type AnalysisMeta implements FeaturesMeta { """The number of analysis.""" count: Int """Last recorded edit made to analysis""" lastEdit: LastEditMeta } union AnalysisParameter = ElevationProfile | LineOfSight | Shadowcast | Viewshed | Suitability | Sunlight """A branch is a design scenario in a plan or project.""" type Branch { attributes: BranchAttributes! } """Attributes of the branch.""" type BranchAttributes { """Unique identifier (UUID) of the feature.""" GlobalID: GlobalID! """Name of the branch.""" BranchName: String! """The order of the branch.""" BranchOrder: Int! """Portal item id of a web scene whose layers are shown as context layers when editing scenarios (only visible in the scenario).""" ContextWebsceneItemId: PortalItemId """Portal item id of an Elevation Layer.""" CustomElevationLayerItemId: PortalItemId """Custom ID of the feature. Used to join fields in the data manager.""" CustomID: String """Description for the branch shown in the scenario switcher.""" Description: String """If `true`, the branch represents existing conditions.""" Existing: Boolean! """If `true`, the branch is partially locked. Can be used by clients to prevent accidental editing of branches.""" Locked: Boolean! """A polygon masking out existing buildings and existing trees.""" MaskingGeometry: Polygon """Array of Media Layer portal item ids with layer order.""" MediaLayers: [MediaLayer!] """ID of the urban event (plan or project) the branch (scenario) belongs to.""" UrbanEventID: GlobalID! """Portal item id of a web scene whose layers are added as visualization of the design in the scenario. The portal item can also be a single layer (e.g., SceneLayer).""" WebsceneItemId: PortalItemId """The last recorded edit.""" LastEdit: LastEdit } """Filters which can be applied to branch queries.""" input BranchFilterInput { globalIDs: [GlobalID!] overviewVisualization: Boolean branchNames: [String!] branchOrders: [Int!] branchOrderIsLessThan: Int branchOrderIsGreaterThan: Int contextWebsceneItemIds: [PortalItemId!] customElevationLayerItemIds: [PortalItemId!] customIds: [String!] descriptions: [String!] existing: Boolean locked: Boolean urbanEventIds: [GlobalID!] websceneItemIds: [PortalItemId!] } enum BranchSortBy { BranchName BranchOrder } input BranchSortInput { direction: SortDirection = ASC sortBy: BranchSortBy! } type BranchesMeta implements FeaturesMeta { """The number of branches.""" count: Int """Last recorded edit made to branches""" lastEdit: LastEditMeta } """ **Front**: Building is aligned to front edge(s) of the parcel. **Side**: Building is aligned to side edge(s) of the parcel. **Rear**: Building is aligned to rear edge(s) of the parcel. """ enum BuildingAlignment { Front Side Rear } """Configuration of the building part such as space use and floor ranges.""" type BuildingPart { """If `true`, the spaces in the building part should be excluded from GFA / FAR calculations.""" gfaIgnore: Boolean! """The floor range of the building part.""" numFloors: NumFloors! """ID of the space use type that is assigned to the building part.""" spaceUseTypeID: GlobalID! } input BuildingPartInput { """If `true`, the spaces in the building part should be excluded from GFA / FAR calculations.""" gfaIgnore: Boolean! = false """The floor range of the building part.""" numFloors: NumFloorsInput! """ID of the space use type that is assigned to the building part.""" spaceUseTypeID: GlobalID! } """A building type is a template used to build out future buildings respecting the zoning code in plans.""" type BuildingType { attributes: BuildingTypeAttributes! } """Attributes of the building type.""" type BuildingTypeAttributes { """Unique identifier (UUID) of the feature.""" GlobalID: GlobalID! """List of parcel edges that the building is aligned to.""" Alignment: [BuildingAlignment!] """Building parts above ground.""" BuildingParts: [BuildingPart!] """Building parts below ground.""" BuildingSubParts: [BuildingPart!] """Name of the building type.""" BuildingTypeName: String! """Custom ID of the feature. Used to join fields in the data manager.""" CustomID: String """Minimal floor area for the generated floors in [m2].""" FloorAreaMin: Float """Maximum length of the generated footprint in [m].""" FootprintLengthMax: Float """Shape of the generated floors.""" FootprintShape: FootprintShape! """Maximum width of the generated footprint in [m].""" FootprintWidthMax: Float """Number of dwelling units per area for parcels with multiple buildings in [units/m2].""" MultipleBuildingsDensity: Float """Distance between dwelling units for parcels with multiple buildings in [m].""" MultipleBuildingsDistance: Float """If `true`, multiple buildings per parcel area enabled.""" MultipleBuildingsEnabled: Boolean! """If `true`, the building type is proposed in the plan.""" Proposal: Boolean! """Minimum length of the generated building segments in [m].""" SegmentLengthMin: Float """Minimum width of the generated building segments in [m].""" SegmentWidthMin: Float """Index of the part where tower massing starts.""" TowerIndex: Int """ID of the urban event (plan) the building type belongs to.""" UrbanEventID: GlobalID """The last recorded edit.""" LastEdit: LastEdit } """Filters which can be applied to building type queries.""" input BuildingTypeFilterInput { globalIDs: [GlobalID!] buildingTypeNames: [String!] customIds: [String!] floorAreaMins: [Float!] floorAreaMinIsLessThan: Float floorAreaMinIsGreaterThan: Float footprintLengthMaxes: [Float!] footprintLengthMaxIsLessThan: Float footprintLengthMaxIsGreaterThan: Float footprintShapes: [FootprintShape!] footprintWidthMaxes: [Float!] footprintWidthMaxIsLessThan: Float footprintWidthMaxIsGreaterThan: Float multipleBuildingsDensities: [Float!] multipleBuildingsDensityIsLessThan: Float multipleBuildingsDensityIsGreaterThan: Float multipleBuildingsDistances: [Float!] multipleBuildingsDistanceIsLessThan: Float multipleBuildingsDistanceIsGreaterThan: Float multipleBuildingsEnabled: Boolean proposal: Boolean segmentLengthMins: [Float!] segmentLengthMinIsLessThan: Float segmentLengthMinIsGreaterThan: Float segmentWidthMins: [Float!] segmentWidthMinIsLessThan: Float segmentWidthMinIsGreaterThan: Float towerIndices: [Int!] towerIndexIsLessThan: Int towerIndexIsGreaterThan: Int urbanEventIds: [GlobalID!] } type BuildingTypesMeta implements FeaturesMeta { """The number of buildingTypes.""" count: Int """Last recorded edit made to buildingTypes""" lastEdit: LastEditMeta } """ **NumberChart**: Metric is visualized as a number. **StackedBarChart**: Metric is visualized in a stacked bar chart. **HorizontalBarChart**: Metric is visualized in a horizontal bar chart. **VerticalBarChart**: Metric is visualized in a vertical bar chart. **DoughnutChart**: Metric is visualized in a doughnut chart. **SortedListChart**: Metric is visualized in a sorted list """ enum ChartStyle { NumberChart StackedBarChart HorizontalBarChart VerticalBarChart DoughnutChart SortedListChart } """ Examples: #FF22AA, #ff22aa, #f2a Needs to match /(^#[0-9a-f]{6}$)|(^#[0-9a-f]{3}$)/i """ scalar Color """ Examples: #FF22AAAA, #ff22aaff, #f2af Needs to match /(^#[0-9a-f]{8}$)|(^#[0-9a-f]{4}$)/i """ scalar ColorAlpha """Layer configuration for context layers.""" type ContextLayerSettings { """If `true`, the layer is visible.""" visible: Boolean! } input ContextLayerSettingsInput { """If `true`, the layer is visible.""" visible: Boolean! } """OverlayType configuration for CoverageMax.""" type CoverageMax { """Overlay method that gets applied to the parcel zoning parameters when redeveloping.""" method: OverlayTypeMethod! } input CoverageMaxInput { """Overlay method that gets applied to the parcel zoning parameters when redeveloping.""" method: OverlayTypeMethod! = Replace } input CreateAnalysisAttributesInput { GlobalID: GlobalID CustomID: String AnalysisName: String! Description: String UrbanEventID: GlobalID DisplayOrder: Int """It may be necessary in clients to set the `Apollo-Require-Preflight` HTTP header to `true` for thumbnail uploads to be accepted.""" Thumbnail: Upload } """Input attributes for creating a new branch.""" input CreateBranchAttributesInput { """Unique identifier (UUID) of the feature.""" GlobalID: GlobalID """ Name of the branch. Minimum length: 1 Maximum length: 200 """ BranchName: String! """The order of the branch.""" BranchOrder: Int! """If `true`, the branch represents existing conditions.""" Existing: Boolean! = false """ID of the urban event (plan or project) the branch (scenario) belongs to.""" UrbanEventID: GlobalID! """ Portal item id of a web scene whose layers are shown as context layers when editing scenarios (only visible in the scenario). Maximum length: 32 """ ContextWebsceneItemId: PortalItemId """ Portal item id of an Elevation Layer. Maximum length: 32 """ CustomElevationLayerItemId: PortalItemId """Custom ID of the feature. Used to join fields in the data manager.""" CustomID: String """ Description for the branch shown in the scenario switcher. Maximum length: 700 """ Description: String """If `true`, the branch is partially locked. Can be used by clients to prevent accidental editing of branches.""" Locked: Boolean = false """A polygon masking out existing buildings and existing trees.""" MaskingGeometry: PolygonInput """Array of Media Layer portal item ids with layer order.""" MediaLayers: [MediaLayerInput!] """ Portal item id of a web scene whose layers are added as visualization of the design in the scenario. The portal item can also be a single layer (e.g., SceneLayer). Maximum length: 32 """ WebsceneItemId: PortalItemId } input CreateBranchInput { attributes: CreateBranchAttributesInput! } """Input attributes for creating a new building type.""" input CreateBuildingTypeAttributesInput { """Unique identifier (UUID) of the feature.""" GlobalID: GlobalID """ Name of the building type. Minimum length: 1 Maximum length: 50 """ BuildingTypeName: String! """Shape of the generated floors.""" FootprintShape: FootprintShape! = Auto """List of parcel edges that the building is aligned to.""" Alignment: [BuildingAlignment!] """Building parts above ground.""" BuildingParts: [BuildingPartInput!] """Building parts below ground.""" BuildingSubParts: [BuildingPartInput!] """Custom ID of the feature. Used to join fields in the data manager.""" CustomID: String """ Minimal floor area for the generated floors in [m2]. Minimum value: 0 """ FloorAreaMin: Float = 25 """ Maximum length of the generated footprint in [m]. Minimum value: 0 """ FootprintLengthMax: Float """ Maximum width of the generated footprint in [m]. Minimum value: 0 """ FootprintWidthMax: Float """ Number of dwelling units per area for parcels with multiple buildings in [units/m2]. Minimum value: 0 """ MultipleBuildingsDensity: Float = 0.0001 """ Distance between dwelling units for parcels with multiple buildings in [m]. Minimum value: 0 """ MultipleBuildingsDistance: Float = 0 """If `true`, multiple buildings per parcel area enabled.""" MultipleBuildingsEnabled: Boolean = false """If `true`, the building type is proposed in the plan.""" Proposal: Boolean = false """ Minimum length of the generated building segments in [m]. Minimum value: 0 """ SegmentLengthMin: Float """ Minimum width of the generated building segments in [m]. Minimum value: 0 """ SegmentWidthMin: Float """ Index of the part where tower massing starts. Minimum value: 0 """ TowerIndex: Int = 1 """ID of the urban event (plan) the building type belongs to.""" UrbanEventID: GlobalID } input CreateBuildingTypeInput { attributes: CreateBuildingTypeAttributesInput! } """Input attributes for creating a new criterion.""" input CreateCriterionAttributesInput { """Unique identifier (UUID) of the feature.""" GlobalID: GlobalID """Name of the criterion.""" CriterionName: String! """Type of the criterion.""" CriterionType: CriterionType! = ParcelInformation """Attribute field to be used for the criterion.""" Field: String! """GlobalID of the model.""" ModelID: GlobalID! """Custom ID of the feature. Used to join fields in the data manager.""" CustomID: String """Whether the criterion is enabled in the calculation. When disabled, this criterion will not count towards the final score.""" Enabled: Boolean = false """Portal item id of an external layer.""" ExternalLayerItemId: String """Sublayer id of an external layer.""" ExternalSublayerId: Float = 0 """Whether reclassification is enabled on this criterion. When enabled, numeric values will be reclassified with ReclassificationIntervals, while string and null values will be reclassified with ReclassificationMappings. When disabled, scores will be copied directly from the input features.""" ReclassificationEnabled: Boolean = false """Reclassification intervals used in this criterion to reclassify numeric values.""" ReclassificationIntervals: [ReclassificationIntervalInput!] """Map of (value, score) pairs used in this criterion to reclassify string and null values to a score.""" ReclassificationMappings: [ReclassificationMappingInput!] """Sampling geometry used to extract the criterion.""" SamplingGeometry: SamplingGeometry = ParcelCentroid """When sampling values to calculate the final score, a parcel might match multiple input features resulting in multiple records. This field configures the method to combine multiple records on one parcel.""" SamplingMethod: SamplingMethod = Any """ID of the urban event (plan) the criteria belongs to.""" UrbanEventID: GlobalID """ Weight of the criterion. Minimum value: 0 """ Weight: Float = 1 } input CreateCriterionInput { attributes: CreateCriterionAttributesInput! } input CreateElevationProfileInput { elevationProfiles: [ElevationProfileParameterInput!]! attributes: CreateAnalysisAttributesInput! } """Input attributes for creating a new extended metric.""" input CreateExtendedMetricAttributesInput { """Unique identifier (UUID) of the feature.""" GlobalID: GlobalID """Custom ID of the feature. Used to join fields in the data manager.""" CustomID: String """The default value of a metric, e.g., of a parameter metric when no parameter is defined.""" DefaultValue: Float """ Description of the metric. Maximum length: 700 """ Description: String """The values to filter on for a filter metric.""" FilterValues: [String!] """The list of units of an extended metric in the denominator.""" FractionUnitTypes: [MetricUnitType!] """The x coordinate of the metric node on the metrics dependency graph.""" GraphX: Float """The y coordinate of the metric node on the metrics dependency graph.""" GraphY: Float """ Name of the metric. Maximum length: 100 """ MetricName: String """The resolution on which an extended metric should be calculated.""" MetricResolution: MetricResolution = None """The way in which calculated metric values are aggregated.""" MetricResultAggregation: MetricResultAggregation = None """The type of extended metric""" MetricType: MetricType = Variable """The rounding method to use when rounding this metric.""" NumberRoundingMethod: NumberRoundingMethod = None """If `true`, the metric is proposed in the plan.""" Proposal: Boolean = false """The list of units of an extended metric in the numerator.""" UnitTypes: [MetricUnitType!] """ID of the urban event (plan or project) the metric belongs to.""" UrbanEventID: GlobalID """The variable value of a metric.""" Value: Float } input CreateExtendedMetricInput { attributes: CreateExtendedMetricAttributesInput! inputs: [ExtendedMetricGraphEdgeInput!] } input CreateExtendedMetricSourceAttributes { GlobalID: GlobalID! ExtendedSourceMetricID: GlobalID! ExtendedTargetMetricID: GlobalID! ExtendedMetricOrder: Int! UrbanEventID: GlobalID } input CreateExtendedMetricSourceInput { attributes: CreateExtendedMetricSourceAttributes! } """Input attributes for creating a new feedback category.""" input CreateFeedbackCategoryAttributesInput { """Unique identifier (UUID) of the feature.""" GlobalID: GlobalID """Reference to the icon of the category that contains an image path and a color.""" Icon: FeedbackCategoryIcon! """ Label of the category. Minimum length: 1 Maximum length: 20 """ Label: String! """Order of the category.""" CategoryOrder: Int """Custom ID of the feature. Used to join fields in the data manager.""" CustomID: String """Description of the category.""" Description: String } input CreateFeedbackCategoryInput { attributes: CreateFeedbackCategoryAttributesInput! } """Input attributes for creating a new indicator.""" input CreateIndicatorAttributesInput { """Unique identifier (UUID) of the feature.""" GlobalID: GlobalID """End date of the lifespan of the indicator.""" EndDate: Timestamp! """ Name of the indicator. Minimum length: 1 """ IndicatorName: String! """Type of the indicator.""" IndicatorType: IndicatorType! = Custom """Start date of the lifespan of the indicator.""" StartDate: Timestamp! """Custom ID of the feature. Used to join fields in the data manager.""" CustomID: String """ Portal item id of an ArcGIS Dashboard which will be embedded in the detail card of the indicator. Maximum length: 32 """ DashboardItemId: PortalItemId """Description of the indicator (markdown enabled).""" Description: String """If `true`, the indicator is featured and appears at the top of the list in the overview.""" Featured: Boolean = false """Configuration of which layers are shown together with indicators and how.""" LayerSettings: LayerSettingsInput """ URL to a webpage. Shown in the detail card of the indicator. Maximum length: 255 """ WebpageUrl: String """ Portal item id of a web scene whose layers are added as visualization. The portal item can also be a single layer (e.g., SceneLayer). Maximum length: 32 """ WebsceneItemId: PortalItemId } input CreateIndicatorInput { attributes: CreateIndicatorAttributesInput! } """Input attributes for creating a new lod1 building.""" input CreateLOD1BuildingAttributesInput { """Unique identifier (UUID) of the feature.""" GlobalID: GlobalID """ID of the branch the building belongs to.""" BranchID: GlobalID """Custom ID of the feature. Used to join fields in the data manager.""" CustomID: String """The extrusion height of the building in [m].""" Height: Float } input CreateLOD1BuildingInput { attributes: CreateLOD1BuildingAttributesInput! """3d geometry (xyz coordinates)""" geometry: PolygonInput! } input CreateLineOfSightInput { lineOfSights: [LineOfSightParameterInput!]! attributes: CreateAnalysisAttributesInput! } """Input attributes for creating a new metric.""" input CreateMetricAttributesInput { """Unique identifier (UUID) of the feature.""" GlobalID: GlobalID """Custom ID of the feature. Used to join fields in the data manager.""" CustomID: String """ Description of the metric. Maximum length: 700 """ Description: String """The x coordinate of the metric node on the metrics dependency graph.""" GraphX: Float """The y coordinate of the metric node on the metrics dependency graph.""" GraphY: Float """ Name of the metric. Maximum length: 100 """ MetricName: String """The rounding method to use when rounding this metric.""" NumberRoundingMethod: NumberRoundingMethod = None """Operation of the metric on how to aggregate the source metrics.""" Operation: Operation = WeightedSum """If `true`, the metric is proposed in the plan.""" Proposal: Boolean = false """Unit type of the metric.""" UnitType: UnitType = Number """ID of the urban event (plan or project) the metric belongs to.""" UrbanEventID: GlobalID } input CreateMetricInput { attributes: CreateMetricAttributesInput! } """Input attributes for creating a new metric source.""" input CreateMetricSourceAttributesInput { """Unique identifier (UUID) of the feature.""" GlobalID: GlobalID """Custom ID of the feature. Used to join fields in the data manager.""" CustomID: String """ID of the metric that the metric source belongs to.""" MetricID: GlobalID """ID of the metric that the source points to if the source type is 'Metric'. Otherwise, this field is ignored.""" SourceMetricID: GlobalID """ Name of the metric source if the source type is anything other than 'Metric'. If source type is 'Metric', this field is ignored. Maximum length: 100 """ SourceName: String """Type of the metric source.""" SourceType: SourceType = SpaceArea """ID of the urban event (plan) the metric source belongs to.""" UrbanEventID: GlobalID """Indicates whether the weight is applied as an inverse (1/n) in the calculation or as the actual number (n).""" WeightInverted: Boolean = false """ Name of the parameter that is used as a weight. If type is 'Constant', this field is ignored. Maximum length: 100 """ WeightName: String """Type of weight that is used for the metric calculation.""" WeightType: WeightType = SpaceUseTypeParameter """Value for the parameter if the weight type is 'Constant'.""" WeightValue: Float } input CreateMetricSourceInput { attributes: CreateMetricSourceAttributesInput! } """Input attributes for creating a new metric value.""" input CreateMetricValueAttributesInput { """Unique identifier (UUID) of the feature.""" GlobalID: GlobalID """ID of the referenced metric. Plans reference metrics in the urban design database of the plan. Projects reference metrics in the urban database of the Urban Model.""" MetricID: GlobalID! """Metric value that is stored on the point.""" Value: Float! """ID of the branch the metric value belongs to.""" BranchID: GlobalID """Custom ID of the feature. Used to join fields in the data manager.""" CustomID: String """The version of metrics this object belongs to.""" MetricVersion: MetricVersion = Basic } input CreateMetricValueInput { attributes: CreateMetricValueAttributesInput! """3d geometry (xyz coordinates)""" geometry: PointInput! } """Input attributes for creating a new overlay.""" input CreateOverlayAttributesInput { """Unique identifier (UUID) of the feature.""" GlobalID: GlobalID """ID of the overlay type the overlay belongs to.""" OverlayTypeID: GlobalID! """ID of the branch the overlay belongs to.""" BranchID: GlobalID """ Maximum allowed coverage in percentage. Minimum value: 0 Maximum value: 1 """ CoverageMax: Float """Custom ID of the feature. Used to join fields in the data manager.""" CustomID: String """Description of the overlay.""" Description: String """ Maximum allowed dwelling units per area in [units/m2]. Minimum value: 0 Maximum value: 200000 """ DwellingUnitsPerAreaMax: Float """Parameter values for different metrics.""" ExtendedMetricParameters: [ExtendedMetricParameterInput!] """ Maximum allowed floor area ratio. Minimum value: 0 Maximum value: 500 """ FARMax: Float """ Maximum allowed height in [m]. Minimum value: 0 Maximum value: 1000 """ HeightMax: Float """Label of the overlay.""" Label: String """ Maximum allowed number of floors. Minimum value: 0 Maximum value: 200 """ NumFloorsMax: Int """Array containing skyplanes.""" Skyplanes: [SkyplaneInput!] """ Maximum allowed substructure depth in [m]. Minimum value: 0 Maximum value: 1000 """ SubstructureDepthMax: Float """An array of tiers and their allowed setbacks in [m].""" Tiers: [TierInput!] } input CreateOverlayInput { attributes: CreateOverlayAttributesInput! """2d geometry (xy coordinates)""" geometry: PolygonInput! } """Input attributes for creating a new overlay type.""" input CreateOverlayTypeAttributesInput { """Unique identifier (UUID) of the feature.""" GlobalID: GlobalID """JSON object containing the configuration of the overlay types.""" FieldsConfig: FieldsConfigInput! """Name of the overlay type.""" OverlayTypeName: String! """The order of the overlay type. Defines the order in which the overlay types are displayed in the legend (and applied if relevant).""" OverlayTypeOrder: Int! = 0 """Hex color of the zone type or overlay.""" Color: Color = "#000000" """Custom ID of the feature. Used to join fields in the data manager.""" CustomID: String """Fill style of the zone type or overlay.""" FillStyle: FillStyle = BackwardDiagonal """Label shown on the overlay geometry.""" Label: OverlayTypeLabel """Outline style of the zone type or overlay.""" OutlineStyle: OutlineStyle = Solid """If `true`, the overlay type is proposed in the plan.""" Proposal: Boolean = false """ID of the urban event (plan) the overlay type belongs to.""" UrbanEventID: GlobalID } input CreateOverlayTypeInput { attributes: CreateOverlayTypeAttributesInput! } """Input attributes for creating a new parcel.""" input CreateParcelAttributesInput { """Unique identifier (UUID) of the feature.""" GlobalID: GlobalID """ID of the branch the parcel belongs to.""" BranchID: GlobalID """ID of the building type the parcel is assigned to for the generation of future buildings.""" BuildingTypeID: GlobalID """ Maximum allowed coverage in percentage. Minimum value: 0 Maximum value: 1 """ CoverageMax: Float """Custom ID of the feature. Used to join fields in the data manager.""" CustomID: String """If `true`, the parcel is being demolished.""" Demolish: Boolean = false """The type of development on the parcel.""" DevelopmentType: DevelopmentType = None """ Maximum allowed dwelling units per area in [units/m2]. Minimum value: 0 Maximum value: 200000 """ DwellingUnitsPerAreaMax: Float """An array of parcel edges and their edge information.""" EdgeInfos: [EdgeInfoInput!] """Parameter values for different metrics.""" ExtendedMetricParameters: [ExtendedMetricParameterInput!] """ Maximum allowed floor area ratio. Minimum value: 0 Maximum value: 500 """ FARMax: Float """Area in [m2] of the parcel ground that is not overlapped by spaces. Is `null` if no `GroundSpaceUseTypeID is defined.`""" GroundArea: Float """ID of the space use type assigned to the parcel ground.""" GroundSpaceUseTypeID: GlobalID """ Maximum allowed height in [m]. Minimum value: 0 Maximum value: 1000 """ HeightMax: Float """ Maximum allowed number of floors. Minimum value: 0 Maximum value: 200 """ NumFloorsMax: Int """Array containing skyplanes.""" Skyplanes: [SkyplaneInput!] """ Maximum allowed substructure depth in [m]. Minimum value: 0 Maximum value: 1000 """ SubstructureDepthMax: Float """An array of tiers and their allowed setbacks in [m].""" Tiers: [TierInput!] } input CreateParcelInput { attributes: CreateParcelAttributesInput! """2d geometry (xy coordinates)""" geometry: PolygonInput! } """Input attributes for creating a new plan.""" input CreatePlanAttributesInput { """Unique identifier (UUID) of the feature.""" GlobalID: GlobalID """End date of the urban event.""" EndDate: Timestamp! """ Name of the urban event. Minimum length: 1 """ EventName: String! """The planning method of the plan.""" PlanningMethod: UrbanEventPlanningMethod! """ Start date of the urban event. Minimum value: 0 """ StartDate: Timestamp! """Address of the urban event.""" Address: String """ Portal item id of a web scene whose layers are shown as context layers when editing a plan or project (visible for all scenarios). Maximum length: 32 """ ContextWebsceneItemId: PortalItemId """Custom ID of the feature. Used to join fields in the data manager.""" CustomID: String """Description of the urban event (markdown enabled).""" Description: String """If `true`, the urban event is featured and appears at the top of the list in the overview.""" Featured: Boolean = false """The version of metrics displayed in the dashboard of a plan.""" MetricVersion: MetricVersion = Basic """Settings for the charts in the metrics dashboard.""" MetricsDashboardCharts: [MetricsDashboardChartInput!] """ID of the status type associated with the urban event.""" Status: GlobalID """Image (blob) to be displayed in the overview card.""" Thumbnail: String """ URL to a webpage. Shown in the detail card of the urban event. Maximum length: 255 """ WebpageUrl: String } input CreatePlanInput { attributes: CreatePlanAttributesInput! """2d geometry (xy coordinates)""" geometry: PolygonInput! } """Input attributes for creating a new point symbol.""" input CreatePointSymbolAttributesInput { """Unique identifier (UUID) of the feature.""" GlobalID: GlobalID """The depth of the symbol in [m].""" Depth: Float! """The heading of the symbol in [deg].""" Heading: Float! """The height of the symbol in [m].""" Height: Float! """URL of the symbol.""" ResourceHref: String! """Style of the symbol.""" SymbolStyle: PointSymbolStyle! """The width of the symbol in [m].""" Width: Float! """ID of the branch the symbol belongs to.""" BranchID: GlobalID """Custom ID of the feature. Used to join fields in the data manager.""" CustomID: String } input CreatePointSymbolInput { attributes: CreatePointSymbolAttributesInput! """2d geometry (xy coordinates)""" geometry: PointInput! } """Input attributes for creating a new polygon symbol.""" input CreatePolygonSymbolAttributesInput { """Unique identifier (UUID) of the feature.""" GlobalID: GlobalID """Style of the symbol.""" SymbolStyle: PolygonSymbolStyle! """ID of the branch the symbol belongs to.""" BranchID: GlobalID """Custom ID of the feature. Used to join fields in the data manager.""" CustomID: String } input CreatePolygonSymbolInput { attributes: CreatePolygonSymbolAttributesInput! """2d geometry (xy coordinates)""" geometry: PolygonInput! } """Input attributes for creating a new project.""" input CreateProjectAttributesInput { """Unique identifier (UUID) of the feature.""" GlobalID: GlobalID """End date of the urban event.""" EndDate: Timestamp! """ Name of the urban event. Minimum length: 1 """ EventName: String! """ Start date of the urban event. Minimum value: 0 """ StartDate: Timestamp! """Address of the urban event.""" Address: String """ Portal item id of a web scene whose layers are shown as context layers when editing a plan or project (visible for all scenarios). Maximum length: 32 """ ContextWebsceneItemId: PortalItemId """Custom ID of the feature. Used to join fields in the data manager.""" CustomID: String """Description of the urban event (markdown enabled).""" Description: String """If `true`, the urban event is featured and appears at the top of the list in the overview.""" Featured: Boolean = false """Settings for the charts in the metrics dashboard.""" MetricsDashboardCharts: [MetricsDashboardChartInput!] """ Portal item id of a 3D Object Scene Layer. Maximum length: 32 """ ObjectSceneLayerItemId: PortalItemId """The Global ID of the scenario to show in overview visualizations.""" OverviewVisualizationBranchId: GlobalID """ID of the status type associated with the urban event.""" Status: GlobalID """Image (blob) to be displayed in the overview card.""" Thumbnail: String """ URL to a webpage. Shown in the detail card of the urban event. Maximum length: 255 """ WebpageUrl: String } input CreateProjectInput { attributes: CreateProjectAttributesInput! """2d geometry (xy coordinates)""" geometry: PolygonInput! } input CreateShadowcastInput { shadowcasts: [ShadowcastParameterInput!]! attributes: CreateAnalysisAttributesInput! } """Input attributes for creating a new space.""" input CreateSpaceAttributesInput { """Unique identifier (UUID) of the feature.""" GlobalID: GlobalID """ID of the parcel the space belongs to.""" ParcelID: GlobalID! """ Type of space. Maximum length: 100 """ SpaceType: SpaceType! = Building """ID of the space use type that is assigned to the space. This is used for coloring the space, aggregating space use areas, and calculating capacity metrics.""" SpaceUseTypeID: GlobalID! """ID of the branch the space belongs to.""" BranchID: GlobalID """Building number the space belongs to.""" BuildingNumber: Int """Custom ID of the feature. Used to join fields in the data manager.""" CustomID: String """The development status of the space.""" DevelopmentStatus: DevelopmentStatus = New """ Floor height of the space in [m]. Minimum value: 0 """ FloorHeight: Float = 5 """Floor number the space belongs to.""" FloorNumber: Int """If `true`, the space should be excluded from GFA / FAR calculations.""" GFAIgnore: Boolean = false } input CreateSpaceInput { attributes: CreateSpaceAttributesInput! """3d geometry (xyz coordinates)""" geometry: PolygonInput! } """Input attributes for creating a new space use type.""" input CreateSpaceUseTypeAttributesInput { """Unique identifier (UUID) of the feature.""" GlobalID: GlobalID """Hex color of the space use type.""" Color: Color! """ Floor height of the space use type in [m]. Minimum value: 0 """ FloorHeight: Float! = 5 """ Label of the space use type. Minimum length: 1 Maximum length: 10 """ Label: String! """ Factor that reduces the total floor area used for capacity indicator calculations. Minimum value: 0 Maximum value: 1 """ NetAreaFactor: Float! = 1 """ Name of the space use type. Minimum length: 1 Maximum length: 100 """ SpaceUseTypeName: String! """ Gross floor area taken up by an average household in the space use type, used for assessing the size of a dwelling unit in [m2]. Minimum value: 0.01 """ AreaPerHousehold: Float """Custom ID of the feature. Used to join fields in the data manager.""" CustomID: String """Parameter values for different metrics.""" ExtendedMetricParameters: [ExtendedMetricParameterInput!] """Metric parameter values (e.g., weights) for a Metric that uses spaces as a data source.""" MetricParameters: [MetricParameterInput!] """If `true`, the space use type is proposed in the plan.""" Proposal: Boolean = false """If `true`, the space use type is residential and therefore can be used in dwelling units.""" SingleUseOnly: Boolean = false """The order of the space use type. Defines the order in which the space use types are displayed in the legend.""" SpaceUseTypeOrder: Int = 0 """ID of the urban event (plan) the space use type belongs to.""" UrbanEventID: GlobalID } input CreateSpaceUseTypeInput { attributes: CreateSpaceUseTypeAttributesInput! } """Input attributes for creating a new status type.""" input CreateStatusTypeAttributesInput { """Unique identifier (UUID) of the feature.""" GlobalID: GlobalID """Reference to the icon of the status that contains an image path and a color.""" Icon: StatusTypeIcon! """ Label of the status. Minimum length: 1 Maximum length: 20 """ Label: String! """Custom ID of the feature. Used to join fields in the data manager.""" CustomID: String """Description of the status.""" Description: String """Order of the status.""" StatusOrder: Int } input CreateStatusTypeInput { attributes: CreateStatusTypeAttributesInput! } input CreateSuitabilityInput { suitabilityParameters: [SuitabilityParameterInput!]! attributes: CreateAnalysisAttributesInput! } """Input attributes for creating a new suitability model.""" input CreateSuitabilityModelAttributesInput { """Unique identifier (UUID) of the feature.""" GlobalID: GlobalID """Name of the model.""" ModelName: String! """Custom ID of the feature. Used to join fields in the data manager.""" CustomID: String """Description""" Description: String """If `true`, the model is proposed in the plan.""" Proposal: Boolean = false """ID of the urban event (plan) the model belongs to.""" UrbanEventID: GlobalID } input CreateSuitabilityModelInput { attributes: CreateSuitabilityModelAttributesInput! } input CreateSunlightInput { sunlights: [SunlightParameterInput!]! attributes: CreateAnalysisAttributesInput! } """Input attributes for creating a new viewpoint.""" input CreateViewpointAttributesInput { """Unique identifier (UUID) of the feature.""" GlobalID: GlobalID """ Heading of the camera. Minimum value: 0 Maximum value: 360 """ Heading: Float! """ Tilt of the camera. Minimum value: 0 Maximum value: 180 """ Tilt: Float! """ Name of the viewpoint. Minimum length: 1 """ ViewpointName: String! """The order of the viewpoint.""" ViewpointOrder: Int! """Custom ID of the feature. Used to join fields in the data manager.""" CustomID: String """ID of the urban event (plan or project) the viewpoint belongs to.""" UrbanEventID: GlobalID } input CreateViewpointInput { attributes: CreateViewpointAttributesInput! """3d geometry (xyz coordinates)""" geometry: PointInput! } input CreateViewshedInput { viewsheds: [ViewshedParameterInput!]! attributes: CreateAnalysisAttributesInput! } """Input attributes for creating a new zone.""" input CreateZoneAttributesInput { """Unique identifier (UUID) of the feature.""" GlobalID: GlobalID """The planning horizon of the zone.""" PlanningHorizon: ZonePlanningHorizon! """The planning method of the zone.""" PlanningMethod: ZonePlanningMethod! """ID of the zone type the zone is assigned to.""" ZoneTypeID: GlobalID! """ID of the branch the zone belongs to.""" BranchID: GlobalID """Custom ID of the feature. Used to join fields in the data manager.""" CustomID: String } input CreateZoneInput { attributes: CreateZoneAttributesInput! """2d geometry (xy coordinates)""" geometry: PolygonInput! } """Input attributes for creating a new zone type.""" input CreateZoneTypeAttributesInput { """Unique identifier (UUID) of the feature.""" GlobalID: GlobalID """Hex color of the zone type or overlay.""" Color: Color! """Description of the zone type.""" Description: String! """ Label of the zone type. Minimum length: 1 Maximum length: 20 """ Label: String! """The planning method of the zone type.""" PlanningMethod: ZoneTypePlanningMethod! """An array of allowed space use types and their distributions.""" AllowedSpaceUseTypes: [AllowedSpaceUseTypeInput!] """ Maximum allowed coverage in percentage. Minimum value: 0 Maximum value: 1 """ CoverageMax: Float """Custom ID of the feature. Used to join fields in the data manager.""" CustomID: String """ Maximum allowed dwelling units per area in [units/m2]. Minimum value: 0 Maximum value: 200000 """ DwellingUnitsPerAreaMax: Float """Parameter values for different metrics.""" ExtendedMetricParameters: [ExtendedMetricParameterInput!] """ Maximum allowed floor area ratio. Minimum value: 0 Maximum value: 500 """ FARMax: Float """Fill style of the zone type or overlay.""" FillStyle: FillStyle = Solid """ Maximum allowed height in [m]. Minimum value: 0 Maximum value: 1000 """ HeightMax: Float """ Factor that reduces the total zone area used for capacity indicator calculations. Minimum value: 0 Maximum value: 1 """ NetAreaFactor: Float = 1 """ Maximum allowed number of floors. Minimum value: 0 Maximum value: 200 """ NumFloorsMax: Int """Outline style of the zone type or overlay.""" OutlineStyle: OutlineStyle = None """If `true`, the zone type is proposed in the plan.""" Proposal: Boolean = false """Array containing skyplanes.""" Skyplanes: [SkyplaneInput!] """ Maximum allowed substructure depth in [m]. Minimum value: 0 Maximum value: 1000 """ SubstructureDepthMax: Float """An array of tiers and their allowed setbacks in [m].""" Tiers: [TierInput!] """ID of the urban event (plan) the zone type belongs to.""" UrbanEventID: GlobalID """Name of the zone type.""" ZoneTypeName: String """The order of the zone type. Defines the order in which the zone types are displayed in the legend.""" ZoneTypeOrder: Int = 0 } input CreateZoneTypeInput { attributes: CreateZoneTypeAttributesInput! } type CriteriaMeta implements FeaturesMeta { """The number of criteria.""" count: Int """Last recorded edit made to criteria""" lastEdit: LastEditMeta } """A criterion is a collection of properties configured to calculate a suitability score.""" type Criterion { attributes: CriterionAttributes! } """Attributes of the criterion.""" type CriterionAttributes { """Unique identifier (UUID) of the feature.""" GlobalID: GlobalID! """Name of the criterion.""" CriterionName: String! """Type of the criterion.""" CriterionType: CriterionType! """Custom ID of the feature. Used to join fields in the data manager.""" CustomID: String """Whether the criterion is enabled in the calculation. When disabled, this criterion will not count towards the final score.""" Enabled: Boolean! """Portal item id of an external layer.""" ExternalLayerItemId: String """Sublayer id of an external layer.""" ExternalSublayerId: Float! """Attribute field to be used for the criterion.""" Field: String! """GlobalID of the model.""" ModelID: GlobalID! """Whether reclassification is enabled on this criterion. When enabled, numeric values will be reclassified with ReclassificationIntervals, while string and null values will be reclassified with ReclassificationMappings. When disabled, scores will be copied directly from the input features.""" ReclassificationEnabled: Boolean! """Reclassification intervals used in this criterion to reclassify numeric values.""" ReclassificationIntervals: [ReclassificationInterval!]! """Map of (value, score) pairs used in this criterion to reclassify string and null values to a score.""" ReclassificationMappings: [ReclassificationMapping!]! """Sampling geometry used to extract the criterion.""" SamplingGeometry: SamplingGeometry! """When sampling values to calculate the final score, a parcel might match multiple input features resulting in multiple records. This field configures the method to combine multiple records on one parcel.""" SamplingMethod: SamplingMethod! """ID of the urban event (plan) the criteria belongs to.""" UrbanEventID: GlobalID """Weight of the criterion.""" Weight: Float! """The last recorded edit.""" LastEdit: LastEdit } """Filters which can be applied to criterion queries.""" input CriterionFilterInput { globalIDs: [GlobalID!] criterionNames: [String!] criterionTypes: [CriterionType!] customIds: [String!] enabled: Boolean externalLayerItemIds: [String!] externalSublayerIds: [Float!] externalSublayerIdIsLessThan: Float externalSublayerIdIsGreaterThan: Float fields: [String!] modelIds: [GlobalID!] reclassificationEnabled: Boolean samplingGeometries: [SamplingGeometry!] samplingMethods: [SamplingMethod!] urbanEventIds: [GlobalID!] weights: [Float!] weightIsLessThan: Float weightIsGreaterThan: Float } """Criteria defined in the Suitability Analysis. See [Manage suitability models](https://doc.arcgis.com/en/urban/latest/help/help-suitability.htm#ESRI_SECTION1_C3AA3FC8A94A4DC59B1BF4924CC64F5C) to learn more.""" type CriterionParameter { """Type of the criterion.""" criterionType: CriterionType! """Whether the criterion is enabled in the calculation. When disabled, this criterion will not count towards the final score.""" enabled: Boolean! """Portal item id of an external layer.""" externalLayerItemId: String """Sublayer id of an external layer.""" externalSublayerId: Float! """Attribute field to be used for the criterion.""" field: String! """Name of the criterion.""" name: String! """Whether reclassification is enabled on this criterion. When enabled, numeric values will be reclassified with ReclassificationIntervals, while string and null values will be reclassified with ReclassificationMappings. When disabled, scores will be copied directly from the input features.""" reclassificationEnabled: Boolean! """Reclassification intervals used in this criterion to reclassify numeric values.""" reclassificationIntervals: [ReclassificationInterval!]! """Map of (value, score) pairs used in this criterion to reclassify string and null values to a score.""" reclassificationMappings: [ReclassificationMapping!]! """Sampling geometry used to extract the criterion.""" samplingGeometry: SamplingGeometry! """When sampling values to calculate the final score, a parcel might match multiple input features resulting in multiple records. This field configures the method to combine multiple records on one parcel.""" samplingMethod: SamplingMethod! """Weight of the criterion.""" weight: Float! } input CriterionParameterInput { """Type of the criterion.""" criterionType: CriterionType! = ParcelInformation """Whether the criterion is enabled in the calculation. When disabled, this criterion will not count towards the final score.""" enabled: Boolean! = false """Sublayer id of an external layer.""" externalSublayerId: Float! = 0 """Attribute field to be used for the criterion.""" field: String! """Name of the criterion.""" name: String! """Whether reclassification is enabled on this criterion. When enabled, numeric values will be reclassified with ReclassificationIntervals, while string and null values will be reclassified with ReclassificationMappings. When disabled, scores will be copied directly from the input features.""" reclassificationEnabled: Boolean! = false """Reclassification intervals used in this criterion to reclassify numeric values.""" reclassificationIntervals: [ReclassificationIntervalInput!]! """Map of (value, score) pairs used in this criterion to reclassify string and null values to a score.""" reclassificationMappings: [ReclassificationMappingInput!]! """Sampling geometry used to extract the criterion.""" samplingGeometry: SamplingGeometry! = ParcelCentroid """When sampling values to calculate the final score, a parcel might match multiple input features resulting in multiple records. This field configures the method to combine multiple records on one parcel.""" samplingMethod: SamplingMethod! = Any """ Weight of the criterion. Minimum value: 0 """ weight: Float! = 1 """Portal item id of an external layer.""" externalLayerItemId: String } """ **ParcelInformation**: Criterion based on a parcel information parameter. **ZoningRegulation**: Criterion based on a zoning regulation parameter. **ExternalLayer**: Criterion based on an external layer. """ enum CriterionType { ParcelInformation ZoningRegulation ExternalLayer } """A query cursor that can be used to fetch the next page of content""" scalar Cursor type DeleteResult { attributes: DeleteResultAttributes! } type DeleteResultAttributes { GlobalID: GlobalID } type DeleteUrbanDesignDatabaseResult { success: Boolean urbanDesignDatabaseId: PortalItemId } """ **New**: Newly built space **Repurposed**: Repurposed (existing) space **Unchanged**: Unchanged (existing) space """ enum DevelopmentStatus { New Repurposed Unchanged } """ **None**: No new spaces: either leave unchanged or demolish the existing building. **BuildingType**: New spaces have been generated procedurally with a building type. **Custom**: New spaces have been custom drawn. """ enum DevelopmentType { None BuildingType Custom } """Display configuration for types and layers.""" type DisplayConfig { """Display configuration of parcel information.""" parcels: ParcelsDisplayConfig } input DisplayConfigInput { """Display configuration of parcel information.""" parcels: ParcelsDisplayConfigInput } """ **Continuous**: Display cumulative shadow duration as a continuous surface. **Hourly**: Display cumulative shadow duration as an hourly aggregation of values. """ enum DurationMode { Continuous Hourly } """OverlayType configuration for DwellingUnitsPerAreaMax.""" type DwellingUnitsPerAreaMax { """Overlay method that gets applied to the parcel zoning parameters when redeveloping.""" method: OverlayTypeMethod! } input DwellingUnitsPerAreaMaxInput { """Overlay method that gets applied to the parcel zoning parameters when redeveloping.""" method: OverlayTypeMethod! = Replace } """JSON object with information about adjacency of the parcel edge.""" type EdgeAdjacency { """The category of the adjacency.""" category: String """What object the edge is adjacent to.""" type: EdgeAdjacencyType! """The width of the adjacent object in [m].""" width: Float! } input EdgeAdjacencyInput { """What object the edge is adjacent to.""" type: EdgeAdjacencyType! """The width of the adjacent object in [m].""" width: Float! = 0 """The category of the adjacency.""" category: String } """**Street**: The edge is adjacent to a street.""" enum EdgeAdjacencyType { Street } """JSON object with edge information for a parcel edge.""" type EdgeInfo { """An array of all adjacencies of the parcel edge.""" adjacencies: [EdgeAdjacency!]! """Orientation of the parcel edge.""" orientation: EdgeOrientation! } input EdgeInfoInput { """An array of all adjacencies of the parcel edge.""" adjacencies: [EdgeAdjacencyInput!]! """Orientation of the parcel edge.""" orientation: EdgeOrientation! } """ **Front**: Edge is oriented to the front. **Side**: Edge is oriented to the side. **Rear**: Edge is oriented to the back. """ enum EdgeOrientation { Front Side Rear } type ElevationProfile { elevationProfiles: [ElevationProfileParameter!]! } """Parameters defining one elevation profile analysis.""" type ElevationProfileParameter { """A polyline along which to sample elevation.""" paths: [Line!]! """The path types that should be visible in the visualization of the elevation profile.""" visiblePathTypes: [VisiblePathType!]! } input ElevationProfileParameterInput { """A polyline along which to sample elevation.""" paths: [LineInput!]! """The path types that should be visible in the visualization of the elevation profile.""" visiblePathTypes: [VisiblePathType!]! } """Layer configuration for existing buildings.""" type ExistingBuildingsLayerSettings { """If `true`, the layer is set to transparent.""" opacity: Float! """If `true`, the layer is visible.""" visible: Boolean! } input ExistingBuildingsLayerSettingsInput { """ If `true`, the layer is set to transparent. Minimum value: 0 Maximum value: 1 """ opacity: Float! """If `true`, the layer is visible.""" visible: Boolean! } """Layer configuration for existing trees.""" type ExistingTreesLayerSettings { """If `true`, the layer is visible.""" visible: Boolean! } input ExistingTreesLayerSettingsInput { """If `true`, the layer is visible.""" visible: Boolean! } """A metric describes the properties and configuration of a metric calculation.""" type ExtendedMetric { attributes: ExtendedMetricAttributes! inputs: [ExtendedMetricGraphEdge!]! } """Attributes of the extended metric.""" type ExtendedMetricAttributes { """Unique identifier (UUID) of the feature.""" GlobalID: GlobalID! """Custom ID of the feature. Used to join fields in the data manager.""" CustomID: String """The default value of a metric, e.g., of a parameter metric when no parameter is defined.""" DefaultValue: Float """Description of the metric.""" Description: String """The values to filter on for a filter metric.""" FilterValues: [String!]! """The list of units of an extended metric in the denominator.""" FractionUnitTypes: [MetricUnitType!]! """The x coordinate of the metric node on the metrics dependency graph.""" GraphX: Float """The y coordinate of the metric node on the metrics dependency graph.""" GraphY: Float """Name of the metric.""" MetricName: String """The resolution on which an extended metric should be calculated.""" MetricResolution: MetricResolution! """The way in which calculated metric values are aggregated.""" MetricResultAggregation: MetricResultAggregation! """The type of extended metric""" MetricType: MetricType! """The rounding method to use when rounding this metric.""" NumberRoundingMethod: NumberRoundingMethod! """If `true`, the metric is proposed in the plan.""" Proposal: Boolean! """The list of units of an extended metric in the numerator.""" UnitTypes: [MetricUnitType!]! """ID of the urban event (plan or project) the metric belongs to.""" UrbanEventID: GlobalID """The variable value of a metric.""" Value: Float """The last recorded edit.""" LastEdit: LastEdit } type ExtendedMetricEntry { label: String value: Float units: [ExtendedMetricUnit!]! fractionUnits: [ExtendedMetricUnit!]! inputType: InputType! inputMetricType: MetricType } """Filters which can be applied to extended metric queries.""" input ExtendedMetricFilterInput { globalIDs: [GlobalID!] customIds: [String!] defaultValues: [Float!] defaultValueIsLessThan: Float defaultValueIsGreaterThan: Float descriptions: [String!] graphXes: [Float!] graphXIsLessThan: Float graphXIsGreaterThan: Float graphYs: [Float!] graphYIsLessThan: Float graphYIsGreaterThan: Float metricNames: [String!] metricResolutions: [MetricResolution!] metricResultAggregations: [MetricResultAggregation!] metricTypes: [MetricType!] numberRoundingMethods: [NumberRoundingMethod!] proposal: Boolean urbanEventIds: [GlobalID!] values: [Float!] valueIsLessThan: Float valueIsGreaterThan: Float } type ExtendedMetricGraphEdge { GlobalID: GlobalID! Order: Int! } input ExtendedMetricGraphEdgeInput { GlobalID: GlobalID! Order: Int! } """Metric parameter values""" type ExtendedMetricParameter { """ID of the Metric that the parameter is assigned to.""" metricID: GlobalID! """Stores the parameter value (e.g., weight).""" value: Float! } input ExtendedMetricParameterInput { """ID of the Metric that the parameter is assigned to.""" metricID: GlobalID! """Stores the parameter value (e.g., weight).""" value: Float! } type ExtendedMetricSource { attributes: ExtendedMetricSourceAttributes! } type ExtendedMetricSourceAttributes { GlobalID: GlobalID! ExtendedSourceMetricID: GlobalID! ExtendedTargetMetricID: GlobalID! ExtendedMetricOrder: Int! UrbanEventID: GlobalID } enum ExtendedMetricUnit { Acre Degree Foot Gallon Hectare Kilogram Kilowatt KilowattHour Liter Meter None Percentage Pound SquareFoot SquareMeter Day CubicFoot CubicMeter } type ExtendedMetricsDashboard { metricName: String! metricDescription: String chartStyle: ChartStyle! icon: Icon! visible: Boolean! totalValue: Float units: [ExtendedMetricUnit!]! fractionUnits: [ExtendedMetricUnit!]! development: MetricSummary! potential: MetricSummary! } type ExtendedMetricsMeta implements FeaturesMeta { """The number of extendedMetrics.""" count: Int """Last recorded edit made to extendedMetrics""" lastEdit: LastEditMeta } """ Geographic extent given as a ring: the minimum and maximum longitude (X) and latitude (Y) of a bounding box. [[X, Y][X, Y]] Coordinates should be specified using the WGS84 (wkid: 4326) spatial reference. """ scalar Extent """OverlayType configuration for FARMax.""" type FARMax { """Overlay method that gets applied to the parcel zoning parameters when redeveloping.""" method: OverlayTypeMethod! } input FARMaxInput { """Overlay method that gets applied to the parcel zoning parameters when redeveloping.""" method: OverlayTypeMethod! = Replace } """Counts, aggregates, and other meta-information about the respective object type.""" interface FeaturesMeta { """The number of features of a given type and parent, with an optional query filter applied.""" count: Int """The last recorded edit made on all entries of a given type."""" lastEdit: LastEditMeta } type FeedbackCategoriesMeta implements FeaturesMeta { """The number of feedbackCategories.""" count: Int """Last recorded edit made to feedbackCategories""" lastEdit: LastEditMeta } """A feedback category provides additional context to a public or internal feedback comment.""" type FeedbackCategory { attributes: FeedbackCategoryAttributes! } """Attributes of the feedback category.""" type FeedbackCategoryAttributes { """Unique identifier (UUID) of the feature.""" GlobalID: GlobalID! """Order of the category.""" CategoryOrder: Int """Custom ID of the feature. Used to join fields in the data manager.""" CustomID: String """Description of the category.""" Description: String """Reference to the icon of the category that contains an image path and a color.""" Icon: FeedbackCategoryIcon! """Label of the category.""" Label: String! """The last recorded edit.""" LastEdit: LastEdit } """Filters which can be applied to feedback category queries.""" input FeedbackCategoryFilterInput { globalIDs: [GlobalID!] categoryOrders: [Int!] categoryOrderIsLessThan: Int categoryOrderIsGreaterThan: Int customIds: [String!] descriptions: [String!] icons: [FeedbackCategoryIcon!] labels: [String!] } enum FeedbackCategoryIcon { SpeechBubbleBike SpeechBubbleBlank SpeechBubbleBook SpeechBubbleBuilding SpeechBubbleBulb SpeechBubbleBus SpeechBubbleCar SpeechBubbleCheck SpeechBubbleCommunity SpeechBubbleCross SpeechBubbleCulture SpeechBubbleDemolish SpeechBubbleDislike SpeechBubbleDrop SpeechBubbleEconomy SpeechBubbleHealth SpeechBubbleHeart SpeechBubbleLike SpeechBubbleOther SpeechBubblePlay SpeechBubbleQuestion SpeechBubbleRecycle SpeechBubbleSnow SpeechBubbleStar SpeechBubbleSun SpeechBubbleTool SpeechBubbleTree SpeechBubbleWalking SpeechBubbleWarning SpeechBubbleWind Unknown } """JSON object containing the configuration of the overlay types.""" type FieldsConfig { """OverlayType configuration for CoverageMax.""" CoverageMax: CoverageMax! """OverlayType configuration for DwellingUnitsPerAreaMax.""" DwellingUnitsPerAreaMax: DwellingUnitsPerAreaMax! """OverlayType configuration for FARMax.""" FARMax: FARMax! """OverlayType configuration for HeightMax.""" HeightMax: HeightMax! """OverlayType configuration for NumFloorsMax.""" NumFloorsMax: NumFloorsMax! """OverlayType configuration for SubstructureDepthMax.""" SubstructureDepthMax: SubstructureDepthMax! } input FieldsConfigInput { """OverlayType configuration for CoverageMax.""" CoverageMax: CoverageMaxInput! """OverlayType configuration for DwellingUnitsPerAreaMax.""" DwellingUnitsPerAreaMax: DwellingUnitsPerAreaMaxInput! """OverlayType configuration for FARMax.""" FARMax: FARMaxInput! """OverlayType configuration for HeightMax.""" HeightMax: HeightMaxInput! """OverlayType configuration for NumFloorsMax.""" NumFloorsMax: NumFloorsMaxInput! """OverlayType configuration for SubstructureDepthMax.""" SubstructureDepthMax: SubstructureDepthMaxInput! } """ **None**: The zone or overlay has no fill. **Solid**: The zone or overlay has a solid fill. **BackwardDiagonal**: The zone or overlay has a backward diagonal lines fill pattern. **Cross**: The zone or overlay has a cross lines fill pattern. **DiagonalCross**: The zone or overlay has a diagonal cross lines fill pattern. **ForwardDiagonal**: The zone or overlay has a forward diagonal lines fill pattern. **Horizontal**: The zone or overlay has a horizontal lines fill pattern. **Vertical**: The zone or overlay has a vertical lines fill pattern. """ enum FillStyle { None Solid BackwardDiagonal Cross DiagonalCross ForwardDiagonal Horizontal Vertical } """ **Auto**: Footprint shape is assessed based on what results in a more optimal shape. **Parcel**: Footprint shape follows the parcel boundary. **Rectangle**: Footprint shape is rectangular. """ enum FootprintShape { Auto Parcel Rectangle } """Setback value in [m] applied to a Front edge.""" type FrontInteriorSetback { """Setback value in [m].""" value: Float! } input FrontInteriorSetbackInput { """ Setback value in [m]. Minimum value: 0 """ value: Float! } """Minimum allowed setbacks at the Front edge of a parcel.""" type FrontSetback { """Setback value in [m] applied to a Front edge.""" interior: FrontInteriorSetback! """Setback value in [m] applied to a Front edge adjacent to a street.""" street: FrontStreetSetback! } input FrontSetbackInput { """Setback value in [m] applied to a Front edge.""" interior: FrontInteriorSetbackInput! """Setback value in [m] applied to a Front edge adjacent to a street.""" street: FrontStreetSetbackInput! } """Setback value in [m] applied to a Front edge adjacent to a street.""" type FrontStreetSetback { """Setback value in [m].""" value: Float! } input FrontStreetSetbackInput { """ Setback value in [m]. Minimum value: 0 """ value: Float! } """Layer configuration for future buildings.""" type FutureBuildingsLayerSettings { """If `true`, the layer is set to transparent.""" opacity: Float! """If `true`, the layer is visible.""" visible: Boolean! } input FutureBuildingsLayerSettingsInput { """ If `true`, the layer is set to transparent. Minimum value: 0 Maximum value: 1 """ opacity: Float! """If `true`, the layer is visible.""" visible: Boolean! } input GeometryFilterInput { """The line geometry to apply as the spatial filter.""" line: LineInput """The point geometry to apply as the spatial filter.""" point: PointInput """The polygon geometry to apply as the spatial filter.""" polygon: PolygonInput """ The spatial relationship to be used for the filter geometry. See: [https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureFilter.html#spatialRelationship](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureFilter.html#spatialRelationship) """ relationship: SpatialRelationship! } """ The unique identifier of a feature in an urban database or urban design database. Example: 2a71c012-abbb-43dc-81c4-c5d55d4604c7 Needs to match /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/i """ scalar GlobalID """OverlayType configuration for HeightMax.""" type HeightMax { """Overlay method that gets applied to the parcel zoning parameters when redeveloping.""" method: OverlayTypeMethod! } input HeightMaxInput { """Overlay method that gets applied to the parcel zoning parameters when redeveloping.""" method: OverlayTypeMethod! = Replace } enum Icon { None Bike Blank Book Building Bulb Bus Car Check Community Cross Culture Demolish Dislike Drop Economy Health Heart Like Other Play Question Recycle Snow Star Sun Tool Tree Walking Warning Wind } type ImportExtendedMetricsResult { """Status of the import.""" success: Boolean! """Additional message providing more detail about the import status.""" message: String } type ImportSuitabilityResult { """Status of the import.""" success: Boolean! """Additional message providing more detail about the import status.""" message: String } """An indicator represents an external data source for visualizing GIS data.""" type Indicator { attributes: IndicatorAttributes! } """Attributes of the indicator.""" type IndicatorAttributes { """Unique identifier (UUID) of the feature.""" GlobalID: GlobalID! """Custom ID of the feature. Used to join fields in the data manager.""" CustomID: String """Portal item id of an ArcGIS Dashboard which will be embedded in the detail card of the indicator.""" DashboardItemId: PortalItemId """Description of the indicator (markdown enabled).""" Description: String """End date of the lifespan of the indicator.""" EndDate: Timestamp! """If `true`, the indicator is featured and appears at the top of the list in the overview.""" Featured: Boolean! """Name of the indicator.""" IndicatorName: String! """Type of the indicator.""" IndicatorType: IndicatorType! """Configuration of which layers are shown together with indicators and how.""" LayerSettings: LayerSettings """Start date of the lifespan of the indicator.""" StartDate: Timestamp! """URL to a webpage. Shown in the detail card of the indicator.""" WebpageUrl: String """Portal item id of a web scene whose layers are added as visualization. The portal item can also be a single layer (e.g., SceneLayer).""" WebsceneItemId: PortalItemId """The last recorded edit.""" LastEdit: LastEdit } """Filters which can be applied to indicator queries.""" input IndicatorFilterInput { globalIDs: [GlobalID!] customIds: [String!] dashboardItemIds: [PortalItemId!] descriptions: [String!] endDate: [Timestamp] beforeEndDate: Timestamp afterEndDate: Timestamp featured: Boolean indicatorNames: [String!] indicatorTypes: [IndicatorType!] startDate: [Timestamp] beforeStartDate: Timestamp afterStartDate: Timestamp webpageUrls: [String!] websceneItemIds: [PortalItemId!] } """ **LivingAtlas**: Built-in indicator based on a Living Atlas dataset. **Custom**: A custom indicator configured by the user. """ enum IndicatorType { LivingAtlas Custom } type IndicatorsMeta implements FeaturesMeta { """The number of indicators.""" count: Int """Last recorded edit made to indicators""" lastEdit: LastEditMeta } """The initial camera viewpoint.""" type InitialCamera { """The camera heading.""" heading: Float! """The camera position.""" position: Position! """The camera tilt.""" tilt: Float! } input InitialCameraInput { """The camera heading.""" heading: Float! """The camera position.""" position: PositionInput! """The camera tilt.""" tilt: Float! } """ **Schematic**: Schematic visualization. **Satellite**: Satellite visualization. """ enum InitialVisualizationStyle { Schematic Satellite } enum InputType { Metric SpaceUse Existing } """A LOD1 building is a low level of detail building in a project scenario and is shown in the overview as an extruded polygon.""" type LOD1Building { attributes: LOD1BuildingAttributes! """3d geometry (xyz coordinates)""" geometry: Polygon } """Attributes of the lod1 building.""" type LOD1BuildingAttributes { """Unique identifier (UUID) of the feature.""" GlobalID: GlobalID! """ID of the branch the building belongs to.""" BranchID: GlobalID """Custom ID of the feature. Used to join fields in the data manager.""" CustomID: String """The extrusion height of the building in [m].""" Height: Float """The last recorded edit.""" LastEdit: LastEdit } """Filters which can be applied to lod1 building queries.""" input LOD1BuildingFilterInput { globalIDs: [GlobalID!] branchIds: [GlobalID!] customIds: [String!] heights: [Float!] heightIsLessThan: Float heightIsGreaterThan: Float } type LOD1BuildingsMeta implements FeaturesMeta { """The number of lod1Buildings.""" count: Int """Last recorded edit made to lod1Buildings""" lastEdit: LastEditMeta } """The last recorded edit made on an entry.""" type LastEdit { """The username of the account the performed the edit.""" Editor: String! """When the last edit occurred""" When: Timestamp! } """The last recorded edit made on all entries of a given type."""" type LastEditMeta { """The username of the account the performed the edit.""" Editor: String """When the last edit occurred""" When: Timestamp! } """Configuration of which layers are shown together with indicators and how.""" type LayerSettings { """Layer configuration for context layers.""" context: ContextLayerSettings! """Layer configuration for existing buildings.""" existingBuildings: ExistingBuildingsLayerSettings! """Layer configuration for existing trees.""" existingTrees: ExistingTreesLayerSettings! """Layer configuration for future buildings.""" futureBuildings: FutureBuildingsLayerSettings! """Layer configuration for plans.""" plans: PlansLayerSettings! """Layer configuration for projects.""" projects: ProjectsLayerSettings! } input LayerSettingsInput { """Layer configuration for context layers.""" context: ContextLayerSettingsInput! """Layer configuration for existing buildings.""" existingBuildings: ExistingBuildingsLayerSettingsInput! """Layer configuration for existing trees.""" existingTrees: ExistingTreesLayerSettingsInput! """Layer configuration for future buildings.""" futureBuildings: FutureBuildingsLayerSettingsInput! """Layer configuration for plans.""" plans: PlansLayerSettingsInput! """Layer configuration for projects.""" projects: ProjectsLayerSettingsInput! } type Line { """ Array of coordinate pairs. [[x, y][x, y]] """ path: [[Float!]!]! spatialReference: SpatialReference! } input LineInput { """ Array of coordinate pairs. [[x, y][x, y]] """ path: [[Float!]!]! spatialReference: SpatialReferenceInput! } type LineOfSight { lineOfSights: [LineOfSightParameter!]! } """Parameters defining one line-of-sight analysis.""" type LineOfSightParameter { """Name of the line of sight analysis""" name: String! """Observer location (point) in the line of sight analysis.""" observer: Point! """A list of targets (points) used for visibility analysis from the observer point.""" targets: [Point!]! } input LineOfSightParameterInput { """Name of the line of sight analysis""" name: String! """Observer location (point) in the line of sight analysis.""" observer: PointInput! """A list of targets (points) used for visibility analysis from the observer point.""" targets: [PointInput!]! } """Media layer portal item id with layer order.""" type MediaLayer { """Display order of the Media Layer""" layerOrder: Float! """Portal item id of a Media Layer""" portalItemId: PortalItemId! } input MediaLayerInput { """Display order of the Media Layer""" layerOrder: Float! """ Portal item id of a Media Layer Maximum length: 32 """ portalItemId: PortalItemId! } """A metric describes the properties and configuration of a metric calculation.""" type Metric { attributes: MetricAttributes! sources: [MetricSource!]! } """Attributes of the metric.""" type MetricAttributes { """Unique identifier (UUID) of the feature.""" GlobalID: GlobalID! """Custom ID of the feature. Used to join fields in the data manager.""" CustomID: String """Description of the metric.""" Description: String """The x coordinate of the metric node on the metrics dependency graph.""" GraphX: Float """The y coordinate of the metric node on the metrics dependency graph.""" GraphY: Float """Name of the metric.""" MetricName: String """The rounding method to use when rounding this metric.""" NumberRoundingMethod: NumberRoundingMethod! """Operation of the metric on how to aggregate the source metrics.""" Operation: Operation! """If `true`, the metric is proposed in the plan.""" Proposal: Boolean! """Unit type of the metric.""" UnitType: UnitType! """ID of the urban event (plan or project) the metric belongs to.""" UrbanEventID: GlobalID """The last recorded edit.""" LastEdit: LastEdit } """Filters which can be applied to metric queries.""" input MetricFilterInput { globalIDs: [GlobalID!] customIds: [String!] descriptions: [String!] graphXes: [Float!] graphXIsLessThan: Float graphXIsGreaterThan: Float graphYs: [Float!] graphYIsLessThan: Float graphYIsGreaterThan: Float metricNames: [String!] numberRoundingMethods: [NumberRoundingMethod!] operations: [Operation!] proposal: Boolean unitTypes: [UnitType!] urbanEventIds: [GlobalID!] } """Metric parameter values on the space use type.""" type MetricParameter { """ID of the MetricSource of the Metric that the parameter is assigned to.""" metricSourceID: GlobalID! """Stores the parameter value (e.g., weight) for the source metric that uses spaces as a data source.""" value: Float! } input MetricParameterInput { """ID of the MetricSource of the Metric that the parameter is assigned to.""" metricSourceID: GlobalID! """Stores the parameter value (e.g., weight) for the source metric that uses spaces as a data source.""" value: Float! } """ **None**: None **Space**: Space **Building**: Building **Parcel**: Parcel **FocusArea**: FocusArea """ enum MetricResolution { None Space Building Parcel FocusArea } """ **None**: None **Sum**: Sum **Max**: Max """ enum MetricResultAggregation { None Sum Max } """A metric source is used in a metric calculation and can be either another metric or the net area of a building or surface space.""" type MetricSource { attributes: MetricSourceAttributes! } """Attributes of the metric source.""" type MetricSourceAttributes { """Unique identifier (UUID) of the feature.""" GlobalID: GlobalID! """Custom ID of the feature. Used to join fields in the data manager.""" CustomID: String """ID of the metric that the metric source belongs to.""" MetricID: GlobalID """ID of the metric that the source points to if the source type is 'Metric'. Otherwise, this field is ignored.""" SourceMetricID: GlobalID """Name of the metric source if the source type is anything other than 'Metric'. If source type is 'Metric', this field is ignored.""" SourceName: String """Type of the metric source.""" SourceType: SourceType! """ID of the urban event (plan) the metric source belongs to.""" UrbanEventID: GlobalID """Indicates whether the weight is applied as an inverse (1/n) in the calculation or as the actual number (n).""" WeightInverted: Boolean! """Name of the parameter that is used as a weight. If type is 'Constant', this field is ignored.""" WeightName: String """Type of weight that is used for the metric calculation.""" WeightType: WeightType! """Value for the parameter if the weight type is 'Constant'.""" WeightValue: Float """The last recorded edit.""" LastEdit: LastEdit } """Filters which can be applied to metric source queries.""" input MetricSourceFilterInput { globalIDs: [GlobalID!] customIds: [String!] metricIds: [GlobalID!] sourceMetricIds: [GlobalID!] sourceNames: [String!] sourceTypes: [SourceType!] urbanEventIds: [GlobalID!] weightInverted: Boolean weightNames: [String!] weightTypes: [WeightType!] weightValues: [Float!] weightValueIsLessThan: Float weightValueIsGreaterThan: Float } type MetricSourcesMeta implements FeaturesMeta { """The number of metricSources.""" count: Int """Last recorded edit made to metricSources""" lastEdit: LastEditMeta } type MetricSummary { value: Float entries: [ExtendedMetricEntry!]! } """ **SpaceUseParameter**: Space use type parameter **SpaceArea**: Space area **NetSpaceArea**: Net space area **DwellingUnits**: Number of dwelling units in the space **BuildingFootprintArea**: Building footprint area **BuildingGrossFloorArea**: Building gross floor area **BuildingFloors**: Number of building floors **BuildingHeight**: Building height **BuildingSubStructureFloors**: Number of building sub-structure floors **BuildingSubStructureDepth**: Building sub-structure depth **ParcelArea**: Parcel area **ParcelParameter**: Parcel parameter **ZoningParameter**: Parameter on zoning type or overlay (not supported for land use) **Variable**: Variable **Multiply**: Multiply **Divide**: Divide **Add**: Add **Subtract**: Subtract **Round**: Round **FilterBySpaceUseType**: Filter on space use type **FilterByDevelopmentStatus**: Filter on development status """ enum MetricType { SpaceUseParameter SpaceArea NetSpaceArea DwellingUnits BuildingFootprintArea BuildingGrossFloorArea BuildingFloors BuildingHeight BuildingSubStructureFloors BuildingSubStructureDepth ParcelArea ParcelParameter ZoningParameter Variable Multiply Divide Add Subtract Round FilterBySpaceUseType FilterByDevelopmentStatus } """ **Length**: Unit of type length [m] **TimeDays**: Unit of type time [d] **Mass**: Unit of type mass [kg] **Area**: Unit of type area [m2] **Volume**: Unit of type volume [m3] **LandArea**: Unit of type area [m2] **BuildingVolume**: Unit type of volume [m3] **EnergyConsumption**: Unit type of energy consumption [Wd] **Power**: Unit of type power [W] **Angle**: Unit type of angle [degrees] **Concentration**: Unit type of concentration [decimal] """ enum MetricUnitType { Length TimeDays Mass Area Volume LandArea BuildingVolume EnergyConsumption Power Angle Concentration } """A metric value is a value stored for a metric.""" type MetricValue { attributes: MetricValueAttributes! """3d geometry (xyz coordinates)""" geometry: Point } """Attributes of the metric value.""" type MetricValueAttributes { """Unique identifier (UUID) of the feature.""" GlobalID: GlobalID! """ID of the branch the metric value belongs to.""" BranchID: GlobalID """Custom ID of the feature. Used to join fields in the data manager.""" CustomID: String """ID of the referenced metric. Plans reference metrics in the urban design database of the plan. Projects reference metrics in the urban database of the Urban Model.""" MetricID: GlobalID! """The version of metrics this object belongs to.""" MetricVersion: MetricVersion! """Metric value that is stored on the point.""" Value: Float! """The last recorded edit.""" LastEdit: LastEdit } """Filters which can be applied to metric value queries.""" input MetricValueFilterInput { globalIDs: [GlobalID!] branchIds: [GlobalID!] customIds: [String!] metricIds: [GlobalID!] metricVersions: [MetricVersion!] values: [Float!] valueIsLessThan: Float valueIsGreaterThan: Float } type MetricValuesMeta implements FeaturesMeta { """The number of metricValues.""" count: Int """Last recorded edit made to metricValues""" lastEdit: LastEditMeta } """ **Basic**: Basic Metrics **Extended**: Extended Metrics """ enum MetricVersion { Basic Extended } type MetricsDashboard { metricName: String! description: String chartStyle: ChartStyle! icon: Icon! visible: Boolean! totalValue: Float unit: Unit! sources: [MetricsDashboardSource!]! } """Setting for an individual metric chart in a dashboard.""" type MetricsDashboardChart { """Chart style of the metric.""" chartStyle: ChartStyle! """Reference to the icon to be shown together with the metric.""" icon: Icon! """ID of the metric.""" metricID: GlobalID! """The version of metrics this object belongs to.""" metricVersion: MetricVersion! """If `true`, the metric is visible in the UI.""" visible: Boolean! } input MetricsDashboardChartInput { """Chart style of the metric.""" chartStyle: ChartStyle! = NumberChart """Reference to the icon to be shown together with the metric.""" icon: Icon! = None """ID of the metric.""" metricID: GlobalID! """If `true`, the metric is visible in the UI.""" visible: Boolean! = true """The version of metrics this object belongs to.""" metricVersion: MetricVersion = Basic } type MetricsDashboardSource { label: String! value: Float! unit: Unit! } type MetricsMeta implements FeaturesMeta { """The number of metrics.""" count: Int """Last recorded edit made to metrics""" lastEdit: LastEditMeta } type Mutation { createElevationProfileAnalyses(urbanDatabaseId: PortalItemId!, elevationProfileAnalyses: [CreateElevationProfileInput!]!): [Analysis!]! updateElevationProfileAnalyses(urbanDatabaseId: PortalItemId!, elevationProfileAnalyses: [UpdateElevationProfileInput!]!): [Analysis!]! createLineOfSightAnalyses(urbanDatabaseId: PortalItemId!, lineOfSightAnalyses: [CreateLineOfSightInput!]!): [Analysis!]! updateLineOfSightAnalyses(urbanDatabaseId: PortalItemId!, lineOfSightAnalyses: [UpdateLineOfSightInput!]!): [Analysis!]! createShadowcastAnalyses(urbanDatabaseId: PortalItemId!, shadowcastAnalyses: [CreateShadowcastInput!]!): [Analysis!]! updateShadowcastAnalyses(urbanDatabaseId: PortalItemId!, shadowcastAnalyses: [UpdateShadowcastInput!]!): [Analysis!]! createViewshedAnalyses(urbanDatabaseId: PortalItemId!, viewshedAnalyses: [CreateViewshedInput!]!): [Analysis!]! updateViewshedAnalyses(urbanDatabaseId: PortalItemId!, viewshedAnalyses: [UpdateViewshedInput!]!): [Analysis!]! createSuitabilityAnalyses(urbanDatabaseId: PortalItemId!, suitabilityAnalyses: [CreateSuitabilityInput!]!): [Analysis!]! updateSuitabilityAnalyses(urbanDatabaseId: PortalItemId!, suitabilityAnalyses: [UpdateSuitabilityInput!]!): [Analysis!]! createSunlightAnalyses(urbanDatabaseId: PortalItemId!, sunlightAnalyses: [CreateSunlightInput!]!): [Analysis!]! updateSunlightAnalyses(urbanDatabaseId: PortalItemId!, sunlightAnalyses: [UpdateSunlightInput!]!): [Analysis!]! deleteAnalyses(urbanDatabaseId: PortalItemId!, globalIDs: [GlobalID!]!, cascade: Boolean = false): [DeleteResult!] """Create new branches (scenarios) in a plan or project inside an urban database or urban design database.""" createBranches(urbanDatabaseId: PortalItemId!, branches: [CreateBranchInput!]!): [Branch!] """Update existing branches.""" updateBranches(urbanDatabaseId: PortalItemId!, branches: [UpdateBranchInput!]!): [Branch!] """Delete branches.""" deleteBranches(urbanDatabaseId: PortalItemId!, globalIDs: [GlobalID!]!, cascade: Boolean = false): [DeleteResult!] """Create new building types in an urban database or in a plan inside an urban design database.""" createBuildingTypes(urbanDatabaseId: PortalItemId!, buildingTypes: [CreateBuildingTypeInput!]!): [BuildingType!] """Update existing building types.""" updateBuildingTypes(urbanDatabaseId: PortalItemId!, buildingTypes: [UpdateBuildingTypeInput!]!): [BuildingType!] """Delete building types.""" deleteBuildingTypes(urbanDatabaseId: PortalItemId!, globalIDs: [GlobalID!]!, cascade: Boolean = false): [DeleteResult!] """Create new indicators in an urban database.""" createIndicators(urbanDatabaseId: PortalItemId!, indicators: [CreateIndicatorInput!]!): [Indicator!] """Update existing indicators.""" updateIndicators(urbanDatabaseId: PortalItemId!, indicators: [UpdateIndicatorInput!]!): [Indicator!] """Delete indicators.""" deleteIndicators(urbanDatabaseId: PortalItemId!, globalIDs: [GlobalID!]!, cascade: Boolean = false): [DeleteResult!] """Create new feedback categories in an urban database.""" createFeedbackCategories(urbanDatabaseId: PortalItemId!, feedbackCategories: [CreateFeedbackCategoryInput!]!): [FeedbackCategory!] """Update existing feedback categories.""" updateFeedbackCategories(urbanDatabaseId: PortalItemId!, feedbackCategories: [UpdateFeedbackCategoryInput!]!): [FeedbackCategory!] """Delete feedback categories.""" deleteFeedbackCategories(urbanDatabaseId: PortalItemId!, globalIDs: [GlobalID!]!, cascade: Boolean = false): [DeleteResult!] """Create new LOD1 buildings in a branch (scenario) of a project inside an urban database or an urban design database.""" createLOD1Buildings(urbanDatabaseId: PortalItemId!, lod1Buildings: [CreateLOD1BuildingInput!]!): [LOD1Building!] """Update existing lod1 buildings.""" updateLOD1Buildings(urbanDatabaseId: PortalItemId!, lod1Buildings: [UpdateLOD1BuildingInput!]!): [LOD1Building!] """Delete lod1 buildings.""" deleteLOD1Buildings(urbanDatabaseId: PortalItemId!, globalIDs: [GlobalID!]!, cascade: Boolean = false): [DeleteResult!] """Create new metrics in an urban database or in a plan or project inside an urban design database.""" createExtendedMetrics(urbanDatabaseId: PortalItemId!, extendedMetrics: [CreateExtendedMetricInput!]!): [ExtendedMetric!] """Update existing extended metrics.""" updateExtendedMetrics(urbanDatabaseId: PortalItemId!, extendedMetrics: [UpdateExtendedMetricInput!]!): [ExtendedMetric!] """Delete extended metrics.""" deleteExtendedMetrics(urbanDatabaseId: PortalItemId!, globalIDs: [GlobalID!]!, cascade: Boolean = false): [DeleteResult!] """Create new metric sources in an urban database or in a plan inside an urban design database.""" createMetricSources(urbanDatabaseId: PortalItemId!, metricSources: [CreateMetricSourceInput!]!): [MetricSource!] """Update existing metric sources.""" updateMetricSources(urbanDatabaseId: PortalItemId!, metricSources: [UpdateMetricSourceInput!]!): [MetricSource!] """Delete metric sources.""" deleteMetricSources(urbanDatabaseId: PortalItemId!, globalIDs: [GlobalID!]!, cascade: Boolean = false): [DeleteResult!] """Create new metrics in an urban database or in a plan or project inside an urban design database.""" createMetrics(urbanDatabaseId: PortalItemId!, metrics: [CreateMetricInput!]!): [Metric!] """Update existing metrics.""" updateMetrics(urbanDatabaseId: PortalItemId!, metrics: [UpdateMetricInput!]!): [Metric!] """Delete metrics.""" deleteMetrics(urbanDatabaseId: PortalItemId!, globalIDs: [GlobalID!]!, cascade: Boolean = false): [DeleteResult!] """Create new metric values in an urban database or in a branch (scenario) of a plan or project inside an urban design database.""" createMetricValues(urbanDatabaseId: PortalItemId!, metricValues: [CreateMetricValueInput!]!): [MetricValue!] """Update existing metric values.""" updateMetricValues(urbanDatabaseId: PortalItemId!, metricValues: [UpdateMetricValueInput!]!): [MetricValue!] """Delete metric values.""" deleteMetricValues(urbanDatabaseId: PortalItemId!, globalIDs: [GlobalID!]!, cascade: Boolean = false): [DeleteResult!] """Create new overlays in an urban database or in a branch (scenario) of a plan inside an urban design database.""" createOverlays(urbanDatabaseId: PortalItemId!, overlays: [CreateOverlayInput!]!): [Overlay!] """Update existing overlays.""" updateOverlays(urbanDatabaseId: PortalItemId!, overlays: [UpdateOverlayInput!]!): [Overlay!] """Delete overlays.""" deleteOverlays(urbanDatabaseId: PortalItemId!, globalIDs: [GlobalID!]!, cascade: Boolean = false): [DeleteResult!] """Create new overlay types in an urban database or in a plan inside an urban design database.""" createOverlayTypes(urbanDatabaseId: PortalItemId!, overlayTypes: [CreateOverlayTypeInput!]!): [OverlayType!] """Update existing overlay types.""" updateOverlayTypes(urbanDatabaseId: PortalItemId!, overlayTypes: [UpdateOverlayTypeInput!]!): [OverlayType!] """Delete overlay types.""" deleteOverlayTypes(urbanDatabaseId: PortalItemId!, globalIDs: [GlobalID!]!, cascade: Boolean = false): [DeleteResult!] """Create new parcels in an urban database or in a branch (scenario) of a plan inside an urban design database.""" createParcels(urbanDatabaseId: PortalItemId!, parcels: [CreateParcelInput!]!): [Parcel!] """Update existing parcels.""" updateParcels(urbanDatabaseId: PortalItemId!, parcels: [UpdateParcelInput!]!): [Parcel!] """Delete parcels.""" deleteParcels(urbanDatabaseId: PortalItemId!, globalIDs: [GlobalID!]!, cascade: Boolean = false): [DeleteResult!] """Create new plans in an urban database or urban design database.""" createPlans(urbanDatabaseId: PortalItemId!, plans: [CreatePlanInput!]!): [Plan!] """Update existing plans.""" updatePlans(urbanDatabaseId: PortalItemId!, plans: [UpdatePlanInput!]!): [Plan!] """Delete plans.""" deletePlans(urbanDatabaseId: PortalItemId!, globalIDs: [GlobalID!]!, cascade: Boolean = false): [DeleteResult!] """Create new point symbols in a branch (scenario) of a project inside an urban design database.""" createPointSymbols(urbanDatabaseId: PortalItemId!, pointSymbols: [CreatePointSymbolInput!]!): [PointSymbol!] """Update existing point symbols.""" updatePointSymbols(urbanDatabaseId: PortalItemId!, pointSymbols: [UpdatePointSymbolInput!]!): [PointSymbol!] """Delete point symbols.""" deletePointSymbols(urbanDatabaseId: PortalItemId!, globalIDs: [GlobalID!]!, cascade: Boolean = false): [DeleteResult!] """Create new polygon symbols in a branch (scenario) of a project inside an urban design database.""" createPolygonSymbols(urbanDatabaseId: PortalItemId!, polygonSymbols: [CreatePolygonSymbolInput!]!): [PolygonSymbol!] """Update existing polygon symbols.""" updatePolygonSymbols(urbanDatabaseId: PortalItemId!, polygonSymbols: [UpdatePolygonSymbolInput!]!): [PolygonSymbol!] """Delete polygon symbols.""" deletePolygonSymbols(urbanDatabaseId: PortalItemId!, globalIDs: [GlobalID!]!, cascade: Boolean = false): [DeleteResult!] """Create new projects in an urban database or urban design database.""" createProjects(urbanDatabaseId: PortalItemId!, projects: [CreateProjectInput!]!): [Project!] """Update existing projects.""" updateProjects(urbanDatabaseId: PortalItemId!, projects: [UpdateProjectInput!]!): [Project!] """Delete projects.""" deleteProjects(urbanDatabaseId: PortalItemId!, globalIDs: [GlobalID!]!, cascade: Boolean = false): [DeleteResult!] """Create new spaces in a branch (scenario) of a plan inside an urban design database.""" createSpaces(urbanDatabaseId: PortalItemId!, spaces: [CreateSpaceInput!]!): [Space!] """Update existing spaces.""" updateSpaces(urbanDatabaseId: PortalItemId!, spaces: [UpdateSpaceInput!]!): [Space!] """Delete spaces.""" deleteSpaces(urbanDatabaseId: PortalItemId!, globalIDs: [GlobalID!]!, cascade: Boolean = false): [DeleteResult!] """Create new space use types in an urban database or in a plan inside an urban design database.""" createSpaceUseTypes(urbanDatabaseId: PortalItemId!, spaceUseTypes: [CreateSpaceUseTypeInput!]!): [SpaceUseType!] """Update existing space use types.""" updateSpaceUseTypes(urbanDatabaseId: PortalItemId!, spaceUseTypes: [UpdateSpaceUseTypeInput!]!): [SpaceUseType!] """Delete space use types.""" deleteSpaceUseTypes(urbanDatabaseId: PortalItemId!, globalIDs: [GlobalID!]!, cascade: Boolean = false): [DeleteResult!] """Create new status types in an urban database.""" createStatusTypes(urbanDatabaseId: PortalItemId!, statusTypes: [CreateStatusTypeInput!]!): [StatusType!] """Update existing status types.""" updateStatusTypes(urbanDatabaseId: PortalItemId!, statusTypes: [UpdateStatusTypeInput!]!): [StatusType!] """Delete status types.""" deleteStatusTypes(urbanDatabaseId: PortalItemId!, globalIDs: [GlobalID!]!, cascade: Boolean = false): [DeleteResult!] """Create new suitability criteria in a plan inside an urban design database.""" createCriteria(urbanDatabaseId: PortalItemId!, criteria: [CreateCriterionInput!]!): [Criterion!] @deprecated(reason: "Criteria have moved to the Analysis field. (Removal date: 2026-11-18)") """Update existing criteria.""" updateCriteria(urbanDatabaseId: PortalItemId!, criteria: [UpdateCriterionInput!]!): [Criterion!] @deprecated(reason: "Criteria have moved to the Analysis field. (Removal date: 2026-11-18)") """Delete criteria.""" deleteCriteria(urbanDatabaseId: PortalItemId!, globalIDs: [GlobalID!]!, cascade: Boolean = false): [DeleteResult!] @deprecated(reason: "Criteria have moved to the Analysis field. (Removal date: 2026-11-18)") """Create new suitability models in a plan inside an urban design database.""" createSuitabilityModels(urbanDatabaseId: PortalItemId!, suitabilityModels: [CreateSuitabilityModelInput!]!): [SuitabilityModel!] """Update existing suitability models.""" updateSuitabilityModels(urbanDatabaseId: PortalItemId!, suitabilityModels: [UpdateSuitabilityModelInput!]!): [SuitabilityModel!] """Delete suitability models.""" deleteSuitabilityModels(urbanDatabaseId: PortalItemId!, globalIDs: [GlobalID!]!, cascade: Boolean = false): [DeleteResult!] """ Create a new urban design database. This operation might take a while. """ createUrbanDesignDatabase(title: String!, urbanModelId: PortalItemId!, description: String, extent: Extent, folderId: PortalItemId): PortalItemId """Update an existing urban design database.""" updateUrbanDesignDatabase(urbanDesignDatabaseId: PortalItemId!, title: String, description: String, extent: Extent): UrbanDesignDatabase! deleteUrbanDesignDatabase(urbanDesignDatabaseId: PortalItemId!): DeleteUrbanDesignDatabaseResult """ Upgrade an urban design database by adding missing layers/tables. This operation might take a while. """ upgradeUrbanDesignDatabase(urbanDesignDatabaseId: PortalItemId!): UpgradeUrbanDesignDatabaseResult! """ " Import existing (basic) metrics into the extended metrics. This will remove all existing extended metrics before the import. """ importPlanExtendedMetrics(urbanDesignDatabaseId: PortalItemId!, planId: GlobalID!): ImportExtendedMetricsResult! """Import existing suitability models into the new analysis editor.""" importPlanSuitabilityModels(urbanDesignDatabaseId: PortalItemId!, planId: GlobalID!): ImportSuitabilityResult! updateUrbanModelConfig(urbanModelId: PortalItemId!, urbanModelConfig: UpdateUrbanModelConfigInput!): UrbanModelConfig """ Create a new urban model with its urban database and urban database (view). This operation might take a while. Requires an Urban license. """ createUrbanModel(title: String!, description: String, extent: Extent, folderId: PortalItemId, spatialReference: SpatialReferenceInput): PortalItemId """Update an existing urban model.""" updateUrbanModel(urbanModelId: PortalItemId!, title: String, description: String, extent: Extent): UrbanModel! """ Upgrade an urban model by adding missing layers/tables to the urban database and urban database (view). This operation might take a while. """ upgradeUrbanModel(urbanModelId: PortalItemId!): UpgradeUrbanModelResult! """ " Import existing (basic) metrics into the extended metrics. This will remove all existing extended metrics before the import. """ importModelExtendedMetrics(urbanModelId: PortalItemId!): ImportExtendedMetricsResult! """Create new viewpoints in a plan or project inside an urban design database.""" createViewpoints(urbanDatabaseId: PortalItemId!, viewpoints: [CreateViewpointInput!]!): [Viewpoint!] """Update existing viewpoints.""" updateViewpoints(urbanDatabaseId: PortalItemId!, viewpoints: [UpdateViewpointInput!]!): [Viewpoint!] """Delete viewpoints.""" deleteViewpoints(urbanDatabaseId: PortalItemId!, globalIDs: [GlobalID!]!, cascade: Boolean = false): [DeleteResult!] """Create new zones in an urban database or in a branch (scenario) of a plan inside an urban design database.""" createZones(urbanDatabaseId: PortalItemId!, zones: [CreateZoneInput!]!): [Zone!] """Update existing zones.""" updateZones(urbanDatabaseId: PortalItemId!, zones: [UpdateZoneInput!]!): [Zone!] """Delete zones.""" deleteZones(urbanDatabaseId: PortalItemId!, globalIDs: [GlobalID!]!, cascade: Boolean = false): [DeleteResult!] """Create new zone types in an urban database or in a plan inside an urban design database.""" createZoneTypes(urbanDatabaseId: PortalItemId!, zoneTypes: [CreateZoneTypeInput!]!): [ZoneType!] """Update existing zone types.""" updateZoneTypes(urbanDatabaseId: PortalItemId!, zoneTypes: [UpdateZoneTypeInput!]!): [ZoneType!] """Delete zone types.""" deleteZoneTypes(urbanDatabaseId: PortalItemId!, globalIDs: [GlobalID!]!, cascade: Boolean = false): [DeleteResult!] } """The floor range of the building part.""" type NumFloors { """The maximum number of floors of the building part.""" max: Float! """The minimum number of floors of the building part.""" min: Float! } input NumFloorsInput { """ The maximum number of floors of the building part. Maximum value: 200 """ max: Float! """ The minimum number of floors of the building part. Minimum value: 0 """ min: Float! } """OverlayType configuration for NumFloorsMax.""" type NumFloorsMax { """Overlay method that gets applied to the parcel zoning parameters when redeveloping.""" method: OverlayTypeMethod! } input NumFloorsMaxInput { """Overlay method that gets applied to the parcel zoning parameters when redeveloping.""" method: OverlayTypeMethod! = Replace } """ **None**: No rounding **Nearest**: Round the metric value to the nearest integer for each parcel. **Up**: Round the metric value to the first higher integer for each parcel. **Down**: Round the metric value to the first lower integer for each parcel. """ enum NumberRoundingMethod { None Nearest Up Down } """**WeightedSum**: Weighted sum of one or more data points.""" enum Operation { WeightedSum } """ The unique identifier of an organization in the ArcGIS portal. Example: r0I0JKe3OLRdkKyK Needs to match /^[0-9a-zA-Z]{16}$/ """ scalar OrganizationId """ **None**: The zone or overlay has no outline. **Solid**: The zone or overlay has a solid outline. **Dash**: The zone or overlay has a dashed outline. **Dot**: The zone or overlay has a dotted outline. """ enum OutlineStyle { None Solid Dash Dot } """An overlay is a boundary with attributes that override zoning parameters.""" type Overlay { attributes: OverlayAttributes! """2d geometry (xy coordinates)""" geometry: Polygon overlayType: OverlayType } """Attributes of the overlay.""" type OverlayAttributes { """Unique identifier (UUID) of the feature.""" GlobalID: GlobalID! """ID of the branch the overlay belongs to.""" BranchID: GlobalID """Maximum allowed coverage in percentage.""" CoverageMax: Float """Custom ID of the feature. Used to join fields in the data manager.""" CustomID: String """Description of the overlay.""" Description: String """Maximum allowed dwelling units per area in [units/m2].""" DwellingUnitsPerAreaMax: Float """Parameter values for different metrics.""" ExtendedMetricParameters: [ExtendedMetricParameter!]! """Maximum allowed floor area ratio.""" FARMax: Float """Maximum allowed height in [m].""" HeightMax: Float """Label of the overlay.""" Label: String """Maximum allowed number of floors.""" NumFloorsMax: Int """ID of the overlay type the overlay belongs to.""" OverlayTypeID: GlobalID! """Array containing skyplanes.""" Skyplanes: [Skyplane!] """Maximum allowed substructure depth in [m].""" SubstructureDepthMax: Float """An array of tiers and their allowed setbacks in [m].""" Tiers: [Tier!] """The last recorded edit.""" LastEdit: LastEdit } """Filters which can be applied to overlay queries.""" input OverlayFilterInput { globalIDs: [GlobalID!] branchIds: [GlobalID!] coverageMaxes: [Float!] coverageMaxIsLessThan: Float coverageMaxIsGreaterThan: Float customIds: [String!] descriptions: [String!] dwellingUnitsPerAreaMaxes: [Float!] dwellingUnitsPerAreaMaxIsLessThan: Float dwellingUnitsPerAreaMaxIsGreaterThan: Float farMaxes: [Float!] farMaxIsLessThan: Float farMaxIsGreaterThan: Float heightMaxes: [Float!] heightMaxIsLessThan: Float heightMaxIsGreaterThan: Float labels: [String!] numFloorsMaxes: [Int!] numFloorsMaxIsLessThan: Int numFloorsMaxIsGreaterThan: Int overlayTypeIds: [GlobalID!] substructureDepthMaxes: [Float!] substructureDepthMaxIsLessThan: Float substructureDepthMaxIsGreaterThan: Float } """An overlay type is used to configure overlays that override zoning parameters.""" type OverlayType { attributes: OverlayTypeAttributes! } """Attributes of the overlay type.""" type OverlayTypeAttributes { """Unique identifier (UUID) of the feature.""" GlobalID: GlobalID! """Hex color of the zone type or overlay.""" Color: Color! """Custom ID of the feature. Used to join fields in the data manager.""" CustomID: String """JSON object containing the configuration of the overlay types.""" FieldsConfig: FieldsConfig! """Fill style of the zone type or overlay.""" FillStyle: FillStyle! """Label shown on the overlay geometry.""" Label: OverlayTypeLabel """Outline style of the zone type or overlay.""" OutlineStyle: OutlineStyle! """Name of the overlay type.""" OverlayTypeName: String! """The order of the overlay type. Defines the order in which the overlay types are displayed in the legend (and applied if relevant).""" OverlayTypeOrder: Int! """If `true`, the overlay type is proposed in the plan.""" Proposal: Boolean! """ID of the urban event (plan) the overlay type belongs to.""" UrbanEventID: GlobalID """The last recorded edit.""" LastEdit: LastEdit } """Filters which can be applied to overlay type queries.""" input OverlayTypeFilterInput { globalIDs: [GlobalID!] colors: [Color!] customIds: [String!] fillStyles: [FillStyle!] labels: [OverlayTypeLabel!] outlineStyles: [OutlineStyle!] overlayTypeNames: [String!] overlayTypeOrders: [Int!] overlayTypeOrderIsLessThan: Int overlayTypeOrderIsGreaterThan: Int proposal: Boolean urbanEventIds: [GlobalID!] } """ **None**: No label is shown. **HeightMax**: Label contains maximum height value in [m]. **NumFloorsMax**: Label contains maximum number of floors value. **FARMax**: Label contains maximum FAR value. **CoverageMax**: Label contains maximum coverage value in percentage. **SubstructureDepthMax**: Label contains maximum substructure depth value in [m]. **DwellingUnitsPerAreaMax**: Label contains maximum dwelling units per area value in [units/ha]. """ enum OverlayTypeLabel { None HeightMax NumFloorsMax FARMax CoverageMax SubstructureDepthMax DwellingUnitsPerAreaMax } """ **Replace**: Override underlying zoning value. **Max**: Override underlying zoning value if overlay value is larger. **Min**: Override underlying zoning value if overlay value is smaller. **Add**: Add overlay value to underlying zoning value. **Subtract**: Subtract overlay value from underlying zoning value. """ enum OverlayTypeMethod { Replace Max Min Add Subtract } type OverlayTypesMeta implements FeaturesMeta { """The number of overlayTypes.""" count: Int """Last recorded edit made to overlayTypes""" lastEdit: LastEditMeta } type OverlaysMeta implements FeaturesMeta { """The number of overlays.""" count: Int """Last recorded edit made to overlays""" lastEdit: LastEditMeta } input PagingInput { """ Maximum number of results to return. Minimum value: 1 Maximum value: 1000 """ limit: Int = 100 """ Number of results to skip. Can be used in combination with limit to achieve paging. """ offset: Int = 0 } """The parameters of an analysis model.""" type Parameters { """Configuration for generating elevation profiles along paths.""" elevationProfiles: [ElevationProfileParameter!]! """Configuration for a line-of-sight visibility analysis.""" lineOfSights: [LineOfSightParameter!]! """Configuration for running a shadow cast analysis.""" shadowcasts: [ShadowcastParameter!]! """Configuration for a suitability analysis.""" suitabilityParameters: [SuitabilityParameter!]! """Configuration for running a sunlight analysis.""" sunlights: [SunlightParameter!]! """Configuration for a viewshed analysis.""" viewsheds: [ViewshedParameter!]! } input ParametersInput { """Configuration for generating elevation profiles along paths.""" elevationProfiles: [ElevationProfileParameterInput!] """Configuration for a line-of-sight visibility analysis.""" lineOfSights: [LineOfSightParameterInput!] """Configuration for running a shadow cast analysis.""" shadowcasts: [ShadowcastParameterInput!] """Configuration for a suitability analysis.""" suitabilityParameters: [SuitabilityParameterInput!] """Configuration for running a sunlight analysis.""" sunlights: [SunlightParameterInput!] """Configuration for a viewshed analysis.""" viewsheds: [ViewshedParameterInput!] } """A parcel is a boundary with parcel attributes.""" type Parcel { attributes: ParcelAttributes! """2d geometry (xy coordinates)""" geometry: Polygon buildingType: BuildingType spaces(filter: SpaceFilterInput, geometryFilter: GeometryFilterInput, paging: PagingInput): [Space!] spacesMeta(filter: SpaceFilterInput, geometryFilter: GeometryFilterInput): SpacesMeta! zoningRegulation: ZoningRegulation! } """Attributes of the parcel.""" type ParcelAttributes { """Unique identifier (UUID) of the feature.""" GlobalID: GlobalID! """ID of the branch the parcel belongs to.""" BranchID: GlobalID """ID of the building type the parcel is assigned to for the generation of future buildings.""" BuildingTypeID: GlobalID """Maximum allowed coverage in percentage.""" CoverageMax: Float """Custom ID of the feature. Used to join fields in the data manager.""" CustomID: String """If `true`, the parcel is being demolished.""" Demolish: Boolean! """The type of development on the parcel.""" DevelopmentType: DevelopmentType! """Maximum allowed dwelling units per area in [units/m2].""" DwellingUnitsPerAreaMax: Float """An array of parcel edges and their edge information.""" EdgeInfos: [EdgeInfo!] """Parameter values for different metrics.""" ExtendedMetricParameters: [ExtendedMetricParameter!]! """Maximum allowed floor area ratio.""" FARMax: Float """Area in [m2] of the parcel ground that is not overlapped by spaces. Is `null` if no `GroundSpaceUseTypeID is defined.`""" GroundArea: Float """ID of the space use type assigned to the parcel ground.""" GroundSpaceUseTypeID: GlobalID """Maximum allowed height in [m].""" HeightMax: Float """Maximum allowed number of floors.""" NumFloorsMax: Int """Array containing skyplanes.""" Skyplanes: [Skyplane!] """Maximum allowed substructure depth in [m].""" SubstructureDepthMax: Float """An array of tiers and their allowed setbacks in [m].""" Tiers: [Tier!] """The last recorded edit.""" LastEdit: LastEdit """ Area of the parcel in [m2]. Geodetic/geodesic area is returned for geographic coordinate systems, planar area is returned for projected coordinate systems. """ Area: Float! } """Filters which can be applied to parcel queries.""" input ParcelFilterInput { globalIDs: [GlobalID!] branchIds: [GlobalID!] buildingTypeIds: [GlobalID!] coverageMaxes: [Float!] coverageMaxIsLessThan: Float coverageMaxIsGreaterThan: Float customIds: [String!] develop: Boolean developmentTypes: [DevelopmentType!] dwellingUnitsPerAreaMaxes: [Float!] dwellingUnitsPerAreaMaxIsLessThan: Float dwellingUnitsPerAreaMaxIsGreaterThan: Float farMaxes: [Float!] farMaxIsLessThan: Float farMaxIsGreaterThan: Float groundAreas: [Float!] groundAreaIsLessThan: Float groundAreaIsGreaterThan: Float groundSpaceUseTypeIds: [GlobalID!] heightMaxes: [Float!] heightMaxIsLessThan: Float heightMaxIsGreaterThan: Float numFloorsMaxes: [Int!] numFloorsMaxIsLessThan: Int numFloorsMaxIsGreaterThan: Int substructureDepthMaxes: [Float!] substructureDepthMaxIsLessThan: Float substructureDepthMaxIsGreaterThan: Float } """Display configuration of parcel information.""" type ParcelsDisplayConfig { """Label associated with parcel CustomID.""" customIDLabel: String } input ParcelsDisplayConfigInput { """Label associated with parcel CustomID.""" customIDLabel: String } type ParcelsMeta implements FeaturesMeta { """The number of parcels.""" count: Int """Last recorded edit made to parcels""" lastEdit: LastEditMeta } """A plan is used for long-term (10–50 years) urban planning on a large scale.""" type Plan { attributes: PlanAttributes! """2d geometry (xy coordinates)""" geometry: Polygon """Analyses""" analyses(filter: AnalysisFilterInput, paging: PagingInput): [Analysis!]! analysesMeta(filter: AnalysisFilterInput): AnalysisMeta! """ Branches (scenarios) in the plan. See [Work with plan scenarios](https://doc.arcgis.com/en/urban/help/help-scenarios.htm). """ branches(filter: BranchFilterInput, paging: PagingInput, sort: [BranchSortInput!]): [PlanBranch]! branchesMeta(filter: BranchFilterInput): PlanBranchesMeta! """ Buildings types in the plan. See [Building types](https://doc.arcgis.com/en/urban/data/data-manager-types.htm#ESRI_SECTION1_BB8E3A8E309C4F45B6F837A07E9D2453). """ buildingTypes(filter: BuildingTypeFilterInput, paging: PagingInput): [BuildingType]! buildingTypesMeta(filter: BuildingTypeFilterInput): BuildingTypesMeta! """ Extended Metrics in the plan. See [Manage metrics](https://doc.arcgis.com/en/urban/data/data-manager-metrics.htm). """ extendedMetrics(filter: ExtendedMetricFilterInput, paging: PagingInput): [ExtendedMetric]! """ Metrics defined in the plan. See [Manage metrics](https://doc.arcgis.com/en/urban/data/data-manager-metrics.htm). """ metrics(filter: MetricFilterInput, paging: PagingInput): [Metric]! @deprecated(reason: "Metrics in Plans have been deprecated. Use the extended metrics (Removal date: 18.11.2026)") metricsMeta(filter: MetricFilterInput): MetricsMeta! @deprecated(reason: "Metrics in Plans have been deprecated. Use the extended metrics (Removal date: 18.11.2026)") """ Sources for metrics in the plan. See [Manage metrics](https://doc.arcgis.com/en/urban/data/data-manager-metrics.htm). """ metricSources(filter: MetricSourceFilterInput, paging: PagingInput): [MetricSource]! @deprecated(reason: "Metrics in Plans have been deprecated. Use the extended metrics (Removal date: 18.11.2026)") metricSourcesMeta(filter: MetricSourceFilterInput): MetricSourcesMeta! @deprecated(reason: "Metrics in Plans have been deprecated. Use the extended metrics (Removal date: 18.11.2026)") """ Overlay types in the plan. See [Create an overlay](https://doc.arcgis.com/en/urban/help/help-create-zoning-overlay.htm). """ overlayTypes(filter: OverlayTypeFilterInput, paging: PagingInput): [OverlayType]! overlayTypesMeta(filter: OverlayTypeFilterInput): OverlayTypesMeta! """ Space-use types in the plan. See [Space-use types](https://doc.arcgis.com/en/urban/data/data-manager-types.htm#ESRI_SECTION1_C30D73392D964D51A8B606128A8A6E8F). """ spaceUseTypes(filter: SpaceUseTypeFilterInput, paging: PagingInput): [SpaceUseType]! spaceUseTypesMeta(filter: SpaceUseTypeFilterInput): SpaceUseTypesMeta! """ Criteria defined in the plan. See [Suitability](https://doc.arcgis.com/en/urban/help/help-suitability.htm). """ criteria(filter: CriterionFilterInput, paging: PagingInput): [Criterion]! @deprecated(reason: "No longer supported. (Removal date: 2026-11-18)") criteriaMeta(filter: CriterionFilterInput): CriteriaMeta! @deprecated(reason: "No longer supported. (Removal date: 2026-11-18)") """ Suitability models defined in the plan. See [Suitability](https://doc.arcgis.com/en/urban/help/help-suitability.htm). """ suitabilityModels(filter: SuitabilityModelFilterInput, paging: PagingInput): [SuitabilityModel]! @deprecated(reason: "No longer supported. (Removal date: 2026-11-18)") suitabilityModelsMeta(filter: SuitabilityModelFilterInput): SuitabilityModelsMeta! @deprecated(reason: "No longer supported. (Removal date: 2026-11-18)") """ Zoning types in the plan. See [Zoning types](https://doc.arcgis.com/en/urban/data/data-manager-types.htm#ESRI_SECTION1_87E11F381BC94CC38639042C7B1331A0). """ zoneTypes(filter: ZoneTypeFilterInput, paging: PagingInput): [ZoneType]! zoneTypesMeta(filter: ZoneTypeFilterInput): ZoneTypesMeta! """ Viewpoints defined in the plan. See [Viewpoints](https://doc.arcgis.com/en/urban/help/help-viewpoints.htm). """ viewpoints(filter: ViewpointFilterInput, paging: PagingInput): [Viewpoint]! viewpointsMeta(filter: ViewpointFilterInput): ViewpointsMeta! } """Attributes of the plan.""" type PlanAttributes { """Unique identifier (UUID) of the feature.""" GlobalID: GlobalID! """Address of the urban event.""" Address: String """Portal item id of a web scene whose layers are shown as context layers when editing a plan or project (visible for all scenarios).""" ContextWebsceneItemId: PortalItemId """Custom ID of the feature. Used to join fields in the data manager.""" CustomID: String """Description of the urban event (markdown enabled).""" Description: String """End date of the urban event.""" EndDate: Timestamp! """Name of the urban event.""" EventName: String! """If `true`, the urban event is featured and appears at the top of the list in the overview.""" Featured: Boolean! """The version of metrics displayed in the dashboard of a plan.""" MetricVersion: MetricVersion! """Settings for the charts in the metrics dashboard.""" MetricsDashboardCharts: [MetricsDashboardChart!]! """The planning method of the plan.""" PlanningMethod: UrbanEventPlanningMethod! """Start date of the urban event.""" StartDate: Timestamp! """ID of the status type associated with the urban event.""" Status: GlobalID """Image (blob) to be displayed in the overview card.""" Thumbnail: String """URL to a webpage. Shown in the detail card of the urban event.""" WebpageUrl: String """The last recorded edit.""" LastEdit: LastEdit } """A plan branch is a design scenario in a plan.""" type PlanBranch { attributes: BranchAttributes! """Metrics dashboards in the branch of the plan.""" metricsDashboards(parcelFilter: ParcelFilterInput, unitSystem: UnitSystem! = Metric, visibleOnly: Boolean): [MetricsDashboard]! @deprecated(reason: "Metrics in Plans have been deprecated. Use the extended metrics (Removal date: 18.11.2026)") """ExtendedMetrics dashboards in the branch of the plan.""" extendedMetricsDashboards(parcelFilter: ParcelFilterInput, unitSystem: UnitSystem! = Metric, visibleOnly: Boolean): [ExtendedMetricsDashboard]! """ Metric values in the branch of the plan. See [Work with metrics](https://doc.arcgis.com/en/urban/help/help-analyze-plan.htm). """ metricValues(filter: MetricValueFilterInput, geometryFilter: GeometryFilterInput, paging: PagingInput): [MetricValue]! metricValuesMeta(filter: MetricValueFilterInput, geometryFilter: GeometryFilterInput): MetricValuesMeta! """ Overlays in the branch of the plan. See [Create an overlay](https://doc.arcgis.com/en/urban/help/help-create-zoning-overlay.htm). """ overlays(filter: OverlayFilterInput, geometryFilter: GeometryFilterInput, paging: PagingInput): [Overlay]! overlaysMeta(filter: OverlayFilterInput, geometryFilter: GeometryFilterInput): OverlaysMeta! """ Parcels in the branch of the plan. See [Add and edit parcels](https://doc.arcgis.com/en/urban/help/help-edit-parcels.htm). """ parcels(filter: ParcelFilterInput, geometryFilter: GeometryFilterInput, paging: PagingInput): [Parcel]! parcelsMeta(filter: ParcelFilterInput, geometryFilter: GeometryFilterInput): ParcelsMeta! """ Spaces in the branch of the plan. See [Work with spaces and surfaces](https://doc.arcgis.com/en/urban/help/help-parcel-redevelopment.htm#ESRI_SECTION1_B18118FDBF3E48E8AE4DC4B7EBB72395). """ spaces(filter: SpaceFilterInput, geometryFilter: GeometryFilterInput, paging: PagingInput): [Space]! spacesMeta(filter: SpaceFilterInput, geometryFilter: GeometryFilterInput): SpacesMeta! """ Zones in the branch of the plan. See [Work with zoning and land-use types](https://doc.arcgis.com/en/urban/help/help-assign-new-zoning.htm). """ zones(filter: ZoneFilterInput, geometryFilter: GeometryFilterInput, paging: PagingInput): [Zone]! zonesMeta(filter: ZoneFilterInput, geometryFilter: GeometryFilterInput): ZonesMeta! } type PlanBranchesMeta implements FeaturesMeta { """The number of planBranches.""" count: Int """Last recorded edit made to planBranches""" lastEdit: LastEditMeta } """Filters which can be applied to plan queries.""" input PlanFilterInput { globalIDs: [GlobalID!] addresses: [String!] contextWebsceneItemIds: [PortalItemId!] customIds: [String!] descriptions: [String!] endDate: [Timestamp] beforeEndDate: Timestamp afterEndDate: Timestamp eventNames: [String!] featured: Boolean metricVersions: [MetricVersion!] planningMethods: [UrbanEventPlanningMethod!] startDate: [Timestamp] beforeStartDate: Timestamp afterStartDate: Timestamp statuses: [GlobalID!] thumbnails: [String!] webpageUrls: [String!] } enum PlanSortBy { EndDate EventName StartDate } input PlanSortInput { direction: SortDirection = ASC sortBy: PlanSortBy! } """Layer configuration for plans.""" type PlansLayerSettings { """If `true`, the layer is visible.""" visible: Boolean! } input PlansLayerSettingsInput { """If `true`, the layer is visible.""" visible: Boolean! } type PlansMeta implements FeaturesMeta { """The number of plans.""" count: Int """Last recorded edit made to plans""" lastEdit: LastEditMeta } type Point { """x coordinate of the point.""" x: Float! """y coordinate of the point.""" y: Float! """ z coordinate of the point. Returns null if the point is of type 2d. """ z: Float spatialReference: SpatialReference! } input PointInput { """x coordinate of the point.""" x: Float! """y coordinate of the point.""" y: Float! """ z coordinate of the point. Valid only if defined as 3d geometry in the geometry field documentation (otherwise not required). """ z: Float spatialReference: SpatialReferenceInput! } """A point symbol is a point geometry in a project scenario with a specific style.""" type PointSymbol { attributes: PointSymbolAttributes! """2d geometry (xy coordinates)""" geometry: Point } """Attributes of the point symbol.""" type PointSymbolAttributes { """Unique identifier (UUID) of the feature.""" GlobalID: GlobalID! """ID of the branch the symbol belongs to.""" BranchID: GlobalID """Custom ID of the feature. Used to join fields in the data manager.""" CustomID: String """The depth of the symbol in [m].""" Depth: Float! """The heading of the symbol in [deg].""" Heading: Float! """The height of the symbol in [m].""" Height: Float! """URL of the symbol.""" ResourceHref: String! """Style of the symbol.""" SymbolStyle: PointSymbolStyle! """The width of the symbol in [m].""" Width: Float! """The last recorded edit.""" LastEdit: LastEdit } """Filters which can be applied to point symbol queries.""" input PointSymbolFilterInput { globalIDs: [GlobalID!] branchIds: [GlobalID!] customIds: [String!] depths: [Float!] depthIsLessThan: Float depthIsGreaterThan: Float headings: [Float!] headingIsLessThan: Float headingIsGreaterThan: Float heights: [Float!] heightIsLessThan: Float heightIsGreaterThan: Float resourceHrefs: [String!] symbolStyles: [PointSymbolStyle!] widths: [Float!] widthIsLessThan: Float widthIsGreaterThan: Float } """ **Trees**: Point represents a tree. **Vehicles**: Point represents a vehicle. **Furniture**: Point represents street furniture. """ enum PointSymbolStyle { Trees Vehicles Furniture } type PointSymbolsMeta implements FeaturesMeta { """The number of pointSymbols.""" count: Int """Last recorded edit made to pointSymbols""" lastEdit: LastEditMeta } type Polygon { """ Array of rings, a single ring is understood as a list of coordinate 2d pairs [x, y], or 3d triplets [x, y, z]. [[[x, y][x, y]][[x, y][x, y]]] Rings are assumed to be 2d unless specified otherwise in the geometry field documentation. """ rings: Rings! spatialReference: SpatialReference! } input PolygonInput { """ Array of rings, a single ring is understood as a list of coordinate 2d pairs [x, y], or 3d triplets [x, y, z]. [[[x, y][x, y]][[x, y][x, y]]] Rings are assumed to be 2d unless specified otherwise in the geometry field documentation. """ rings: Rings! spatialReference: SpatialReferenceInput! } """A polygon symbol is a 2D polygon in a project scenario with a specific style.""" type PolygonSymbol { attributes: PolygonSymbolAttributes! """2d geometry (xy coordinates)""" geometry: Polygon } """Attributes of the polygon symbol.""" type PolygonSymbolAttributes { """Unique identifier (UUID) of the feature.""" GlobalID: GlobalID! """ID of the branch the symbol belongs to.""" BranchID: GlobalID """Custom ID of the feature. Used to join fields in the data manager.""" CustomID: String """Style of the symbol.""" SymbolStyle: PolygonSymbolStyle! """The last recorded edit.""" LastEdit: LastEdit } """Filters which can be applied to polygon symbol queries.""" input PolygonSymbolFilterInput { globalIDs: [GlobalID!] branchIds: [GlobalID!] customIds: [String!] symbolStyles: [PolygonSymbolStyle!] } """ **Grass**: Polygon represents grass / open area. **Concrete**: Polygon represents concrete / sealed area. **Water**: Polygon represents water. """ enum PolygonSymbolStyle { Grass Concrete Water } type PolygonSymbolsMeta implements FeaturesMeta { """The number of polygonSymbols.""" count: Int """Last recorded edit made to polygonSymbols""" lastEdit: LastEditMeta } """ The unique identifier of an item in the ArcGIS portal. Example: d8a87a34620e4182a1cabf0f0fae0728 Needs to match /^[0-9a-f]{12}4[0-9a-f]{3}[89ab][0-9a-f]{15}$/ """ scalar PortalItemId enum PortalItemSortBy { Title Created Modified } input PortalItemSortInput { direction: SortDirection = ASC sortBy: PortalItemSortBy! } """The camera position.""" type Position { """The spatial reference of the camera position.""" spatialReference: SpatialReference! """The x-coordinate of the camera position.""" x: Float! """The y-coordinate of the camera position.""" y: Float! """The z-coordinate of the camera position.""" z: Float! } input PositionInput { """The spatial reference of the camera position.""" spatialReference: SpatialReferenceInput! """The x-coordinate of the camera position.""" x: Float! """The y-coordinate of the camera position.""" y: Float! """The z-coordinate of the camera position.""" z: Float! } """A project is used for short-term (1-5 years) urban planning at the parcel level.""" type Project { attributes: ProjectAttributes! """2d geometry (xy coordinates)""" geometry: Polygon """Analyses""" analyses(filter: AnalysisFilterInput, paging: PagingInput): [Analysis!]! analysesMeta(filter: AnalysisFilterInput): AnalysisMeta! """ Branches (scenarios) in the project. See [Work with project scenarios](https://doc.arcgis.com/en/urban/help/help-projects-scenarios.htm). """ branches(filter: BranchFilterInput, paging: PagingInput, sort: [BranchSortInput!]): [ProjectBranch]! branchesMeta(filter: BranchFilterInput): ProjectBranchesMeta! """ Project status types defined in the project. See [Project status types](https://doc.arcgis.com/en/urban/data/data-manager-types.htm#ESRI_SECTION1_B937885446E34EB381FFF216E56AAA70). """ statusType: StatusType! """ Viewpoints defined in the project. See [Viewpoints](https://doc.arcgis.com/en/urban/help/help-viewpoints.htm). """ viewpoints(filter: ViewpointFilterInput, paging: PagingInput): [Viewpoint]! viewpointsMeta(filter: ViewpointFilterInput): ViewpointsMeta! } """Attributes of the project.""" type ProjectAttributes { """Unique identifier (UUID) of the feature.""" GlobalID: GlobalID! """Address of the urban event.""" Address: String """Portal item id of a web scene whose layers are shown as context layers when editing a plan or project (visible for all scenarios).""" ContextWebsceneItemId: PortalItemId """Custom ID of the feature. Used to join fields in the data manager.""" CustomID: String """Description of the urban event (markdown enabled).""" Description: String """End date of the urban event.""" EndDate: Timestamp! """Name of the urban event.""" EventName: String! """If `true`, the urban event is featured and appears at the top of the list in the overview.""" Featured: Boolean! """Settings for the charts in the metrics dashboard.""" MetricsDashboardCharts: [MetricsDashboardChart!]! """Portal item id of a 3D Object Scene Layer.""" ObjectSceneLayerItemId: PortalItemId """The Global ID of the scenario to show in overview visualizations.""" OverviewVisualizationBranchId: GlobalID """Start date of the urban event.""" StartDate: Timestamp! """ID of the status type associated with the urban event.""" Status: GlobalID """Image (blob) to be displayed in the overview card.""" Thumbnail: String """URL to a webpage. Shown in the detail card of the urban event.""" WebpageUrl: String """The last recorded edit.""" LastEdit: LastEdit } """A project branch is a design scenario in a project.""" type ProjectBranch { attributes: BranchAttributes! """ Metric values in the branch of the project. See [Work with the dashboard](https://doc.arcgis.com/en/urban/help/help-metrics-project.htm). """ metricValues(filter: MetricValueFilterInput, geometryFilter: GeometryFilterInput, paging: PagingInput): [MetricValue]! metricValuesMeta(filter: MetricValueFilterInput, geometryFilter: GeometryFilterInput): MetricValuesMeta! """Metrics dashboards in the branch of the project.""" metricsDashboards(unitSystem: UnitSystem! = Metric, visibleOnly: Boolean): [MetricsDashboard]! """ Low level of detail (LOD1) schematic buildings in the branch of the project. See [Draw buildings](https://doc.arcgis.com/en/urban/help/help-edit-project.htm#ESRI_SECTION1_81D7BE94C40741CF85BAEB6A4CA53A1E). """ lod1Buildings(filter: LOD1BuildingFilterInput, geometryFilter: GeometryFilterInput, paging: PagingInput): [LOD1Building]! lod1BuildingsMeta(filter: LOD1BuildingFilterInput, geometryFilter: GeometryFilterInput): LOD1BuildingsMeta! """ Point symbols representing trees, vehicles, and other urban furniture in the branch of the project. See [Edit a project](https://doc.arcgis.com/en/urban/help/help-edit-project.htm). """ pointSymbols(filter: PointSymbolFilterInput, geometryFilter: GeometryFilterInput, paging: PagingInput): [PointSymbol]! pointSymbolsMeta(filter: PointSymbolFilterInput, geometryFilter: GeometryFilterInput): PointSymbolsMeta! """ Polygon symbols representing grass, concrete, water, or other surface layers in the branch of the project. See [Edit a project](https://doc.arcgis.com/en/urban/help/help-edit-project.htm). """ polygonSymbols(filter: PolygonSymbolFilterInput, geometryFilter: GeometryFilterInput, paging: PagingInput): [PolygonSymbol]! polygonSymbolsMeta(filter: PolygonSymbolFilterInput, geometryFilter: GeometryFilterInput): PolygonSymbolsMeta! } type ProjectBranchesMeta implements FeaturesMeta { """The number of projectBranches.""" count: Int """Last recorded edit made to projectBranches""" lastEdit: LastEditMeta } """Filters which can be applied to project queries.""" input ProjectFilterInput { globalIDs: [GlobalID!] addresses: [String!] contextWebsceneItemIds: [PortalItemId!] customIds: [String!] descriptions: [String!] endDate: [Timestamp] beforeEndDate: Timestamp afterEndDate: Timestamp eventNames: [String!] featured: Boolean objectSceneLayerItemIds: [PortalItemId!] overviewVisualizationBranchIds: [GlobalID!] startDate: [Timestamp] beforeStartDate: Timestamp afterStartDate: Timestamp statuses: [GlobalID!] thumbnails: [String!] webpageUrls: [String!] } enum ProjectSortBy { EndDate EventName StartDate } input ProjectSortInput { direction: SortDirection = ASC sortBy: ProjectSortBy! } """Layer configuration for projects.""" type ProjectsLayerSettings { """If `true`, the layer is visible.""" visible: Boolean! } input ProjectsLayerSettingsInput { """If `true`, the layer is visible.""" visible: Boolean! } type ProjectsMeta implements FeaturesMeta { """The number of projects.""" count: Int """Last recorded edit made to projects""" lastEdit: LastEditMeta } type Query { """ A cursor representing the current state of the query which can be passed to subsequent queries to page results. """ cursor(next: Cursor, limit: Int): String """Query an urban design database by id.""" urbanDesignDatabase(urbanDesignDatabaseId: PortalItemId!): UrbanDesignDatabase """Query multiple urban design databases. If no filters are specified in a query, entries limited by the default limit argument will be returned.""" urbanDesignDatabases(extent: Extent, title: String, groupIds: [PortalItemId!], organizationId: OrganizationId, owners: [String!], limit: Int = 10, offset: Int = 1, sort: PortalItemSortInput, urbanModelId: PortalItemId): [UrbanDesignDatabase!] """Counts, aggregates, and other information about urban design databases.""" urbanDesignDatabasesMeta(extent: Extent, title: String, groupIds: [PortalItemId!], organizationId: OrganizationId, owners: [String!], urbanModelId: PortalItemId): UrbanDesignDatabasesMeta! """Query an urban model by id.""" urbanModel(urbanModelId: PortalItemId!): UrbanModel """Query multiple urban models. If no filters are specified in a query, entries limited by the default limit argument will be returned.""" urbanModels(extent: Extent, title: String, groupIds: [PortalItemId!], organizationId: OrganizationId, owners: [String!], limit: Int = 10, offset: Int = 1, sort: PortalItemSortInput): [UrbanModel!] urbanModelsMeta(extent: Extent, title: String, groupIds: [PortalItemId!], organizationId: OrganizationId, owners: [String!]): UrbanModelsMeta! } """Setback value in [m] applied to a Rear edge.""" type RearInteriorSetback { """Setback value in [m].""" value: Float! } input RearInteriorSetbackInput { """ Setback value in [m]. Minimum value: 0 """ value: Float! } """Minimum allowed setbacks at the Rear edge of a parcel.""" type RearSetback { """Setback value in [m] applied to a Rear edge.""" interior: RearInteriorSetback! """Setback value in [m] applied to a Rear edge adjacent to a street.""" street: RearStreetSetback! } input RearSetbackInput { """Setback value in [m] applied to a Rear edge.""" interior: RearInteriorSetbackInput! """Setback value in [m] applied to a Rear edge adjacent to a street.""" street: RearStreetSetbackInput! } """Setback value in [m] applied to a Rear edge adjacent to a street.""" type RearStreetSetback { """Setback value in [m].""" value: Float! } input RearStreetSetbackInput { """ Setback value in [m]. Minimum value: 0 """ value: Float! } """Reclassification interval.""" type ReclassificationInterval { """Ending value (exclusive) of the interval.""" end: Float! """Whether this value causes the parcel to be excluded from the score calculation. Parcels that match excluded intervals on at least one criterion are excluded from the entire rest of the calculation.""" exclude: Boolean! """Score of the interval.""" score: Float! """Starting value (inclusive) of the interval.""" start: Float! } input ReclassificationIntervalInput { """Ending value (exclusive) of the interval.""" end: Float! """Whether this value causes the parcel to be excluded from the score calculation. Parcels that match excluded intervals on at least one criterion are excluded from the entire rest of the calculation.""" exclude: Boolean! = false """ Score of the interval. Minimum value: 0 Maximum value: 10 """ score: Float! """Starting value (inclusive) of the interval.""" start: Float! } """Reclassification mapping.""" type ReclassificationMapping { """Whether this value causes the parcel to be excluded from the score calculation. Parcels that match excluded values on at least one criterion are excluded from the entire rest of the calculation.""" exclude: Boolean! """Score of the interval.""" score: Float! """Value of the field.""" value: String } input ReclassificationMappingInput { """Whether this value causes the parcel to be excluded from the score calculation. Parcels that match excluded values on at least one criterion are excluded from the entire rest of the calculation.""" exclude: Boolean! = false """ Score of the interval. Minimum value: 0 Maximum value: 10 """ score: Float! """Value of the field.""" value: String } """ A single ring is understood as a list of coordinate 2d pairs [x, y], or 3d triplets [x, y, z]. [[x, y][x, y]][[x, y][x, y]] A ring is assumed to be 2d unless specified otherwise in the geometry field documentation. """ scalar Rings """ **ParcelCentroid**: Parcel centroid **ParcelGeometry**: Parcel geometry """ enum SamplingGeometry { ParcelCentroid ParcelGeometry } """ **Any**: Use the value from any matching feature. **Sum**: Use the sum of the values over all matching features. **Average**: Use the average of the values over all matching features. **Minimum**: Use the minimum value from all matching features. **Maximum**: Use the maximum value from all matching features. """ enum SamplingMethod { Any Sum Average Minimum Maximum } """ **Default**: Default satellite visualization. **Custom**: Custom satellite visualization. """ enum SatelliteVisualization { Default Custom } """ **Default**: Default schematic visualization. **Custom**: Custom schematic visualization. """ enum SchematicVisualization { Default Custom } type Shadowcast { shadowcasts: [ShadowcastParameter!]! } """Parameters controlling a single shadow cast computation.""" type ShadowcastParameter { """Hex color of the shadow cast visualization.""" color: ColorAlpha! """Individual shadows are displayed at this time interval, starting with the `StartTimeOfDay`. The interval is expressed in milliseconds [ms].""" discreteInterval: Float! """Mode in which the cumulative shadow duration should be displayed: as a continuous surface or as an hourly aggregation of values.""" durationMode: DurationMode! """In the threshold visualization, individual discrete shadows are displayed as context at this time interval. The interval is expressed in milliseconds [ms].""" thresholdDiscreteInterval: Float! """Time period in milliseconds [ms]. Only shadows cast for more time than this value are displayed.""" thresholdValue: Float! """Date and temporal window covered by the analysis.""" time: Time! """Type of visualization to display the shadow cast. See [visualizationType](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#visualizationType) to learn more.""" visualizationType: VisualizationType! } input ShadowcastParameterInput { """Hex color of the shadow cast visualization.""" color: ColorAlpha! """ Individual shadows are displayed at this time interval, starting with the `StartTimeOfDay`. The interval is expressed in milliseconds [ms]. Minimum value: 0 """ discreteInterval: Float! """Mode in which the cumulative shadow duration should be displayed: as a continuous surface or as an hourly aggregation of values.""" durationMode: DurationMode! """ In the threshold visualization, individual discrete shadows are displayed as context at this time interval. The interval is expressed in milliseconds [ms]. Minimum value: 0 """ thresholdDiscreteInterval: Float! = 3600000 """ Time period in milliseconds [ms]. Only shadows cast for more time than this value are displayed. Minimum value: 0 Maximum value: 28800000 """ thresholdValue: Float! """Date and temporal window covered by the analysis.""" time: TimeInput! """Type of visualization to display the shadow cast. See [visualizationType](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#visualizationType) to learn more.""" visualizationType: VisualizationType! } """Setback value in [m] applied to a Side edge.""" type SideInteriorSetback { """Setback value in [m].""" value: Float! } input SideInteriorSetbackInput { """ Setback value in [m]. Minimum value: 0 """ value: Float! } """Minimum allowed setbacks at the Side edge of a parcel.""" type SideSetback { """Setback value in [m] applied to a Side edge.""" interior: SideInteriorSetback! """Setback value in [m] applied to a Side edge adjacent to a street.""" street: SideStreetSetback! } input SideSetbackInput { """Setback value in [m] applied to a Side edge.""" interior: SideInteriorSetbackInput! """Setback value in [m] applied to a Side edge adjacent to a street.""" street: SideStreetSetbackInput! } """Setback value in [m] applied to a Side edge adjacent to a street.""" type SideStreetSetback { """Setback value in [m].""" value: Float! } input SideStreetSetbackInput { """ Setback value in [m]. Minimum value: 0 """ value: Float! } """JSON object containing information about a skyplane.""" type Skyplane { """The adjacency of the skyplane""" adjacency: SkyplaneAdjacency! """Skyplane angle relative to the ground in [deg].""" angle: Float! """Horizontal offset of the skyplane relative to the parcel edge in [m].""" horizontalOffset: Float! """The orientation of the skyplane""" orientation: SkyplaneOrientation! """Vertical offset of the skyplane relative to the parcel edge in [m].""" verticalOffset: Float! } """ **Street**: Skyplane is oriented to the street. **Interior**: Skyplane is oriented to the interior. """ enum SkyplaneAdjacency { Street Interior } input SkyplaneInput { """The adjacency of the skyplane""" adjacency: SkyplaneAdjacency! """ Skyplane angle relative to the ground in [deg]. Minimum value: 0 Maximum value: 90 """ angle: Float! = 90 """Horizontal offset of the skyplane relative to the parcel edge in [m].""" horizontalOffset: Float! = 0 """The orientation of the skyplane""" orientation: SkyplaneOrientation! """Vertical offset of the skyplane relative to the parcel edge in [m].""" verticalOffset: Float! = 0 } """ **Front**: Skyplane is oriented to the front. **Side**: Skyplane is oriented to the side. **Rear**: Skyplane is oriented to the back. """ enum SkyplaneOrientation { Front Side Rear } """ **ASC**: Ascending order. **DESC**: Descending order. """ enum SortDirection { ASC DESC } """ **SpaceArea**: Area of a space is used as a data point for the metric. **Metric**: Another metric is used as a data point for the metric. """ enum SourceType { SpaceArea Metric } """A space is a boundary with attributes used for building spaces and surface spaces.""" type Space { attributes: SpaceAttributes! """3d geometry (xyz coordinates)""" geometry: Polygon spaceUseType: SpaceUseType } """Attributes of the space.""" type SpaceAttributes { """Unique identifier (UUID) of the feature.""" GlobalID: GlobalID! """ID of the branch the space belongs to.""" BranchID: GlobalID """Building number the space belongs to.""" BuildingNumber: Int """Custom ID of the feature. Used to join fields in the data manager.""" CustomID: String """The development status of the space.""" DevelopmentStatus: DevelopmentStatus! """Floor height of the space in [m].""" FloorHeight: Float """Floor number the space belongs to.""" FloorNumber: Int """If `true`, the space should be excluded from GFA / FAR calculations.""" GFAIgnore: Boolean! """ID of the parcel the space belongs to.""" ParcelID: GlobalID! """Type of space.""" SpaceType: SpaceType! """ID of the space use type that is assigned to the space. This is used for coloring the space, aggregating space use areas, and calculating capacity metrics.""" SpaceUseTypeID: GlobalID! """The last recorded edit.""" LastEdit: LastEdit """ Area of the space in [m2]. Geodetic/geodesic area is returned for geographic coordinate systems, planar area is returned for projected coordinate systems. """ Area: Float! } """Filters which can be applied to space queries.""" input SpaceFilterInput { globalIDs: [GlobalID!] branchIds: [GlobalID!] buildingNumbers: [Int!] buildingNumberIsLessThan: Int buildingNumberIsGreaterThan: Int customIds: [String!] developmentStatuses: [DevelopmentStatus!] floorHeights: [Float!] floorHeightIsLessThan: Float floorHeightIsGreaterThan: Float floorNumbers: [Int!] floorNumberIsLessThan: Int floorNumberIsGreaterThan: Int gfaIgnore: Boolean parcelIds: [GlobalID!] spaceTypes: [SpaceType!] spaceUseTypeIds: [GlobalID!] } """ **Building**: The space is part of a building. **Surface**: The space is not part of a building and draped to the surface. """ enum SpaceType { Building Surface } """A space use type is used to configure a space in a building or a surface.""" type SpaceUseType { attributes: SpaceUseTypeAttributes! } """Attributes of the space use type.""" type SpaceUseTypeAttributes { """Unique identifier (UUID) of the feature.""" GlobalID: GlobalID! """Gross floor area taken up by an average household in the space use type, used for assessing the size of a dwelling unit in [m2].""" AreaPerHousehold: Float """Hex color of the space use type.""" Color: Color! """Custom ID of the feature. Used to join fields in the data manager.""" CustomID: String """Parameter values for different metrics.""" ExtendedMetricParameters: [ExtendedMetricParameter!]! """Floor height of the space use type in [m].""" FloorHeight: Float! """Label of the space use type.""" Label: String! """Metric parameter values (e.g., weights) for a Metric that uses spaces as a data source.""" MetricParameters: [MetricParameter!]! """Factor that reduces the total floor area used for capacity indicator calculations.""" NetAreaFactor: Float! """If `true`, the space use type is proposed in the plan.""" Proposal: Boolean! """If `true`, the space use type is residential and therefore can be used in dwelling units.""" SingleUseOnly: Boolean! """Name of the space use type.""" SpaceUseTypeName: String! """The order of the space use type. Defines the order in which the space use types are displayed in the legend.""" SpaceUseTypeOrder: Int! """ID of the urban event (plan) the space use type belongs to.""" UrbanEventID: GlobalID """The last recorded edit.""" LastEdit: LastEdit } """Filters which can be applied to space use type queries.""" input SpaceUseTypeFilterInput { globalIDs: [GlobalID!] areaPerHouseholds: [Float!] areaPerHouseholdIsLessThan: Float areaPerHouseholdIsGreaterThan: Float colors: [Color!] customIds: [String!] floorHeights: [Float!] floorHeightIsLessThan: Float floorHeightIsGreaterThan: Float labels: [String!] netAreaFactors: [Float!] netAreaFactorIsLessThan: Float netAreaFactorIsGreaterThan: Float proposal: Boolean singleUseOnly: Boolean spaceUseTypeNames: [String!] spaceUseTypeOrders: [Int!] spaceUseTypeOrderIsLessThan: Int spaceUseTypeOrderIsGreaterThan: Int urbanEventIds: [GlobalID!] } type SpaceUseTypesMeta implements FeaturesMeta { """The number of spaceUseTypes.""" count: Int """Last recorded edit made to spaceUseTypes""" lastEdit: LastEditMeta } type SpacesMeta implements FeaturesMeta { """The number of spaces.""" count: Int """Last recorded edit made to spaces""" lastEdit: LastEditMeta } """ Spatial reference used for the data's horizontal (xy) coordinates. See: [https://developers.arcgis.com/rest/services-reference/using-spatial-references.htm](https://developers.arcgis.com/rest/services-reference/using-spatial-references.htm) By default, Urban uses a gravity-related height model for the data's vertical (z) coordinate. See: [https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-HeightModelInfo.html#heightModel](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-HeightModelInfo.html#heightModel). Other vertical spatial references are currently not supported in Urban. """ type SpatialReference { """ Well-known ID (wkid) is a unique number assigned to a coordinate system. This field returns the most recent and official identifier for the coordinate system (if there is one). It may or may not be the same as the identifier assigned to the spatial reference during its creation. """ wkid: Int! """A list of well-known IDs that may be used as synonyms for the primary well-known ID due to being equivalent. These are usually older or non-standard well-known IDs that have been deprecated in favour of newer, standardized values.""" alternativeWkids: [Int!]! } input SpatialReferenceInput { wkid: Int! } """ **Intersects**: Returns results that intersect the filter geometry. **EnvelopeIntersects**: Returns results that intersect the envelope (or extent) of the filter geometry. **Contains**: Returns results that are completely contained by the filter geometry. **Crosses**: Returns results when the interior of a filter geometry comes into contact with the interior or boundary of a geometry. In other words, the geometries share some interior area, but not all interior area. **Overlaps**: Returns results that overlap the filter geometry. Only features of the same geometry can be compared. **Touches**: Returns results that touch the filter geometry. The boundaries of the geometries intersect, but not their interiors. **Within**: Returns results that completely contain the filter geometry. In other words, the filter geometry is completely within the features in the layer view. It is the opposite of contains. """ enum SpatialRelationship { Intersects EnvelopeIntersects Contains Crosses Overlaps Touches Within } """A status type is used to describe the status of a project.""" type StatusType { attributes: StatusTypeAttributes! } """Attributes of the status type.""" type StatusTypeAttributes { """Unique identifier (UUID) of the feature.""" GlobalID: GlobalID! """Custom ID of the feature. Used to join fields in the data manager.""" CustomID: String """Description of the status.""" Description: String """Reference to the icon of the status that contains an image path and a color.""" Icon: StatusTypeIcon! """Label of the status.""" Label: String! """Order of the status.""" StatusOrder: Int """The last recorded edit.""" LastEdit: LastEdit } """Filters which can be applied to status type queries.""" input StatusTypeFilterInput { globalIDs: [GlobalID!] customIds: [String!] descriptions: [String!] icons: [StatusTypeIcon!] labels: [String!] statusOrders: [Int!] statusOrderIsLessThan: Int statusOrderIsGreaterThan: Int } enum StatusTypeIcon { ProjectApprovedBlue ProjectApprovedCyan ProjectApprovedGreen ProjectApprovedPurple ProjectApprovedRed ProjectApprovedYellow ProjectConstructionCompleteBlue ProjectConstructionCompleteCyan ProjectConstructionCompleteGreen ProjectConstructionCompletePurple ProjectConstructionCompleteRed ProjectConstructionCompleteYellow ProjectLetterOfIntentBlue ProjectLetterOfIntentCyan ProjectLetterOfIntentGreen ProjectLetterOfIntentPurple ProjectLetterOfIntentRed ProjectLetterOfIntentYellow ProjectPrefileBlue ProjectPrefileCyan ProjectPrefileGreen ProjectPrefilePurple ProjectPrefileRed ProjectPrefileYellow ProjectUnderConstructionBlue ProjectUnderConstructionCyan ProjectUnderConstructionGreen ProjectUnderConstructionPurple ProjectUnderConstructionRed ProjectUnderConstructionYellow ProjectUnderConstruction2Blue ProjectUnderConstruction2Cyan ProjectUnderConstruction2Green ProjectUnderConstruction2Purple ProjectUnderConstruction2Red ProjectUnderConstruction2Yellow ProjectUnderReviewBlue ProjectUnderReviewCyan ProjectUnderReviewGreen ProjectUnderReviewPurple ProjectUnderReviewRed ProjectUnderReviewYellow ProjectWrenchBlue ProjectWrenchCyan ProjectWrenchGreen ProjectWrenchPurple ProjectWrenchRed ProjectWrenchYellow Unknown } type StatusTypesMeta implements FeaturesMeta { """The number of statusTypes.""" count: Int """Last recorded edit made to statusTypes""" lastEdit: LastEditMeta } """Street-view configuration.""" type Streetview { """Mapillary API key to access the street-view mode.""" apiKey: String! """Mapillary image filter key to filter images by username.""" filterKey: String """The street-view image provider.""" provider: StreetviewProvider! } input StreetviewInput { """Mapillary API key to access the street-view mode.""" apiKey: String! """The street-view image provider.""" provider: StreetviewProvider! """Mapillary image filter key to filter images by username.""" filterKey: String } """**MAPILLARY**: Mapillary street-view image provider.""" enum StreetviewProvider { MAPILLARY } """OverlayType configuration for SubstructureDepthMax.""" type SubstructureDepthMax { """Overlay method that gets applied to the parcel zoning parameters when redeveloping.""" method: OverlayTypeMethod! } input SubstructureDepthMaxInput { """Overlay method that gets applied to the parcel zoning parameters when redeveloping.""" method: OverlayTypeMethod! = Replace } type Suitability { suitabilityParameters: [SuitabilityParameter!]! } """A suitability model stores settings such as suitability criteria belonging to the model and the name of the suitability model.""" type SuitabilityModel { attributes: SuitabilityModelAttributes! criteria: [Criterion!]! } """Attributes of the suitability model.""" type SuitabilityModelAttributes { """Unique identifier (UUID) of the feature.""" GlobalID: GlobalID! """Custom ID of the feature. Used to join fields in the data manager.""" CustomID: String """Description""" Description: String """Name of the model.""" ModelName: String! """If `true`, the model is proposed in the plan.""" Proposal: Boolean! """ID of the urban event (plan) the model belongs to.""" UrbanEventID: GlobalID """The last recorded edit.""" LastEdit: LastEdit } """Filters which can be applied to suitability model queries.""" input SuitabilityModelFilterInput { globalIDs: [GlobalID!] customIds: [String!] descriptions: [String!] modelNames: [String!] proposal: Boolean urbanEventIds: [GlobalID!] } type SuitabilityModelsMeta implements FeaturesMeta { """The number of suitabilityModels.""" count: Int """Last recorded edit made to suitabilityModels""" lastEdit: LastEditMeta } """Suitability models defined in the plan. See [Manage suitability models](https://doc.arcgis.com/en/urban/latest/help/help-suitability.htm#ESRI_SECTION1_C3AA3FC8A94A4DC59B1BF4924CC64F5C) to learn more.""" type SuitabilityParameter { """Collection of criteria used to compute suitability scores.""" criteria: [CriterionParameter!]! } input SuitabilityParameterInput { """Collection of criteria used to compute suitability scores.""" criteria: [CriterionParameterInput!]! } type Sunlight { sunlights: [SunlightParameter!]! } """Parameters controlling a single sunlight computation.""" type SunlightParameter { """Individual sunlight states are displayed at this time interval, starting with the `StartTimeOfDay`. The interval is expressed in milliseconds [ms].""" discreteInterval: Float! """Mode in which the cumulative sunlight duration should be displayed: as a continuous surface or as an hourly aggregation of values.""" durationMode: DurationMode! """Time period in milliseconds [ms]. Only areas receiving sunlight for more time than this value are displayed.""" thresholdValue: Float! """Date and temporal window covered by the analysis.""" time: Time! """Type of visualization to display the sunlight analysis.""" visualizationType: VisualizationType! } input SunlightParameterInput { """ Individual sunlight states are displayed at this time interval, starting with the `StartTimeOfDay`. The interval is expressed in milliseconds [ms]. Minimum value: 0 """ discreteInterval: Float! """Mode in which the cumulative sunlight duration should be displayed: as a continuous surface or as an hourly aggregation of values.""" durationMode: DurationMode! """ Time period in milliseconds [ms]. Only areas receiving sunlight for more time than this value are displayed. Minimum value: 0 Maximum value: 28800000 """ thresholdValue: Float! """Date and temporal window covered by the analysis.""" time: TimeInput! """Type of visualization to display the sunlight analysis.""" visualizationType: VisualizationType! } """ **Small**: 200px wide. **Medium**: 400px wide. **Large**: 800px wide. **Huge**: 2400px wide. """ enum ThumbnailSize { Small Medium Large Huge } """JSON object containing information about setback values.""" type Tier { """Information about setback values for different parcel edge orientations and adjacencies.""" setbacks: TierSetbacks! """The start height of the tier in [m].""" startHeight: Float! } input TierInput { """Information about setback values for different parcel edge orientations and adjacencies.""" setbacks: TierSetbacksInput! """ The start height of the tier in [m]. Minimum value: 0 Maximum value: 0 """ startHeight: Float! } """Information about setback values for different parcel edge orientations and adjacencies.""" type TierSetbacks { """Minimum allowed setbacks at the Front edge of a parcel.""" front: FrontSetback! """Minimum allowed setbacks at the Rear edge of a parcel.""" rear: RearSetback! """Minimum allowed setbacks at the Side edge of a parcel.""" side: SideSetback! } input TierSetbacksInput { """Minimum allowed setbacks at the Front edge of a parcel.""" front: FrontSetbackInput! """Minimum allowed setbacks at the Rear edge of a parcel.""" rear: RearSetbackInput! """Minimum allowed setbacks at the Side edge of a parcel.""" side: SideSetbackInput! } """Date and temporal window covered by the analysis.""" type Time { """The calendar date used to calculate the analysis (Unix timestamp).""" date: Timestamp! """Time (in milliseconds from midnight of the date) when the analysis computation should stop.""" endTimeOfDay: Float! """Time (in milliseconds from midnight of the date) when the analysis computation should start.""" startTimeOfDay: Float! """The difference in hours between UTC time and the times displayed in the analysis.""" utcOffset: Float! } input TimeInput { """ The calendar date used to calculate the analysis (Unix timestamp). Minimum value: 0 """ date: Timestamp! """Time (in milliseconds from midnight of the date) when the analysis computation should stop.""" endTimeOfDay: Float! """Time (in milliseconds from midnight of the date) when the analysis computation should start.""" startTimeOfDay: Float! """The difference in hours between UTC time and the times displayed in the analysis.""" utcOffset: Float! } """The javascript `Date` as integer. Type represents date and time as number of milliseconds from start of UNIX epoch.""" scalar Timestamp """ **None**: - **PerDay**: /d **Percentage**: % **Degree**: ° **Kilowatt**: kW **KilowattHourPerDay**: kWh/d **Meter**: m **SquareMeter**: m2 **PerSquareMeter**: /m2 **Hectare**: ha **PerHectare**: /ha **Liter**: l **LiterPerDay**: l/d **Kilogram**: kg **KilogramPerDay**: kg/d **Foot**: ft **SquareFoot**: sqft **PerSquareFoot**: /sqft **Acre**: acre **PerAcre**: /acre **Gallon**: gal **GallonPerDay**: gal/d **Pound**: lb **PoundPerDay**: lb/d """ enum Unit { None PerDay Percentage Degree Kilowatt KilowattHourPerDay Meter SquareMeter Hectare PerSquareMeter PerHectare Liter LiterPerDay Kilogram KilogramPerDay Foot SquareFoot Acre PerSquareFoot PerAcre Gallon GallonPerDay Pound PoundPerDay } enum UnitSystem { Metric USStandard } """ **Number**: No unit type. **NumberPerDay**: Unit of type number per day [/d]. **Length**: Unit of type length [m]. **Area**: Unit of type area [m2]. **LandArea**: Unit of type area [m2]. **Density**: Unit of type density [/m2]. **LandDensity**: Unit of type density [/m2]. **Concentration**: Unit of type concentration. **Angle**: Unit of type angle [degree]. **EnergyPerDay**: Unit of type energy per day [W/d]. **Power**: Unit of type power [W]. **MassPerDay**: Unit of type mass per day [kg/d]. **Mass**: Unit of type mass [kg]. **VolumePerDay**: Unit of type volume per day [m3/d]. **Volume**: Unit of type volume [m3]. """ enum UnitType { Number NumberPerDay Length Area LandArea Density LandDensity Concentration Angle EnergyPerDay Power MassPerDay Mass VolumePerDay Volume } input UpdateAnalysisAttributesInput { GlobalID: GlobalID! CustomID: String AnalysisName: String Description: String UrbanEventID: GlobalID DisplayOrder: Int """It may be necessary in clients to set the `Apollo-Require-Preflight` HTTP header to `true` for thumbnail uploads to be accepted.""" Thumbnail: Upload } """Input attributes for updating an existing branch.""" input UpdateBranchAttributesInput { """Unique identifier (UUID) of the feature.""" GlobalID: GlobalID! """ Name of the branch. Minimum length: 1 Maximum length: 200 """ BranchName: String """The order of the branch.""" BranchOrder: Int """ Portal item id of a web scene whose layers are shown as context layers when editing scenarios (only visible in the scenario). Maximum length: 32 """ ContextWebsceneItemId: PortalItemId """ Portal item id of an Elevation Layer. Maximum length: 32 """ CustomElevationLayerItemId: PortalItemId """Custom ID of the feature. Used to join fields in the data manager.""" CustomID: String """ Description for the branch shown in the scenario switcher. Maximum length: 700 """ Description: String """If `true`, the branch represents existing conditions.""" Existing: Boolean """If `true`, the branch is partially locked. Can be used by clients to prevent accidental editing of branches.""" Locked: Boolean """A polygon masking out existing buildings and existing trees.""" MaskingGeometry: PolygonInput """Array of Media Layer portal item ids with layer order.""" MediaLayers: [MediaLayerInput!] """ID of the urban event (plan or project) the branch (scenario) belongs to.""" UrbanEventID: GlobalID """ Portal item id of a web scene whose layers are added as visualization of the design in the scenario. The portal item can also be a single layer (e.g., SceneLayer). Maximum length: 32 """ WebsceneItemId: PortalItemId } input UpdateBranchInput { attributes: UpdateBranchAttributesInput! } """Input attributes for updating an existing building type.""" input UpdateBuildingTypeAttributesInput { """Unique identifier (UUID) of the feature.""" GlobalID: GlobalID! """List of parcel edges that the building is aligned to.""" Alignment: [BuildingAlignment!] """Building parts above ground.""" BuildingParts: [BuildingPartInput!] """Building parts below ground.""" BuildingSubParts: [BuildingPartInput!] """ Name of the building type. Minimum length: 1 Maximum length: 50 """ BuildingTypeName: String """Custom ID of the feature. Used to join fields in the data manager.""" CustomID: String """ Minimal floor area for the generated floors in [m2]. Minimum value: 0 """ FloorAreaMin: Float """ Maximum length of the generated footprint in [m]. Minimum value: 0 """ FootprintLengthMax: Float """Shape of the generated floors.""" FootprintShape: FootprintShape """ Maximum width of the generated footprint in [m]. Minimum value: 0 """ FootprintWidthMax: Float """ Number of dwelling units per area for parcels with multiple buildings in [units/m2]. Minimum value: 0 """ MultipleBuildingsDensity: Float """ Distance between dwelling units for parcels with multiple buildings in [m]. Minimum value: 0 """ MultipleBuildingsDistance: Float """If `true`, multiple buildings per parcel area enabled.""" MultipleBuildingsEnabled: Boolean """If `true`, the building type is proposed in the plan.""" Proposal: Boolean """ Minimum length of the generated building segments in [m]. Minimum value: 0 """ SegmentLengthMin: Float """ Minimum width of the generated building segments in [m]. Minimum value: 0 """ SegmentWidthMin: Float """ Index of the part where tower massing starts. Minimum value: 0 """ TowerIndex: Int """ID of the urban event (plan) the building type belongs to.""" UrbanEventID: GlobalID } input UpdateBuildingTypeInput { attributes: UpdateBuildingTypeAttributesInput! } """Input attributes for updating an existing criterion.""" input UpdateCriterionAttributesInput { """Unique identifier (UUID) of the feature.""" GlobalID: GlobalID! """Name of the criterion.""" CriterionName: String """Type of the criterion.""" CriterionType: CriterionType """Custom ID of the feature. Used to join fields in the data manager.""" CustomID: String """Whether the criterion is enabled in the calculation. When disabled, this criterion will not count towards the final score.""" Enabled: Boolean """Portal item id of an external layer.""" ExternalLayerItemId: String """Sublayer id of an external layer.""" ExternalSublayerId: Float """Attribute field to be used for the criterion.""" Field: String """GlobalID of the model.""" ModelID: GlobalID """Whether reclassification is enabled on this criterion. When enabled, numeric values will be reclassified with ReclassificationIntervals, while string and null values will be reclassified with ReclassificationMappings. When disabled, scores will be copied directly from the input features.""" ReclassificationEnabled: Boolean """Reclassification intervals used in this criterion to reclassify numeric values.""" ReclassificationIntervals: [ReclassificationIntervalInput!] """Map of (value, score) pairs used in this criterion to reclassify string and null values to a score.""" ReclassificationMappings: [ReclassificationMappingInput!] """Sampling geometry used to extract the criterion.""" SamplingGeometry: SamplingGeometry """When sampling values to calculate the final score, a parcel might match multiple input features resulting in multiple records. This field configures the method to combine multiple records on one parcel.""" SamplingMethod: SamplingMethod """ID of the urban event (plan) the criteria belongs to.""" UrbanEventID: GlobalID """ Weight of the criterion. Minimum value: 0 """ Weight: Float } input UpdateCriterionInput { attributes: UpdateCriterionAttributesInput! } input UpdateElevationProfileInput { elevationProfiles: [ElevationProfileParameterInput!]! attributes: UpdateAnalysisAttributesInput! } """Input attributes for updating an existing extended metric.""" input UpdateExtendedMetricAttributesInput { """Unique identifier (UUID) of the feature.""" GlobalID: GlobalID! """Custom ID of the feature. Used to join fields in the data manager.""" CustomID: String """The default value of a metric, e.g., of a parameter metric when no parameter is defined.""" DefaultValue: Float """ Description of the metric. Maximum length: 700 """ Description: String """The values to filter on for a filter metric.""" FilterValues: [String!] """The list of units of an extended metric in the denominator.""" FractionUnitTypes: [MetricUnitType!] """The x coordinate of the metric node on the metrics dependency graph.""" GraphX: Float """The y coordinate of the metric node on the metrics dependency graph.""" GraphY: Float """ Name of the metric. Maximum length: 100 """ MetricName: String """The resolution on which an extended metric should be calculated.""" MetricResolution: MetricResolution """The way in which calculated metric values are aggregated.""" MetricResultAggregation: MetricResultAggregation """The type of extended metric""" MetricType: MetricType """The rounding method to use when rounding this metric.""" NumberRoundingMethod: NumberRoundingMethod """If `true`, the metric is proposed in the plan.""" Proposal: Boolean """The list of units of an extended metric in the numerator.""" UnitTypes: [MetricUnitType!] """ID of the urban event (plan or project) the metric belongs to.""" UrbanEventID: GlobalID """The variable value of a metric.""" Value: Float } input UpdateExtendedMetricInput { attributes: UpdateExtendedMetricAttributesInput! inputs: [ExtendedMetricGraphEdgeInput!] } """Input attributes for updating an existing feedback category.""" input UpdateFeedbackCategoryAttributesInput { """Unique identifier (UUID) of the feature.""" GlobalID: GlobalID! """Order of the category.""" CategoryOrder: Int """Custom ID of the feature. Used to join fields in the data manager.""" CustomID: String """Description of the category.""" Description: String """Reference to the icon of the category that contains an image path and a color.""" Icon: FeedbackCategoryIcon """ Label of the category. Minimum length: 1 Maximum length: 20 """ Label: String } input UpdateFeedbackCategoryInput { attributes: UpdateFeedbackCategoryAttributesInput! } """Input attributes for updating an existing indicator.""" input UpdateIndicatorAttributesInput { """Unique identifier (UUID) of the feature.""" GlobalID: GlobalID! """Custom ID of the feature. Used to join fields in the data manager.""" CustomID: String """ Portal item id of an ArcGIS Dashboard which will be embedded in the detail card of the indicator. Maximum length: 32 """ DashboardItemId: PortalItemId """Description of the indicator (markdown enabled).""" Description: String """End date of the lifespan of the indicator.""" EndDate: Timestamp """If `true`, the indicator is featured and appears at the top of the list in the overview.""" Featured: Boolean """ Name of the indicator. Minimum length: 1 """ IndicatorName: String """Type of the indicator.""" IndicatorType: IndicatorType """Configuration of which layers are shown together with indicators and how.""" LayerSettings: LayerSettingsInput """Start date of the lifespan of the indicator.""" StartDate: Timestamp """ URL to a webpage. Shown in the detail card of the indicator. Maximum length: 255 """ WebpageUrl: String """ Portal item id of a web scene whose layers are added as visualization. The portal item can also be a single layer (e.g., SceneLayer). Maximum length: 32 """ WebsceneItemId: PortalItemId } input UpdateIndicatorInput { attributes: UpdateIndicatorAttributesInput! } """Input attributes for updating an existing lod1 building.""" input UpdateLOD1BuildingAttributesInput { """Unique identifier (UUID) of the feature.""" GlobalID: GlobalID! """ID of the branch the building belongs to.""" BranchID: GlobalID """Custom ID of the feature. Used to join fields in the data manager.""" CustomID: String """The extrusion height of the building in [m].""" Height: Float } input UpdateLOD1BuildingInput { attributes: UpdateLOD1BuildingAttributesInput! """3d geometry (xyz coordinates)""" geometry: PolygonInput } input UpdateLineOfSightInput { lineOfSights: [LineOfSightParameterInput!]! attributes: UpdateAnalysisAttributesInput! } """Input attributes for updating an existing metric.""" input UpdateMetricAttributesInput { """Unique identifier (UUID) of the feature.""" GlobalID: GlobalID! """Custom ID of the feature. Used to join fields in the data manager.""" CustomID: String """ Description of the metric. Maximum length: 700 """ Description: String """The x coordinate of the metric node on the metrics dependency graph.""" GraphX: Float """The y coordinate of the metric node on the metrics dependency graph.""" GraphY: Float """ Name of the metric. Maximum length: 100 """ MetricName: String """The rounding method to use when rounding this metric.""" NumberRoundingMethod: NumberRoundingMethod """Operation of the metric on how to aggregate the source metrics.""" Operation: Operation """If `true`, the metric is proposed in the plan.""" Proposal: Boolean """Unit type of the metric.""" UnitType: UnitType """ID of the urban event (plan or project) the metric belongs to.""" UrbanEventID: GlobalID } input UpdateMetricInput { attributes: UpdateMetricAttributesInput! } """Input attributes for updating an existing metric source.""" input UpdateMetricSourceAttributesInput { """Unique identifier (UUID) of the feature.""" GlobalID: GlobalID! """Custom ID of the feature. Used to join fields in the data manager.""" CustomID: String """ID of the metric that the metric source belongs to.""" MetricID: GlobalID """ID of the metric that the source points to if the source type is 'Metric'. Otherwise, this field is ignored.""" SourceMetricID: GlobalID """ Name of the metric source if the source type is anything other than 'Metric'. If source type is 'Metric', this field is ignored. Maximum length: 100 """ SourceName: String """Type of the metric source.""" SourceType: SourceType """ID of the urban event (plan) the metric source belongs to.""" UrbanEventID: GlobalID """Indicates whether the weight is applied as an inverse (1/n) in the calculation or as the actual number (n).""" WeightInverted: Boolean """ Name of the parameter that is used as a weight. If type is 'Constant', this field is ignored. Maximum length: 100 """ WeightName: String """Type of weight that is used for the metric calculation.""" WeightType: WeightType """Value for the parameter if the weight type is 'Constant'.""" WeightValue: Float } input UpdateMetricSourceInput { attributes: UpdateMetricSourceAttributesInput! } """Input attributes for updating an existing metric value.""" input UpdateMetricValueAttributesInput { """Unique identifier (UUID) of the feature.""" GlobalID: GlobalID! """ID of the branch the metric value belongs to.""" BranchID: GlobalID """Custom ID of the feature. Used to join fields in the data manager.""" CustomID: String """ID of the referenced metric. Plans reference metrics in the urban design database of the plan. Projects reference metrics in the urban database of the Urban Model.""" MetricID: GlobalID """The version of metrics this object belongs to.""" MetricVersion: MetricVersion """Metric value that is stored on the point.""" Value: Float } input UpdateMetricValueInput { attributes: UpdateMetricValueAttributesInput! """3d geometry (xyz coordinates)""" geometry: PointInput } """Input attributes for updating an existing overlay.""" input UpdateOverlayAttributesInput { """Unique identifier (UUID) of the feature.""" GlobalID: GlobalID! """ID of the branch the overlay belongs to.""" BranchID: GlobalID """ Maximum allowed coverage in percentage. Minimum value: 0 Maximum value: 1 """ CoverageMax: Float """Custom ID of the feature. Used to join fields in the data manager.""" CustomID: String """Description of the overlay.""" Description: String """ Maximum allowed dwelling units per area in [units/m2]. Minimum value: 0 Maximum value: 200000 """ DwellingUnitsPerAreaMax: Float """Parameter values for different metrics.""" ExtendedMetricParameters: [ExtendedMetricParameterInput!] """ Maximum allowed floor area ratio. Minimum value: 0 Maximum value: 500 """ FARMax: Float """ Maximum allowed height in [m]. Minimum value: 0 Maximum value: 1000 """ HeightMax: Float """Label of the overlay.""" Label: String """ Maximum allowed number of floors. Minimum value: 0 Maximum value: 200 """ NumFloorsMax: Int """ID of the overlay type the overlay belongs to.""" OverlayTypeID: GlobalID """Array containing skyplanes.""" Skyplanes: [SkyplaneInput!] """ Maximum allowed substructure depth in [m]. Minimum value: 0 Maximum value: 1000 """ SubstructureDepthMax: Float """An array of tiers and their allowed setbacks in [m].""" Tiers: [TierInput!] } input UpdateOverlayInput { attributes: UpdateOverlayAttributesInput! """2d geometry (xy coordinates)""" geometry: PolygonInput } """Input attributes for updating an existing overlay type.""" input UpdateOverlayTypeAttributesInput { """Unique identifier (UUID) of the feature.""" GlobalID: GlobalID! """Hex color of the zone type or overlay.""" Color: Color """Custom ID of the feature. Used to join fields in the data manager.""" CustomID: String """JSON object containing the configuration of the overlay types.""" FieldsConfig: FieldsConfigInput """Fill style of the zone type or overlay.""" FillStyle: FillStyle """Label shown on the overlay geometry.""" Label: OverlayTypeLabel """Outline style of the zone type or overlay.""" OutlineStyle: OutlineStyle """Name of the overlay type.""" OverlayTypeName: String """The order of the overlay type. Defines the order in which the overlay types are displayed in the legend (and applied if relevant).""" OverlayTypeOrder: Int """If `true`, the overlay type is proposed in the plan.""" Proposal: Boolean """ID of the urban event (plan) the overlay type belongs to.""" UrbanEventID: GlobalID } input UpdateOverlayTypeInput { attributes: UpdateOverlayTypeAttributesInput! } """Input attributes for updating an existing parcel.""" input UpdateParcelAttributesInput { """Unique identifier (UUID) of the feature.""" GlobalID: GlobalID! """ID of the branch the parcel belongs to.""" BranchID: GlobalID """ID of the building type the parcel is assigned to for the generation of future buildings.""" BuildingTypeID: GlobalID """ Maximum allowed coverage in percentage. Minimum value: 0 Maximum value: 1 """ CoverageMax: Float """Custom ID of the feature. Used to join fields in the data manager.""" CustomID: String """If `true`, the parcel is being demolished.""" Demolish: Boolean """The type of development on the parcel.""" DevelopmentType: DevelopmentType """ Maximum allowed dwelling units per area in [units/m2]. Minimum value: 0 Maximum value: 200000 """ DwellingUnitsPerAreaMax: Float """An array of parcel edges and their edge information.""" EdgeInfos: [EdgeInfoInput!] """Parameter values for different metrics.""" ExtendedMetricParameters: [ExtendedMetricParameterInput!] """ Maximum allowed floor area ratio. Minimum value: 0 Maximum value: 500 """ FARMax: Float """Area in [m2] of the parcel ground that is not overlapped by spaces. Is `null` if no `GroundSpaceUseTypeID is defined.`""" GroundArea: Float """ID of the space use type assigned to the parcel ground.""" GroundSpaceUseTypeID: GlobalID """ Maximum allowed height in [m]. Minimum value: 0 Maximum value: 1000 """ HeightMax: Float """ Maximum allowed number of floors. Minimum value: 0 Maximum value: 200 """ NumFloorsMax: Int """Array containing skyplanes.""" Skyplanes: [SkyplaneInput!] """ Maximum allowed substructure depth in [m]. Minimum value: 0 Maximum value: 1000 """ SubstructureDepthMax: Float """An array of tiers and their allowed setbacks in [m].""" Tiers: [TierInput!] } input UpdateParcelInput { attributes: UpdateParcelAttributesInput! """2d geometry (xy coordinates)""" geometry: PolygonInput } """Input attributes for updating an existing plan.""" input UpdatePlanAttributesInput { """Unique identifier (UUID) of the feature.""" GlobalID: GlobalID! """Address of the urban event.""" Address: String """ Portal item id of a web scene whose layers are shown as context layers when editing a plan or project (visible for all scenarios). Maximum length: 32 """ ContextWebsceneItemId: PortalItemId """Custom ID of the feature. Used to join fields in the data manager.""" CustomID: String """Description of the urban event (markdown enabled).""" Description: String """End date of the urban event.""" EndDate: Timestamp """ Name of the urban event. Minimum length: 1 """ EventName: String """If `true`, the urban event is featured and appears at the top of the list in the overview.""" Featured: Boolean """The version of metrics displayed in the dashboard of a plan.""" MetricVersion: MetricVersion """Settings for the charts in the metrics dashboard.""" MetricsDashboardCharts: [MetricsDashboardChartInput!] """The planning method of the plan.""" PlanningMethod: UrbanEventPlanningMethod """ Start date of the urban event. Minimum value: 0 """ StartDate: Timestamp """ID of the status type associated with the urban event.""" Status: GlobalID """Image (blob) to be displayed in the overview card.""" Thumbnail: String """ URL to a webpage. Shown in the detail card of the urban event. Maximum length: 255 """ WebpageUrl: String } input UpdatePlanInput { attributes: UpdatePlanAttributesInput! """2d geometry (xy coordinates)""" geometry: PolygonInput } """Input attributes for updating an existing point symbol.""" input UpdatePointSymbolAttributesInput { """Unique identifier (UUID) of the feature.""" GlobalID: GlobalID! """ID of the branch the symbol belongs to.""" BranchID: GlobalID """Custom ID of the feature. Used to join fields in the data manager.""" CustomID: String """The depth of the symbol in [m].""" Depth: Float """The heading of the symbol in [deg].""" Heading: Float """The height of the symbol in [m].""" Height: Float """URL of the symbol.""" ResourceHref: String """Style of the symbol.""" SymbolStyle: PointSymbolStyle """The width of the symbol in [m].""" Width: Float } input UpdatePointSymbolInput { attributes: UpdatePointSymbolAttributesInput! """2d geometry (xy coordinates)""" geometry: PointInput } """Input attributes for updating an existing polygon symbol.""" input UpdatePolygonSymbolAttributesInput { """Unique identifier (UUID) of the feature.""" GlobalID: GlobalID! """ID of the branch the symbol belongs to.""" BranchID: GlobalID """Custom ID of the feature. Used to join fields in the data manager.""" CustomID: String """Style of the symbol.""" SymbolStyle: PolygonSymbolStyle } input UpdatePolygonSymbolInput { attributes: UpdatePolygonSymbolAttributesInput! """2d geometry (xy coordinates)""" geometry: PolygonInput } """Input attributes for updating an existing project.""" input UpdateProjectAttributesInput { """Unique identifier (UUID) of the feature.""" GlobalID: GlobalID! """Address of the urban event.""" Address: String """ Portal item id of a web scene whose layers are shown as context layers when editing a plan or project (visible for all scenarios). Maximum length: 32 """ ContextWebsceneItemId: PortalItemId """Custom ID of the feature. Used to join fields in the data manager.""" CustomID: String """Description of the urban event (markdown enabled).""" Description: String """End date of the urban event.""" EndDate: Timestamp """ Name of the urban event. Minimum length: 1 """ EventName: String """If `true`, the urban event is featured and appears at the top of the list in the overview.""" Featured: Boolean """Settings for the charts in the metrics dashboard.""" MetricsDashboardCharts: [MetricsDashboardChartInput!] """ Portal item id of a 3D Object Scene Layer. Maximum length: 32 """ ObjectSceneLayerItemId: PortalItemId """The Global ID of the scenario to show in overview visualizations.""" OverviewVisualizationBranchId: GlobalID """ Start date of the urban event. Minimum value: 0 """ StartDate: Timestamp """ID of the status type associated with the urban event.""" Status: GlobalID """Image (blob) to be displayed in the overview card.""" Thumbnail: String """ URL to a webpage. Shown in the detail card of the urban event. Maximum length: 255 """ WebpageUrl: String } input UpdateProjectInput { attributes: UpdateProjectAttributesInput! """2d geometry (xy coordinates)""" geometry: PolygonInput } input UpdateShadowcastInput { shadowcasts: [ShadowcastParameterInput!]! attributes: UpdateAnalysisAttributesInput! } """Input attributes for updating an existing space.""" input UpdateSpaceAttributesInput { """Unique identifier (UUID) of the feature.""" GlobalID: GlobalID! """ID of the branch the space belongs to.""" BranchID: GlobalID """Building number the space belongs to.""" BuildingNumber: Int """Custom ID of the feature. Used to join fields in the data manager.""" CustomID: String """The development status of the space.""" DevelopmentStatus: DevelopmentStatus """ Floor height of the space in [m]. Minimum value: 0 """ FloorHeight: Float """Floor number the space belongs to.""" FloorNumber: Int """If `true`, the space should be excluded from GFA / FAR calculations.""" GFAIgnore: Boolean """ID of the parcel the space belongs to.""" ParcelID: GlobalID """ Type of space. Maximum length: 100 """ SpaceType: SpaceType """ID of the space use type that is assigned to the space. This is used for coloring the space, aggregating space use areas, and calculating capacity metrics.""" SpaceUseTypeID: GlobalID } input UpdateSpaceInput { attributes: UpdateSpaceAttributesInput! """3d geometry (xyz coordinates)""" geometry: PolygonInput } """Input attributes for updating an existing space use type.""" input UpdateSpaceUseTypeAttributesInput { """Unique identifier (UUID) of the feature.""" GlobalID: GlobalID! """ Gross floor area taken up by an average household in the space use type, used for assessing the size of a dwelling unit in [m2]. Minimum value: 0.01 """ AreaPerHousehold: Float """Hex color of the space use type.""" Color: Color """Custom ID of the feature. Used to join fields in the data manager.""" CustomID: String """Parameter values for different metrics.""" ExtendedMetricParameters: [ExtendedMetricParameterInput!] """ Floor height of the space use type in [m]. Minimum value: 0 """ FloorHeight: Float """ Label of the space use type. Minimum length: 1 Maximum length: 10 """ Label: String """Metric parameter values (e.g., weights) for a Metric that uses spaces as a data source.""" MetricParameters: [MetricParameterInput!] """ Factor that reduces the total floor area used for capacity indicator calculations. Minimum value: 0 Maximum value: 1 """ NetAreaFactor: Float """If `true`, the space use type is proposed in the plan.""" Proposal: Boolean """If `true`, the space use type is residential and therefore can be used in dwelling units.""" SingleUseOnly: Boolean """ Name of the space use type. Minimum length: 1 Maximum length: 100 """ SpaceUseTypeName: String """The order of the space use type. Defines the order in which the space use types are displayed in the legend.""" SpaceUseTypeOrder: Int """ID of the urban event (plan) the space use type belongs to.""" UrbanEventID: GlobalID } input UpdateSpaceUseTypeInput { attributes: UpdateSpaceUseTypeAttributesInput! } """Input attributes for updating an existing status type.""" input UpdateStatusTypeAttributesInput { """Unique identifier (UUID) of the feature.""" GlobalID: GlobalID! """Custom ID of the feature. Used to join fields in the data manager.""" CustomID: String """Description of the status.""" Description: String """Reference to the icon of the status that contains an image path and a color.""" Icon: StatusTypeIcon """ Label of the status. Minimum length: 1 Maximum length: 20 """ Label: String """Order of the status.""" StatusOrder: Int } input UpdateStatusTypeInput { attributes: UpdateStatusTypeAttributesInput! } input UpdateSuitabilityInput { suitabilityParameters: [SuitabilityParameterInput!]! attributes: UpdateAnalysisAttributesInput! } """Input attributes for updating an existing suitability model.""" input UpdateSuitabilityModelAttributesInput { """Unique identifier (UUID) of the feature.""" GlobalID: GlobalID! """Custom ID of the feature. Used to join fields in the data manager.""" CustomID: String """Description""" Description: String """Name of the model.""" ModelName: String """If `true`, the model is proposed in the plan.""" Proposal: Boolean """ID of the urban event (plan) the model belongs to.""" UrbanEventID: GlobalID } input UpdateSuitabilityModelInput { attributes: UpdateSuitabilityModelAttributesInput! } input UpdateSunlightInput { sunlights: [SunlightParameterInput!]! attributes: UpdateAnalysisAttributesInput! } input UpdateUrbanModelConfigInput { """Portal item id of a web scene containing custom baselayers.""" customBaselayersItemId: PortalItemId """Portal item id of a Web Map containing a custom basemap.""" customBasemapItemId: PortalItemId """Portal item id of an Elevation Layer.""" customElevationLayerItemId: PortalItemId """Portal item id of a Web Map containing a custom satellite basemap.""" customSatelliteBasemapItemId: PortalItemId """Display configuration for types and layers.""" displayConfig: DisplayConfigInput """Portal item id of a Scene Layer containing existing buildings.""" existingBuildingsLayerItemId: PortalItemId """Portal item id of a Scene Layer containing existing buildings with realistic textures.""" existingSatelliteBuildingsLayerItemId: PortalItemId """Portal item id of a Scene Layer containing realistic existing trees to be used in imagery visualization.""" existingSatelliteTreesLayerItemId: PortalItemId """Portal item id of a Scene Layer containing existing trees.""" existingTreesLayerItemId: PortalItemId """The Hub annotation layer that contains public feedback.""" hubAnnotationsLayerItemId: PortalItemId """The initial camera viewpoint.""" initialCamera: InitialCameraInput """Type of visualization of the basemap and the existing buildings that is used on initial load of the application.""" initialVisualizationStyle: InitialVisualizationStyle """URL to the city logo.""" logoUrl: String """Name of the city.""" name: String """Selection of default or custom satellite (realistic) visualization.""" satelliteVisualization: SatelliteVisualization """Selection of default or custom schematic visualization.""" schematicVisualization: SchematicVisualization """Street-view configuration.""" streetview: StreetviewInput } """Input attributes for updating an existing viewpoint.""" input UpdateViewpointAttributesInput { """Unique identifier (UUID) of the feature.""" GlobalID: GlobalID! """Custom ID of the feature. Used to join fields in the data manager.""" CustomID: String """ Heading of the camera. Minimum value: 0 Maximum value: 360 """ Heading: Float """ Tilt of the camera. Minimum value: 0 Maximum value: 180 """ Tilt: Float """ID of the urban event (plan or project) the viewpoint belongs to.""" UrbanEventID: GlobalID """ Name of the viewpoint. Minimum length: 1 """ ViewpointName: String """The order of the viewpoint.""" ViewpointOrder: Int } input UpdateViewpointInput { attributes: UpdateViewpointAttributesInput! """3d geometry (xyz coordinates)""" geometry: PointInput } input UpdateViewshedInput { viewsheds: [ViewshedParameterInput!]! attributes: UpdateAnalysisAttributesInput! } """Input attributes for updating an existing zone.""" input UpdateZoneAttributesInput { """Unique identifier (UUID) of the feature.""" GlobalID: GlobalID! """ID of the branch the zone belongs to.""" BranchID: GlobalID """Custom ID of the feature. Used to join fields in the data manager.""" CustomID: String """The planning horizon of the zone.""" PlanningHorizon: ZonePlanningHorizon """The planning method of the zone.""" PlanningMethod: ZonePlanningMethod """ID of the zone type the zone is assigned to.""" ZoneTypeID: GlobalID } input UpdateZoneInput { attributes: UpdateZoneAttributesInput! """2d geometry (xy coordinates)""" geometry: PolygonInput } """Input attributes for updating an existing zone type.""" input UpdateZoneTypeAttributesInput { """Unique identifier (UUID) of the feature.""" GlobalID: GlobalID! """An array of allowed space use types and their distributions.""" AllowedSpaceUseTypes: [AllowedSpaceUseTypeInput!] """Hex color of the zone type or overlay.""" Color: Color """ Maximum allowed coverage in percentage. Minimum value: 0 Maximum value: 1 """ CoverageMax: Float """Custom ID of the feature. Used to join fields in the data manager.""" CustomID: String """Description of the zone type.""" Description: String """ Maximum allowed dwelling units per area in [units/m2]. Minimum value: 0 Maximum value: 200000 """ DwellingUnitsPerAreaMax: Float """Parameter values for different metrics.""" ExtendedMetricParameters: [ExtendedMetricParameterInput!] """ Maximum allowed floor area ratio. Minimum value: 0 Maximum value: 500 """ FARMax: Float """Fill style of the zone type or overlay.""" FillStyle: FillStyle """ Maximum allowed height in [m]. Minimum value: 0 Maximum value: 1000 """ HeightMax: Float """ Label of the zone type. Minimum length: 1 Maximum length: 20 """ Label: String """ Factor that reduces the total zone area used for capacity indicator calculations. Minimum value: 0 Maximum value: 1 """ NetAreaFactor: Float """ Maximum allowed number of floors. Minimum value: 0 Maximum value: 200 """ NumFloorsMax: Int """Outline style of the zone type or overlay.""" OutlineStyle: OutlineStyle """The planning method of the zone type.""" PlanningMethod: ZoneTypePlanningMethod """If `true`, the zone type is proposed in the plan.""" Proposal: Boolean """Array containing skyplanes.""" Skyplanes: [SkyplaneInput!] """ Maximum allowed substructure depth in [m]. Minimum value: 0 Maximum value: 1000 """ SubstructureDepthMax: Float """An array of tiers and their allowed setbacks in [m].""" Tiers: [TierInput!] """ID of the urban event (plan) the zone type belongs to.""" UrbanEventID: GlobalID """Name of the zone type.""" ZoneTypeName: String """The order of the zone type. Defines the order in which the zone types are displayed in the legend.""" ZoneTypeOrder: Int } input UpdateZoneTypeInput { attributes: UpdateZoneTypeAttributesInput! } type UpgradeInfo { """Status of the upgrade.""" upgradeStatus: UpgradeStatus! """Additional message providing more detail about the upgrade status.""" message: String } """ **Ready**: The urban model or urban design database is up to date. An upgrade is not required. **InProgress**: The urban model or urban design database is currently being upgraded. The status will change to `Ready` once the upgrade is finished. **UpgradeAvailable**: An upgrade is available. **ServiceUnavailable**: The upgrade failed due to a server error. The `message` field might contain additional information. **Invalid**: The urban model or urban design database cannot be upgraded. The `message` field might contain additional information. """ enum UpgradeStatus { Ready InProgress UpgradeAvailable ServiceUnavailable Invalid } type UpgradeUrbanDesignDatabaseResult { upgradeInfo: UpgradeInfo! } type UpgradeUrbanModelResult { upgradeInfo: UpgradeInfo! } """The `Upload` scalar type represents a file upload.""" scalar Upload type UrbanDatabase { """Sharing level of the urban database item.""" access: AccessLevel! """ Buildings types in the urban database. See [Building types](https://doc.arcgis.com/en/urban/data/data-manager-types.htm#ESRI_SECTION1_BB8E3A8E309C4F45B6F837A07E9D2453). """ buildingTypes(filter: BuildingTypeFilterInput, paging: PagingInput): [BuildingType]! """Counts, aggregates, and other information about the building types in the urban database.""" buildingTypesMeta(filter: BuildingTypeFilterInput): BuildingTypesMeta! """ Categories for feedback comments. See [Feedback categories](https://doc.arcgis.com/en/urban/data/data-manager-types.htm#ESRI_SECTION1_ADD83BFD80F541559960A47C0706C7A3). """ feedbackCategories(filter: FeedbackCategoryFilterInput, paging: PagingInput): [FeedbackCategory]! """Counts, aggregates, and other information about the feedback categories in the urban database.""" feedbackCategoriesMeta(filter: FeedbackCategoryFilterInput): FeedbackCategoriesMeta! """Portal item id of the urban database (view). Provides read-only access to the data. Use this id to query the data.""" id: PortalItemId! """ Indicators in the urban database. See [Work with indicators](https://doc.arcgis.com/en/urban/help/help-custom-indicators.htm). """ indicators(filter: IndicatorFilterInput, paging: PagingInput): [Indicator]! """Counts, aggregates, and other information about the indicators in the urban database.""" indicatorsMeta(filter: IndicatorFilterInput): IndicatorsMeta! """ Low level of detail (LOD1) schematic buildings in the urban database. See [Develop a parcel](https://doc.arcgis.com/en/urban/help/help-parcel-redevelopment.htm). """ lod1Buildings(filter: LOD1BuildingFilterInput, geometryFilter: GeometryFilterInput, paging: PagingInput): [LOD1Building]! """Counts, aggregates, and other information about the low level-of-detail buildings in the urban database.""" lod1BuildingsMeta(filter: LOD1BuildingFilterInput, geometryFilter: GeometryFilterInput): LOD1BuildingsMeta! """ Extended Metrics defined in the urban database. See [Manage metrics](https://doc.arcgis.com/en/urban/data/data-manager-metrics.htm). """ extendedMetrics(filter: ExtendedMetricFilterInput, paging: PagingInput): [ExtendedMetric]! """ Metrics defined in the urban database. See [Manage metrics](https://doc.arcgis.com/en/urban/data/data-manager-metrics.htm). """ metrics(filter: MetricFilterInput, paging: PagingInput): [Metric]! """Counts, aggregates, and other information about the metrics in the urban database.""" metricsMeta(filter: MetricFilterInput): MetricsMeta! """ Sources for metrics in the urban database. See [Manage metrics](https://doc.arcgis.com/en/urban/data/data-manager-metrics.htm). """ metricSources(filter: MetricSourceFilterInput, paging: PagingInput): [MetricSource]! """Counts, aggregates, and other information about the metric sources in the urban database.""" metricSourcesMeta(filter: MetricSourceFilterInput): MetricSourcesMeta! """ Metric values in the urban database. See [Manage metrics](https://doc.arcgis.com/en/urban/data/data-manager-metrics.htm). """ metricValues(filter: MetricValueFilterInput, geometryFilter: GeometryFilterInput, paging: PagingInput): [MetricValue]! """Counts, aggregates, and other information about the metric values in the urban database.""" metricValuesMeta(filter: MetricValueFilterInput): MetricValuesMeta! """ Overlays in the urban database. See [Create an overlay](https://doc.arcgis.com/en/urban/help/help-create-zoning-overlay.htm). """ overlays(filter: OverlayFilterInput, geometryFilter: GeometryFilterInput, paging: PagingInput): [Overlay]! """Counts, aggregates, and other information about the overlays in the urban database.""" overlaysMeta(filter: OverlayFilterInput, geometryFilter: GeometryFilterInput): OverlaysMeta! """ Overlay types in the urban database. See [Create an overlay](https://doc.arcgis.com/en/urban/help/help-create-zoning-overlay.htm). """ overlayTypes(filter: OverlayTypeFilterInput, paging: PagingInput): [OverlayType]! """Counts, aggregates, and other information about the overlay types in the urban database.""" overlayTypesMeta(filter: OverlayTypeFilterInput): OverlayTypesMeta! """ArcGIS account username of the user who owns the urban database.""" owner: String! """ Parcels in the urban database. See [Add and edit parcels](https://doc.arcgis.com/en/urban/help/help-edit-parcels.htm). """ parcels(filter: ParcelFilterInput, geometryFilter: GeometryFilterInput, paging: PagingInput): [Parcel]! """Counts, aggregates, and other information about the parcels in the urban database.""" parcelsMeta(filter: ParcelFilterInput, geometryFilter: GeometryFilterInput): ParcelsMeta! """ Point symbols representing trees, vehicles, and other urban furniture in the urban database. See [Edit a project](https://doc.arcgis.com/en/urban/help/help-edit-project.htm). """ pointSymbols(filter: PointSymbolFilterInput, geometryFilter: GeometryFilterInput, paging: PagingInput): [PointSymbol]! """Counts, aggregates, and other information about point symbols in the urban database.""" pointSymbolsMeta(filter: PointSymbolFilterInput, geometryFilter: GeometryFilterInput): PointSymbolsMeta! """ Polygon symbols representing grass, concrete, water, or other surface layers in the urban database. See [Edit a project](https://doc.arcgis.com/en/urban/help/help-edit-project.htm). """ polygonSymbols(filter: PolygonSymbolFilterInput, geometryFilter: GeometryFilterInput, paging: PagingInput): [PolygonSymbol]! """Counts, aggregates, and other information about the polygon symbols in the urban database.""" polygonSymbolsMeta(filter: PolygonSymbolFilterInput, geometryFilter: GeometryFilterInput): PolygonSymbolsMeta! """ Projects in the urban database. See [Create a project](https://doc.arcgis.com/en/urban/help/help-create-project.htm). """ projects(filter: ProjectFilterInput, geometryFilter: GeometryFilterInput, paging: PagingInput, sort: [ProjectSortInput!]): [Project]! """Counts, aggregates, and other information about the projects in the urban database.""" projectsMeta(filter: ProjectFilterInput, geometryFilter: GeometryFilterInput): ProjectsMeta! """ Space-use types in the urban database. See [Space-use types](https://doc.arcgis.com/en/urban/data/data-manager-types.htm#ESRI_SECTION1_C30D73392D964D51A8B606128A8A6E8F). """ spaceUseTypes(filter: SpaceUseTypeFilterInput, paging: PagingInput): [SpaceUseType]! """Counts, aggregates, and other information about the space-use types in the urban database.""" spaceUseTypesMeta(filter: SpaceUseTypeFilterInput): SpaceUseTypesMeta! """ Project status types defined in the urban database. See [Project status types](https://doc.arcgis.com/en/urban/data/data-manager-types.htm#ESRI_SECTION1_B937885446E34EB381FFF216E56AAA70). """ statusTypes(filter: StatusTypeFilterInput, paging: PagingInput): [StatusType]! """Counts, aggregates, and other information about the project status types in the urban database.""" statusTypesMeta(filter: StatusTypeFilterInput): StatusTypesMeta! """Source URL for the feature service.""" url: String! """ Zones in the urban database. See [Zoning types](https://doc.arcgis.com/en/urban/data/data-manager-types.htm#ESRI_SECTION1_87E11F381BC94CC38639042C7B1331A0). """ zones(filter: ZoneFilterInput, geometryFilter: GeometryFilterInput, paging: PagingInput): [Zone]! """Counts, aggregates, and other information about the zones in the urban database.""" zonesMeta(filter: ZoneFilterInput, geometryFilter: GeometryFilterInput): ZonesMeta! """ Zoning types in the urban database. See [Zoning Types](https://doc.arcgis.com/en/urban/data/data-manager-types.htm#ESRI_SECTION1_87E11F381BC94CC38639042C7B1331A0). """ zoneTypes(filter: ZoneTypeFilterInput, paging: PagingInput): [ZoneType]! """Counts, aggregates, and other information about the zoning types in the urban database.""" zoneTypesMeta(filter: ZoneTypeFilterInput): ZoneTypesMeta! } """A design that planners are currently working on. Stored as a feature service in the portal. Contains a plan or a project.""" type UrbanDesignDatabase { """Sharing level of the urban design database item.""" access: AccessLevel! """Creation date of the urban design database.""" created: Timestamp! """Description of the urban design database.""" description: String """Geographic extent of the urban design database.""" extent: Extent """Id of the folder in which the urban design database is stored.""" folderId: PortalItemId """Id of the urban design database.""" id: PortalItemId! """Date of the last urban design database modification.""" modified: Timestamp! """Number of views.""" numViews: Int! """ArcGIS account username of the user who owns the urban design database.""" owner: String! """ Plans in the urban design database. See [Create a plan](https://doc.arcgis.com/en/urban/help/help-create-plan.htm). """ plans(filter: PlanFilterInput, geometryFilter: GeometryFilterInput, paging: PagingInput, sort: [PlanSortInput!]): [Plan] """Counts, aggregates, and other information about plans in the urban design database.""" plansMeta(filter: PlanFilterInput, geometryFilter: GeometryFilterInput): PlansMeta! """ Projects in the urban design database. See [Create a project](https://doc.arcgis.com/en/urban/help/help-create-project.htm). """ projects(filter: ProjectFilterInput, geometryFilter: GeometryFilterInput, paging: PagingInput, sort: [ProjectSortInput!]): [Project] """Counts, aggregates, and other information about projects in the urban design database.""" projectsMeta(filter: ProjectFilterInput, geometryFilter: GeometryFilterInput): ProjectsMeta! """Information about the upgrade status of the urban design database.""" upgradeInfo: UpgradeInfo """ Spatial reference used for the data's horizontal (xy) coordinates. See: [https://developers.arcgis.com/rest/services-reference/using-spatial-references.htm](https://developers.arcgis.com/rest/services-reference/using-spatial-references.htm) By default, Urban uses a gravity-related height model for the data's vertical (z) coordinate. See: [https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-HeightModelInfo.html#heightModel](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-HeightModelInfo.html#heightModel). Other vertical spatial references are currently not supported in Urban. """ spatialReference: SpatialReference! """URL of an image suitable for display, for example overview cards.""" thumbnail(size: ThumbnailSize): String """ Title of the urban design database. Maximum length: 232 """ title: String! """Id of the urban model to which the urban design database belongs.""" urbanModelId: PortalItemId! """URL of the urban design database feature service.""" url: String! """Version of the urban design database.""" version: String } type UrbanDesignDatabasesMeta { """The number of urban design databases.""" count: Int } """ **Zoning**: Planning method of the plan is zoning. **LandUse**: Planning method of the plan is land use. """ enum UrbanEventPlanningMethod { Zoning LandUse } """An urban model represents a city. Stored as an Urban Model item in the portal.""" type UrbanModel { """Sharing level of the urban model item.""" access: AccessLevel! """Configuration settings stored for the urban model.""" config: UrbanModelConfig """Creation date of the urban model.""" created: Timestamp! """Description of the urban model.""" description: String """Geographic extent of the urban model.""" extent: Extent """Id of the folder in which the urban model is stored.""" folderId: PortalItemId """Id of the urban model.""" id: PortalItemId! """Date of the last urban model modification.""" modified: Timestamp! """Number of views.""" numViews: Int! """ArcGIS account username of the user who owns the urban model.""" owner: String! """ Spatial reference used for the data's horizontal (xy) coordinates. See: [https://developers.arcgis.com/rest/services-reference/using-spatial-references.htm](https://developers.arcgis.com/rest/services-reference/using-spatial-references.htm) By default, Urban uses a gravity-related height model for the data's vertical (z) coordinate. See: [https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-HeightModelInfo.html#heightModel](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-HeightModelInfo.html#heightModel). Other vertical spatial references are currently not supported in Urban. """ spatialReference: SpatialReference! """URL of an image suitable for display, for example overview cards.""" thumbnail(size: ThumbnailSize): String """ Title of the urban model. Maximum length: 232 """ title: String! """Urban database of the urban model.""" urbanDatabase(admin: Boolean = false): UrbanDatabase """Id of the urban database. Provides write access to the data. Use this id to create, update, or delete the data through mutations.""" urbanDatabaseId: PortalItemId! """Id of the urban database (view). Provides read-only access to the data. Use this id to query the data.""" urbanDatabaseViewId: PortalItemId! """Urban design databases of the urban model.""" urbanDesignDatabases(extent: Extent, title: String, groupIds: [PortalItemId!], organizationId: OrganizationId, owners: [String!], limit: Int = 10, offset: Int = 1, sort: PortalItemSortInput): [UrbanDesignDatabase!] """Information about the upgrade status of the urban model.""" upgradeInfo: UpgradeInfo """Version of the urban model.""" version: String } """Configuration settings stored for the urban model.""" type UrbanModelConfig { """Portal item id of a web scene containing custom baselayers.""" customBaselayersItemId: PortalItemId """Portal item id of a Web Map containing a custom basemap.""" customBasemapItemId: PortalItemId """Portal item id of an Elevation Layer.""" customElevationLayerItemId: PortalItemId """Portal item id of a Web Map containing a custom satellite basemap.""" customSatelliteBasemapItemId: PortalItemId """Display configuration for types and layers.""" displayConfig: DisplayConfig """Portal item id of a Scene Layer containing existing buildings.""" existingBuildingsLayerItemId: PortalItemId """Portal item id of a Scene Layer containing existing buildings with realistic textures.""" existingSatelliteBuildingsLayerItemId: PortalItemId """Portal item id of a Scene Layer containing realistic existing trees to be used in imagery visualization.""" existingSatelliteTreesLayerItemId: PortalItemId """Portal item id of a Scene Layer containing existing trees.""" existingTreesLayerItemId: PortalItemId """The Hub annotation layer that contains public feedback.""" hubAnnotationsLayerItemId: PortalItemId """The initial camera viewpoint.""" initialCamera: InitialCamera """Type of visualization of the basemap and the existing buildings that is used on initial load of the application.""" initialVisualizationStyle: InitialVisualizationStyle! """URL to the city logo.""" logoUrl: String """Name of the city.""" name: String """Selection of default or custom satellite (realistic) visualization.""" satelliteVisualization: SatelliteVisualization! """Selection of default or custom schematic visualization.""" schematicVisualization: SchematicVisualization! """Street-view configuration.""" streetview: Streetview } type UrbanModelsMeta { """The number of urban models.""" count: Int } """A viewpoint is a 3D point with a title and a camera position.""" type Viewpoint { attributes: ViewpointAttributes! """3d geometry (xyz coordinates)""" geometry: Point } """Attributes of the viewpoint.""" type ViewpointAttributes { """Unique identifier (UUID) of the feature.""" GlobalID: GlobalID! """Custom ID of the feature. Used to join fields in the data manager.""" CustomID: String """Heading of the camera.""" Heading: Float! """Tilt of the camera.""" Tilt: Float! """ID of the urban event (plan or project) the viewpoint belongs to.""" UrbanEventID: GlobalID """Name of the viewpoint.""" ViewpointName: String! """The order of the viewpoint.""" ViewpointOrder: Int! """The last recorded edit.""" LastEdit: LastEdit } """Filters which can be applied to viewpoint queries.""" input ViewpointFilterInput { globalIDs: [GlobalID!] customIds: [String!] headings: [Float!] headingIsLessThan: Float headingIsGreaterThan: Float tilts: [Float!] tiltIsLessThan: Float tiltIsGreaterThan: Float urbanEventIds: [GlobalID!] viewpointNames: [String!] viewpointOrders: [Int!] viewpointOrderIsLessThan: Int viewpointOrderIsGreaterThan: Int } type ViewpointsMeta implements FeaturesMeta { """The number of viewpoints.""" count: Int """Last recorded edit made to viewpoints""" lastEdit: LastEditMeta } type Viewshed { viewsheds: [ViewshedParameter!]! } """Parameters defining one viewshed analysis.""" type ViewshedParameter { """The maximum distance from the observer in which to perform viewshed analysis.""" farDistance: Float! """The compass heading of the observer view direction, from the north and increasing clock-wise.""" heading: Float! """Angle defining the width of the scope being analyzed.""" horizontalFieldOfView: Float! """The name that identifies this viewshed analysis.""" name: String! """Observer location (point) of the viewshed analysis.""" observer: Point! """The tilt of the observer view direction, a tilt of 0 is when looking straight down and 90 is when looking parallel to the surface.""" tilt: Float! """Angle defining the height of the scope being analyzed.""" verticalFieldOfView: Float! } input ViewshedParameterInput { """The maximum distance from the observer in which to perform viewshed analysis.""" farDistance: Float! """The compass heading of the observer view direction, from the north and increasing clock-wise.""" heading: Float! """Angle defining the width of the scope being analyzed.""" horizontalFieldOfView: Float! """The name that identifies this viewshed analysis.""" name: String! """Observer location (point) of the viewshed analysis.""" observer: PointInput! """The tilt of the observer view direction, a tilt of 0 is when looking straight down and 90 is when looking parallel to the surface.""" tilt: Float! """Angle defining the height of the scope being analyzed.""" verticalFieldOfView: Float! } """ **Ground**: Display elevation values from the ground of the basemap. **View**: Display elevation values from the scene view. """ enum VisiblePathType { Ground View } """ **Discrete**: Display individual shadows cast at a given time interval. **Duration**: Displays all areas that receive shadows either in a continuous mode or in 1 hour time intervals. **Threshold**: Only displays areas that receive shadows for a period longer than a given threshold value. """ enum VisualizationType { Discrete Duration Threshold } """ **SpaceUseTypeParameter**: Space use type parameter is used as a weight. **Constant**: A constant value is used as a weight """ enum WeightType { SpaceUseTypeParameter Constant } """A zone is a boundary that references a zone type. The zone is used for zoning and land use.""" type Zone { attributes: ZoneAttributes! """2d geometry (xy coordinates)""" geometry: Polygon zoneType: ZoneType } """Attributes of the zone.""" type ZoneAttributes { """Unique identifier (UUID) of the feature.""" GlobalID: GlobalID! """ID of the branch the zone belongs to.""" BranchID: GlobalID """Custom ID of the feature. Used to join fields in the data manager.""" CustomID: String """The planning horizon of the zone.""" PlanningHorizon: ZonePlanningHorizon! """The planning method of the zone.""" PlanningMethod: ZonePlanningMethod! """ID of the zone type the zone is assigned to.""" ZoneTypeID: GlobalID! """The last recorded edit.""" LastEdit: LastEdit } """Filters which can be applied to zone queries.""" input ZoneFilterInput { globalIDs: [GlobalID!] branchIds: [GlobalID!] customIds: [String!] planningHorizons: [ZonePlanningHorizon!] planningMethods: [ZonePlanningMethod!] zoneTypeIds: [GlobalID!] } """ **Existing**: Zone boundary shows existing conditions. **Future**: Zone boundary represents future intentions. """ enum ZonePlanningHorizon { Existing Future } """ **Zoning**: Zone boundary is used for zoning planning. **LandUse**: Zone boundary is used for land use planning. """ enum ZonePlanningMethod { Zoning LandUse } """A zone type is used to configure the zoning parameters of a zone.""" type ZoneType { attributes: ZoneTypeAttributes! } """Attributes of the zone type.""" type ZoneTypeAttributes { """Unique identifier (UUID) of the feature.""" GlobalID: GlobalID! """An array of allowed space use types and their distributions.""" AllowedSpaceUseTypes: [AllowedSpaceUseType!] """Hex color of the zone type or overlay.""" Color: Color! """Maximum allowed coverage in percentage.""" CoverageMax: Float """Custom ID of the feature. Used to join fields in the data manager.""" CustomID: String """Description of the zone type.""" Description: String! """Maximum allowed dwelling units per area in [units/m2].""" DwellingUnitsPerAreaMax: Float """Parameter values for different metrics.""" ExtendedMetricParameters: [ExtendedMetricParameter!]! """Maximum allowed floor area ratio.""" FARMax: Float """Fill style of the zone type or overlay.""" FillStyle: FillStyle! """Maximum allowed height in [m].""" HeightMax: Float """Label of the zone type.""" Label: String! """Factor that reduces the total zone area used for capacity indicator calculations.""" NetAreaFactor: Float """Maximum allowed number of floors.""" NumFloorsMax: Int """Outline style of the zone type or overlay.""" OutlineStyle: OutlineStyle! """The planning method of the zone type.""" PlanningMethod: ZoneTypePlanningMethod! """If `true`, the zone type is proposed in the plan.""" Proposal: Boolean! """Array containing skyplanes.""" Skyplanes: [Skyplane!] """Maximum allowed substructure depth in [m].""" SubstructureDepthMax: Float """An array of tiers and their allowed setbacks in [m].""" Tiers: [Tier!] """ID of the urban event (plan) the zone type belongs to.""" UrbanEventID: GlobalID """Name of the zone type.""" ZoneTypeName: String """The order of the zone type. Defines the order in which the zone types are displayed in the legend.""" ZoneTypeOrder: Int! """The last recorded edit.""" LastEdit: LastEdit } """Filters which can be applied to zone type queries.""" input ZoneTypeFilterInput { globalIDs: [GlobalID!] colors: [Color!] coverageMaxes: [Float!] coverageMaxIsLessThan: Float coverageMaxIsGreaterThan: Float customIds: [String!] descriptions: [String!] dwellingUnitsPerAreaMaxes: [Float!] dwellingUnitsPerAreaMaxIsLessThan: Float dwellingUnitsPerAreaMaxIsGreaterThan: Float farMaxes: [Float!] farMaxIsLessThan: Float farMaxIsGreaterThan: Float fillStyles: [FillStyle!] heightMaxes: [Float!] heightMaxIsLessThan: Float heightMaxIsGreaterThan: Float labels: [String!] netAreaFactors: [Float!] netAreaFactorIsLessThan: Float netAreaFactorIsGreaterThan: Float numFloorsMaxes: [Int!] numFloorsMaxIsLessThan: Int numFloorsMaxIsGreaterThan: Int outlineStyles: [OutlineStyle!] planningMethods: [ZoneTypePlanningMethod!] proposal: Boolean substructureDepthMaxes: [Float!] substructureDepthMaxIsLessThan: Float substructureDepthMaxIsGreaterThan: Float urbanEventIds: [GlobalID!] zoneTypeNames: [String!] zoneTypeOrders: [Int!] zoneTypeOrderIsLessThan: Int zoneTypeOrderIsGreaterThan: Int } """ **Zoning**: Zone type is used for zoning planning. **LandUse**: Zone type is used for land use planning. """ enum ZoneTypePlanningMethod { Zoning LandUse } type ZoneTypesMeta implements FeaturesMeta { """The number of zoneTypes.""" count: Int """Last recorded edit made to zoneTypes""" lastEdit: LastEditMeta } type ZonesMeta implements FeaturesMeta { """The number of zones.""" count: Int """Last recorded edit made to zones""" lastEdit: LastEditMeta } """Zoning regulation with overlays and parcel overrides applied.""" type ZoningRegulation { attributes: ZoningRegulationAttributes! } type ZoningRegulationAttributes { AllowedSpaceUseTypes: [AllowedSpaceUseType!] CoverageMax: Float DwellingUnitsPerAreaMax: Float FARMax: Float HeightMax: Float NumFloorsMax: Int Skyplanes: [Skyplane!] SubstructureDepthMax: Float Tiers: [Tier!] ExtendedMetricParameters: [ExtendedMetricParameter!] }