Schematic Diagram Information object
Overview
This topic discusses the JSON Schematic Diagram Information object as returned by the REST API.
A Schematic Diagram Information object provides the following information:
- name—Diagram name (String).
- id—Diagram identifier in the schematic service (String).
- templateIdentifier—Identifier of the diagram template on which the schematic diagram is based in the schematic service (String).
- templateObjectID—OBJECTID of the diagram template on which the schematic diagram is based in the schematic dataset (Long).
- schematicLayerIdentifier—Identifier of the schematic diagram layer in the schematic service (Long).
- folderObjectID—OBJECTID of the schematic folder where the diagram is stored in the schematic dataset (Long).
- folderIdentifier—Identifier of the schematic folder where the diagram is stored in the schematic service (String).
- objectID—OBJECTID of the schematic diagram in the schematic dataset (Long).
- createdBy—Name of the diagram creator (String).
- lastModificationBy—Name of the last user who modified the diagram (String).
- lastUpdateBy—Name of the last user who updated the diagram (String).
- creationDate—Diagram creation date (String).
- lastModificationDate—Diagram's last modification date (String).
- lastUpdateDate—Diagram's last update date (String).
- lockedBy—Name of the last user who locked the diagram (String).
- version—SDE version on which the diagram is based (String).
- extent—Diagram extent (<envelope>).
- rootNodes (optional)—List of the schematic root node identifiers (Array of String).
- endNodes (optional)—List of the schematic end node identifiers (Array of String).
JSON syntax
{
"name" : "<diagramName>",
"id" : "<diagramId>",
"templateIdentifier" : "<templateIdentifier>",
"templateObjectID" : <templateObjectID>,
"schematicLayerIdentifier" : <schematicLayerIdentifier>,
"folderObjectID" : <folderObjectID>,
"folderIdentifier" : "<folderIdentifier>",
"objectID" : <objectID>,
"createdBy" : "<diagramCreator>",
"lastModificationBy" : "<diagramLastEditor>",
"lastUpdateBy" : "<diagramLastUpdator>",
"creationDate" : "<diagramCreationDate>",
"lastModificationDate" : "<diagramModificationDate>",
"lastUpdateDate" : "<diagramLastUpdateDate>",
"lockedBy" : "<diagramLastLocker>",
"version" : "<version>",
"extent" : <envelope>,
"rootNodes" : ["<rootNode1>" , ..., "<rootNodeN>"],
"endNodes" : ["<endNode1>" , ..., "<endNodeK>"]
}
JSON example
{
"name" : "ESTANCIA",
"id" : "0-334",
"templateIdentifier" : "0",
"templateObjectID" : 3204,
"schematicLayerIdentifier" : 0,
"folderObjectID" : 1,
"folderIdentifier" : "1",
"objectID" : 334,
"createdBy" : "NCA3885",
"lastModificationBy" : "ABL4732",
"lastUpdateBy" : "",
"creationDate" : "01/21/2011 16:07:46",
"lastModificationDate" : "02/14/2011 18:34:46",
"lastUpdateDate" : "",
"lockedBy" : "",
"version" : "",
"extent" : {
"xmin" : 6.0370819091796868,
"ymin" : -8.059234619140625,
"xmax" : 29.909512329101563,
"ymax" : 11.059844970703125,
"spatialReference" : {
"wkt" : "{B286C06B-0879-11D2-AACA-00C04FA33C20}"
}
},
"rootNodes" : [
"115"
],
"endNodes" : [
]
}
Response examples
Example 1: The Schematic Diagram Information object returned for the schematic diagram whose ID is '2-1' under the S1_Schematics public sample Schematics service.
Example 2: The Schematic Diagram Information object returned for the schematic diagram whose ID is '0-13' under the S2_InternalPlants public sample Schematics service.