Schematic Sublayer Object

Overview

This document discusses the JSON Schematic Sublayer Object as returned by the REST API.

A Schematic Sublayer Object provides the following information:

  • id: The sublayer id in the schematic layer (Long).
  • name: The sublayer name (String).
  • featureClassID: The feature class ID related to the sublayer (Long).
  • elementType: The type of the schematic elements in this sublayer; that is, esriSchematicNodeType, esriSchematicLinkType, esriSchematicNodeOnLinkType, or esriSchematicSubLinkType).
  • geometryType: The type of geometry for the schematic elements in this sublayer; that is, esriGeometryPoint, esriGeometryPolyline, or esriGeometryPolygon.
  • attributes: An array of attributes that may be set for the schematic elements in this sublayer and can be useful to manage schematic features editing. This array is empty in most of the cases. It only returns some very specific attributes when they are configured on the related schematic feature class. The returned attributes are usually configured on containers or node-on-links schematic features.

    Each attribute item in this array is formatted as follows:

    • name: The attribute name. When they are configured on the related schematic feature class, the following attribute names are returned: ContainerMargin, ContainerMarginUnit, ContainerLeftMargin, ContainerRightMargin, ContainerTopMargin, ContainerBottomMargin, ContainerMarginSymbolsFlag, and AbsolutePosition.
    • value: The attribute value.

JSON Syntax

{
   "id" : <sublayerId>,
   "name" : "<sublayerName>",
   "featureClassID" : <sublayerFeatureClassID>,
   "elementType" : "esriSchematicNodeType" | "esriSchematicLinkType" | "esriSchematicNodeOnLinkType" | "esriSchematicSubLinkType",
   "geometryType" : "esriGeometryPoint" | "esriGeometryPolyline" | "esriGeometryPolygon"
   "attributes" :  [
    {
      "name": "<attribute1Name>",
      "value": "<attribute1Value>"
    },
    ...
    {
      "name": "<attributeNName>",
      "value": "<attributeNValue>"
    }
   ]
}

JSON Examples

//Sample response for a schematic sublayer object related to a link schematic feature class
{
  "id" : 3,
  "name" : "ISP_PIPES",
  "featureClassID" : 32,
  "elementType" : "esriSchematicLinkType",
  "geometryType" : "esriGeometryPolyline"
  "attributes" : [
  ]
}
//Sample response for a schematic sublayer object related to a node schematic feature class
{
  "id" : 1,
  "name" : "ISP_Equipments",
  "featureClassID" : 31,
  "elementType" : "esriSchematicNodeType",
  "geometryType" : "esriGeometryPoint"
  "attributes" : [
    {
      "name": "ContainerMargin",
      "value": "3"
    },
    {
      "name": "ContainerMarginSymbolsFlag",
      "value": "1"
    }
  ]
}
//Sample response for a schematic sublayer object related to a node-on-link schematic feature class
{
  "id" : 4,
  "name" : "NOL1",
  "featureClassID" : 36,
  "elementType" : "esriSchematicNodeOnLinkType",
  "geometryType" : "esriGeometryPoint"
  "attributes" : [
    {
      "name": "AbsolutePosition",
      "value": null
    }
  ]
}