Schematic Diagram Content object

Overview

This topic discusses the JSON representation of Schematic Diagram Content objects.

A Schematic Diagram Content object is returned with the following properties:

name: The diagram name
extent: The diagram extent (envelope)
layers: An array of layer objects that compose the schematic diagram
rootNodes: Optional; An array of schematic feature identifiers (Long) that identify schematic root nodes in the diagram.
endNodes: Optional; An array of schematic feature identifiers (Long) that identify schematic end nodes in the diagram.

Use dark colors for code blocksCopy
{
  "name": "<DiagramName>",
  "extent": <envelope>,
  "layers": [
  //First feature layer
    {
      "featureSet": {
        "displayFieldName": "",
        "fieldAliases": {
          "<field1>": "<aliasField1>",
          ...,
          "<fieldN>": "<aliasFieldN>"
        },
        "geometryType": "<esriGeometryPoint | esriGeometryPolyline | esriGeometryPolygon>",
        "spatialReference": <spatialReference>,
        "fields": [
          {
            "name": "<field1Name>",
            "type": <field1Type>,
            "alias": "<field1Alias>"
          },
          ...,
          {
            "name": "<fieldNName>",
            "type": <fieldNType>,
            "alias": "<fieldNAlias>"
          },
        ],
        "features": [
          <schFeature1>,
          ...,
          <schFeatureN>
        ]  //List of the schematic feature objects for this feature layer that are contained in the diagram
      },
      "featureClassID": <featureClassID1>, //This corresponds to the OBJECTID of the schematic feature class related to the layer
      "selectedIDs": [
        "<schFeature1_ID>",
        ...,
        "<schFeatureM_ID>"
      ] //List of the SCHEMATICTID for each schematic feature currently selected in this layer
    },
    //Next feature layer
    {
      ...
    }
  ],
  "rootNodes": [
    "<schFeature1_ID>",
    ...,
    "<schFeatureM_ID>"
  ], //List of the SCHEMATICTID of the root schematic feature nodes
  "endNodes": [
    "<schFeature1_ID>",
    ...,
    "<schFeatureK_ID>"
  ] //List of the SCHEMATICTID of the end schematic feature nodes
}

