Release notes July 2021

Learn about recent changes to the ArcGIS Urban API. The release date is July 19, 2021.

What's new

This section provides a summary of the most important changes in this release.

• The deprecated top-level queries have been removed (Breaking changes).
• New metrics and spaces layers have been added. Read the Urban release notes to learn more about the functionality of the new layers.
• You can now upgrade your urban models and urban design databases to the new schema using the API.
  Read the data model changes section to learn more about the urban model and design database upgrade with the API.

Schema changes

This section describes new features, improvements, and changes made to the Urban API schema.

The following types related to metrics were added:

The following fields, input fields, and enums related to metrics were added:

The following types related to spaces were added:

The following fields, input fields, and enums related to spaces were added:

The following fields and types related to the upgrade of the urban model and urban design database were added:

The following elements related to new type DevelopmentType were added:

Other removals, additions and changes were introduced:

Bug fixes

• Handled invalid feature services in Query.urbanDesignDatabases.
• Added a transformation of the input geometry data to the Web Mercator projection (ESPG:4326/102100) in create and update operations, as expected by ArcGIS Urban feature services.
• Added PortalItemID to the error message displayed for an unsupported feature service.
• Set limit to 0 in the paging argument throws an error instead of returning the default number of objects.
• Set the correct extent when using a createUrbanDesignDatabase mutation.
• Fixed mutations response when requesting return fields.
• Fixed globalIDs filter behavior.

Deprecations

• The following fields belonging to BranchAttributes are deprecated as they are now stored in the new MetricValues (Effective: 2022-06-06):

  • BranchAttributes.FirstOrderMetrics
  • BranchAttributes.SecondOrderMetrics

• The following fields belonging to ParcelAttributes are deprecated as they are now stored in the new Metrics or MetricValues (Effective: 2022-06-06):

  • ParcelAttributes.Households
  • ParcelAttributes.HouseholdsAfter
  • ParcelAttributes.HouseholdsTarget
  • ParcelAttributes.Jobs
  • ParcelAttributes.JobsAfter
  • ParcelAttributes.JobsTarget
  • ParcelAttributes.Population
  • ParcelAttributes.PopulationAfter
  • ParcelAttributes.PopulationTarget

• The following fields belonging to PlanAttributes are deprecated as they are now stored in the new Metrics or MetricValues (Effective: 2022-06-06):

  • PlanAttributes.Households
  • PlanAttributes.HouseholdsAfter
  • PlanAttributes.HouseholdsTarget
  • PlanAttributes.Jobs
  • PlanAttributes.JobsAfter
  • PlanAttributes.JobsTarget
  • PlanAttributes.Population
  • PlanAttributes.PopulationAfter
  • PlanAttributes.PopulationTarget

• The following fields belonging to ProjectAttributes are deprecated as they are now stored in the new Metrics or MetricValues (Effective: 2022-06-06):

  • ProjectAttributes.Households
  • ProjectAttributes.HouseholdsAfter
  • ProjectAttributes.HouseholdsTarget
  • ProjectAttributes.Jobs
  • ProjectAttributes.JobsAfter
  • ProjectAttributes.JobsTarget
  • ProjectAttributes.Population
  • ProjectAttributes.PopulationAfter
  • ProjectAttributes.PopulationTarget

• The following fields belonging to SpaceUseTypeAttributes are deprecated as they are now stored in the new MetricsParameters (Effective: 2022-06-06):

  • SpaceUseTypeAttributes.AreaPerJob
  • SpaceUseTypeAttributes.AreaPerParkingSpot
  • SpaceUseTypeAttributes.AreaPerPerson
  • SpaceUseTypeAttributes.SecondOrderCoefficients

Breaking changes

The following breaking changes related to the deprecated urbanDesign and urbanDesigns fields were made:

• Field urbanDesign (deprecated) was removed from object type Query
• Field urbanDesigns (deprecated) was removed from object type Query
  • Type UrbanDesign was removed
  • Type UrbanDesignTypes was removed
