ArcGIS REST API

Export Subnetwork

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

Description

The exportSubnetwork operation is used to export information about a subnetwork into a JSON file. That information can then be consumed by outside systems such as outage management and asset tracking. The exportSubnetwork operation allows you to delete corresponding rows in the Subnetwork Sources table as long as the IsDeleted attribute is set to True. This indicates a source feeding the subnetwork has been removed.

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>

moment

Description: Optional parameter representing the session moment (the default is the version current moment). This should only be specified by the client when they do not want to use the current moment.

domainNetworkName

Description: The name of the domain network that the subnetwork is a part of.

Syntax: domainNetworkName=<name>

tierName

Description: The name of the tier that the subnetwork is a part of.

Syntax: tierName=<name>

subnetworkName

Description: The name of the subnetwork to update.

Syntax: subnetworkName=<name>

exportAcknowledgement

Description: Optional parameter representing whether or not the export is acknowledged (default is false).

Values: "true" | "false"

traceConfiguration

Description: Optional parameter representing the collection of trace configuration parameters (see above).

Syntax: traceConfiguration=<trace configuration>

resultFields

Description: Optional parameter that specifies which fields on the elements to return (default is none).

Syntax :

[
  { 
    "layerId" : <layerId>,
    "resultFields" : [ <field1>, <field2>, . . . ]
  }
]
resultType

Description: Optional parameter representing the type of results to return.

Values: "elements" | "connectivity" | "networkAttributes" | "assetInfo" | "aggregatedGeometry"

JSON Response Syntax

JSON response:

{
  "moment" : <datetime>,
  "subnetworkHasBeenDeleted" : <true | false>,
  "elements" : [                        // optional
    {                                   // optional
      "networkSourceId" : <long>,       // optional
      "globalId" : <guid>,              // optional
      "objectId" : <oid>                // optional
      "terminalId" : <long>,            // optional
      "networkAttributes" : [           // optional
        "<networkAttribute1>" : <long>, // optional
        "<networkAttribute2>" : <long>  // optional
      ],                                // optional
      "assetGroup" : <long>,            // optional
      "assetType" : <long>              // optional
    }
  ],
  "url" : "<url>",              // url of created connectivity file
  "success" : <true | false>,
  "error" : {                   // only if success is false
    "extendedCode" : <HRESULT>,
    "message" : <error message>,
    "details" : [ <detail> ]  
  }
}

Connectivity file JSON response:

{ 
  "type" : "tabular",
  "subnetworkName" : <name>,
  "sourceMapping" : { "<sourceId1>" : <sourceName1>, 
                      "<sourceId2>" : <sourceName2>, . . .
  }
  "rows" : [
    {
      "viaSourceId" : <long>, 
      "viaGlobalId" : <guid>, 
      "viaSubtypeName" : <name>, 
      "viaGeometry" : <geometry>,
      "fromSourceId" : <long>, 
      "fromGlobalId" : <guid>, 
      "fromSubtypeName" : <name>, 
      "fromTerminalId" : <long>, 
      "fromGeometry" : <geometry>
      "toSourceId" : <long>, 
      "toGlobalId" : <guid>, 
      "toSubtypeName" : <name>, 
      "toTerminalId" : <long>, 
      "toGeometry" : <geometry>
    }
  ]
  "controllers: [
    {
      "networkSourceId" : <long>, 
      "globalId" : <guid>, 
      "terminalId" : <long>,
      "controllerName" : <name>
    },
  ]
}