Use dark colors for code blocksCopy
{
  "name": "SmallDiagram",
  "extent": {
    "xmin": -20188492.5143,
    "ymin": 13197754.015000001,
    "xmax": -15695315.069899999,
    "ymax": 18282139.017800003,
    "spatialReference": {
      "wkid": 102585,
      "latestWkid": 102585
    }
  },
  "layers": [
    {
      "featureSet": {
        "displayFieldName": "",
        "fieldAliases": {
          "ID": "ID",
          "DIAGRAMCLASSID": "DIAGRAMCLASSID",
          "DIAGRAMOBJECTID": "DIAGRAMOBJECTID",
          "SCHEMATICTID": "SCHEMATICTID",
          "ISINITIAL": "ISINITIAL",
          "ISDISPLAYED": "ISDISPLAYED",
          "RELATIONOBJECTID": "RELATIONOBJECTID",
          "RELATIONCLASSID": "RELATIONCLASSID",
          "DATASOURCEID": "DATASOURCEID",
          "UCID": "UCID",
          "UOID": "UOID",
          "USID": "USID",
          "UPDATESTATUS": "UPDATESTATUS",
          "SUBTYPE": "SUBTYPE",
          "PROPERTYSET": "PROPERTYSET",
          "FROMTID": "FROMTID",
          "TOTID": "TOTID",
          "FROMPORT": "FROMPORT",
          "TOPORT": "TOPORT",
          "FLOWDIRECTION": "FLOWDIRECTION",
          "UGUID": "UGUID",
          "Category": "Category",
          "SHAPE.len": "SHAPE.len"
        },
        "geometryType": "esriGeometryPolyline",
        "spatialReference": {
          "wkid": 102585,
          "latestWkid": 102585
        },
        "fields": [
          {
            "name": "ID",
            "type": "esriFieldTypeOID",
            "alias": "ID"
          },
          {
            "name": "DIAGRAMCLASSID",
            "type": "esriFieldTypeInteger",
            "alias": "DIAGRAMCLASSID"
          },
          {
            "name": "DIAGRAMOBJECTID",
            "type": "esriFieldTypeInteger",
            "alias": "DIAGRAMOBJECTID"
          },
          {
            "name": "SCHEMATICTID",
            "type": "esriFieldTypeString",
            "alias": "SCHEMATICTID",
            "length": 128
          },
          {
            "name": "ISINITIAL",
            "type": "esriFieldTypeInteger",
            "alias": "ISINITIAL"
          },
          {
            "name": "ISDISPLAYED",
            "type": "esriFieldTypeInteger",
            "alias": "ISDISPLAYED"
          },
          {
            "name": "RELATIONOBJECTID",
            "type": "esriFieldTypeInteger",
            "alias": "RELATIONOBJECTID"
          },
          {
            "name": "RELATIONCLASSID",
            "type": "esriFieldTypeInteger",
            "alias": "RELATIONCLASSID"
          },
          {
            "name": "DATASOURCEID",
            "type": "esriFieldTypeInteger",
            "alias": "DATASOURCEID"
          },
          {
            "name": "UCID",
            "type": "esriFieldTypeInteger",
            "alias": "UCID"
          },
          {
            "name": "UOID",
            "type": "esriFieldTypeInteger",
            "alias": "UOID"
          },
          {
            "name": "USID",
            "type": "esriFieldTypeInteger",
            "alias": "USID"
          },
          {
            "name": "UPDATESTATUS",
            "type": "esriFieldTypeInteger",
            "alias": "UPDATESTATUS"
          },
          {
            "name": "SUBTYPE",
            "type": "esriFieldTypeInteger",
            "alias": "SUBTYPE"
          },
          {
            "name": "PROPERTYSET",
            "type": "esriFieldTypeBlob",
            "alias": "PROPERTYSET"
          },
          {
            "name": "FROMTID",
            "type": "esriFieldTypeString",
            "alias": "FROMTID",
            "length": 128
          },
          {
            "name": "TOTID",
            "type": "esriFieldTypeString",
            "alias": "TOTID", "length": 128
          },
          {
            "name": "FROMPORT",
            "type": "esriFieldTypeInteger",
            "alias": "FROMPORT"
          },
          {
            "name": "TOPORT",
            "type": "esriFieldTypeInteger",
            "alias": "TOPORT"
          },
          {
            "name": "FLOWDIRECTION",
            "type": "esriFieldTypeInteger",
            "alias": "FLOWDIRECTION"
          },
          {
            "name": "UGUID",
            "type": "esriFieldTypeGUID",
            "alias": "UGUID",
            "length": 38
          },
          {
            "name": "Category",
            "type": "esriFieldTypeString",
            "alias": "Category",
            "length": 50
          },
          {
            "name": "SHAPE.len",
            "type": "esriFieldTypeDouble",
            "alias": "SHAPE.len"
          }
        ],
        "features": [
          {
            "attributes": {
              "ID": 1,
              "DIAGRAMCLASSID": 948,
              "DIAGRAMOBJECTID": 2,
              "SCHEMATICTID": "1299-5-0",
              "ISINITIAL": -1,
              "ISDISPLAYED": -1,
              "RELATIONOBJECTID": -2,
              "RELATIONCLASSID": -2,
              "DATASOURCEID": 1,
              "UCID": 1299,
              "UOID": 5,
              "USID": 0,
              "UPDATESTATUS": 1,
              "SUBTYPE": 0,
              "FROMTID": "1296-38-0",
              "TOTID": "1296-41-0",
              "FROMPORT": 0,
              "TOPORT": 0,
              "FLOWDIRECTION": 1,
              "UGUID": null,
              "Category": "Big",
              "SHAPE.len": 0
            },
            "geometry": {
              "paths": [
                [
                  [
                    -15695315.069899999,
                    15956722.621100001
                  ],
                  [
                    -20188492.5143,
                    18282139.017800003
                  ]
                ]
              ],
              "spatialReference": {
                "wkid": 102585,
                "latestWkid": 102585
              }
            }
          },
          {
            "attributes": {
              "ID": 2,
              "DIAGRAMCLASSID": 948,
              "DIAGRAMOBJECTID": 2,
              "SCHEMATICTID": "1299-6-0",
              "ISINITIAL": -1,
              "ISDISPLAYED": -1,
              "RELATIONOBJECTID": -2,
              "RELATIONCLASSID": -2,
              "DATASOURCEID": 1,
              "UCID": 1299,
              "UOID": 6,
              "USID": 0,
              "UPDATESTATUS": 1,
              "SUBTYPE": 0,
              "FROMTID": "1296-38-0",
              "TOTID": "1296-40-0",
              "FROMPORT": 0,
              "TOPORT": 0,
              "FLOWDIRECTION": 1,
              "UGUID": null,
              "Category": "Small",
              "SHAPE.len": 0
            },
            "geometry": {
              "paths": [
                [
                  [
                    -15695315.069899999,
                    15956722.621100001
                  ],
                  [
                    -18257214.489999998,
                    13197754.015000001
                  ]
                ]
              ],
              "spatialReference": {
                "wkid": 102585,
                "latestWkid": 102585
              }
            }
          }
        ]
      },
      "featureClassID": 947
    },
    {
      "featureSet": {
        "displayFieldName": "",
        "fieldAliases": {
          "ID": "ID",
          "DIAGRAMCLASSID": "DIAGRAMCLASSID",
          "DIAGRAMOBJECTID": "DIAGRAMOBJECTID",
          "SCHEMATICTID": "SCHEMATICTID",
          "ISINITIAL": "ISINITIAL",
          "ISDISPLAYED": "ISDISPLAYED",
          "RELATIONOBJECTID": "RELATIONOBJECTID",
          "RELATIONCLASSID": "RELATIONCLASSID",
          "DATASOURCEID": "DATASOURCEID",
          "UCID": "UCID",
          "UOID": "UOID",
          "USID": "USID",
          "UPDATESTATUS": "UPDATESTATUS",
          "SUBTYPE": "SUBTYPE",
          "PROPERTYSET": "PROPERTYSET",
          "INITIALX": "INITIALX",
          "INITIALY": "INITIALY",
          "ROTATION": "ROTATION",
          "UGUID": "UGUID",
          "Type": "Type",
          "Name": "Name"
        },
        "geometryType": "esriGeometryPoint",
        "spatialReference": {
          "wkid": 102585,
          "latestWkid": 102585
        },
        "fields": [
          {
            "name": "ID",
            "type": "esriFieldTypeOID",
            "alias": "ID"
          },
          {
            "name": "DIAGRAMCLASSID",
            "type": "esriFieldTypeInteger",
            "alias": "DIAGRAMCLASSID"
          },
          {
            "name": "DIAGRAMOBJECTID",
            "type": "esriFieldTypeInteger",
            "alias": "DIAGRAMOBJECTID"
          },
          {
            "name": "SCHEMATICTID",
            "type": "esriFieldTypeString",
            "alias": "SCHEMATICTID",
            "length": 128
          },
          {
            "name": "ISINITIAL",
            "type": "esriFieldTypeInteger",
            "alias": "ISINITIAL"
          },
          {
            "name": "ISDISPLAYED",
            "type": "esriFieldTypeInteger",
            "alias": "ISDISPLAYED"
          },
          {
            "name": "RELATIONOBJECTID",
            "type": "esriFieldTypeInteger",
            "alias": "RELATIONOBJECTID"
          },
          {
            "name": "RELATIONCLASSID",
            "type": "esriFieldTypeInteger",
            "alias": "RELATIONCLASSID"
          },
          {
            "name": "DATASOURCEID",
            "type": "esriFieldTypeInteger",
            "alias": "DATASOURCEID"
          },
          {
            "name": "UCID",
            "type": "esriFieldTypeInteger",
            "alias": "UCID"
          },
          {
            "name": "UOID",
            "type": "esriFieldTypeInteger",
            "alias": "UOID"
          },
          {
            "name": "USID",
            "type": "esriFieldTypeInteger",
            "alias": "USID"
          },
          {
            "name": "UPDATESTATUS",
            "type": "esriFieldTypeInteger",
            "alias": "UPDATESTATUS"
          },
          {
            "name": "SUBTYPE",
            "type": "esriFieldTypeInteger",
            "alias": "SUBTYPE"
          },
          {
            "name": "PROPERTYSET",
            "type": "esriFieldTypeBlob",
            "alias": "PROPERTYSET"
          },
          {
            "name": "INITIALX",
            "type": "esriFieldTypeDouble",
            "alias": "INITIALX"
          },
          {
            "name": "INITIALY",
            "type": "esriFieldTypeDouble",
            "alias": "INITIALY"
          },
          {
            "name": "ROTATION",
            "type": "esriFieldTypeDouble",
            "alias": "ROTATION"
          },
          {
            "name": "UGUID",
            "type": "esriFieldTypeGUID",
            "alias": "UGUID",
            "length": 38
          },
          {
            "name": "Type",
            "type": "esriFieldTypeString",
            "alias": "Type",
            "length": 1
          },
          {
            "name": "Name",
            "type": "esriFieldTypeString",
            "alias": "Name",
            "length": 50
          }
        ],
        "features": [
          {
            "attributes": {
              "ID": 1,
              "DIAGRAMCLASSID": 948,
              "DIAGRAMOBJECTID": 2,
              "SCHEMATICTID": "1296-38-0",
              "ISINITIAL": -1,
              "ISDISPLAYED": -1,
              "RELATIONOBJECTID": -2,
              "RELATIONCLASSID": -2,
              "DATASOURCEID": 1,
              "UCID": 1296,
              "UOID": 38,
              "USID": 0,
              "UPDATESTATUS": 1,
              "SUBTYPE": 0,
              "INITIALX": -15695315.0699,
              "INITIALY": 15956722.621099999,
              "ROTATION": 0,
              "UGUID": null,
              "Type": "E",
              "Name": "ROMY"
            },
            "geometry": {
              "x": -15695315.069899999,
              "y": 15956722.621100001,
              "spatialReference": {
                "wkid": 102585,
                "latestWkid": 102585
              }
            }
          },
          {
            "attributes": {
              "ID": 2,
              "DIAGRAMCLASSID": 948,
              "DIAGRAMOBJECTID": 2,
              "SCHEMATICTID": "1296-40-0",
              "ISINITIAL": -1,
              "ISDISPLAYED": -1,
              "RELATIONOBJECTID": -2,
              "RELATIONCLASSID": -2,
              "DATASOURCEID": 1,
              "UCID": 1296,
              "UOID": 40,
              "USID": 0,
              "UPDATESTATUS": 1,
              "SUBTYPE": 0,
              "INITIALX": -18257214.489999998,
              "INITIALY": 13197754.015000001,
              "ROTATION": 0,
              "UGUID": null,
              "Type": "D",
              "Name": "TAGA"
            },
            "geometry": {
              "x": -18257214.489999998,
              "y": 13197754.015000001,
              "spatialReference": {
                "wkid": 102585,
                "latestWkid": 102585
              }
            }
          },
          {
            "attributes": {
              "ID": 3,
              "DIAGRAMCLASSID": 948,
              "DIAGRAMOBJECTID": 2,
              "SCHEMATICTID": "1296-41-0",
              "ISINITIAL": -1,
              "ISDISPLAYED": -1,
              "RELATIONOBJECTID": -2,
              "RELATIONCLASSID": -2,
              "DATASOURCEID": 1,
              "UCID": 1296,
              "UOID": 41,
              "USID": 0,
              "UPDATESTATUS": 1,
              "SUBTYPE": 0,
              "INITIALX": -20188492.5143,
              "INITIALY": 18282139.0178,
              "ROTATION": 0,
              "UGUID": null,
              "Type": "A",
              "Name": "UMOL"
            },
            "geometry": {
              "x": -20188492.5143,
              "y": 18282139.017800003,
              "spatialReference": {
                "wkid": 102585,
                "latestWkid": 102585
              }
            }
          }
        ]
      },
      "featureClassID": 946
    }
  ]
}

