Enable Topology

Description

The enableTopology operation enables the network topology for a utility network in the DEFAULT version. When the topology is enabled, all feature and association edits generate dirty areas, which are then consumed when you use validate to update the network topology. When the topology is enabled, the following happens:

• The topology is built and updated for the full extent of the network.
• All errors are deleted.
• Any new errors are added to the dirty areas sublayer of the utility network.
• The topology is marked as enabled.

You can enable the topology using either an asynchronous or synchronous job. While the network is being enabled, all other sessions connected to the DEFAULT version are blocked from running validate or enable operations. This operation is not supported with named versions.

• This operation must be run by the portal utility network owner.

Request parameters

JSON Response syntax

JSON response (when async = false):

1
2
3
4
5
6
7
8
9
{
  "moment" : <datetime>,
  "success" : <true | false>,
  "error" : {                   // only if success is false
    "extendedCode” : <HRESULT>,
    "message" : <error message>,
    "details" : [ <detail> ]
  }
}

JSON response (when async = true):

1
2
3
{
  "statusUrl" : <url>
}

JSON response to the status URL (when pending or in progress):

1
2
3
4
5
{
  "status" : "<Pending | InProgress>",
  "submissionTime" : <datetime>,
  "lastUpdatedTime" : <datetime>
 }

Example usage

Enable the network topology for a utility network using the enableTopology operation.

Request URL and parameters:

https://myserver.esri.com/server/rest/services/LandUse/UtilityNetworkServer/enableTopology

1
2
3
f=json
maxErrorCount=1000
async=false

JSON response:

1
2
3
4
{
 "moment": 1554336000000,
 "success": true
}