Validate Network Topology
- URL:https://<utilitynetworkservices-url>/validateNetworkTopology(POST only)
- Version Introduced:10.6
Description
Validating the network topology for a utility network maintains consistency between feature editing space and network topology space. Validating a network topology may include all or a subset of the dirty areas present in the network. Validation of network topology is supported synchronously and asynchronously.
License:Request Parameters
Parameter | Details |
|---|---|
| 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> |
| 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> |
| validateArea | Description: The envelope of the area to validate. |
| 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. See the topic on asynchronous usage for more information. The default is false. Values: "true" | "false" |
JSON Response Syntax
JSON response (when async = false):
{
"moment" : <datetime>,
"fullUpdate" : <true | false>,
"validateErrorsCreated" : <true | false>,
"dirtyAreaCount" : <long>,
"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>
}
JSON response to the status URL (when completed):
{
"moment" : <datetime>,
"fullUpdate" : <true | false>,
"validateErrorsCreated" : <true | false>,
"dirtyAreaCount" : <long>,
"status" : "Completed",
"submissionTime" : <datetime>,
"lastUpdatedTime" : <datetime>,
"success" : <true | false>,
"error" : { // only if success is false
"extendedCode" : <HRESULT>,
"message" : <error message>,
"details" : [ <detail> ]
}
}