Skip To Content
ArcGIS Developer
Dashboard

Schematic Layer

Description

The Schematic Layer resource represents a single schematic layer under a schematic service. Each schematic layer is returned with the following information:

  • id: The identifier of the schematic layer in the schematic service (Long)
  • name: The name of the schematic layer in the schematic service (String)
  • dataType: The type of the schematic layer, which is one of the following:
    • Schematic Diagram Template Layer: when the schematic layer references a schematic diagram template
    • Schematic Diagram Layer: when the schematic layer references a single schematic diagram
  • dataName: The name of the schematic diagram or schematic diagram template in the schematic dataset (String)
  • alwaysLoadDiagram: Indicates whether or not the schematic diagram is automatically loaded in memory (Boolean)
  • subLayers: The list of the sublayers (Array of Schematic Sublayer Object) that compose the schematic layer.

Note:

The name and dataName properties are often the same. They are different if, during the authoring of schematic layers, the author changed the layer name.

Note:

The alwaysLoadDiagram property value corresponds to the status of the Immediately load diagram into memory check box that displays on the Properties tab related to any diagram template when you edit the schematic dataset within Schematic Dataset Editor. If this box is checked for a diagram template, any schematic layer that references this diagram template or one of the schematic diagrams based on that template will be returned with alwaysLoadDiagram = True.

Request parameters

ParameterDetails
f

The response format. The default response format is html.

Values: html | json

Example usage

Example 1: The schematic layer, which id is '3' under the S1_Schematics public sample Schematics service. This is the last schematic layer from the four schematic layers under this sample service.

https://servicesbeta6.esri.com/arcgis/rest/services/S1_Schematics/MapServer/exts/SchematicsServer/schematiclayers/3

Example 2: The schematic layer, which id is '0' under the S2_InternalPlants public sample Schematics service. This is the only schematic layer under this sample server.

https://servicesbeta6.esri.com/arcgis/rest/services/S2_InternalPlants/MapServer/exts/SchematicsServer/schematiclayers/0

JSON Response syntax


            {
  "id" : <schLayerId>,
  "name" : "<schLayerName>",
  "dataType" : "Schematic Diagram Template Layer" | "Schematic Layer",
  "dataName" : "<schLayerDataName>",
  "alwaysLoadDiagram" : true | false,
  "subLayers": [
	 <schSublayer1>,
	 ...,
	 <schSublayerN>
  ]
}

JSON Response example


            {
  "id" : 0,
  "name" : "ISP_GasPlant",
  "dataType" : "Schematic Diagram Template Layer",
  "dataName" : "ISP_GasPlant",
  "alwaysLoadDiagram" : false,
  "subLayers" : [
    {
      "id" : 1,
      "name" : "ISP_EQUIPMENTS",
      "featureClassID" : 3202,
      "elementType" : "esriSchematicNodeType",
      "geometryType" : "esriGeometryPoint"
      "attributes" : [
      
      ]
    },
    {
      "id" : 2,
      "name" : "ISP_VALVES",
      "featureClassID" : 3201,
      "elementType" : "esriSchematicNodeType",
      "geometryType" : "esriGeometryPoint"
      "attributes" : [
      
      ]
    },
    {
      "id" : 3,
      "name" : "ISP_PIPES",
      "featureClassID" : 3203,
      "elementType" : "esriSchematicLinkType",
      "geometryType" : "esriGeometryPolyline"
      "attributes" : [
      
      ]
    }
  ]
}