Extend (Network Diagrams)

Description

The extend operation is performed on a Diagram resource. The result of this operation is a Diagram JSON Information object, and the moment the edit operation happens for a stored diagram.

It is used to extend the diagram resource content one connectivity level, optionally regarding to the traversability over the network.

License:
The ArcGIS Utility Network Management extension is required to use this operation.

Request Parameters

ParameterDetails
gdbVersion

Description: The name of the geodatabase version.

Syntax: gdbVersion=<version>

Example: gdbVersion=ABV1

sessionId

Description: The token (guid) used to lock the version.

Syntax: sessionId=<guid>

Example: sessionId=44G259DE-87B0-407D-8F2E-DCB7665DD0F0

ignoreTraversability

Description: Boolean.

  • True— Extend the diagram content without taking the traversability of the network into account (default); that is, extend the diagram one connectivity level regarding to the simple network topology.
  • False—Extend the diagram content while taking the traversability of the network into account; that is, extent the diagram one connectivity level regarding to resources that could limit the flow to traverse; for example, closed valves or disconnected zones.
Legacy:

This parameter is deprecated at 10.6.1. It is systematically ignored whatever its value, when the extendType is specified. However, to maintain compatibility with 10.6.0, it remains interpreted when the extendType parameter is not specified.

Syntax: ignoreTraversability= <true | false>

Example: ignoreTraversability= false

extendType

Description: The type of extend you want to process.

Syntax: extendType=<esriDiagramExtendByAttachment | esriDiagramExtendByConnectivity | esriDiagramExtendByTraversability | esriDiagramExtendByContainment>

Example: extentType = esriDiagramExtendByConnectivity

fromFeatures

Description: An array of diagram feature Global IDs, those diagram features being those from which the extend process will execute.

Syntax: fromFeatures=["<globalID1>", ...,"<globalIDN>]

Example: fromFeatures=["{22E157ED-68A0-407D-9F06-A030C5A1995F}"]

f

Description: The response format. The default response format is html.

Values: <html | json>

Example Usage

Extending one connectivity level the newly created temporary diagram which Name is 7C458C4491F94B5591635AFA029816FF: http://batz.esri.com/server/rest/services/Naperville/NetworkDiagramServer/diagrams/7C458C4491F94B5591635AFA029816FF/extend?gdbVersion=ABV1&sessionId=&ignoreTraversability=true&f=pjson

Extending the diagram called DiagramTest1 one connectivity level regarding to the traversability over the network: http://batz.esri.com/server/rest/services/Naperville/NetworkDiagramServer/diagrams/DiagramTest2/extend?gdbVersion=&sessionId=&ignoreTraversability=false&f=pjson

JSON Response Syntax

A JSON object composed of a Diagram JSON Information object and a moment: {"diagramInfo": Diagram JSON Information, "moment": <moment>}

Note:

The moment is only returned for a stored diagram.

JSON Response Example

{
 "diagramInfo": {
  "tag": "",
  "isStored": true,
  "isSystem": false,
  "creator": "acb7352",
  "creationDate": 1503065870000,
  "lastUpdateBy": "acb7352",
  "lastUpdateDate": 1503066275000,
  "containerMargin": 0.5,
  "junctionCount": 38,
  "edgeCount": 37,
  "containerCount": 5,
  "aggregationCount": 0,
  "access": "esriDiagramPublicAccess",
  "diagramExtent": {
   "xmin": 1033445.9759065136,
   "ymin": 1871200.7451592833,
   "xmax": 1034656.045008678,
   "ymax": 1871864.0919296965,
   "spatialReference": {
    "wkid": 102671,
    "latestWkid": 3435
   }
  },
  "networkExtent": {
   "xmin": 1033446.4759055115,
   "ymin": 1871201.2451582849,
   "xmax": 1034656.045008678,
   "ymax": 1871863.5919306949,
   "spatialReference": {
    "wkid": 102671,
    "latestWkid": 3435
   }
  },
  "name": "DiagramTest1",
  "id": "{22C1EEB8-1152-440F-B2FF-6B7C6A43076E}",
  "template": "ExpandContainers"
 },
 "moment": 1503066274871
}