Release notes June 2022

Learn about recent changes to the ArcGIS Urban API. The release date is June 29, 2022.

What's new

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

• New fields and types related to the visualization style of the overlays and zoning have been introduced.
• Zoning ordering has been introduced.
• Zoning regulation has been added to parcels.
• Filtering the urbanDesignDatabases by urbanModelId has been added.
• Sensible default values have been added to various input fields.
• Previously deprecated fields have been removed in this release (breaking changes). See the Breaking changes section for more detail.
• Various changes and improvements have been made to the Urban API documentation.
• Doc strings in the Urban API schema have been improved.

Schema changes

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

The following type, fields and input fields related to new FillStyle type were added to OverlayTypeAttributes and ZoneTypeAttributes:

The following type, fields and input fields related to new OutlineStyle type were added to OverlayTypeAttributes and ZoneTypeAttributes:

The following field and input fields related to Color were added to OverlayTypeAttributes:

The following field and input fields related to Description were added to OverlayAttributes:

The following field and input fields related to Label were added to OverlayAttributes:

The following field and input fields related to ZoneTypeOrder were added to ZoneTypeAttributes:

The following types and field related to ZoningRegulation were added:

The following argument was added to urbanDesignDatabases query:

Other removals, additions and changes were introduced:

Bug fixes

• Fixed an issue that caused certain queries to result in a timeout.
• Fixed a bug when querying the StatusType of the UrbanDatabase.

Deprecations

• Field Query.apiInfo is deprecated (Removal date: 2023-08-01). This field is no longer supported.
• Field SpaceAttributes.NetAreaFactor is deprecated (Removal date: 2023-06-29). This field is no longer used.
• Fields FieldsConfig.Skyplanes and FieldsConfig.Tiers are deprecated (Removal date: 2023-06-29). Configuration of Tiers and Skyplanes is no longer supported.
  • Input field FieldsConfigInput.Skyplanes changed type from SkyplanesInput! to SkyplanesInput
• Enum value OverlayTypeMethod.None is deprecated (Removal date: 2023-06-29). The None option is no longer supported.
• Arguments groups and organization of Query.urbanDesignDatabases are deprecated (Removal date: 2023-08-01). Use groupIds and organizationId arguments instead.
• Arguments groups and organization of Query.urbanModels are deprecated (Removal date: 2023-08-01). Use groupIds and organizationId arguments instead.
• Argument sort of UrbanDatabase.parcels and PlanBranch.parcels is deprecated (Removal date: 2023-07-31). Sorting by SuitabilityScore will not be supported once the deprecated SuitabilityScore is removed.

Breaking changes

The following breaking changes related to type of the UrbanDesignDatabase were made:

• Field type (deprecated) was removed from object type UrbanDesignDatabase
• Type UrbanDesignDatabaseType was removed

The following breaking changes related to the PlanningMethod field were made:

• Field PlanningMethod was removed from object type ProjectAttributes
• Input field PlanningMethod was removed from input object type UpdateProjectAttributesInput
• Field PlanAttributes.PlanningMethod changed type from UrbanEventPlanningMethod to UrbanEventPlanningMethod!
• Input field CreatePlanAttributesInput.PlanningMethod changed type from UrbanEventPlanningMethod to UrbanEventPlanningMethod!

The following breaking changes related to the deprecated FirstOrderMetrics, SecondOrderMetrics, and SecondOrderCoefficients fields were made:

• Field FirstOrderMetrics (deprecated) was removed from object type BranchAttributes
  • Type FirstOrderMetrics was removed
  • Type FirstOrderMetricsInput was removed
  • Input field FirstOrderMetrics was removed from input object type UpdateBranchAttributesInput
  • Input field FirstOrderMetrics was removed from input object type CreateBranchAttributesInput
  • Type FirstOrderMetricsHouseholds was removed
  • Type FirstOrderMetricsHouseholdsInput was removed
  • Type FirstOrderMetricsJobs was removed
  • Type FirstOrderMetricsJobsInput was removed
  • Type FirstOrderMetricsParkingSpots was removed
  • Type FirstOrderMetricsParkingSpotsInput was removed
  • Type FirstOrderMetricsPopulation was removed
  • Type FirstOrderMetricsPopulationInput was removed
• Field SecondOrderMetrics (deprecated) was removed from object type BranchAttributes
  • Type SecondOrderMetrics was removed
  • Type SecondOrderMetricsInput was removed
  • Input field SecondOrderMetrics was removed from input object type UpdateBranchAttributesInput
  • Input field SecondOrderMetrics was removed from input object type CreateBranchAttributesInput
