Diagram

Description

The Diagram resource represents a single network diagram under a Network Diagrams service. It is returned as a Diagram JSON Information object.

It supports three child resources:

  • Diagram Map—which mimics a map service resource for the network diagram,
  • Dynamic Layers—which describes the sublayers under the diagram layer,
  • Layer Definitions—which details the layer and labeling properties that define each sublayer under the diagram layer.
and a large set of operations:
  • overwriteFromFeatures—Overwrites the diagram resource content from a set of utility network feature Global IDs.
  • appendFeatures—Appends a set of utility network features to the diagram resource.
  • update—Updates the diagram resource content; that is, reflect any changes that may have impacted the network features that have been used to build the diagram.
  • extend—Extends the diagram resource content one feature level by connectivity, traversability, containment or attachment.
  • store—Stores the temporary network diagram resource in the database.
  • findNetworkFeatures—Searches for the utility network features associated with the set of diagram features referenced in the diagram resource.
  • findDiagramFeatures—Searches for the diagram features referenced in the diagram resource that are associated with a set of utility network features or a set of diagram features represented in another network diagram.
  • getAggregations—Returns the list of the diagram aggregations represented in the diagram resource.
  • saveLayout—Saves new geometries that may have been computed for a set of diagram features represented in the diagram resource.
  • applyLayout—Applies a diagram layout algorithm on the diagram resource.
  • applyTemplateLayouts—Applies the list of the layout algorithms configured on the template.
  • manageFlag—Adds or removes a flag on a particular diagram feature
  • clearFlags—Clears all the flags on the diagram resource.
  • getFlags—Retrieves all the flags on the diagram resource.
  • queryDiagramElementsByExtent—Retrieves the set of diagram features represented in the diagram resource that intersect a specified envelope.
  • queryDiagramElementsByObjectIDs—Retrieves the set of diagram features represented in the diagram resource with the specified ObjectIDs.

Diagram REST end point

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

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

moment

Description: The session moment.

Syntax: moment=<moment>

Example: moment=1490867969324

f

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

Values: <html | json>

Example Usage

Accessing the DiagramTest1 REST end point in Default: http://batz.esri.com/server/rest/services/Naperville/NetworkDiagramServer/diagrams/DiagramTest1?f=pjson

Accessing the DiagramTest1 REST end point in a specific version called 'ABV1': http://batz.esri.com/server/rest/services/Naperville/NetworkDiagramServer/diagrams/DiagramTest1?gdbversion=ABV1&f=pjson

JSON Response Syntax

A Diagram JSON Information object.

JSON Response Example

{
 "tag": "#ElectricDistribution#RMT001#Medium Voltage Radial",
 "isStored": true,
 "isSystem": true,
 "creator": "acb7352",
 "creationDate": 1503062040000,
 "lastUpdateBy": "acb7352",
 "lastUpdateDate": 1503062040000,
 "containerMargin": 0.5,
 "junctionCount": 5701,
 "edgeCount": 6264,
 "containerCount": 668,
 "aggregationCount": 0,
 "access": "esriDiagramPublicAccess",
 "diagramExtent": {
  "xmin": 1027304.9786740914,
  "ymin": 1862504.1933266893,
  "xmax": 1036507.4494423419,
  "ymax": 1869488.4421534389,
  "spatialReference": {
   "wkid": 102671,
   "latestWkid": 3435
  }
 },
 "networkExtent": {
  "xmin": 1027304.9786740914,
  "ymin": 1862504.1933266893,
  "xmax": 1036507.4494423419,
  "ymax": 1869488.4421534389,
  "spatialReference": {
   "wkid": 102671,
   "latestWkid": 3435
  }
 },
 "name": "DiagramTest1",
 "id": "{6F1E9192-A2C4-401D-B044-C02BBC99BE3A}",
 "template": "Basic"
}