Disable Topology

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

Description

The disableTopology operation 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, the following happens:

  • All current rows in the topology tables are deleted.
  • No dirty areas are generated from edits.
  • Remaining errors and their associated dirty areas still exist and can be cleaned up.

Disabling the topology is supported both synchronously and asynchronously. To perform certain network configuration tasks, the network topology must be disabled.

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

  • The topology can be disabled in the default version or in a named version. If disabled in a named version, it may not be later enabled in the named version. The reconcile process should be used to inherit the topology state from the default branch version.

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

gdbVersion

(Optional)

Specifies the name of the geodatabase version. The default is sde.DEFAULT.

Syntax: gdbVersion=<version>

Example: gdbVersion=sde.DEFAULT

sessionId

(Optional)

Specifies the token guid used to lock the version. If the calling client is editing a named version, the session ID must be provided; if the client is editing DEFAULT, the version may not be locked and the session ID should not be specified.

Syntax: sessionId=<guid>

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

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

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

Use dark colors for code blocksCopy
1
2
3
4
f=json
gdbVersion=SDE.DEFAULT
sessionID={29CC8FF6-D6C6-4157-A9A8-A9A9BCFE07D1}
async=false

JSON response:

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

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