• Field SecondOrderCoefficients (deprecated) was removed from object type SpaceUseTypeAttributes
  • Type SecondOrderCoefficients was removed
  • Type SecondOrderCoefficientsInput was removed
  • Input field SecondOrderCoefficients was removed from input object type UpdateSpaceUseTypeAttributesInput
  • Input field SecondOrderCoefficients was removed from input object type CreateSpaceUseTypeAttributesInput
  • Type CO2EmissionsCoefficients was removed
  • Type CO2EmissionsCoefficientsInput was removed
  • Type DailyTripsCoefficients was removed
  • Type DailyTripsCoefficientsInput was removed
  • Type EnergyUseCoefficients was removed
  • Type EnergyUseCoefficientsInput was removed
  • Type ExternalWaterUseCoefficients was removed
  • Type ExternalWaterUseCoefficientsInput was removed
  • Type InternalWaterUseCoefficients was removed
  • Type InternalWaterUseCoefficientsInput was removed
  • Type RequiredParkingSpotsCoefficients was removed
  • Type RequiredParkingSpotsCoefficientsInput was removed
  • Type SolidWasteCoefficients was removed
  • Type SolidWasteCoefficientsInput was removed
  • Type WasteWaterCoefficients was removed
  • Type WasteWaterCoefficientsInput was removed

The following breaking changes related to the deprecated Households, HouseholdsAfter, and HouseholdsTarget fields were made:

• Field Households (deprecated) was removed from object type ParcelAttributes
• Field HouseholdsAfter (deprecated) was removed from object type ParcelAttributes
• Field HouseholdsTarget (deprecated) was removed from object type ParcelAttributes
• Field Households (deprecated) was removed from object type PlanAttributes
• Field HouseholdsAfter (deprecated) was removed from object type PlanAttributes
• Field HouseholdsTarget (deprecated) was removed from object type PlanAttributes
• Field Households (deprecated) was removed from object type ProjectAttributes
• Field HouseholdsAfter (deprecated) was removed from object type ProjectAttributes
• Field HouseholdsTarget (deprecated) was removed from object type ProjectAttributes
• Input field Households was removed from input object type UpdateProjectAttributesInput
• Input field HouseholdsAfter was removed from input object type UpdateProjectAttributesInput
• Input field HouseholdsTarget was removed from input object type UpdateProjectAttributesInput
• Input field Households was removed from input object type UpdatePlanAttributesInput
• Input field HouseholdsAfter was removed from input object type UpdatePlanAttributesInput
• Input field HouseholdsTarget was removed from input object type UpdatePlanAttributesInput
• Input field Households was removed from input object type UpdateParcelAttributesInput
• Input field HouseholdsAfter was removed from input object type UpdateParcelAttributesInput
• Input field HouseholdsTarget was removed from input object type UpdateParcelAttributesInput
• Input field Householdswas removed from input object type CreateParcelAttributesInput
• Input field HouseholdsAfter was removed from input object type CreateParcelAttributesInput
• Input field HouseholdsTarget was removed from input object type CreateParcelAttributesInput
• Input field Households was removed from input object type CreatePlanAttributesInput
• Input field HouseholdsAfter was removed from input object type CreatePlanAttributesInput
• Input field HouseholdsTarget was removed from input object type CreatePlanAttributesInput
• Input field Households was removed from input object type CreateProjectAttributesInput
• Input field HouseholdsAfter was removed from input object type CreateProjectAttributesInput
• Input field HouseholdsTarget was removed from input object type CreateProjectAttributesInput

The following breaking changes related to the deprecated Jobs, JobsAfter, and JobsTarget fields were made:

• Field Jobs (deprecated) was removed from object type ParcelAttributes
• Field JobsAfter (deprecated) was removed from object type ParcelAttributes
• Field JobsTarget (deprecated) was removed from object type ParcelAttributes
• Field Jobs (deprecated) was removed from object type PlanAttributes
• Field JobsAfter (deprecated) was removed from object type PlanAttributes
• Field JobsTarget (deprecated) was removed from object type PlanAttributes
• Field Jobs (deprecated) was removed from object type ProjectAttributes
• Field JobsAfter (deprecated) was removed from object type ProjectAttributes
• Field JobsTarget (deprecated) was removed from object type ProjectAttributes
• Input field Jobs was removed from input object type CreateParcelAttributesInput
• Input field JobsAfter was removed from input object type CreateParcelAttributesInput
• Input field JobsTarget was removed from input object type CreateParcelAttributesInput
• Input field Jobs was removed from input object type CreatePlanAttributesInput
• Input field JobsAfter was removed from input object type CreatePlanAttributesInput
• Input field JobsTarget was removed from input object type CreatePlanAttributesInput
• Input field Jobs was removed from input object type CreateProjectAttributesInput
• Input field JobsAfter was removed from input object type CreateProjectAttributesInput
• Input field JobsTarget was removed from input object type CreateProjectAttributesInput
• Input field Jobs was removed from input object type UpdateParcelAttributesInput
• Input field JobsAfter was removed from input object type UpdateParcelAttributesInput
• Input field JobsTarget was removed from input object type UpdateParcelAttributesInput
• Input field Jobs was removed from input object type UpdatePlanAttributesInput
• Input field JobsAfter was removed from input object type UpdatePlanAttributesInput
• Input field JobsTarget was removed from input object type UpdatePlanAttributesInput
• Input field Jobs was removed from input object type UpdateProjectAttributesInput
• Input field JobsAfter was removed from input object type UpdateProjectAttributesInput
• Input field JobsTarget was removed from input object type UpdateProjectAttributesInput

