ArcGIS REST API

Find Diagram Infos

Description

The findDiagramInfos operation is performed on a Network Diagrams Service resource. The result of this operation is an array of Diagram Information JSON objects.

It returns the diagram info object for each of the diagram names specified in input.

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

moment

Description: The session moment.

Syntax: moment=<moment>

Example: moment=1490867969324

diagramNames

Required

Description: An array of strings, each one corresponding to a diagram name, for which you want to get diagram information.

Syntax: diagramNames = ["<diagramName1>",…,"<diagramNameN>"]

Example: diagramNames = ["Basic_RMT001","DiagramTest1"]

f

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

Values: <html | json>

Example Usage

Retrieving the diagram information objects for two diagrams called "DiagramTest1" and "DiagramTest2" in version called ABV1, that is, running the findDiagramInfos operation with diagramNames = ["DiagramTest2","DiagramTest1"]: http://batz.esri.com/server/rest/services/Naperville/NetworkDiagramServer/findDiagramInfos?gdbVersion=ABV1&sessionId=&moment=&diagramNames=%5B%22DiagramTest1%22%2C%22DiagramTest2%22%5D&f=pjson

JSON Response Syntax

{
 "diagramInfos": [
  <diagramInfo1>,
  …,
  <diagramInfoN>
}

See Diagram JSON Information object to get the syntax for each <diagramInfo> object in the output array.

JSON Response Example

{
 "diagramInfos": [
  {
   "tag": "",
   "isStored": true,
   "isSystem": false,
   "creator": "acb7352",
   "creationDate": 1505219137000,
   "lastUpdateBy": "acb7352",
   "lastUpdateDate": 1505219137000,
   "containerMargin": 0.5,
   "junctionCount": 11,
   "edgeCount": 10,
   "containerCount": 1,
   "aggregationCount": 0,
   "access": "esriDiagramPublicAccess",
   "diagramExtent": {
    "xmin": 6807591.7656002343,
    "ymin": 1847967.7367558032,
    "xmax": 6808661.8976463079,
    "ymax": 1848650.1848659664,
    "spatialReference": {
     "wkid": 3498,
     "latestWkid": 3498
    }
   },
   "networkExtent": {
    "xmin": 6807591.7656002343,
    "ymin": 1847967.7367558032,
    "xmax": 6808661.8976463079,
    "ymax": 1848650.1848659664,
    "spatialReference": {
     "wkid": 3498,
     "latestWkid": 3498
    }
   },
   "name": "DiagramTest1",
   "id": "{033B675B-0DFF-4E82-85BC-85DD1235D42C}",
   "template": "Basic",
   "consistencyState": "esriDiagramHasDirtyFeatures"
  },
  {
   "tag": "",
   "isStored": true,
   "isSystem": false,
   "creator": "acb7352",
   "creationDate": 1505146520000,
   "lastUpdateBy": "acb7352",
   "lastUpdateDate": 1505146520000,
   "containerMargin": 0.5,
   "junctionCount": 10,
   "edgeCount": 9,
   "containerCount": 0,
   "aggregationCount": 3,
   "access": "esriDiagramPublicAccess",
   "diagramExtent": {
    "xmin": 6807591.7656002343,
    "ymin": 1847967.7367558032,
    "xmax": 6808661.8976463079,
    "ymax": 1848650.1848659664,
    "spatialReference": {
     "wkid": 3498,
     "latestWkid": 3498
    }
   },
   "networkExtent": {
    "xmin": 6807591.7656002343,
    "ymin": 1847967.7367558032,
    "xmax": 6808661.8976463079,
    "ymax": 1848650.1848659664,
    "spatialReference": {
     "wkid": 3498,
     "latestWkid": 3498
    }
   },
   "name": "DiagramTest2",
   "id": "{A611F65A-F6C9-445B-A6C2-35C9EF1CF107}",
   "template": "CollapseContainers",
   "consistencyState": "esriDiagramIsConsistent"
  }
 ]
}