Skip To Content ArcGIS for Developers Sign In Dashboard

Disable Topology

Description

Disables the network topology for a utility network. When the topology is disabled, feature and association edits do not generate dirty areas. Analytics and diagram generation can't be performed if the topology is not present.

When the topology is disabled:

  • All rows at the current moment in the topology tables are deleted.
  • No dirty areas are generated from edits.
  • Remaining error features still exist and can be cleaned up without the overhead of dirty areas.

In order to perform certain network configuration tasks, the network topology must be disabled.

  • This operation must be executed by the portal utility network owner.
  • The topology can be disabled in the DEFAULT version or in a user version. If disabled in a child version, it may not be later enabled in the child version.
    • If the topology is disabled in a user version, the reconcile process can be used to inherit the topology state from the default branch version.

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.

gdbVersion

Description: Optional parameter specifying the name of the geodatabase version (default is DEFAULT).

Syntax: gdbVersion=<version>

Example: gdbVersion=sde.DEFAULT

sessionId

Description: Optional parameter representing the token (guid) used to lock the version. If the calling client is editing a named version, the sessionId must be provided; if the client is editing DEFAULT, the version may not be locked and the sessionId should not be specified.

Syntax: sessionId=<guid>

Example: sessionId={29CC8FF6-D6C6-4157-A9A8-A9A9BCFE07D1}

JSON Response Syntax

JSON response syntax for disableTopology:

{
  "moment" : <datetime>,
  "success" : <true | false>,
  "error" : {                   // only if success is false
    "extendedCode" : <HRESULT>,
    "message" : <error message>,
    "details" : [ <detail> ]
  }
}

Example usage

Disable the network topology for a utility network using the disableTopology operation.

Request URL and parameters:

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

f=json
gdbVersion=SDE.DEFAULT
sessionID=

JSON response:

{
 "moment": 1554393356246,
 "success": true
}