ArcGIS REST API

Diagram Dataset

Description

The Diagram Dataset resource regroups the info related to each diagram template under a Network Diagrams service. It is returned as an array of diagram template info.

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

f

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

Values: <html | json>

Example Usage

http://batz.esri.com/server/rest/services/Naperville/NetworkDiagramServer/diagramDataset?f=pjson

JSON Response Syntax

An array of diagram template info that provides the following information:

  • name—The name of the diagram template (String).
  • description—The description of the diagram template (String).
  • creationDate—The template creation date (Date).
  • lastUpdateDate—The template's last update date (Date).
  • usedByATier—Whether the template is used to generate subnetwork system diagram in a tier (Boolean).
  • enableDiagramExtend—Whether the template enables diagram extend (Boolean).
  • enableDiagramStorage—Whether the template enables diagram storage (Boolean).

{
 "diagramTemplateInfos": [
  {
   "name": "<template1>",
   "description": "<template1Description>",
   "creationDate": <template1CreationDate>,
   "lastUpdateDate": <template1LastUpdateDate>,
   "usedByATier": <true | false>,
   "enableDiagramExtend": <true | false>,
   "enableDiagramStorage": <true | false>
  },
  ...,
  {
   "name": "<templateN>",
   "description": "<templateNDescription>",
   "creationDate": <templateNCreationDate>,
   "lastUpdateDate": <templateNLastUpdateDate>,
   "usedByATier": <true | false>,
   "enableDiagramExtend": <true | false>,
   "enableDiagramStorage": <true | false>
  }
 ]
}

JSON Response Example

{
 "diagramTemplateInfos": [
  {
   "name": "Basic",
   "description": "",
   "creationDate": -2209161600000,
   "lastUpdateDate": 1520936616000,
   "usedByATier": true,
   "enableDiagramExtend": true,
   "enableDiagramStorage": true
  },
  {
   "name": "ExpandContainers",
   "description": "",
   "creationDate": -2209161600000,
   "lastUpdateDate": 1520936659000,
   "usedByATier": false,
   "enableDiagramExtend": false,
   "enableDiagramStorage": true
  },
  {
   "name": "CollapseContainers",
   "description": "",
   "creationDate": -2209161600000,
   "lastUpdateDate": 1520936644000,
   "usedByATier": false,
   "enableDiagramExtend": false,
   "enableDiagramStorage": true
  }
 ]
}