Learn about recent changes to the ArcGIS Urban API. The release date is November 18th, 2025.
What's new
-
Added
Extendedto Parcel. These parameters can be use in metrics calculations.Metric Parameter -
Added
SuitabilitytoAnalysis. The suitability analysis has been migrated to be part of the analysis tools.Parameter -
Added
visibleto the elevation profile. Now you can add visibility settings to your elevation profile which are persisted.Path Types
Added the field Development to spaces. Now you can define one of three development statuses: New, Unchanged, Repurposed.
Examples
The following section provides a few examples of how to use the new Urban API features added in the November 2025 release.
Mutation Parcel Parameters
This example shows how to import parcel parameters and join them by parcel ID.
mutation UpdateParcels(
$urbanDatabaseId: PortalItemId!
$parcels: [{"attributes": {"BranchID": GlobalID, "GlobalID": GlobalID!, "ExtendedMetricParameters": {"metricID": GlobalID, "value": Float!}
}}]
) {
updateParcels(urbanDatabaseId: $urbanDatabaseId, parcels: $parcels) {
attributes {
GlobalID
ExtendedMetricParameters { metricID:metricID, value:value }
}
}
}Query Elevation Profile
This example shows how to query an elevation profile with the new field visible, indicating the visibility settings in the elevation profile analysis.
query{
urbanDesignDatabase(urbanDesignDatabaseId: PortalItemId!) {
id
owner
plans {
analyses {
attributes {
AnalysisName
Parameters {
... on ElevationProfile {
elevationProfiles {
paths {
path
}
visiblePathTypes
}
}
}
}
}
}
}
}The response should look something like this:
"visiblePathTypes": [
"Ground",
"View"
]Development Status for Spaces
The following example shows the details about the new Development field added to spaces:
DevelopmentStatus: {
title: 'DevelopmentStatus',
type: 'string',
description: 'The development status of the space.',
enum: ['New', 'Repurposed', 'Unchanged'],
'meta:enum': {
New: 'Newly built space',
Repurposed: 'Repurposed (existing) space',
Unchanged: 'Unchanged (existing) space',
},
default: 'New',
},...Schema changes
This section describes new features and changes made to the Urban API schema.
The following fields and inputs related to Suitability were added:
- Member
Suitabilitywas added to Union typeAnalysis.Parameter - Type
Suitabilitywas added. - Type
Suitabilitywas added.Parameter - Type
Suitabilitywas added.Parameter Input - Type
Updatewas added.Suitability Input - Field
suitabilitywas added to object typeParameters Parameters.
The following fields and inputs related to the elevation profile analysis were added:
- Input field
visibleof typePath Types [was added to input object typeVisible Path Type!]! Elevation.Profile Parameter Input
The following fields and inputs related to spaces were added:
- Input field
Developmentof typeStatus Developmentwas added to input object typeStatus Create.Space Attributes Input
The following fields related to the new metrics were added:
- Input field
Defaultof typeValue Floatwas added to input object typeCreate.Extended Metric Attributes Input
The following fields and inputs related to parcels were added:
- Field
Extendedwas added to object typeMetric Parameters Parcel.Attributes - Input field
Extendedof typeMetric Parameters [was added to input object typeExtended Metric Parameter Input!] Create.Parcel Attributes Input
Bug fixes and improvements
-
We updated the Urban API Python module sgql code generator statement in the documentation to exclude a default type
Time. This is necessary as the Urban schema now also includes a typeTime. See Python sgqlc client library to learn more about Simple GraphQL Client Python library (sgqlc). -
Metricsunit forUnit Type Energyhas been corrected from [kWh] to [Wd] as it is stored in the database.Consumption
Deprecations
The following fields for the old metrics in plans have been deprecated:
-
plan.metrics(Removal date: 2026-11-18). No longer supported. -
plan.metrics(Removal date: 2026-11-18). No longer supported.Meta -
plan.metric(Removal date: 2026-11-18). No longer supported.Sources -
plan.metric(Removal date: 2026-11-18). No longer supported.Sources Meta -
plan.branch.metrics(Removal date: 2026-11-18). No longer supported.Dashboards
Breaking changes
The following field was added to Elevation:
- Input field
visibleof typePath Types [was added to input object typeVisible Path Type!]! Elevation.Profile Parameter Input