- URL:
- https://<root>/<serviceName>/UtilityNetworkServer/updateSubnetwork
- Methods:
POST
- Required Capability:
- Requires the ArcGIS Advanced Editing user type extension license
- Version Introduced:
- 10.6
Description
A subnetwork is updated by calling the update
operation. With this operation, one or all of the subnetworks in a single tier can be updated. When a subnetwork is updated, a trace is performed from all subnetwork controllers, the Subnetwork Name attribute is updated for all features in the subnetwork; the record representing the subnetwork inside the SubnetLine class is refreshed; the Subnetworks table is updated; and diagrams are generated or updated for the subnetwork. When a subnetwork is succcessfully updated it is considered clean (or consistent) and its record in the SubnetLine feature class, subnetwork system diagrams, and various fields for modified network features are updated and are in sync with changes made to the network topology.
To learn more, see Update a subnetwork.
Request parameters
Parameter | Details |
---|---|
| The output format of the response. The default response format is
|
(Optional) | Specifies the name of the geodatabase version. The default is 'sde.DEFAULT'. Syntax: |
(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: |
(Required) | The name of the domain network that the subnetwork is a part of. Syntax: |
(Required) | The name of the tier that the subnetwork is a part of. Syntax: |
(Optional) | Specifies the name of the subnetwork to update. If this parameter is not specified, the Syntax: |
(Optional) | Boolean parameter that is set to true when all the subnetworks in a tier need to be updated. The default is false.
|
(Optional) | Boolean parameter to continue updating subnetworks when
|
(Optional) | Specifies the collection of trace configuration parameters. See the Syntax: |
(Optional) | 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
|
JSON Response syntax
Response when async = false
:
{
"moment" : <datetime>,
"failures" : [ // only if continueOnFailure = true
{
"subnetworkName" : <name>,
"extendedError" : <long>,
"message" : <error message>
}
],
"success" : <true | false>,
"error" : { // only if success is false
"extendedCode" : <HRESULT>,
"message" : <error message>,
"details" : [ <detail> ]
}
}
Response when async = true
:
{
"statusUrl" : <url>
}
Response to the status
when either pending or in progress:
{
"status" : “<Pending | InProgress>”,
"submissionTime" : <datetime>,
"lastUpdatedTime" : <datetime>
}
Response to the status URL when completed:
{
"moment” : <datetime>,
"status” : “Completed”,
"submissionTime” : <datetime>,
"lastUpdatedTime” : <datetime>,
"failures" : [ // Only if continueOnFailure = true
{
"subnetworkName" : <name>,
"extendedCode" : <HRESULT>,
"message" : <error message>
}
],
"success" : <true | false>,
"error" : { // only if success is false
"extendedCode" : <HRESULT>,
"message" : <error message>,
"details" : [ <detail> ]
}
}