- URL:https://<schematicdiagramtemplates-url>/<tempId>
- 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).
Note:
The canGenerate property is always False when builderType=Network Dataset Builder.
When builderType=Standard Builder, the canGenerate property is True for a schematic diagram template that is referenced in a published schematic layer which datatype is Schematic Diagram Template Layer.
When builderType=Standard Builder and all the diagrams based on the diagram template have been authorized as single schematic diagrams in the Schematics service (that is, a single schematic diagram per schematic layer), the canGenerate property is False for that diagram template.
The Schematic Diagram Template resource supports 9 operations:
- Delete Diagram - Used to delete a schematic diagram.
- Generate Diagram - Used to generate a new schematic diagram.
- Load Diagram - Used to load a schematic diagram in memory.
- Lock Diagram - Used to lock a schematic diagram.
- Query Associated Objects - Used to find the primary and secondary associations for a set of schematic features contained in a schematic diagram.
- Query Associated Schematic Features - Used to find the schematic features contained in a diagram that are associated with a set of GIS features/objects.
- Save Diagram - Used to save a schematic diagram.
- Unlock Diagram - Used to unlock a schematic diagram.
- Update Diagram - Used to update 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
https://servicesbeta6.esri.com/arcgis/rest/services/S1_Schematics/MapServer/exts/SchematicsServer/templates/2Example 2: The schematic diagram template which id is '0' under the S2_InternalPlants public sample Schematics service which references an only diagram template
https://servicesbeta6.esri.com/arcgis/rest/services/S2_InternalPlants/MapServer/exts/SchematicsServer/templates/0JSON Response syntax
{
"name" : "<schTemplateName>",
"id" : <schTemplateId>,
"objectID" : <schTemplateObjectID>,
"canGenerate" : <true | false>,
"builderType" : "Standard Builder" | "Network Dataset Builder" | "XML Builder",
"algorithms" : [
{
<algorithm1—See the Schematic Algorithm topic for the JSON Syntax>,
...,
<algorithmN—See the Schematic Algorithm topic for the JSON Syntax>
}
]
}
JSON Response example
{
"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
}
]
}
]
}