Update Subnetwork

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 updateSubnetwork 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

Parameter	Details
`f`	The output format of the response. The default response format is `html`. Values: `html` \| `json` \| `pjson`
`gdbVersion` (Optional)	Specifies the name of the geodatabase version. The default is 'sde.DEFAULT'. Syntax: `gdbVersion=<version>`
`sessionId` (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: `sessionId=<guid>`
`domainNetworkName` (Required)	The name of the domain network that the subnetwork is a part of. Syntax: `domainNetworkName=<name>`
`tierName` (Required)	The name of the tier that the subnetwork is a part of. Syntax: `tierName=<name>`
`subnetworkName` (Optional)	Specifies the name of the subnetwork to update. If this parameter is not specified, the `allSubnetworksInTier` parameter 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. The default is false.
`continueOnFailure` (Optional)	Boolean parameter to continue updating subnetworks when `allSubnetworksInTier` is true and a failure occurs when processing a subnetwork. The default is false.
`traceConfiguration` (Optional)	Specifies the collection of trace configuration parameters. See the `traceConfiguration` parameter in the Trace topic. Syntax: `traceConfiguration=<trace configuration>`
`async` (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 `false`. Values: `true` \| `false`

f

The output format of the response. The default response format is html.

Values: html | json | pjson

gdbVersion

(Optional)

Specifies the name of the geodatabase version. The default is 'sde.DEFAULT'.

Syntax: gdbVersion=<version>

sessionId

(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: sessionId=<guid>

domainNetworkName

(Required)

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

Syntax: domainNetworkName=<name>

tierName

(Required)

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

Syntax: tierName=<name>

subnetworkName

(Optional)

Specifies the name of the subnetwork to update. If this parameter is not specified, the allSubnetworksInTier parameter 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. The default is false.

continueOnFailure

(Optional)

Boolean parameter to continue updating subnetworks when allSubnetworksInTier is true and a failure occurs when processing a subnetwork. The default is false.

traceConfiguration

(Optional)

Specifies the collection of trace configuration parameters. See the traceConfiguration parameter in the Trace topic.

Syntax: traceConfiguration=<trace configuration>

async

(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 false.

Values: true | false

JSON Response syntax

Response when async = false:

Use dark colors for code blocksCopy
{
  "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 :

Use dark colors for code blocksCopy
{
  "statusUrl" : <url>
}

Response to the statusURL when either pending or in progress:

Use dark colors for code blocksCopy
{
  "status" : “<Pending | InProgress>”,
  "submissionTime" : <datetime>,
  "lastUpdatedTime" : <datetime>
}

Response to the status URL when completed:

Use dark colors for code blocksCopy
{
  "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> ]
  }
}