Schematic Diagram Template

URL:
https://<root>/<serviceName>/MapServer/exts/SchematicServer/templates/<tempId>
Methods:
POST
Operations:
Delete Diagram, Generate Diagram, Load Diagram, Lock Diagram, Query Associated Objects, Query Associated Schematic Features, Save Diagram, Unlock Diagram, Update Diagram
Child Resources:
Schematic Algorithms
Version Introduced:
10.1

Description

The Schematic Diagram Template resource represents a single schematic diagram template under a schematic service. It is returned by the REST API with the following information:

  • name: The diagram template name (String),
  • id: The diagram template identifier in the schematic service (Long),
  • objectID: The diagram template OBJECTID in the schematic dataset (Long),
  • canGenerate: Indicates if the Generate Diagram operation is available for this diagram template or not (Boolean),
  • builderType: The type of builder on which the diagram template is based; that is, Standard Builder, Network Dataset Builder , or XML Builder ,
  • algorithms: The list of the schematic layout algorithms available for this diagram template (Array of Schematic Algorithm resources).

The Schematic Diagram Template resource supports 9 operations:

Request parameters

ParameterDetails

f

The response format. The default response format is html .

Values: html | json

Example usage

Example 1: The schematic diagram template which id is '2' under the S1_Schematics public sample Schematics service which references four diagram templates

1
https://myserver.esri.com/arcgis/rest/services/S1_Schematics/MapServer/exts/SchematicsServer/templates/2

Example 2: The schematic diagram template which id is '0' under the S2_InternalPlants public sample Schematics service which references an only diagram template

1
https://myserver.esri.com/arcgis/rest/services/S2_InternalPlants/MapServer/exts/SchematicsServer/templates/0

JSON Response syntax

1
2
3
4
5
6
7
8
9
10
11
12
13
14
{
  "name" : "<schTemplateName>",
  "id" : <schTemplateId>,
  "objectID" : <schTemplateObjectID>,
  "canGenerate" : <true | false>,
  "builderType" : "Standard Builder" | "Network Dataset Builder" | "XML Builder",
  "algorithms" : [
    {
      <algorithm1—[see Schematic Algorithm—JSON Syntax](/schematic-algorithm/#json-response-syntax)>,
      ...,
      <algorithmN—[see Schematic Algorithm—JSON Syntax](/schematic-algorithm/#json-response-syntax)>
    }
  ]
}

Learn about Schematic Algorithm—JSON Syntax

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
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
{
  "name" : "OSP",
  "id" : 1,
  "objectID" : 2896,
  "canGenerate" : true,
  "builderType" : "Standard Builder",
  //The list of the schematic layout algorithms available for this diagram template
  "algorithms" : [
    {
      "id" : 0,
      "name" : "Bypass Nodes"
    },
    {
      "id" : 2,
      "name" : "Geo - Angle Directed",
      "parameters" : [
        {
          "name" : "NumberOfIterations",
          "type" : "Long",
          "value" : 1
        },
        {
          "name" : "NumberOfDirections",
          "type" : "Long",
          "value" : 8
        }
      ]
    },
    {
      "id" : 3,
      "name" : "Geo - Compression",
      "parameters" : [
        {
          "name" : "Containers",
          "type" : "Boolean",
          "value" : true
        },
        {
          "name" : "KeepInsideVertices",
          "type" : "Boolean",
          "value" : true
        },
        {
          "name" : "KeepOutsideVertices",
          "type" : "Boolean",
          "value" : false
        },
        {
          "name" : "MaximumDistanceForGrouping",
          "type" : "Double",
          "value" : 0
        }
      ]
    },
    {
      "id" : 4,
      "name" : "Geo - Force Directed",
      "parameters" : [
        {
          "name" : "NumberOfIterations",
          "type" : "Long",
          "value" : 20
        },
        {
          "name" : "RepelFactor",
          "type" : "Double",
          "value" : 1
        },
        {
          "name" : "DegreeOfFreedom",
          "type" : "Long",
          "value" : 1
        }
      ]
    }
  ]
}

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