Template

URL:
https://<root>/<serviceName>/NetworkDiagramServer/templates/<templateName>
Methods:
POST
Version Introduced:
10.6

Description

The Template resource represents a single diagram template under a Network Diagram service. It is returned as a JSON object that provides the list of the diagram layouts and their property sets, which are preset for the template.

The Template resource doesn't support any operation nor any child resource.

Template REST end point resource

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

f

The response format. The default response format is html.

Values: <html | json>

Example usage

Access the Basic template REST end point:

  • URL: https://myserver.esri.com/server/rest/services/Naperville/NetworkDiagramServer/templates/Basic

  • Parameters

    Use dark colors for code blocksCopy
    1
    2
    3
    gdbVersion=
    sessionId=
    f=pjson
  • Sent URL (GET): https://myserver.esri.com/server/rest/services/Naperville/NetworkDiagramServer/templates/Basic?gdbVersion=&sessionId=&f=pjson

.

JSON Response syntax

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
{
 "description": "< templateDescription >",
 "enableDiagramStorage": < true | false >,
 "enableDiagramExtend": < true | false >,
 "creationDate": < templateCreationDate >,
 "lastUpdateDate": < templateLastUpdateDate >,
 "usedByATier": < true | false>,
 "containerMargin": 0.5,
 "layoutParams": {
  "<algo1Name>:{
   "type": "PropertySet",
   "propertySetItems": [
    "algo1ParamName1", < algo1ParamValue1 >,
    …,
    "algo1ParamNameN", < algo1ParamValueN >
   ]
  },
  …,
  "<algoKName>:{
   "type": "PropertySet",
   "propertySetItems": [
    "algoKParamName1", < algoKParamValue1 >,
    …,
    "algoKParamNameP", < algoKParamValueP >
   ]
  }
 }
}

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
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
{
 "description": "Add containers, connectivity associations, and structural attachments.",
 "enableDiagramStorage": true,
 "enableDiagramExtend": true,
 "creationDate": -2209161600000,
 "lastUpdateDate": 1523346184000,
 "usedByATier": true,
 "containerMargin": 0.5,
 "layoutParams": {
  "AngleDirectedDiagramLayout": {
   "type": "PropertySet",
   "propertySetItems": [
    "are_containers_preserved",
    false,
    "is_active",
    false,
    "iterations_number",
    1,
    "number_of_directions",
    8
   ]
  },
  "CompressionDiagramLayout": {
   "type": "PropertySet",
   "propertySetItems": [
    "are_containers_preserved",
    true,
    "is_active",
    false,
    "grouping_distance",
    20,
    "vertices_removal_rule",
    2
   ]
  },
  "ForceDirectedDiagramLayout": {
   "type": "PropertySet",
   "propertySetItems": [
    "are_containers_preserved",
    false,
    "is_active",
    false,
    "iterations_number",
    20,
    "repel_factor",
    1,
    "degree_freedom",
    1,
    "edge_display_type",
    0,
    "breakpoint_position",
    0.29999999999999999
   ]
  },
  "GeoPositionsDiagramLayout": {
   "type": "PropertySet",
   "propertySetItems": [
    "is_active",
    false,
    "restore_edges_geo_positions",
    true
   ]
  },
  "GridDiagramLayout": {
   "type": "PropertySet",
   "propertySetItems": [
    "are_containers_preserved",
    false,
    "is_active",
    false,
    "cell_width",
    2,
    "cell_height",
    2
   ]
  },
  "LinearDispatchDiagramLayout": {
   "type": "PropertySet",
   "propertySetItems": [
    "is_unit_absolute",
    false,
    "is_active",
    false,
    "junction_placement_type",
    1,
    "maximum_shift",
    2,
    "minimum_shift",
    2,
    "iterations_number",
    5,
    "is_path_preserved",
    true,
    "are_leaves_moved",
    false,
    "are_leaves_expanded",
    false,
    "expand_shift",
    2
   ]
  },
  "MainLineTreeDiagramLayout": {
   "type": "PropertySet",
   "propertySetItems": [
    "are_containers_preserved",
    false,
    "is_active",
    false,
    "is_unit_absolute",
    false,
    "tree_direction",
    2,
    "branches_placement",
    2,
    "perpendicular",
    2,
    "along",
    2,
    "disjoined_graph",
    4,
    "are_edges_orthogonal",
    false,
    "breakpoint_position",
    0.29999999999999999,
    "edge_display_type",
    0
   ]
  },
  "MainRingDiagramLayout": {
   "type": "PropertySet",
   "propertySetItems": [
    "are_containers_preserved",
    false,
    "is_active",
    false,
    "is_unit_absolute",
    false,
    "ring_type",
    1,
    "tree_type",
    4,
    "edge_display_type",
    0,
    "ring_width",
    50,
    "ring_height",
    20,
    "perpendicular",
    2,
    "along",
    2,
    "breakpoint_position",
    0.29999999999999999
   ]
  },
  "PartialOverlappingEdgesDiagramLayout": {
   "type": "PropertySet",
   "propertySetItems": [
    "is_active",
    false,
    "buffer_width",
    1,
    "offset",
    0.5,
    "optimize_edges",
    false
   ]
  },
  "RadialTreeDiagramLayout": {
   "type": "PropertySet",
   "propertySetItems": [
    "are_containers_preserved",
    false,
    "is_active",
    false,
    "is_unit_absolute",
    false,
    "initial_radius",
    5,
    "disjoined_graph",
    10,
    "radius_factor",
    1
   ]
  },
  "RelativeMainlineDiagramLayout": {
   "type": "PropertySet",
   "propertySetItems": [
    "are_containers_preserved",
    false,
    "is_active",
    false,
    "is_unit_absolute",
    true,
    "perpendicular",
    2,
    "minimalDistance_absolute",
    0,
    "breakpoint_angle",
    45,
    "compression_ratio",
    0,
    "is_using_length_attribute",
    false,
    "is_compressing",
    false,
    "is_using_line_type_attribute",
    false,
    "is_using_priority_attribute",
    false,
    "line_attribute_name",
    "",
    "line_type_attribute_name",
    "",
    "main_line_value",
    "",
    "excluded_line_values",
    "",
    "priority_attribute_name",
    "",
    "priority_value",
    "",
    "length_attribute_name",
    "",
    "mainline_direction",
    2
   ]
  },
  "ReshapeEdgesDiagramLayout": {
   "type": "PropertySet",
   "propertySetItems": [
    "are_containers_preserved",
    false,
    "is_active",
    false,
    "reshape_type",
    1,
    "is_path_preserved",
    true,
    "angle_threshold",
    0,
    "shift_between_edge",
    0.5,
    "offset_between_segment",
    5,
    "breakpoint",
    8.6600000000000001
   ]
  },
  "RotateTreeDiagramLayout": {
   "type": "PropertySet",
   "propertySetItems": [
    "are_containers_preserved",
    false,
    "is_active",
    false,
    "rotation_angle",
    45
   ]
  },
  "SeparateOverlappingEdgesDiagramLayout": {
   "type": "PropertySet",
   "propertySetItems": [
    "are_containers_preserved",
    false,
    "is_active",
    false,
    "shift_between_edge",
    0.5
   ]
  },
  "SmartTreeDiagramLayout": {
   "type": "PropertySet",
   "propertySetItems": [
    "are_containers_preserved",
    false,
    "is_active",
    false,
    "is_unit_absolute",
    false,
    "tree_direction",
    2,
    "subtree",
    2,
    "perpendicular",
    2,
    "along",
    2,
    "disjoined_graph",
    4,
    "are_edges_orthogonal",
    false,
    "breakpoint_position",
    0.29999999999999999,
    "edge_display_type",
    0
   ]
  },
  "SpatialDispatchDiagramLayout": {
   "type": "PropertySet",
   "propertySetItems": [
    "are_containers_preserved",
    false,
    "is_active",
    false,
    "iterations_number",
    5,
    "maximum_shift_factor",
    2
   ]
  }
 }
}

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