Skip To Content
ArcGIS Developers
Dashboard

Disable Subnetwork Controller

Description

A subnetwork controller is the origin (or destination) of resource flow for a subpart of the network. Examples of subnetwork controllers are circuit breakers in electric networks or town border stations in gas networks. Subnetwork controllers correspond to devices that have the Subnetwork Controller network capability set. A subnetwork controller is removed with the disableSubnetworkController operation.

License:
The active portal account must be licensed with the ArcGIS Utility Network user type extension to use this operation.

Request parameters

ParameterDetails
f

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

Description: Optional parameter representing 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

Description: The network source ID that the subnetwork controller participates in.

Syntax: networkSourceId=<networkSourceId>

featureGlobalId

Required

Description: The global ID of the device being disabled as a network controller.

Syntax: featureGlobalId=<guid>

terminalId

Description: The terminal ID of the device being disabled as a network controller.

Syntax: terminalId=<terminalID>

JSON Response syntax

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

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

JSON response:

{
 "exceededTransferLimit": false,
 "serviceEdits": [
  
 ],
 "moment": 1554214503427,
 "success": true
}