ArcGIS REST API

Enable Subnetwork Controller

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

Description

A subnetwork controller is the origin (or destination) of resource flow for a subpart of the network (for example, a circuit breaker in electric networks or a town border station in gas networks). Controllers correspond to Devices that have the Subnetwork Controller network capability set.

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. 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 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 network controller participates in.

Syntax: networkSourceId=<networkSourceId>

featureGlobalId

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

Syntax: featureGlobalId=<guid>

terminalID

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

Syntax:terminalID=<terminalID>

subnetworkControllerName

Description: The name of the subnetwork controller.

Syntax:subnetworkControllerName=<name>

subnetworkName

Description: Optional parameter specifying the name of the subnetwork.

Syntax:subnetworkName=<name>

tierName

Description: The name of the tier.

Syntax: tierName=<name>

description

Description: Optional parameter representing the description of the subnetwork controller (default is null).

Syntax: description=<string>

notes

Description: Optional parameter representing the notes associated with the subnetwork controller.

Syntax: notes=<notes>

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