• Field createUrbanDesign (deprecated) was removed from object type Mutation
• Field deleteUrbanDesign (deprecated) was removed from object type Mutation
  • Type DeleteUrbanDesignResult was removed

The following breaking changes related to the removal of the top-level queries were made:

• Following deprecated fields were removed from object type Query:

  • branch
  • branches
  • buildingType
  • buildingTypes
  • indicator
  • indicators
  • lod1Building
  • lod1Buildings
  • overlay
  • overlayType
  • overlayTypes
  • overlays
  • parcel
  • parcels
  • plan
  • plans
  • pointSymbol
  • pointSymbols
  • polygonSymbol
  • polygonSymbols
  • project
  • projects
  • spaceUseType
  • spaceUseTypes
  • statusType
  • statusTypes
  • urbanModelConfig
  • zone
  • zoneType
  • zoneTypes
  • zones

• Following types were removed:

  • BranchesSort
  • BranchesSortFields
  • BuildingTypesSort
  • BuildingTypesSortFields
  • IndicatorsSort
  • IndicatorsSortFields
  • LOD1BuildingsSort
  • LOD1BuildingsSortFields
  • OverlayTypesSort
  • OverlayTypesSortFields
  • OverlaysSort
  • OverlaysSortFields
  • ParcelsSort
  • ParcelsSortFields
  • PlansSort
  • PlansSortFields
  • PointSymbolsSort
  • PointSymbolsSortFields
  • PolygonSymbolsSort
  • PolygonSymbolsSortFields
  • ProjectsSort
  • ProjectsSortFields
  • SpaceUseTypesSort
  • SpaceUseTypesSortFields
  • StatusTypesSort
  • StatusTypesSortFields
  • UrbanDesignTypes
  • ZoneTypesSort
  • ZoneTypesSortFields
  • ZonesSort
  • ZonesSortFields

The following additions and breaking changes related to new type BuildingAlignment were made:

• Type BuildingAlignment was added
• Field BuildingTypeAttributes.Alignment changed type from [String!] to [BuildingAlignment!]
• Input field CreateBuildingTypeAttributesInput.Alignment changed type from [String!] to [BuildingAlignment!]
• Input field UpdateBuildingTypeAttributesInput.Alignment changed type from [String!] to [BuildingAlignment!]

The following additions and breaking changes related to new type AccessLevel were made:

• Type AccessLevel was added
• Field UrbanDatabase.access changed type from String to AccessLevel!
• Field UrbanDesignDatabase.access changed type from String! to AccessLevel!
• Field UrbanModel.access changed type from String! to AccessLevel!

The following additions and breaking changes related to new type Extent were made:

• Type Extent was added
• Type for argument extent on field Mutation.createUrbanDesignDatabase changed from [[Float]] to Extent
• Type for argument extent on field Query.urbanDesignDatabases changed from [[Float]] to Extent
• Type for argument extent on field Query.urbanModels changed from [[Float]] to Extent
• Field UrbanDesignDatabase.extent changed type from [[Float!]!] to Extent
• Field UrbanModel.extent changed type from [[Float!]!] to Extent

Other breaking changes made in this release were the following:

• Field urbanPublicViewId (deprecated) was removed from object type UrbanModel
• Type UrbanDesignDatabaseTypes was renamed to UrbanDesignDatabaseType
  • Field UrbanDesignDatabase.type changed type from UrbanDesignDatabaseTypes! to UrbanDesignDatabaseType!
  • Type for argument type on field Query.urbanDesignDatabases changed from UrbanDesignDatabaseTypes to UrbanDesignDatabaseType
  • Type for argument type on field Mutation.createUrbanDesignDatabase changed from UrbanDesignDatabaseTypes! to UrbanDesignDatabaseType!

Known issues

• Updating or creating too many features in a single API call may lead to a timeout or server error. See the Troubleshooting section for more details.