This document discusses the JSON Schematic Folder object as returned by the REST API.
A folder consists of 4 mandatory properties:
name
: The folder name (String),id
: The identifier of the folder in the schematic service (String),objectID
: The OBJECTID of the folder in the schematic dataset (Long),folders
: the list of its subfolders (Array of Schematic Folder Object). Note that this list could be empty.{
"name" : "<FolderName>",
"id" : "<FolderId>",
"objectID" : <FolderObjectID>,
"folders": [
<SubFolder1>,
...,
<SubFolderN>
]
}
//Sample Schematic Folder object containing three sub-folders
{
"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" : [
]
}
]
}