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:

  • BranchMetricValue
  • BranchMetricValueInput
  • CreateMetricAttributesInput
  • CreateMetricInput
  • CreateMetricSourceAttributesInput
  • CreateMetricSourceInput
  • CreateMetricValueAttributesInput
  • CreateMetricValueInput
  • Metric
  • MetricAttributes
  • MetricFilterInput
  • MetricParameter
  • MetricParameterInput
  • MetricSource
  • MetricSourceAttributes
  • MetricSourceFilterInput
  • MetricValue
  • MetricValueAttributes
  • MetricValueFilterInput
  • MetricsDashboardChart
  • MetricsDashboardChartInput
  • SpaceMetricValue
  • SpaceMetricValueInput
  • UpdateMetricAttributesInput
  • UpdateMetricInput
  • UpdateMetricSourceAttributesInput
  • UpdateMetricSourceInput
  • UpdateMetricValueAttributesInput
  • UpdateMetricValueInput
  • WeightType

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

  • Field MetricValues was added to object type BranchAttributes
  • Field createMetricSources was added to object type Mutation
  • Field createMetricValues was added to object type Mutation
  • Field createMetrics was added to object type Mutation
  • Field deleteMetricSources was added to object type Mutation
  • Field deleteMetricValues was added to object type Mutation
  • Field deleteMetrics was added to object type Mutation
  • Field updateMetricSources was added to object type Mutation
  • Field updateMetricValues was added to object type Mutation
  • Field updateMetrics was added to object type Mutation
  • Field metricSources was added to object type Plan
  • Field metrics was added to object type Plan
  • Field MetricsDashboardCharts was added to object type PlanAttributes
  • Field metricValues was added to object type PlanBranch
  • Field MetricParameters was added to object type SpaceUseTypeAttributes
  • Field metricSources was added to object type UrbanDatabase
  • Field metricValues was added to object type UrbanDatabase
  • Field metrics was added to object type UrbanDatabase
  • Input field MetricsDashboardCharts was added to input object type CreatePlanAttributesInput
  • Input field MetricValues was added to input object type CreateBranchAttributesInput
  • Input field MetricsDashboardCharts was added to input object type CreateProjectAttributesInput
  • Input field MetricParameters was added to input object type CreateSpaceUseTypeAttributesInput
  • Input field MetricValues was added to input object type UpdateBranchAttributesInput
  • Input field MetricsDashboardCharts was added to input object type UpdatePlanAttributesInput
  • Input field MetricsDashboardCharts was added to input object type UpdateProjectAttributesInput
  • Input field MetricParameters was added to input object type UpdateSpaceUseTypeAttributesInput

The following types related to spaces were added:

  • CreateSpaceAttributesInput
  • CreateSpaceInput
  • Space
  • SpaceAttributes
  • SpaceFilterInput
  • SpaceType
  • UpdateSpaceAttributesInput
  • UpdateSpaceInput

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

  • Field createSpaces was added to object type Mutation
  • Field deleteSpaces was added to object type Mutation
  • Field updateSpaces was added to object type Mutation
  • Field spaces was added to object type Parcel
  • Field spaces was added to object type PlanBranch

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

  • Field upgradeInfo was added to object type UrbanDesignDatabase
  • Field upgradeInfo was added to object type UrbanModel
  • Type UpgradeInfo was added
  • Field upgradeUrbanDesignDatabase was added to object type Mutation
  • Field upgradeUrbanModel was added to object type Mutation
  • Type UpgradeUrbanDesignDatabaseResult was added
  • Type UpgradeUrbanModelResult was added
  • Type UpgradeStatus was added

The following elements related to new type DevelopmentType were added:

  • Type DevelopmentType was added
  • Field DevelopmentType was added to object type ParcelAttributes
  • Input field DevelopmentType was added to input object type CreateParcelAttributesInput
  • Input field DevelopmentType was added to input object type UpdateParcelAttributesInput

Other removals, additions and changes were introduced:

  • Input field z was added to input object type PointInput
  • Argument sort: PortalItemSortInput added to field Query.urbanDesignDatabases
  • Argument sort: PortalItemSortInput added to field Query.urbanModels
  • Type PortalItemSortBy was added
  • Type PortalItemSortInput was added
  • Input field initialVisualizationStyle was added to input object type UpdateUrbanModelConfigInput
  • Field initialVisualizationStyle was added to object type UrbanModelConfig
  • Type ChartStyle was added
  • Type Icon was added
  • Type InitialVisualizationStyle was added
  • Type Operation was added
  • Field z was added to object type Point
  • Field statusType was added to object type Project
  • Type SourceType was added
  • Description Urban Model configuration which is stored on the Urban Model portal item was removed from object type StreetviewProvider
  • Type UnitType was added
  • Field owner was added to object type UrbanDatabase
  • Field UrbanDatabase.url changed type from String to String!
  • Field UrbanDesignDatabase.url changed type from String to String!
  • Type UrbanDesignDatabaseType was added
  • Field UrbanDesignDatabase.plans changed type from [Plan]! to [Plan]
  • Field UrbanDesignDatabase.projects changed type from [Project]! to [Project]
  • Input field PagingInput.limit default value changed from 10 to 100

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.

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