Schematic Algorithms

URL:: https://<root>/<serviceName>/MapServer/exts/SchematicServer/templates/<tempID>/algorithms
Methods:: POST
Version Introduced:: 10.1

Description

The algorithms resource represents all the schematic algorithms available for a diagram template. It is returned as an array of Schematic Algorithm resources by the REST API.

Request parameters

Parameter	Details
`f`	The response format. The default response format is html. Values: html \| json

Example usage

Example 1: The schematic algorithms available for the diagram template which id is '2' under the S1_Schematics public sample Schematics service

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

Example 2: The schematic algorithms available for the diagram template which id is '0' under the S2_InternalPlants public sample Schematics service

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

JSON Response syntax

Use dark colors for code blocksCopy
"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
//Sample syntax response where the Square Links, Bypass Nodes, and Hierarchical - Compact Tree are the only available algorithms on a diagram template
 "algorithms": [
  //Sample syntax response for the Square Links algorithm
  {
     "id" : 0,
     "name" : "Square Links",
     "parameters" :[
       {
         "name" : "&PreservePath",
         "type" : "Boolean",
         "value" : true
       }
     ]
   },
  //Sample syntax response for the Bypass Nodes algorithm
   {
     "id" : 1,
     "name" : "Bypass Nodes"
   },
  //Sample syntax response for the Hierarchical - Compact Tree algorithm
   {
     "id" : 2,
     "name" : "Hierarchical - Compact Tree",
     "parameters" :[
       {
         "name" : "Direction",
         "type" : "Long",
         "value" : 2
       },
       {
         "name" : "SpacingAlongDirection",
         "type" : "Double",
         "value" : 2
       },
       {
         "name" : "SpacingPerpendicularToDirection",
         "type" : "Double",
         "value" : 2
       },
       {
         "name" : "BreakPoint",
         "type" : "Double",
         "value" : 0.5
       },
       {
         "name" : "OrthogonalDisplay",
         "type" : "Boolean",
         "value" : False
       },
       {
         "name" : "AbsoluteUnits",
         "type" : "Boolean",
         "value" : True
       }
     ]
   }
]