Release notes December 2024

Learn about recent changes to the ArcGIS Urban API. The release date is December 4th, 2024.

What's new

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

• New metrics are now also exposed through the Urban API. See Metrics (new) section in the ArcGIS Urban documentation to learn more about new metrics in Urban.
• The deprecated field MetricValues reached its sunset date and was removed (breaking change).
• The deprecated field GeodeticShapeArea reached its sunset date and was removed (breaking change).
• The deprecated async flag for creating and upgrading urban models and design databases was removed.
• Added an alternativewkids field to the SpatialReference attribute. Now you can query other wkids available for the used spatial reference. See Alternative wkids for an example.
• Added a global limit override to the cursor node. Now you can define a limit that will be automatically set on the top-level query, as well as overwritten for the nested fragments of the query. See Global limit for an example.

Examples

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

Alternative wkids

This example shows how to query the alternative wkids available for the used spatial reference. Use the following operation to query alernativeWkids field for parcels in a plan:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
query ReadPlanParcels($urbanDesignDatabaseId: PortalItemId!, $urbanEventId: GlobalID!, $branchId: GlobalID!) {
  urbanDesignDatabase(urbanDesignDatabaseId: $urbanDesignDatabaseId) {
    plans(filter: { globalIDs: [$urbanEventId] }) {
      branches(filter: { globalIDs: [$branchId] }) {
        parcels {
          geometry {
            spatialReference {
              wkid
              alternativeWkids
            }
          }
        }
      }
    }
  }
}

The response should look something like this:

1
2
3
4
"spatialReference": {
  "wkid": 3857,
  "alternativeWkids": [102100]
}

Global limit

This example shows how to use the global limit set for the cursor to override the limit defined in the nested fragment of the query. Use the following operation to override the paging limit set for the zoneTypes:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
fragment ZoneTypesFragment on UrbanDatabase {
  zoneTypes(paging: { limit: 5 }) {
    attributes {
      GlobalID
    }
  }
}

query {
  cursor(limit: 10)
  urbanModel(urbanModelId: "URBAN_MODEL_ID") {
    urbanDatabase {
      id
      ...ZoneTypesFragment
    }
  }
}

Schema changes

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

The following mutations related to the new metrics were added:

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

MetricVersion field was added to PlanAttributes and MetricValueAttributes:

Other additions and changes were introduced:

Bug fixes and improvements

• Fixed a bug where the StatusType of Project was sometimes not returned correctly in a query

Breaking changes

The following previously deprecated fields have been removed.

MetricValues has been removed from Branch and Space Attributes:

• Field MetricValues (deprecated) was removed from object type BranchAttributes
  • Type BranchMetricValue was removed
  • Type BranchMetricValueInput was removed
  • Input field MetricValues was removed from input object type UpdateBranchAttributesInput
  • Input field MetricValues was removed from input object type CreateBranchAttributesInput
• Field MetricValues (deprecated) was removed from object type SpaceAttributes
  • Type SpaceMetricValue was removed
  • Type SpaceMetricValueInput was removed
  • Input field MetricValues was removed from input object type UpdateSpaceAttributesInput
  • Input field MetricValues was removed from input object type CreateSpaceAttributesInput

Metric has been removed from MetricValue:

• Field metric (deprecated) was removed from object type MetricValue

GeodeticShapeArea had been removed from Parcel and Space attributes:

• Field GeodeticShapeArea (deprecated) was removed from object type ParcelAttributes
• Field GeodeticShapeArea (deprecated) was removed from object type SpaceAttributes
• Input field geodeticShapeAreaIsGreaterThan was removed from input object type ParcelFilterInput
• Input field geodeticShapeAreaIsLessThan was removed from input object type ParcelFilterInput
• Input field geodeticShapeAreas was removed from input object type ParcelFilterInput
• Input field geodeticShapeAreaIsGreaterThan was removed from input object type SpaceFilterInput
• Input field geodeticShapeAreaIsLessThan was removed from input object type SpaceFilterInput
• Input field geodeticShapeAreas was removed from input object type SpaceFilterInput

Other breaking changes were made:

• Field MetricAttributes.MetricName changed type from String! to String
• Field MetricSourceAttributes.MetricID changed type from GlobalID! to GlobalID