- URL:https://<utilitynetworkservice-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 you use validate to update the network topology. When the topology is enabled, the following happens:
- The topology is updated for the full extent of the network.
- All errors are deleted.
- Any new errors are added to the dirty areas sublayer.
- The topology is marked as enabled.
Enabling the topology is supported both synchronously and asynchronously. While the network is being enabled, all other sessions connected to the DEFAULT version are blocked from running validate or enable operations.
- This operation must be run by the portal utility network owner.
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 |
| 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. Syntax: maxErrorCount=<integer> Example: maxErrorCount=10000 |
| 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
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
f=json
maxErrorCount=1000
async=falseJSON response:
{
"moment": 1554336000000,
"success": true
}