Disable Subnetwork Controller

URL:: https://<root>/<serviceName>/UtilityNetworkServer/disableSubnetworkController
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 disableSubnetworkController operation removes the subnetwork controller capability from a terminal on 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)	Specifies the network source ID of the class that the subnetwork controller participates in. Syntax: `networkSourceId=<networkSourceId>`
`featureGlobalId` (Required)	Specifies the global ID of the device being disabled as a subnetwork controller. Syntax: `featureGlobalId=<guid>`
`terminalId` (Required)	Specifies the terminal ID of the device being disabled as a subnetwork controller. Syntax: `terminalId=<terminalID>`
`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)

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

Syntax: networkSourceId=<networkSourceId>

featureGlobalId

(Required)

Specifies the global ID of the device being disabled as a subnetwork controller.

Syntax: featureGlobalId=<guid>

terminalId

(Required)

Specifies the terminal ID of the device being disabled as a subnetwork controller.

Syntax: terminalId=<terminalID>

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

Example usage

Disable a subnetwork controller using the disableSubnetworkController operation.

Request URL and parameters:

https://myserver.esri.com/server/rest/services/LandUse/UtilityNetworkServer/disableSubnetworkController

Use dark colors for code blocksCopy
f=json
gdbVersion=UNADMIN.CAROLINA
sessionId={B8BB5DF8-5DA4-4706-98DB-7398BFCFA290}
featureGlobalId={B8493B23-B40B-4E3E-8C4B-0DD83C28D2CC}
networkSourceId=6
terminalId=6

JSON response:

Use dark colors for code blocksCopy
{
 "exceededTransferLimit": false,
 "serviceEdits": [

 ],
 "moment": 1554214503427,
 "success": true
}