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:

deleteDiagram—Deletes a schematic diagram.
generateDiagram—Generates a new schematic diagram.
loadDiagram—Loads a schematic diagram in memory.
lockDiagram—Locks a schematic diagram.
queryAssociatedObjects—Finds the primary and secondary associations for a set of schematic features contained in a schematic diagram.
queryAssociatedSchematicFeatures—Finds the schematic features contained in a diagram that are associated with a set of GIS features/objects.
saveDiagram—Saves a schematic diagram.
unlockDiagram—Unlocks a schematic diagram.
updateDiagram—Udates an existing schematic diagram.

Request parameters

Parameter	Details
`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

Use dark colors for code blocksCopy
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

Use dark colors for code blocksCopy
https://myserver.esri.com/arcgis/rest/services/S2_InternalPlants/MapServer/exts/SchematicsServer/templates/0

JSON Response syntax

Use dark colors for code blocksCopy
{
  "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

Use dark colors for code blocksCopy
{
  "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
        }
      ]
    }
  ]
}