Update Subnetwork
- URL:https:<utilitynetworkservice-url>/updateSubnetwork(POST only)
- Version Introduced:10.6
Description
A subnetwork is updated by calling the updateSubnetwork operation. With this operation, one or all of the subnetworks in a single tier can be updated. When a subnetwork is updated, four things can occur; 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 finally diagrams are generated or updated for the subnetwork.
License:Request parameters
Parameter | Details |
|---|---|
| f | 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 | 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> |
| domainNetworkName | The name of the domain network that the subnetwork is a part of. Syntax: domainNetworkName=<name> |
| tierName | The name of the tier that the subnetwork is a part of. Syntax: tierName=<name> |
| subnetworkName | Optional parameter representing the name of the subnetwork to update. If this parameter is not specified, the allSubnetworksInTier should be set to true, otherwise an error will be reported. Syntax: subnetworkName=<name> |
| allSubnetworksInTier | Optional Boolean parameter that is set to true when all the subnetworks in a tier need to be updated (default is false). |
| continueOnFailure | Optional Boolean parameter to continue updating subnetworks when allSubnetworksInTier is true and a failure occurs when processing a subnetwork (default is false). |
| traceConfiguration | Optional parameter representing the collection of trace configuration parameters. See the traceConfiguration parameter in the Trace topic. Syntax: traceConfiguration=<trace configuration> |
| async | 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
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 statusURL 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> ]
}
}