ArcGIS REST API

Enable Topology

  • URL:https://<utlitynetworkservice-url>/enableTopology(POST only)
  • Version Introduced:10.6

Description

Enabling the network topology for a utility network is done on the DEFAULT version. Enabling is not supported in named versions. When the topology is enabled, all feature and association edits generate dirty areas which are then consumed when the network topology is updated. When the topology is enabled:

  • Any existing error features are deleted.
  • The topology will be updated for the full extent of the network.
  • Any newly discovered error features will be added to the error tables.
  • The topology is marked as enabled.

Enabling the topology requires that there are no active transactions making modifications to any feature class. While the network is being enabled, all editing will be blocked, as well as modifications to the utility network definition.

License:
The ArcGIS Utility Network Management extension is required to use these resources.

Request Parameters

ParameterDetails
f

Description: Optional parameter representing the output format of the response. The default response format is html.

Values: html | json.

maxErrorCount

Description: Optional parameter specifying when the process of enabling the network topology will stop if the maximum number of errors is met. Errors will be recorded in the error tables. The default value is 10,000. Setting a value of 0 will ignore the restriction for max errors.

Syntax: maxErrorCount=<integer>

Example: maxErrorCount=10000

JSON Response Syntax

JSON response syntax for enableTopology

{ 
  "statusUrl" : <url>
}

JSON response to the status URL (when pending or in progress):
{
  "status" : "<Pending | InProgress>",
  "submissionTime" : <datetime>,
  "lastUpdatedTime" : <datetime>
 }

JSON response to the status URL (when completed):
{
  "moment" : <datetime>,
  "hasErrors" : <true | false>,
  "status" : "Completed",
  "submissionTime" : <datetime>,
  "lastUpdatedTime" : <datetime>,
  "success" : <true | false>,
  "error" : {                   // only if success is false
    "extendedCode” : <HRESULT>,
    "message" : <error message>,
    "details" : [ <detail> ]
  }
}