Layer object definition

Each layer item in the layers array corresponds to a schematic feature class associated with the diagram template on which the diagram is based.

All the schematic feature classes that are associated with the diagram template are detailed in this layers array, including those for which no schematic features are contained in the diagram.

Syntax
Use dark colors for code blocksCopy
"layers": [
  {
    "featureSet": {
      "displayFieldName": "",
      "fieldAliases": {
        "<field1>": "<aliasField1>",
        ...,
        "<fieldN>": "<aliasFieldN>"
      },
      "geometryType": "<esriGeometryPoint | esriGeometryPolyline | esriGeometryPolygon>",
      "spatialReference": <spatialReference>,
      "fields": [
        {
          "name": "<field1Name>",
          "type": <field1Type>,
          "alias": "<field1Alias>"
        },
        ...,
        {
          "name": "<fieldNName>",
          "type": <fieldNType>,
          "alias": "<fieldNAlias>"
        },
      ],
      "features": [
        <schFeature1>,
        ...,
        <schFeatureN>
      ]  //List of the schematic feature objects for this feature layer that are contained in the diagram
    },
    "featureClassID": <featureClassID1>, //This corresponds to the OBJECTID of the schematic feature class related to the layer
    "selectedIDs": [
      "<schFeature1_ID>",
      ...,
      "<schFeatureM_ID>"
    ] //List of the SCHEMATICTID for each schematic feature currently selected in this layer
  }
]

