Diagram Dataset | ArcGIS REST APIs

URL:: https://<root>/<serviceName>/NetworkDiagramServer/diagramDataset
Methods:: POST
Version Introduced:: 10.6.1

Description

The diagramDataset resource regroups the info related to each diagram template under a Network Diagram service. It returns an array of diagram template info.

Conceptual representation of Diagram Dataset resource

Request parameters

Parameter Details

Parameter	Details
`gdbVersion`	The name of the geodatabase version. Syntax: `gdbVersion=<version>` Example: `gdbVersion=ABV1`
`sessionId`	The token (guid) used to lock the version. Syntax: `sessionId=<guid>` Example: `sessionId=44G259DE-87B0-407D-8F2E-DCB7665DD0F0`
`f`	The response format. The default response format is html. Values: `<html \| json>`

gdbVersion

The name of the geodatabase version.

Syntax: gdbVersion=<version>

Example: gdbVersion=ABV1

sessionId

The token (guid) used to lock the version.

Syntax: sessionId=<guid>

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

f

The response format. The default response format is html.

Values: <html | json>

Example usage

https://myserver.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 a subnetwork system diagram in a tier (Boolean).
enableDiagramExtend —Whether the template enables diagram extend (Boolean).
enableDiagramStorage —Whether the template enables diagram storage (Boolean).
keepVertices —Introduced at ArcGIS Enterprise 12.1. Whether the template keeps vertices along network edges (Boolean).
removeLinearContainers —Introduced at ArcGIS Enterprise 12.1. Whether the template removes all linear containers at the end of diagram buildings (Boolean).
persistAggregations —Introduced at ArcGIS Enterprise 12.1. Whether the template persists aggregated network features and objects (Boolean).
layerDefinitionsID —Introduced at ArcGIS Enterprise 12.1. The ID of the diagram layer definition set up on the template (String).
associatedTelecomDomain —Introduced at ArcGIS Enterprise 12.1. The name of the telecom domain associated with the template (String).

Use dark colors for code blocksCopy
{
 "diagramTemplateInfos": [
  {
   "name": "< template1 >",
   "description": "< template1Description >",
   "creationDate": < template1CreationDate >,
   "lastUpdateDate": < template1LastUpdateDate >,
   "usedByATier": < true | false >,
   "enableDiagramExtend": < true | false >,
   "enableDiagramStorage": < true | false >,
   "keepVertices": < true | false >,
   "removeLinearContainers": < true | false >,
   "persistAggregations": < true | false >,
   "layerDefinitionsID": "< template1LayerDefinitionsID >",
   "associatedTelecomDomain": "< template1AssociatedTelecomDomain >"
  },
  ...,
  {
   "name": "< templateN >",
   "description": "< templateNDescription >",
   "creationDate": < templateNCreationDate >,
   "lastUpdateDate": < templateNLastUpdateDate >,
   "usedByATier": < true | false >,
   "enableDiagramExtend": < true | false >,
   "enableDiagramStorage": < true | false >
   "keepVertices": < true | false >,
   "removeLinearContainers": < true | false >,
   "persistAggregations": < true | false >,
   "layerDefinitionsID": "< templateNLayerDefinitionsID >",
   "associatedTelecomDomain": "< templateNAssociatedTelecomDomain >"
  }
 ]
}

JSON Response example

Use dark colors for code blocksCopy
{
 "diagramTemplateInfos": [
  {
   "name": "Basic",
   "description": "",
   "creationDate": 1764784819000,
   "lastUpdateDate": 1765882537000,
   "usedByATier": true,
   "enableDiagramExtend": true,
   "enableDiagramStorage": true
   "keepVertices": true,
   "removeLinearContainers": false,
   "persistAggregations": true,
   "layerDefinitionsID": "17765548803855218373;1022502;39987",
   "associatedTelecomDomain": ""

  },
  {
   "name": "ExpandContainers",
   "description": "",
   "creationDate": 1764784819000,
   "lastUpdateDate": 1765882538000,
   "usedByATier": false,
   "enableDiagramExtend": false,
   "enableDiagramStorage": true
   "keepVertices": true,
   "removeLinearContainers": false,
   "persistAggregations": true,
   "layerDefinitionsID": "17765548803855218373;1022502;39987",
   "associatedTelecomDomain": ""
  },
  {
   "name": "CollapseContainers",
   "description": "",
   "creationDate": 1764784819000,
   "lastUpdateDate": 1765882539000,
   "usedByATier": false,
   "enableDiagramExtend": false,
   "enableDiagramStorage": true
   "keepVertices": true,
   "removeLinearContainers": false,
   "persistAggregations": true,
   "layerDefinitionsID": "17765548803855218373;1022502;39987",
   "associatedTelecomDomain": ""
  },
  {
   "name": "CircuitDiagrams",
   "description": "",
   "creationDate": 1765881178000,
   "lastUpdateDate": 1765882548000,
   "usedByATier": false,
   "enableDiagramExtend": false,
   "enableDiagramStorage": true
   "keepVertices": true,
   "removeLinearContainers": false,
   "persistAggregations": true,
   "layerDefinitionsID": "14141622135582967480;2712434;125292",
   "associatedTelecomDomain": "Telco"
  }

 ]
}