Apply Template Layouts

URL:
https://<root>/<serviceName>/NetworkDiagramServer/diagrams/<diagramName>/applyTemplateLayouts
Methods:
POST
Version Introduced:
10.6

Description

The applyTemplateLayouts operation re-applies the list of the layout algorithms configured on the template the diagram is based on. It is performed on a Diagram resource. The result of this operation is a Diagram JSON Information object, and the moment the operation happens for a stored 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

junctionObjectIDs

For the case you want the template layout algorithms to apply to a diagram part, list of junction ObjectIDs (long) that will be processed:

Syntax: junctionObjectIDs=[<DiagJctOid1>, …, <DiagJctOidN]

Example: junctionObjectIDs=[1,2,3,4,5]

containerObjectIDs

For the case you want the template layout algorithms to apply to a diagram part, a list of container ObjectIDs (long) that will be processed:

Syntax: containerObjectIDs=[<DiagConOid1>, …, <DiagConOidN]

Example: containerObjectIDs=[1]

edgeObjectIDs

For the case you want the template layout algorithms to apply to a diagram part, a list of edge ObjectIDs (long) that will be processed:

Syntax: edgeObjectIDs=[<DiagEdgOid1>, …, <DiagEdgOidN]

Example: edgeObjectIDs=[1,2,3]

f

The response format. The default response format is html.

Values: <html | json>

Example Usage

Re-applying the set of diagram layout configured on the template on the DiagramTest1 diagram in ABV1 version; that is:

  • URL: https://myserver.esri.com/server/rest/services/Naperville/NetworkDiagramServer/diagrams/DiagramTest1/applyTemplateLayouts

  • Parameters:

    1
    2
    3
    4
    5
    6
    gdbVersion=ABV1
    sessionId=
    junctionObjectIDs=
    containerObjectIDs=
    edgeObjectIDs=
    f=pjson
  • Sent URL (GET): https://myserver.esri.com/server/rest/services/Naperville/NetworkDiagramServer/diagrams/DiagramTest1/applyTemplateLayouts?gdbVersion=ABV1&sessionId=&junctionObjectIDs=&containerObjectIDs=&edgeObjectIDs=&f=pjson

JSON Response Syntax

A JSON object composed of a Diagram JSON Information object and the moment (date) the applyTemplateLayouts operation happens for a stored diagram: {"diagramInfo": , "moment": <moment>}

JSON Response Example

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
{
 "diagramInfo": {
  "tag": "",
  "isStored": true,
  "isSystem": false,
  "creator": "acb7352",
  "creationDate": 1480322602000,
  "lastUpdateBy": "acb7352",
  "lastUpdateDate": 1480510663000,
  "containerMargin": 0.5,
  "junctionCount": 12,
  "edgeCount": 10,
  "containerCount": 2,
  "aggregationCount": 0,
  "access": "esriDiagramPublicAccess",
  "diagramExtent": {
   "xmin": 1034510.9868998453,
   "ymin": 1871808.4880382791,
   "xmax": 1034521.2178505138,
   "ymax": 1871862.6050560325,
   "spatialReference": {
    "wkid": 102671,
    "latestWkid": 3435
   }
  },
  "networkExtent": {
   "xmin": 1034510.9868998453,
   "ymin": 1871808.4880382791,
   "xmax": 1034521.2178505138,
   "ymax": 1871862.6050560325,
   "spatialReference": {
    "wkid": 102671,
    "latestWkid": 3435
   }
  },
  "name": "DiagramTest1",
  "id": "{5330ED92-B6CE-4EF7-9A10-E4D5BF77582B}",
  "template": "ExpandContainers"
 },
 "moment": 1490869536422
}

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

You can no longer sign into this site. Go to your ArcGIS portal or the ArcGIS Location Platform dashboard to perform management tasks.

Your ArcGIS portal

Create, manage, and access API keys and OAuth 2.0 developer credentials, hosted layers, and data services.

Your ArcGIS Location Platform dashboard

Manage billing, monitor service usage, and access additional resources.

Learn more about these changes in the What's new in Esri Developers June 2024 blog post.

Close