URL:
https://<root>/<serviceName>/NetworkDiagramServer/createDiagramFromCircuitName
Methods:
POST
Version Introduced:
12.1

Description

The createDiagramFromCircuitName operation creates a new diagram resource starting from a circuit name provided as input. It is performed on a Network Diagram Service resource. The result of this operation is a Diagram Information JSON object. The newly created diagram is a temporary diagram.

Request Parameters

ParameterDetails

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

template

(Required)

The name of the diagram template the new network diagram will be based on. This template must be configured with a trace rule set up to apply a Circuit trace type on a telecom domain.

Syntax:

Use dark colors for code blocksCopy
1
template=<templateName>

Example:

Use dark colors for code blocksCopy
1
template=CircuitDiagrams

circuitName

(Required)

The name of the telecom circuit to trace.

Syntax:

Use dark colors for code blocksCopy
1
circuitName=<circuitName>

Example:

Use dark colors for code blocksCopy
1
circuitName=WirelessCircuitA

f

The response format. The default response format is html.

Values: <html | json>

Example Usage

The following is a sample request URL for the createDiagramFromCircuitName operation that demonstrates creating a new temporary network diagram based on the CircuitDiagrams template from the circuit name ISP2BLDGLTOQ:

  • URL:

    Use dark colors for code blocksCopy
    1
    https://myserver.esri.com/server/rest/services/TelecomUN/NetworkDiagramServer/createDiagramFromCircuitName
  • Parameters:

    Use dark colors for code blocksCopy
    1
    2
    3
    4
    5
    gdbVersion=
    sessionId=
    template=CircuitDiagrams
    circuitName=ISP2BLDGLTOQ
    f=pjson
  • Sent URL (GET):

    Use dark colors for code blocksCopy
    1
    https://myserver.esri.com/server/rest/services/TelecomUN/NetworkDiagramServer/createDiagramFromCircuitName?gdbVersion=&sessionId=&moment=&template=CircuitDiagrams&circuitName=ISP2BLDGLTOQ&f=pjson`

JSON Response Syntax

A Diagram JSON Information object.

JSON Response Example

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
{
 "diagramInfo": {
  "tag": "",
  "isStored": false,
  "canStore": false,
  "canExtend": false,
  "isSystem": false,
  "creator": "acb7352",
  "creationDate": 1765905318000,
  "lastUpdateBy": "acb7352",
  "lastUpdateDate": 1765905318000,
  "containerMargin": 5.3819336805555702,
  "junctionCount": 5,
  "edgeCount": 4,
  "containerCount": 5,
  "aggregationCount": 0,
  "isHistorical": false,
  "reflexiveEdgeRadius": 10.7638673611111,
  "access": "esriDiagramPublicAccess",
  "diagramExtent": {
   "xmin": 6805383.3198858052,
   "ymin": 1843889.5654501468,
   "xmax": 6805503.4187269658,
   "ymax": 1843911.0932942331,
   "spatialReference": {
    "wkid": 3498,
    "latestWkid": 3498
   }
  },
  "networkExtent": {
   "xmin": 6804170.3764455467,
   "ymin": 1843697.0202315599,
   "xmax": 6805649.9417278916,
   "ymax": 1843953.360270068,
   "zmin": 0,
   "zmax": 0,
   "mmin": 0,
   "mmax": 0,
   "spatialReference": {
    "wkid": 3498,
    "latestWkid": 3498
   }
  },
  "name": "A8E3C267B0B6441D9B5FF1CDAF0FA051",
  "id": "{90AE5891-AAA7-463D-9738-14D2555BEE1B}",
  "template": "CircuitDiagrams"
 }
}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.