Release notes February 2021

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 UrbanModel and UrbanDesignDatabase encapsulate main data concepts. You can access the remaining queries through the nested child-properties of the top-level queries.
• 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 DataLoaders.
• UrbanEvents and ZoneTypeIDCaches have been removed (Breaking changes).

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:

The following types related to the FilterInput were added:

The following types and fields related to plan and project branches were added:

The following fields were added to plans and projects:

Other removals, additions and changes were introduced:

Deprecations

• Some queries are deprecated and will be removed. UseQuery.UrbanModelorQuery.UrbanDesignDatabase instead (Effective 2021-06-01). The deprecated queries are the following:

  • Query.branch
  • Query.branches
  • Query.buildingType
  • Query.buildingTypes
  • Query.indicator
  • Query.indicators
  • Query.lod1Building
  • Query.lod1Buildings
  • Query.overlay
  • Query.ovelayType
  • Query.overlayTypes
  • Query.overlays
  • Query.parcel
  • Query.parcels
  • Query.plan
  • Query.plans
  • Query.pointSymbol
  • Query.pointSymbol
  • Query.polygonSymbol
  • Query.polygonSymbols
  • Query.project
  • Query.projects
  • Query.spaceUseType
  • Query.spaceUseTypes
  • Query.StatusType
  • Query.statusTypes
  • Query.urbanDesign
  • Query.urbanModelConfig
  • Query.zone
  • Query.zoneType
  • Query.zoneTypes
  • Query.zones

• Queries Query.urbanDesign and Query.urbanDesigns are deprecated and replaced with Query.urbanDesignDatabase and Query.urbanDesignDatabased to provide a clearer naming scheme (Effective 2021-06-01).

• Field UrbanModel.urbanPublicViewId is deprecated and replaced with urbanDatabaseViewId to provide a clearer naming scheme (Effective 2021-06-01).

• Mutations Mutation.createUrbanDesign and Mutation.deleteUrbanDesign are deprecated and replaced with Mutation.createUrbanDesignDatabase and Mutation.deleteUrbanDesignDatabase to provide a clearer naming scheme (Effective 2021-06-01).

Breaking changes

The following breaking changes related to the deprecated UrbanEvent and UrbanEvents were made:

• Field createUrbanEvents (deprecated) was removed from object type Mutation
  • Type CreateUrbanEventAttributesInput was removed
  • Type CreateUrbanEventInput was removed
• Field deleteUrbanEvents (deprecated) was removed from object type Mutation
• Field updateUrbanEvents (deprecated) was removed from object type Mutation
  • Type UpdateUrbanEventAttributesInput was removed
  • Type UpdateUrbanEventInput was removed
• Field urbanEvent (deprecated) was removed from object type Query
• Field urbanEvents (deprecated) was removed from object type Query
  • Type UrbanEvent was removed
  • Type UrbanEventAttributes was removed
  • Type UrbanEventType was removed
  • Type UrbanEventsSort was removed
  • Type UrbanEventsSortFields was removed

The following breaking changes related to the IDCache were made:

• Field CurrentZoneTypeIDCache (deprecated) was removed from object type ParcelAttributes
  • Enum value CurrentZoneTypeIDCache was removed from enum ParcelsSortFields
  • Input field CurrentZoneTypeIDCache was removed from input object type CreateParcelAttributesInput
  • Input field CurrentZoneTypeIDCache was removed from input object type UpdateParcelAttributesInput
• Field OriginalZoneTypeIDCache (deprecated) was removed from object type ParcelAttributes
  • Enum value OriginalZoneTypeIDCache was removed from enum ParcelsSortFields
  • Input field OriginalZoneTypeIDCache was removed from input object type CreateParcelAttributesInput
  • Input field OriginalZoneTypeIDCache was removed from input object type UpdateParcelAttributesInput

Other breaking changes made in this release were the following:

• Field culture was removed from object type UrbanModel
  • Reason: field culture is not used by the UrbanModel object type.
• Field url was removed from object type UrbanModel
  • Reason: field url is never set for the UrbanModel object type.
• Input field GeodeticShapeArea was removed from input object type CreateParcelAttributesInput
  • Reason: field GeodeticShapeArea is now calculated automatically with the coordinates of the parcel object.
• Input field GeodeticShapeArea was removed from input object type UpdateParcelAttributesInput
  • Reason: field GeodeticShapeArea is now calculated automatically with the coordinates of the parcel object.