Enable Subnetwork Controller

URL:: https://<root>/<serviceName>/UtilityNetworkServer/enableSubnetworkController
Methods:: POST
Required Capability:: Requires the ArcGIS Advanced Editing user type extension license
Version Introduced:: 10.6

Description

Subnetwork controllers correspond to devices that have the Subnetwork Controller network capability set. The enableSubnetworkController operation adds the subnetwork controller capability to the terminal of a device or junction object. A subnetwork controller specifies the origin (or destination) of a subnetwork and defines how resources flow through a network. Examples of subnetwork controllers include circuit breakers in electric networks or town border stations in gas networks.

Request parameters

Parameter Details

Parameter	Details
`f`	Specifies the output format of the response. The default response format is `html` . Use dark colors for code blocksCopy `1 f=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>`
`networkSourceId` (Required)	The network source ID of the class that the subnetwork controller participates in. Syntax: `networkSourceId=<networkSourceId>`
`featureGlobalId` (Required)	The global ID of the device being enabled as a subnetwork controller. Syntax: `featureGlobalId=<guid>`
`terminalID` (Required)	The terminal ID of the device being enabled as a subnetwork controller. Syntax: `terminalID=<terminalID>`
`subnetworkControllerName` (Required)	The name of the subnetwork controller. Syntax: `subnetworkControllerName=<name>`
`subnetworkName` (Optional)	Specifies the name of the subnetwork. When a value is not provided, a unique guid is generated to represent the subnetwork name. Syntax: `subnetworkName=<name>`
`tierName` (Required)	The name of the tier to which the subnetwork belongs. Syntax: `tierName=<name>`
`description` (Optional)	Specifies the description of the subnetwork controller. The default is null. Syntax: `description=<string>`
`notes` (Optional)	Specifies any notes associated with the subnetwork controller. Syntax: `notes=<notes>`
`outSR` (Optional)	introduced at ArcGIS Enterprise 11.1. Specifies the output spatial reference. Syntax: `outSR={wkid=<wkid>}`

f

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

Use dark colors for code blocksCopy
f=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>

networkSourceId

(Required)

The network source ID of the class that the subnetwork controller participates in.

Syntax: networkSourceId=<networkSourceId>

featureGlobalId

(Required)

The global ID of the device being enabled as a subnetwork controller.

Syntax: featureGlobalId=<guid>

terminalID

(Required)

The terminal ID of the device being enabled as a subnetwork controller.

Syntax: terminalID=<terminalID>

subnetworkControllerName

(Required)

The name of the subnetwork controller.

Syntax: subnetworkControllerName=<name>

subnetworkName

(Optional)

Specifies the name of the subnetwork. When a value is not provided, a unique guid is generated to represent the subnetwork name.

Syntax: subnetworkName=<name>

tierName

(Required)

The name of the tier to which the subnetwork belongs.

Syntax: tierName=<name>

description

(Optional)

Specifies the description of the subnetwork controller. The default is null.

Syntax: description=<string>

notes

(Optional)

Specifies any notes associated with the subnetwork controller.

Syntax: notes=<notes>

outSR

(Optional)

introduced at ArcGIS Enterprise 11.1. Specifies the output spatial reference.

Syntax: outSR={wkid=<wkid>}

JSON Response syntax

Use dark colors for code blocksCopy
{
  "moment" : <datetime>
  "exceededTransferLimit : <true | false>,
  “serviceEdits" : [
    {
      "id" : <layerId>,
      "editedFeatures" :
        {
          "adds" : [<currentFeature1>, <currentFeature2>],
          "updates" : [
            [<originalFeature3>, <currentFeature3>],
            [<originalFeature4>, <currentFeature4>]
          ],
          "deletes" : [<originalFeature5>, <originalFeature6>]
        }
    }
  ],
  "success" : <true | false>,
  "error" : {                   // only if success is false
    "extendedCode" : <HRESULT>,
    "message" : <error message>,
    "details" : [ <detail> ]
}
}