Property Details

Property	Details
`featureSet`	The `featureSet` object related to the feature layer, formatted to include the following properties: `displayFieldName` `fieldAliases`: List of field aliases Use dark colors for code blocksCopy `1 {"<field1Name>": "<field1Alias>", ..., "<fieldNName>": "<fieldNAlias>"}` `geometryType`: Type of geometry for the schematic features in this layer `esriGeometryPoint` `esriGeometryPolyline` `esriGeometryPolygon` `spatialReference`: Spatial reference for the related schematic feature class `fields`: Array of triplets that precises the `name`, `type`, and `alias` for each field Use dark colors for code blocksCopy `1 {"name": "<fieldName>", "type": <fieldType>, "alias": "<fieldAlias>"}` `features`: Array of schematic feature objects contained in the diagram for the feature layer. This array is empty when there are no schematic features for this layer contained in the schematic diagram.
`featureClassID`	ID of the schematic feature class related to the feature layer (Long).
`selectedIDs`	Array of the schematic feature identifiers (Long) that are currently selected in the diagram (optional).

featureSet

The featureSet object related to the feature layer, formatted to include the following properties:

displayFieldName

fieldAliases: List of field aliases

Use dark colors for code blocksCopy
{"<field1Name>": "<field1Alias>", ..., "<fieldNName>": "<fieldNAlias>"}

