Schematic Diagram Information object—Common Data Types

Overview

The JSON Schematic Diagram Information object as returned by the REST API is described below.

JSON properties

A Schematic Diagram Information object provides the following information:


Property	Description
name	The diagram name (String).
id	The diagram identifier in the schematic service (String).
templateIdentifier	The identifier of the diagram template on which the schematic diagram is based in the schematic service (String).
templateObjectID	The OBJECTID of the diagram template on which the schematic diagram is based in the schematic dataset (Long).
schematicLayerIdentifier	The identifier of the schematic diagram layer in the schematic service (Long).
folderObjectID	The OBJECTID of the schematic folder where the diagram is stored in the schematic dataset (Long).
folderIdentifier	The identifier of the schematic folder where the diagram is stored in the schematic service (String).
objectID	The OBJECTID of the schematic diagram in the schematic dataset (Long).
createdBy	The name of the diagram creator (String).
lastModificationBy	The name of the last user who modified the diagram (String).
lastUpdateBy	The name of the last user who updated the diagram (String).
creationDate	The diagram creation date (String).
lastModificationDate	The date the diagram was last modified (String).
lastUpdateDate	The date the diagram was last updated (String).
lockedBy	The name of the last user who locked the diagram (String).
version	The SDE version on which the diagram is based (String).
extent	The diagram extent (<envelope>).
rootNodes (Optional)	The list of the schematic root node identifiers (Array of String).
endNodes (Optional)	The list of the schematic end node identifiers (Array of String).

JSON Response 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 Response examples

This section provides various request URLs and JSON response examples for Schematic Diagram Information objects

Example response one

The example URL below demonstrates a request URL that returns the JSON object for the schematic diagram whose ID is 2-1 under the S1_Schematics public sample Schematics service.

https://machine.domain.com/webadaptor/rest/services/S1_Schematics/MapServer/exts/SchematicsServer/diagrams/2-1?f=pjson

When submitted, the request returns the following Schematic Diagram Information JSON object:

{
  "name": "MPS_Goldmine",
  "id": "2-1",
  "templateIdentifier": "2",
  "templateObjectID": 120,
  "schematicLayerIdentifier": 2,
  "folderObjectID": 3,
  "folderIdentifier": "3",
  "objectID": 1,
  "createdBy": "anne0002",
  "lastModificationBy": "anne0002",
  "lastUpdateBy": "anne0002",
  "creationDate": "7/1/2011 9:24:53 AM",
  "lastModificationDate": "9/13/2011 4:32:54 PM",
  "lastUpdateDate": "9/13/2011 4:32:55 PM",
  "lockedBy": "",
  "version": "",
  "extent": {
    "xmin": 123887.92612546384,
    "ymin": 4075951.9117009705,
    "xmax": 147794.10396917461,
    "ymax": 4102425.3573760176,
    "spatialReference": {
      "wkid": 102118,
      "latestWkid": 102118
    }
  },
  "rootNodes": [],
  "endNodes": []
}

Example response two

The example URL below demonstrates a request URL that returns the JSON object for the schematic diagram whose ID is 0-13 under the S2_InternalPlants public sample Schematics service.

https://machine.domain.com/webadaptor/rest/services/S2_InternalPlants/MapServer/exts/SchematicsServer/diagrams/0-13?f=pjson