Disable Subnetwork Controller

  • URL:http://<utilitynetworkservice-url>/disableSubnetworkController(POST only)
  • Version Introduced:10.6

Description

A subnetwork controller (or simply, a source or a sink) 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 source is removed with disableSubnetworkController.

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

networkSourceId

Description: The network source id that the source or sink participates in; required parameter.

Syntax: networkSourceId=<networkSourceId>

featureGlobalId

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

Syntax: featureGlobalId=<guid>

terminalId

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

Syntax: terminalId=<terminalID>

JSON Response Syntax

JSON response syntax for disableSubnetworkController

{
  "moment" : <datetime>
  "success" : <true | false>,
  "error" : {                   // only if success is false
    "hresult" : <HRESULT>,
    "message" : <error message>,
    "details" : [ <detail> ]
  }
}