geometryType: Type of geometry for the schematic features in this layer
- esriGeometryPoint
- esriGeometryPolyline
- esriGeometryPolygon
spatialReference: Spatial reference for the related schematic feature class
fields: Array of triplets that precises the name, type, and alias for each field
Use dark colors for code blocksCopy
1 {"name": "<fieldName>", "type": <fieldType>, "alias": "<fieldAlias>"}
features: Array of schematic feature objects contained in the diagram for the feature layer. This array is empty when there are no schematic features for this layer contained in the schematic diagram.

featureClassID

ID of the schematic feature class related to the feature layer (Long).

selectedIDs

Array of the schematic feature identifiers (Long) that are currently selected in the diagram (optional).

Use dark colors for code blocksCopy
"layers": [
  {
    "featureSet": {
      "displayFieldName": "",
      "fieldAliases": {
        "ID": "ID",
        "DIAGRAMCLASSID": "DIAGRAMCLASSID",
        "DIAGRAMOBJECTID": "DIAGRAMOBJECTID",
        "SCHEMATICTID": "SCHEMATICTID",
        "ISINITIAL": "ISINITIAL",
        "ISDISPLAYED": "ISDISPLAYED",
        "RELATIONOBJECTID": "RELATIONOBJECTID",
        "RELATIONCLASSID": "RELATIONCLASSID",
        "DATASOURCEID": "DATASOURCEID",
        "UCID": "UCID",
        "UOID": "UOID",
        "USID": "USID",
        "UPDATESTATUS": "UPDATESTATUS",
        "SUBTYPE": "SUBTYPE",
        "PROPERTYSET": "PROPERTYSET",
        "FROMTID": "FROMTID",
        "TOTID": "TOTID",
        "FROMPORT": "FROMPORT",
        "TOPORT": "TOPORT",
        "FLOWDIRECTION": "FLOWDIRECTION",
        "UGUID": "UGUID",
        //The next Category field corresponds to a custom attribute for this link schematic feature class
        "Category": "Category",
        "SHAPE.len": "SHAPE.len"
      },
      "geometryType": "esriGeometryPolyline",
      "spatialReference": {
        "wkid": 102585,
        "latestWkid": 102585
      },
      "fields": [
        {
          "name": "ID",
          "type": "esriFieldTypeOID",
          "alias": "ID"
        },
        {
          "name": "DIAGRAMCLASSID",
          "type": "esriFieldTypeInteger",
          "alias": "DIAGRAMCLASSID"
        },
        {
          "name": "DIAGRAMOBJECTID",
          "type": "esriFieldTypeInteger",
          "alias": "DIAGRAMOBJECTID"
        },
        {
          "name": "SCHEMATICTID",
          "type": "esriFieldTypeString",
          "alias": "SCHEMATICTID",
          "length": 128
        },
        {
          "name": "ISINITIAL",
          "type": "esriFieldTypeInteger",
          "alias": "ISINITIAL"
        },
        {
          "name": "ISDISPLAYED",
          "type": "esriFieldTypeInteger",
          "alias": "ISDISPLAYED"
        },
        {
          "name": "RELATIONOBJECTID",
          "type": "esriFieldTypeInteger",
          "alias": "RELATIONOBJECTID"
        },
        {
          "name": "RELATIONCLASSID",
          "type": "esriFieldTypeInteger",
          "alias": "RELATIONCLASSID"
        },
        {
          "name": "DATASOURCEID",
          "type": "esriFieldTypeInteger",
          "alias": "DATASOURCEID"
        },
        {
          "name": "UCID",
          "type": "esriFieldTypeInteger",
          "alias": "UCID"
        },
        {
          "name": "UOID",
          "type": "esriFieldTypeInteger",
          "alias": "UOID"
        },
        {
          "name": "USID",
          "type": "esriFieldTypeInteger",
          "alias": "USID"
        },
        {
          "name": "UPDATESTATUS",
          "type": "esriFieldTypeInteger",
          "alias": "UPDATESTATUS"
        },
        {
          "name": "SUBTYPE",
          "type": "esriFieldTypeInteger",
          "alias": "SUBTYPE"
        },
        {
          "name": "PROPERTYSET",
          "type": "esriFieldTypeBlob",
          "alias": "PROPERTYSET"
        },
        {
          "name": "FROMTID",
          "type": "esriFieldTypeString",
          "alias": "FROMTID",
          "length": 128
        },
        {
          "name": "TOTID",
          "type": "esriFieldTypeString",
          "alias": "TOTID", "length": 128
        },
        {
          "name": "FROMPORT",
          "type": "esriFieldTypeInteger",
          "alias": "FROMPORT"
        },
        {
          "name": "TOPORT",
          "type": "esriFieldTypeInteger",
          "alias": "TOPORT"
        },
        {
          "name": "FLOWDIRECTION",
          "type": "esriFieldTypeInteger",
          "alias": "FLOWDIRECTION"
        },
        {
          "name": "UGUID",
          "type": "esriFieldTypeGUID",
          "alias": "UGUID",
          "length": 38
        },
        {
          "name": "Category",
          "type": "esriFieldTypeString",
          "alias": "Category",
          "length": 50
        },
        {
          "name": "SHAPE.len",
          "type": "esriFieldTypeDouble",
          "alias": "SHAPE.len"
        }
      ]
    }
  }
]

ArcGIS REST APIs

Schematic Diagram Content object

Overview

Layer object definition