ArcGIS REST API

Update Subnetwork

  • URL:http:<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:
The ArcGIS Utility Network Management extension is required to use these resources.

Request Parameters

ParameterDetails
f

Description: Optional parameter representing the output format of the response (default is JSON).

gdbVersion

Description: 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>

domainNetworkName

Description: The name of the domain network that the subnetwork is a part of.

Syntax: domainNetworkName=<name>

tierName

Description: The name of the tier that the subnetwork is a part of.

Syntax: tierName=<name>

subnetworkName

Description: 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

Description: Optional Boolean parameter that is set to true when all the subnetworks in a tier need to be updated (default is false).

continueOnFailute

Description: Optional Boolean parameter to continue updating subnetworks when allSubnetworksInTier is true and a failure occurs when processing a subnetwork (default is false).

traceConfiguration

Description: Optional parameter representing the collection of trace configuration parameters (see above).

Syntax: traceConfiguration=<trace configuration>

JSON Response Syntax

{
  "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> ]
  }
}