Get folders
Since Product Version: 3.0
Resource Information
Rate Limiting?
|
Yes
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
DevNet Discussions
API version v1 is deprecated
This API version has been deprecated. It will be removed in a future release of the product. Please develop new clients using the latest API version. Please modify your existing clients to use a later API version.
Resource URL
/webacs/api/v1/op/cliTemplateConfiguration/folder
Response Parameters
folderFQN
String
|
Fully qualified name of the group
|
groupId
long
|
Identifier for the fully qualified name folder
|
Sample Payloads
Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.
Sample XML Response Payload
https://localhost/webacs/api/v1/op/cliTemplateConfiguration/folder?folderFQN=My Templates/folderName
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v1/op/cliTemplateConfiguration/folder?folderFQN=My Templates/folderName" rootUrl="https://localhost/webacs/api/v1/op">
<folderHierarchyItem>
<folderFQN>String value</folderFQN>
<groupId>2</groupId>
</folderHierarchyItem>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v1/op/cliTemplateConfiguration/folder.json?folderFQN=My Templates/folderName
{
"mgmtResponse" : {
"@responseType" : "operation",
"@requestUrl" : "https : \/\/localhost\/webacs\/api\/v1\/op\/cliTemplateConfiguration\/folder?folderFQN=My Templates\/folderName",
"@rootUrl" : "https : \/\/localhost\/webacs\/api\/v1\/op",
"folderHierarchyItem" : {
"folderFQN" : "String value",
"groupId" : 2
}
}
}
Resource Information
Rate Limiting?
|
Yes
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
DevNet Discussions
Resource URL
/webacs/api/v2/op/cliTemplateConfiguration/folder
Unmodified
This resource has not been modified since the previous API version.
Response Parameters
folderFQN
String
|
Fully qualified name of the group
|
groupId
long
|
Identifier for the fully qualified name folder
|
Sample Payloads
Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.
Sample XML Response Payload
https://localhost/webacs/api/v2/op/cliTemplateConfiguration/folder?folderFQN=My Templates/folderName
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v2/op/cliTemplateConfiguration/folder?folderFQN=My Templates/folderName" rootUrl="https://localhost/webacs/api/v2/op">
<folderHierarchyItem>
<folderFQN>String value</folderFQN>
<groupId>2</groupId>
</folderHierarchyItem>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v2/op/cliTemplateConfiguration/folder.json?folderFQN=My Templates/folderName
{
"mgmtResponse" : {
"@requestUrl" : "https://localhost/webacs/api/v2/op/cliTemplateConfiguration/folder?folderFQN=My Templates/folderName",
"@responseType" : "operation",
"@rootUrl" : "https://localhost/webacs/api/v2/op",
"folderHierarchyItem" : [ {
"folderFQN" : "String value",
"groupId" : 2
} ]
}
}
Resource Information
Rate Limiting?
|
Yes
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
DevNet Discussions
Resource URL
/webacs/api/v3/op/cliTemplateConfiguration/folder
Unmodified
This resource has not been modified since the previous API version.
Response Parameters
folderFQN
String
|
Fully qualified name of the group
|
groupId
long
|
Identifier for the fully qualified name folder
|
Sample Payloads
Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.
Sample XML Response Payload
https://localhost/webacs/api/v3/op/cliTemplateConfiguration/folder?folderFQN=My Templates/folderName
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v3/op/cliTemplateConfiguration/folder?folderFQN=My Templates/folderName" rootUrl="https://localhost/webacs/api/v3/op">
<folderHierarchyItem>
<folderFQN>String value</folderFQN>
<groupId>2</groupId>
</folderHierarchyItem>
<folderHierarchyItem>
<folderFQN>Another string value</folderFQN>
<groupId>12</groupId>
</folderHierarchyItem>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v3/op/cliTemplateConfiguration/folder.json?folderFQN=My Templates/folderName
{
"mgmtResponse" : {
"@requestUrl" : "https://localhost/webacs/api/v3/op/cliTemplateConfiguration/folder?folderFQN=My Templates/folderName",
"@responseType" : "operation",
"@rootUrl" : "https://localhost/webacs/api/v3/op",
"folderHierarchyItem" : [ {
"folderFQN" : "String value",
"groupId" : 2
}, {
"folderFQN" : "Another string value",
"groupId" : 12
} ]
}
}
Resource Information
Rate Limiting?
|
Yes
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
DevNet Discussions
Resource URL
/webacs/api/v4/op/cliTemplateConfiguration/folder
Unmodified
This resource has not been modified since the previous API version.
Response Parameters
folderFQN
String
|
Fully qualified name of the group
|
groupId
long
|
Identifier for the fully qualified name folder
|
Sample Payloads
Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.
Sample XML Response Payload
https://localhost/webacs/api/v4/op/cliTemplateConfiguration/folder?folderFQN=My Templates/folderName
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v4/op/cliTemplateConfiguration/folder?folderFQN=My Templates/folderName" rootUrl="https://localhost/webacs/api/v4/op">
<folderHierarchyItem>
<folderFQN>String value</folderFQN>
<groupId>2</groupId>
</folderHierarchyItem>
<folderHierarchyItem>
<folderFQN>Another string value</folderFQN>
<groupId>12</groupId>
</folderHierarchyItem>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v4/op/cliTemplateConfiguration/folder.json?folderFQN=My Templates/folderName
{
"mgmtResponse" : {
"@requestUrl" : "https://localhost/webacs/api/v4/op/cliTemplateConfiguration/folder?folderFQN=My Templates/folderName",
"@responseType" : "operation",
"@rootUrl" : "https://localhost/webacs/api/v4/op",
"folderHierarchyItem" : [ {
"folderFQN" : "String value",
"groupId" : 2
}, {
"folderFQN" : "Another string value",
"groupId" : 12
} ]
}
}