- URL:https://<utilitynetworkservice-url>/disableTopology(POST only)
- Version Introduced:10.6
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, 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.
License:
The active portal account must be assigned a license with the ArcGIS Advanced Editing user type extension to use this operation.Request parameters
| Parameter | Details |
|---|---|
| f | Description: Optional parameter specifying 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 specifying 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 | Description: 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. Values: true | false This parameter was introduced at ArcGIS Enterprise 10.9.1 |
JSON Response syntax
JSON response (when async = false):
{
"moment" : <datetime>,
"success" : <true | false>,
"error" : { // only if success is false
"extendedCode" : <HRESULT>,
"message" : <error message>,
"details" : [ <detail> ]
}
}
JSON response (when async = true):
{
"statusUrl" : <url>
}
JSON response to the status URL (when pending or in progress):
{
"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
f=json
gdbVersion=SDE.DEFAULT
sessionID={29CC8FF6-D6C6-4157-A9A8-A9A9BCFE07D1}
async=falseJSON response:
{
"moment": 1554393356246,
"success": true
}