Learn about the changes to the ArcGIS Urban API introduced in the release from February 15, 2021.
What's new
This section provides a summary of the most important changes in this release.
- The February 2021 release of the Urban API introduces nested queries that expose the true data model of ArcGIS Urban.
The restructured top-level queries, which are
Urban
andModel Urban
encapsulate main data concepts. You can access the remaining queries through the nested child-properties of the top-level queries.Design Database - Due to the introduction of nested queries, most of the previous top-level queries have been deprecated.
- The performance of the data fetching has been improved with
Data
.Loaders Urban
andEvents Zone
have been removed (Breaking changes).Type IDCaches
Schema changes
This section describes new features, improvements, and changes made to the Urban API schema.
The following types and fields related to the urban design database were added:
- Type
Urban
was addedDatabase - Type
Urban
was addedDesign Database - Type
Urban
was addedDesign Database Types - Type
Delete
was addedUrban Design Database Result - Field
create
was added to object typeUrban Design Database Mutation
- Field
delete
was added to object typeUrban Design Database Mutation
- Field
urban
was added to object typeDesign Database Query
- Field
urban
was added to object typeDesign Databases Query
- Field
urban
was added to object typeDatabase Urban
Model - Field
urban
was added to object typeDatabase View I d Urban
Model
The following types related to the Filter
were added:
- Type
Branch
was addedFilter Input - Type
Building
was addedType Filter Input - Type
Geometry
was addedFilter Input - Type
Indicator
was addedFilter Input - Type
LOD1Building
was addedFilter Input - Type
Overlay
was addedFilter Input - Type
Overlay
was addedType Filter Input - Type
Parcel
was addedFilter Input - Type
Plan
was addedFilter Input - Type
Point
was addedSymbol Filter Input - Type
Polygon
was addedSymbol Filter Input - Type
Project
was addedFilter Input - Type
Space
was addedU s e Type Filter Input - Type
Status
was addedType Filter Input - Type
Zone
was addedFilter Input - Type
Zone
was addedType Filter Input
The following types and fields related to plan and project branches were added:
- Type
Plan
was addedBranch - Type
Project
was addedBranch - Field
overlays
was added to object typePlan
Branch - Field
parcels
was added to object typePlan
Branch - Field
zones
was added to object typePlan
Branch - Field
lod1Buildings
was added to object typeProject
Branch - Field
point
was added to object typeSymbols Project
Branch - Field
polygon
was added to object typeSymbols Project
Branch
The following fields were added to plans and projects:
- Field
branches
was added to object typePlan
- Field
building
was added to object typeTypes Plan
- Field
overlay
was added to object typeTypes Plan
- Field
space
was added to object typeU s e Types Plan
- Field
zone
was added to object typeTypes Plan
- Field
branches
was added to object typeProject
Other removals, additions and changes were introduced:
- All input fields of type
Date
changed type fromDate
toTimestamp
- Type
Date
was removed - Type
Timestamp
was added - All input fields of type
Color
changed type fromString
toColor
- Type
Color
was added - Type for all geometry arguments was changed from
Geometry
toInput Geometry
Filter Input - Type
Geometry
was removedInput - Input field
Update
changed type fromUrban Model Config Input.existing Satellite Buildings Layer Item I d String
toPortal
Item I d - Field
Urban
changed type fromModel Config.existing Satellite Buildings Layer Item I d String
toPortal
Item I d - Input field
display
was added to input object typeConfig Update
Urban Model Config Input - Type
Display
was addedConfig - Type
Display
was addedConfig Input - Field
overlay
was added to object typeType Overlay
- Field
building
was added to object typeType Parcel
- Field
zone
was added to object typeType Zone
- Type
Paging
was addedInput - Type
Parcels
was addedDisplay Config - Type
Parcels
was addedDisplay Config Input - Field
config
was added to object typeUrban
Model - Field
display
was added to object typeConfig Urban
Model Config - Input field
gfa
was added to input object typeIgnore Building
Part Input - Field
gfa
was added to object typeIgnore Building
Part
Deprecations
-
Some queries are deprecated and will be removed. Use
Query.Urban
orModel Query.Urban
instead (Effective 2021-06-01). The deprecated queries are the following:Design Database Query.branch
Query.branches
Query.building
Type Query.building
Types Query.indicator
Query.indicators
Query.lod1Building
Query.lod1Buildings
Query.overlay
Query.ovelay
Type Query.overlay
Types Query.overlays
Query.parcel
Query.parcels
Query.plan
Query.plans
Query.point
Symbol Query.point
Symbol Query.polygon
Symbol Query.polygon
Symbols Query.project
Query.projects
Query.space
U s e Type Query.space
U s e Types Query.Status
Type Query.status
Types Query.urban
Design Query.urban
Model Config Query.zone
Query.zone
Type Query.zone
Types Query.zones
-
Queries
Query.urban
andDesign Query.urban
are deprecated and replaced withDesigns Query.urban
andDesign Database Query.urban
to provide a clearer naming scheme (Effective 2021-06-01).Design Databased -
Field
Urban
is deprecated and replaced withModel.urban Public View I d urban
to provide a clearer naming scheme (Effective 2021-06-01).Database View I d -
Mutations
Mutation.create
andUrban Design Mutation.delete
are deprecated and replaced withUrban Design Mutation.create
andUrban Design Database Mutation.delete
to provide a clearer naming scheme (Effective 2021-06-01).Urban Design Database
Breaking changes
The following breaking changes related to the deprecated Urban
and Urban
were made:
- Field
create
(deprecated) was removed from object typeUrban Events Mutation
- Type
Create
was removedUrban Event Attributes Input - Type
Create
was removedUrban Event Input
- Type
- Field
delete
(deprecated) was removed from object typeUrban Events Mutation
- Field
update
(deprecated) was removed from object typeUrban Events Mutation
- Type
Update
was removedUrban Event Attributes Input - Type
Update
was removedUrban Event Input
- Type
- Field
urban
(deprecated) was removed from object typeEvent Query
- Field
urban
(deprecated) was removed from object typeEvents Query
- Type
Urban
was removedEvent - Type
Urban
was removedEvent Attributes - Type
Urban
was removedEvent Type - Type
Urban
was removedEvents Sort - Type
Urban
was removedEvents Sort Fields
- Type
The following breaking changes related to the IDCache
were made:
- Field
Current
(deprecated) was removed from object typeZone Type IDCache Parcel
Attributes - Enum value
Current
was removed from enumZone Type IDCache Parcels
Sort Fields - Input field
Current
was removed from input object typeZone Type IDCache Create
Parcel Attributes Input - Input field
Current
was removed from input object typeZone Type IDCache Update
Parcel Attributes Input
- Enum value
- Field
Original
(deprecated) was removed from object typeZone Type IDCache Parcel
Attributes - Enum value
Original
was removed from enumZone Type IDCache Parcels
Sort Fields - Input field
Original
was removed from input object typeZone Type IDCache Create
Parcel Attributes Input - Input field
Original
was removed from input object typeZone Type IDCache Update
Parcel Attributes Input
- Enum value
Other breaking changes made in this release were the following:
- Field
culture
was removed from object typeUrban
Model - Reason: field
culture
is not used by theUrban
object type.Model
- Reason: field
- Field
url
was removed from object typeUrban
Model - Reason: field
url
is never set for theUrban
object type.Model
- Reason: field
- Input field
Geodetic
was removed from input object typeShape Area Create
Parcel Attributes Input - Reason: field
Geodetic
is now calculated automatically with the coordinates of theShape Area parcel
object.
- Reason: field
- Input field
Geodetic
was removed from input object typeShape Area Update
Parcel Attributes Input - Reason: field
Geodetic
is now calculated automatically with the coordinates of theShape Area parcel
object.
- Reason: field