Release notes February 2023

Learn about recent changes to the ArcGIS Urban API. The release date is February 22, 2023.

What's new

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

• The GraphQL Playground has been replaced with GraphiQL.
• An OptIn directive which enables the use of experimental features has been added.
• Various descriptions have been improved.

Schema changes

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

The Develop field on ParcelAttributes was renamed to Demolish:

Other additions were introduced:

Bug fixes

• Fixed a bug where Urban model creation would fail for trial organizations.

Deprecations

The Locked field on BranchAttributes, IndicatorAttributes, PlanAttributes and ProjectAttributes has been deprecated:

• Field BranchAttributes.Locked is deprecated (Removal date: 2024-02-28). No longer supported.
• Field IndicatorAttributes.Locked is deprecated (Removal date: 2024-02-28). No longer supported.
• Field PlanAttributes.Locked is deprecated (Removal date: 2024-02-28). No longer supported.
• Field ProjectAttributes.Locked is deprecated (Removal date: 2024-02-28). No longer supported.

The Develop and ShowZoningEnvelopes fields on ParcelAttributes have been deprecated:

• Field ParcelAttributes.Develop is deprecated (Removal date: 2024-02-28). Use the Demolish field instead.
• Field ParcelAttributes.ShowZoningEnvelopes is deprecated (Removal date: 2024-02-22). This field is no longer used. After improving the zoning workflow in the Urban web app, manually turning envelopes on and off for individual parcels will no longer be available.

Upcoming breaking changes

Changes scheduled for 2023-10-25

The default value for the async argument on createUrbanModel and createUrbanDesignDatabase will be changed from false to true.

This is a potential breaking change for clients that do not explicitly specify the async argument. Specify the async argument explicitly to prevent your application from breaking. It is strongly recommended to set async to true, as the async: false option will not be supported in the long-term future.

Use the following operations to create a new urban model or urban design database using the async: true parameter.

1. Create a new urban model using the createUrbanModel mutation and specify async: true:

1
2
3
4
5
6
7
mutation {
  createUrbanModel(
    title: "URBAN_MODEL_NAME",
    folderId: "FOLDER_ID"
    async: true
  )
}

The response should look something like this:

1
2
3
4
5
{
  "data": {
    "createUrbanModel": "96de6000c21c48bf87707154b711e7e5"
  }
}

2. Periodically check the status of the urban model, for example each 10 seconds:

1
2
3
4
5
6
7
query {
  urbanModel(urbanModelId: "96de6000c21c48bf87707154b711e7e5") {
    upgradeInfo {
      upgradeStatus
    }
  }
}

The response tells you if the urban model is ready or not:

1
2
3
4
5
6
7
8
9
{
  "data": {
    "urbanModel": {
      "upgradeInfo": {
        "upgradeStatus": "InProgress"
      }
    }
  }
}

Wait for the upgradeStatus to become Ready. Now your urban model is ready to be used.