Learn about recent changes to the ArcGIS Urban API. The release date is June 28, 2023.
What's new
This section provides a summary of the most important changes in this release.
Metafields containing general information forUrbanandModels Urbanhave been added.Design Databases - Metric values for projects are now stored directly in the project scenario (
projects.branches.metric) instead of the attributes of a project scenario (Values projects.branches.attributes.metric).Values
Schema changes
This section describes new features, improvements, and changes made to the Urban API schema.
Meta fields were added for Urban and Urban:
- Field
urbanwas added to object typeModels Meta Query- Type
Urbanwas addedModels Meta
- Type
- Field
urbanwas added to object typeDesign Databases Meta Query- Type
Urbanwas addedDesign Databases Meta
- Type
Metric values were added to Project:
- Field
metricwas added to object typeValues ProjectBranch - Field
metricwas added to object typeValues Meta ProjectBranch
The spatial field on Urban and Urban types was set to non-null:
- Field
Urbanchanged type fromDesign Database.spatial Reference SpatialtoReference SpatialReference! - Field
Urbanchanged type fromModel.spatial Reference SpatialtoReference SpatialReference!
A geometry was added to Urban:
- Argument
geometrywas added to fieldFilter : Geometry Filter Input Urban.Database.metric Values
Bug fixes
- Fixed a bug where the extent of newly created design database was not set correctly (only design feature services created since the February 2023 release were affected by this issue). As a result, those design databases might not be returned correctly when filtered by the
extent. As a workaround, define the content extent of the corresponding hosted feature layer on ArcGIS Online and try again. See Define content extent for details. - Fixed a bug where an invalid wkid was returned for the
spatialfield of theReference Masking. The Urban API returned both the deprecated wkid:102100 and official wkid:3875 for the Web Mercator projection. Now only the official wkid:3857 is returned for the Web Mercator projection.Geometry - Fixed incorrect default value stored in the
Ownerfield during an update.Name - Fixed a bug where a stringified
nullvalue was stored forTiersandSkyplanesinstead of the actualnull. - Improved error messages for invalid
Tiersinput values.
Deprecations
Metric fields in the Branch and Space have been deprecated:
- Field
Branchis deprecated (Removal date: 2024-06-26). No longer supported. Use theAttributes. Metric Values metricfield on the plan or project branch (scenario).Values - Field
Spaceis deprecated (Removal date: 2024-06-25). No longer supported. Use theAttributes. Metric Values metricfield on the plan or project branch (scenario).Values - Field
Metricis deprecated (Removal date: 2024-06-26). No longer supported. To resolve the metric id, use the metrics stored for the urban model or plan.Value.metric
The following deprecations have been removed:
Field Branchis no longer deprecatedAttributes. Locked
Breaking changes
The following previously deprecated fields have been removed.
Net has been removed from Spaces:
- Field
Net(deprecated) was removed from object typeArea Factor SpaceAttributes - Input field
Netwas removed from input object typeArea Factor CreateSpace Attributes Input - Input field
Netwas removed from input object typeArea Factor UpdateSpace Attributes Input
- Input field
Tiers and Skyplanes have been removed from Fields:
- Field
Skyplanes(deprecated) was removed from object typeFieldsConfig - Input field
Skyplaneswas removed from input object typeFieldsConfig Input - Type
Skyplaneswas removed - Type
Skyplaneswas removedInput - Type
Overlaywas removedType Method Skyplanes
- Input field
- Field
Tiers(deprecated) was removed from object typeFieldsConfig - Input field
Tierswas removed from input object typeFieldsConfig Input - Type
Tierswas removed - Type
Tierswas removedInput - Type
Overlaywas removedType Method Tiers
- Input field
The None enum option has been removed from Overlay:
- Enum value
None(deprecated) was removed from enumOverlayType Method
Upcoming breaking changes
See the February 2023 release notes for upcoming breaking changes.