Skip to content

Learn about recent changes to the ArcGIS Urban API. The release date is March 25th, 2026.

What's new

  • Added support for zoning and overlay parameters in metrics by adding ExtendedMetricParameters to ZoneTypes and Overlays.
  • Added DisplayOrder to AnalysisAttributes to allow custom ordering of analyses.
  • Added Thumbnail to AnalysisAttributes, enabling storage and retrieval of analysis thumbnails.
  • Added Upload scalar to support file uploads such as thumbnails in GraphQL mutations.
  • Added schematicVisualization and realisticVisualization to UrbanModelConfig for new basemap visualization options.

Examples

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

Uploading a thumbnail during analysis creation

This example shows how to upload a thumbnail to an analysis.

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
mutation CreateViewshedAnalysis($urbanDatabaseId: PortalItemId!, $thumbnail: Upload) {
  createViewshedAnalyses(
    urbanDatabaseId: $urbanDatabaseId
    viewshedAnalyses: [...]
  ) {
    attributes {
      CustomID
      GlobalID
      Thumbnail
    }
  }
}

Querying new visualization configuration fields

This example shows how to query the schematicVisualization and the realisticVisualization from the UrbanModelConfig.

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
query UrbanModelConfig {
  urbanModel(urbanModelId: "") {
    config {
      schematicVisualization
      realisticVisualization
    }
  }
}

The response should look something like this:

Use dark colors for code blocksCopy
1
2
3
4
"config": {
  "schematicVisualization": "Default",
  "realisticVisualization": "Custom"
}

Querying display order for analyses

This example shows how to query the DisplayOrder from an analysis.

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
query Analyses {
  urbanDesignDatabase(urbanDesignDatabaseId: "") {
    plans {
      analyses {
        attributes {
          DisplayOrder
        }
      }
    }
  }
}

Schema changes

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

  • An Upload scalar was added to support file uploads that follows the GraphQL multipart request spec. This standard is typically supported by GraphQL client libraries (e.g., apollo-upload-client).
  • Field Thumbnail was added to AnalysisAttributes.
  • Field DisplayOrder was added to AnalysisAttributes.
  • Fields schematicVisualization and realisticVisualization was added to UrbanModelConfig.
  • Field ExtendedMetricParameters was added on ZoneTypes and on Overlays.

Bug fixes and improvements

  • Bug fixes for concurrent queries accessing urban models hosted on different systems.

Deprecations

No new deprecations in this release.

Breaking changes

  • Field PublicFeedbackEnabled was removed.
  • Field PublicFeedbackEndDate was removed.

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