- URL:
- https://<root>/<serviceName>/MapServer/exts/SchematicServer
- Methods:
GET
POST
- Operations:
- Search Diagrams
- Child Resources:
- Schematic Folders, Schematic Diagrams
- Version Introduced:
- 10.1
Description
The Schematic
service exposes the schematic diagrams capability resources. It represents a Schematics service published with ArcGIS Server. The resource provides information about the service itself (name, type) the number of published diagrams and published schematic layers, and the number of published diagram templates.
Here is an overview of the capabilities supported in the Schematics Server REST API:
- The SchematicServer service resource supports the searchDiagrams operation. It is used to search diagrams in the schematic service by criteria.
- The folders resource represents the set of schematic folders in the schematic dataset(s) related to the schematic layers under a published schematic service.
- The diagrams resource represents all the diagrams related to the schematic layers under a published schematic service.
- The Schematic Diagram resource represents a single diagram under a schematic service.
- The map resource is a child resource of a schematic diagram resource. It mimics a map service resource and is used to export a schematic diagram as a map image or perform identify operations on a Schematic Diagram resource.
- The export operation can be performed on a schematic diagram map resource.
- The identify operation can be performed on a schematic diagram map resource.
- The templates resource represents all the schematic diagram templates related to the published schematic diagrams under a schematic service.
- The Schematic Diagram Template resource represents a single schematic diagram template under a schematic service.
- The deleteDiagram, generateDiagram, queryAssociatedObjects, queryAssociatedSchematicFeatures, loadDiagram, lockDiagram, saveDiagram, unlockDiagram, and updateDiagram operations can be performed on a Schematic Diagram Template resource.
- The algorithms resource is a child resource of a Schematic Diagram Template resource. It allows to access all the algorithms available for a diagram template.
- The Schematic Algorithm resource is a single schematic algorithm available for a diagram template.
- The apply operation can be performed on a schematic algorithm resource.
Request parameters
Parameter | Details |
---|---|
| The response format. The default response format is Values: |
Example usage
Example 1: the S1_Schematics public sample Schematics service
https://myserver.esri.com/arcgis/rest/services/S1_Schematics/MapServer/exts/SchematicsServer
Example 2: the S2_InternalPlants public sample Schematics service
https://myserver.esri.com/arcgis/rest/services/S2_InternalPlants/MapServer/exts/SchematicsServer
JSON Response syntax
{
"name":"<ServiceName>",
"type":"<ServiceType>",
"nbEstimatedDiagrams":<nbEstimatedDiagrams>,
"nbTemplates":<nbTemplates>,
"nbSchematicLayers":<nbSchematicLayers>
}
JSON Response example
{
"name":"Schematics Server",
"type":"Map Server Extension",
"nbEstimatedDiagrams":15,
"nbTemplates":4,
"nbSchematicLayers":4
}