Schematic Folder object

Overview

This topic discusses the JSON Schematic Folder object as returned by the REST API.

A folder consists of the following four mandatory properties:

• name—Folder name (String).
• id—Identifier of the folder in the schematic service (String).
• objectID—OBJECTID of the folder in the schematic dataset (Long).
• folders—List of its subfolders (Array of Schematic Folder Object).

  Note:

  This list may be empty.

JSON syntax

            {
  "name" : "<FolderName>",
  "id" : "<FolderId>",
  "objectID" : <FolderObjectID>,
  "folders": [
	 <SubFolder1>,
	 ...,
	 <SubFolderN>
  ]
}

JSON example

            //Sample Schematic Folder object containing three subfolders.
{
  "name" : "OSP diagrams",
  "id" : "2",
  "objectID" : 2,
  "folders" : [
    {
      "name" : "OSPEast",
      "id" : "321",
      "objectID" : 321,
      "folders" : [
       
      ]
    },
    {
      "name" : "OSPWest",
      "id" : "322",
      "objectID" : 322,
      "folders" : [
      
      ]
    },
    {
      "name" : "OSPSouth",
      "id" : "323",
      "objectID" : 323,
      "folders" : [
       
      ]
    }
  ]
}