Enable Topology

URL:
https://<root>/<serviceName>/UtilityNetworkServer/enableTopology
Methods:
POST
Required Capability:
Requires the portal utility network owner and ArcGIS Advanced Editing user type extension license
Version Introduced:
10.6

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.

Request parameters

ParameterDetails

f

Specifies the output format of the response. The default response format is html .

Use dark colors for code blocksCopy
1
f=html | json | pjson

maxErrorCount

(Optional)

The maxErrorCount specifies the threshold of errors that will stop the process of enabling the network topology when met. The default value is 10,000.

Syntax: maxErrorCount=<integer>

Example: maxErrorCount=10000

async

(Optional)

Introduced at ArcGIS Enterprise 10.9.1. If true, the request is processed as an asynchronous job, and a URL is returned that a client can visit to check the status of the job. The default is false.

Use dark colors for code blocksCopy
1
async=true | false

JSON Response syntax

JSON response (when async = false):

Use dark colors for code blocksCopy
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):

Use dark colors for code blocksCopy
1
2
3
{
  "statusUrl" : <url>
}

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

Use dark colors for code blocksCopy
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

Use dark colors for code blocksCopy
1
2
3
f=json
maxErrorCount=1000
async=false

JSON response:

Use dark colors for code blocksCopy
1
2
3
4
{
 "moment": 1554336000000,
 "success": true
}

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