Learn about recent changes to the ArcGIS Urban API. The release date is July 24th, 2025.
What's new
-
Added an
Overviewfield to theVisualization Branch Id Projects.attributes. Now you can define which scenario in a project is visible in the overview and other plans and projects as context. -
Field
thresholdwas added to object typeDiscrete Interval Shadowcast. See the shadow cast analysis documentation to learn more on how discrete shadows are being used.Parameter
Examples
The following section provides a few examples of how to use the new Urban API features added in the July 2025 release.
Mutating Scenario visible in overview
You can now define which branch (scenario) of a project is visible in the overview. The following example shows how you can set the Overview in the projects.attributes:
mutation SetOverviewBranch (
$urbanDatabaseId: PortalItemId!
$projectID: GlobalID!
$overviewBranchID: GlobalID!
) {
updateProjects(
urbanDatabaseId: $urbanDatabaseId
projects: [{
attributes: {GlobalID: $projectID, OverviewVisualizationBranchId: $overviewBranchID }
}]
) {
attributes { GlobalID OverviewVisualizationBranchId }
}
}Querying Scenario visible in overview
This example returns the information for the branch (scenario) to be shown in the overview due to the filter filter. The Global of the overview branch is also available via the Overview field in the Project object. The Global of the overview branch is also available via the Overview field in the Project object.
fragment ProjectOverviewBranch on Project {
attributes { OverviewVisualizationBranchId }
branches(filter: { overviewVisualization: true }) {
attributes { GlobalID }
}
}Schema changes
This section describes new features and changes made to the Urban API schema.
The following fields and inputs related to project scenarios (branches) were added to projects:
-
Field
Overviewwas added to theVisualization Branch Id Projects.attributes -
Input field
Overviewof typeVisualization Branch Id Globalwas added to input object typeID UpdateProject Attributes Input -
Input field
Overviewof typeVisualization Branch Id Globalwas added to input object typeID CreateProject Attributes Input
The following fields and inputs related to the Shadowcast were added:
-
Field
thresholdwas added to object typeDiscrete Interval ShadowcastParameter -
Input field
thresholdof typeDiscrete Interval Float!was added to input object typeShadowcastParameter Input
Bug fixes and improvements
-
In certain cases, some queries would treat
nullin returned values incorrectly, replacing them with default values. Null values are now handled consistently and returned when appropriate. -
If there are multiple projects in the same database (e.g. Projects in the 'UrbanDatabase') then the analysis query would always only return the analyses from the first project. This bug has been fixed by filtering for the parent
Urban.Event ID
Deprecations
The following fields on Plans have been deprecated:
-
criteria(Removal date: 2026-07-25). This field is no longer supported. -
criteria(Removal date: 2026-07-25). This field is no longer supported.Meta -
suitability(Removal date: 2026-07-25). This field is no longer supported.Models -
suitability(Removal date: 2026-07-25). This field is no longer supported.Models Meta
Breaking changes
The following previously deprecated fields have been removed.
-
Modalhas been removed from Branch:Split -
Field
Modal(deprecated) was removed from object typeSplit BranchAttributes - Input field
Modalwas removed from input object typeSplit CreateBranch Attributes Input - Input field
Modalwas removed from input object typeSplit UpdateBranch Attributes Input - Type
Modalwas removedSplit - Type
Modalwas removedSplit Input
- Input field