The following breaking changes related to the deprecated Population, PopulationAfter, and PopulationTarget fields were made:

• Input field Population was removed from input object type CreateParcelAttributesInput
• Input field PopulationAfter was removed from input object type CreateParcelAttributesInput
• Input field PopulationTarget was removed from input object type CreateParcelAttributesInput
• Input field Population was removed from input object type CreatePlanAttributesInput
• Input field PopulationAfter was removed from input object type CreatePlanAttributesInput
• Input field PopulationTarget was removed from input object type CreatePlanAttributesInput
• Input field Population was removed from input object type CreateProjectAttributesInput
• Input field PopulationAfter was removed from input object type CreateProjectAttributesInput
• Input field PopulationTarget was removed from input object type CreateProjectAttributesInput
• Field Population (deprecated) was removed from object type ParcelAttributes
• Field PopulationAfter (deprecated) was removed from object type ParcelAttributes
• Field PopulationTarget (deprecated) was removed from object type ParcelAttributes
• Field Population (deprecated) was removed from object type PlanAttributes
• Field PopulationAfter (deprecated) was removed from object type PlanAttributes
• Field PopulationTarget (deprecated) was removed from object type PlanAttributes
• Field Population (deprecated) was removed from object type ProjectAttributes
• Field PopulationAfter (deprecated) was removed from object type ProjectAttributes
• Field PopulationTarget (deprecated) was removed from object type ProjectAttributes
• Input field Population was removed from input object type UpdateParcelAttributesInput
• Input field PopulationAfter was removed from input object type UpdateParcelAttributesInput
• Input field PopulationTarget was removed from input object type UpdateParcelAttributesInput
• Input field Population was removed from input object type UpdatePlanAttributesInput
• Input field PopulationAfter was removed from input object type UpdatePlanAttributesInput
• Input field PopulationTarget was removed from input object type UpdatePlanAttributesInput
• Input field Population was removed from input object type UpdateProjectAttributesInput
• Input field PopulationAfter was removed from input object type UpdateProjectAttributesInput
• Input field PopulationTarget was removed from input object type UpdateProjectAttributesInput

The following deprecated fields were removed from the SpaceUseTypeAttributes:

• Field AreaPerJob (deprecated) was removed from object type SpaceUseTypeAttributes
  • Input field AreaPerJob was removed from input object type CreateSpaceUseTypeAttributesInput
  • Input field AreaPerJob was removed from input object type UpdateSpaceUseTypeAttributesInput
• Field AreaPerParkingSpot (deprecated) was removed from object type SpaceUseTypeAttributes
  • Input field AreaPerParkingSpot was removed from input object type CreateSpaceUseTypeAttributesInput
  • Input field AreaPerParkingSpot was removed from input object type UpdateSpaceUseTypeAttributesInput
• Field AreaPerPerson (deprecated) was removed from object type SpaceUseTypeAttributes
  • Input field AreaPerPerson was removed from input object type CreateSpaceUseTypeAttributesInput
  • Input field AreaPerPerson was removed from input object type UpdateSpaceUseTypeAttributesInput

Other breaking changes:

• Enum value None was removed from enum UrbanEventPlanningMethod
• Input field CoverageMaxInput.method changed type from OverlayTypeMethod to OverlayTypeMethod!
• Input field PlanningMethod was removed from input object type CreateProjectAttributesInput
• Input field DwellingUnitsPerAreaMaxInput.method changed type from OverlayTypeMethod to OverlayTypeMethod!
• Input field FARMaxInput.method changed type from OverlayTypeMethod to OverlayTypeMethod!
• Input field HeightMaxInput.method changed type from OverlayTypeMethod to OverlayTypeMethod!
• Input field NumFloorsMaxInput.method changed type from OverlayTypeMethod to OverlayTypeMethod!
• Input field SubstructureDepthMaxInput.method changed type from OverlayTypeMethod to OverlayTypeMethod!