Skip to content

Learn about recent changes to the ArcGIS Urban API. The release date is November 18th, 2025.

What's new

  • Added ExtendedMetricParameter to Parcel. These parameters can be use in metrics calculations.

  • Added Suitability to AnalysisParameter. The suitability analysis has been migrated to be part of the analysis tools.

  • Added visiblePathTypes to the elevation profile. Now you can add visibility settings to your elevation profile which are persisted.

Added the field DevelopmentStatus to spaces. Now you can define one of three development statuses: New, Unchanged, Repurposed.

Examples

The following section provides a few examples of how to use the new Urban API features added in the November 2025 release.

Mutation Parcel Parameters

This example shows how to import parcel parameters and join them by parcel ID.

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
mutation UpdateParcels(
    $urbanDatabaseId: PortalItemId!
    $parcels: [{"attributes": {"BranchID": GlobalID, "GlobalID": GlobalID!, "ExtendedMetricParameters": {"metricID": GlobalID, "value": Float!}
  }}]
  ) {
    updateParcels(urbanDatabaseId: $urbanDatabaseId, parcels: $parcels) {
      attributes {
        GlobalID
        ExtendedMetricParameters { metricID:metricID, value:value }
      }
    }
  }

Query Elevation Profile

This example shows how to query an elevation profile with the new field visiblePathTypes, indicating the visibility settings in the elevation profile analysis.

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
 query{
  urbanDesignDatabase(urbanDesignDatabaseId: PortalItemId!) {
    id
    owner
    plans {
    	analyses {
        attributes {
          AnalysisName
          Parameters {
            ... on ElevationProfile {
              elevationProfiles {
                paths {
                  path
                }
                visiblePathTypes
              }
            }
          }
        }
      }
    }
  }
}

The response should look something like this:

Use dark colors for code blocksCopy
1
2
3
4
"visiblePathTypes": [
                      "Ground",
                      "View"
                    ]

Development Status for Spaces

The following example shows the details about the new DevelopmentStatus field added to spaces:

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
DevelopmentStatus: {
  title: 'DevelopmentStatus',
  type: 'string',
  description: 'The development status of the space.',
  enum: ['New', 'Repurposed', 'Unchanged'],
  'meta:enum': {
    New: 'Newly built space',
    Repurposed: 'Repurposed (existing) space',
    Unchanged: 'Unchanged (existing) space',
  },
  default: 'New',
},...

Schema changes

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

The following fields and inputs related to Suitability were added:

The following fields and inputs related to the elevation profile analysis were added:

  • Input field visiblePathTypes of type [VisiblePathType!]! was added to input object type ElevationProfileParameterInput.

The following fields and inputs related to spaces were added:

  • Input field DevelopmentStatus of type DevelopmentStatus was added to input object type CreateSpaceAttributesInput.

The following fields related to the new metrics were added:

  • Input field DefaultValue of type Float was added to input object type CreateExtendedMetricAttributesInput.

The following fields and inputs related to parcels were added:

Bug fixes and improvements

  • We updated the Urban API Python module sgql code generator statement in the documentation to exclude a default type Time. This is necessary as the Urban schema now also includes a type Time. See Python sgqlc client library to learn more about Simple GraphQL Client Python library (sgqlc).

  • MetricsUnitType unit for EnergyConsumption has been corrected from [kWh] to [Wd] as it is stored in the database.

Deprecations

The following fields for the old metrics in plans have been deprecated:

  • plan.metrics (Removal date: 2026-11-18). No longer supported.

  • plan.metricsMeta (Removal date: 2026-11-18). No longer supported.

  • plan.metricSources (Removal date: 2026-11-18). No longer supported.

  • plan.metricSourcesMeta (Removal date: 2026-11-18). No longer supported.

  • plan.branch.metricsDashboards (Removal date: 2026-11-18). No longer supported.

Breaking changes

The following field was added to ElevationProfileParameterInput:

  • Input field visiblePathTypes of type [VisiblePathType!]! was added to input object type ElevationProfileParameterInput.

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