- URL:https://<schematicserver-url>/folders
- Version Introduced:10.1
Description
The Schematic Folders resource represents the set of schematic folders in the schematic dataset(s) related to the schematic layers under a schematic service. It is returned as an array of <Schematic Folder Object> by the REST API.
Tip:
When consuming a schematic service under which there is a large number of schematic diagrams, you will have quicker response when displaying the list of the published diagrams if those diagrams are organized by schematic folders instead of being all stored at the schematic dataset root.
Request parameters
| Parameter | Details |
|---|---|
| f | The response format. The default response format is html. Values: html | json |
Example usage
Example 1: The schematic folders under the S1_Schematics public sample Schematics service
https://servicesbeta6.esri.com/arcgis/rest/services/S1_Schematics/MapServer/exts/SchematicsServer/foldersExample 2: The schematic folders under the S2_InternalPlants public sample Schematics service
https://servicesbeta6.esri.com/arcgis/rest/services/S2_InternalPlants/MapServer/exts/SchematicsServer/foldersJSON Response syntax
{
"folders" : [
<folder1—See the Schematic Folder Object topic for the JSON Syntax>,
...,
<folderN—See the Schematic Folder Object topic for the JSON Syntax>
]
}
JSON Response example
//Sample response for a schematic service that references a schematic dataset containing two root folders, ISP diagrams and OSP diagrams
{
"folders" : [
{
"name" : "ISP diagrams",
"id" : "1",
"objectID" : 1,
"folders" : [
]
},
{
"name" : "OSP diagrams",
"id" : "2",
"objectID" : 2,
"folders" : [
//The OSP diagrams root folder contains three sub-folders; there are OSPEast, OSPWest, and OPSSouth
{
"name" : "OSPEast",
"id" : "321",
"objectID" : 321,
"folders" : [
]
},
{
"name" : "OSPWest",
"id" : "322",
"objectID" : 322,
"folders" : [
]
},
{
"name" : "OSPSouth",
"id" : "323",
"objectID" : 323,
"folders" : [
]
}
]
}
]
}