Release notes February 2021

Learn about recent changes to the ArcGIS Urban API. Release date is February 15, 2021.

What's new

This section provides a short 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.

Addition of types and fields related to the urban design database:

  • Type UrbanDatabase was added
  • Type UrbanDesignDatabase was added
  • Type UrbanDesignDatabaseTypes was added
  • Type DeleteUrbanDesignDatabaseResult was added
  • Field createUrbanDesignDatabase was added to object type Mutation
  • Field deleteUrbanDesignDatabase was added to object type Mutation
  • Field urbanDesignDatabase was added to object type Query
  • Field urbanDesignDatabases was added to object type Query
  • Field urbanDatabase was added to object type UrbanModel
  • Field urbanDatabaseViewId was added to object type UrbanModel

Addition of types related to the filter input types:

  • Type BranchFilterInput was added
  • Type BuildingTypeFilterInput was added
  • Type GeometryFilterInput was added
  • Type IndicatorFilterInput was added
  • Type LOD1BuildingFilterInput was added
  • Type OverlayFilterInput was added
  • Type OverlayTypeFilterInput was added
  • Type ParcelFilterInput was added
  • Type PlanFilterInput was added
  • Type PointSymbolFilterInput was added
  • Type PolygonSymbolFilterInput was added
  • Type ProjectFilterInput was added
  • Type SpaceUseTypeFilterInput was added
  • Type StatusTypeFilterInput was added
  • Type ZoneFilterInput was added
  • Type ZoneTypeFilterInput was added

Addition of types and fields to branches:

  • Type PlanBranch was added
  • Type ProjectBranch was added
  • Field overlays was added to object type PlanBranch
  • Field parcels was added to object type PlanBranch
  • Field zones was added to object type PlanBranch
  • Field lod1Buildings was added to object type ProjectBranch
  • Field pointSymbols was added to object type ProjectBranch
  • Field polygonSymbols was added to object type ProjectBranch

Addition of fields to plans and projects:

  • Field branches was added to object type Plan
  • Field buildingTypes was added to object type Plan
  • Field overlayTypes was added to object type Plan
  • Field spaceUseTypes was added to object type Plan
  • Field zoneTypes was added to object type Plan
  • Field branches was added to object type Project

Other removals, additions and changes:

  • All input fields of type Date changed type from Date to Timestamp
  • Type Date was removed
  • Type Timestamp was added
  • All input fields of type Color changed type from String to Color
  • Type Color was added
  • Type for all geometry arguments was changed from GeometryInput to GeometryFilterInput
  • Type GeometryInput was removed
  • Input field UpdateUrbanModelConfigInput.existingSatelliteBuildingsLayerItemId changed type from String to PortalItemId
  • Field UrbanModelConfig.existingSatelliteBuildingsLayerItemId changed type from String to PortalItemId
  • Input field displayConfig was added to input object type UpdateUrbanModelConfigInput
  • Type DisplayConfig was added
  • Type DisplayConfigInput was added
  • Field overlayType was added to object type Overlay
  • Field buildingType was added to object type Parcel
  • Field zoneType was added to object type Zone
  • Type PagingInput was added
  • Type ParcelsDisplayConfig was added
  • Type ParcelsDisplayConfigInput was added
  • Field config was added to object type UrbanModel
  • Field displayConfig was added to object type UrbanModelConfig
  • Input field gfaIgnore was added to input object type BuildingPartInput
  • Field gfaIgnore was added to object type BuildingPart

Deprecations

  • The following queries are deprecated and will be removed:

    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.pointSymbolsv, vQuery.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.

    UseQuery.UrbanModelorQuery.UrbanDesignDatabase instead. Effective 2021-06-01.

  • 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

Breaking changes related to Urban Events:

  • 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

Breaking changes related to ID Caches:

  • 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:

  • 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.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.