Synthesize Association Geometries

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

Description

The synthesizeAssociationGeometries operation is used to export geometries representing associations that are synthesized as line segments corresponding to the geometries of the devices at the endpoints. All features associated with an association must be in the specified extent in order for the geometry to be synthesized. If only zero or one of the devices/junctions intersects the extent, then no geometry will be synthesized.

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 has previously started a service session (editing) and holds an exclusive lock on the specified version, the request will fail if the sessionId is not provided. If the specified version is currently locked by any other session, the request will fail if the sessionId is not provided or does not match the sessionId which holds the exclusive lock.

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.

attachmentAssociations

Description: Optional boolean parameter representing whether to return attachment associations (default is false).

Values: "true" | "false"

connectivityAssociations

Description: Optional boolean parameter representing whether to return connectivity associations (default is false).

Values: "true" | "false"

containmentAssociations

Description: Optional boolean parameter representing whether to return containment associations (default is false).

Values: "true" | "false"

extent

Description: Optional boolean parameter representing whether to return containment associations (default is false).

Values: "true" | "false"

JSON Response Syntax

JSON response:

{
  "maxGeometryCountExceeded" : <true | false>,
  "associations" : [
    {
      "globalId" : <guid>,
      "associationType" : <attachment | connectivity | containment>,
      "fromNetworkSourceId" : <long>,
      "fromGlobalId" : <guid>,
      "fromTerminalId" : <long>,
      "toNetworkSourceId" : <long>,
      "toGlobalId" : <guid>,
      "toTerminalId" : <long>,
      "geometry" : <geometry>
    }
  ],
  "success" : <true | false>,
  "error" : {                   // only if success is false
    "extendedCode" : <HRESULT>,
    "message" : <error message>,
    "details" : [ <detail> ]    
  }
}