Summary
Gets information on all Profile Directories, recursively listing their children.
This method will also list profile directories that are located in the Recycle Bin ("movedToBin":"true").
Resource URL
/v3/directories/profiledirectories?facets=children
Example Request
curl \
--request GET \
https://[server]:8443/umsapi/v3/directories/profiledirectories/facets=children
Response Type
Returns a list of Profile Directories,. with their DirectoryChildren fields containing other objects.
Example Response
[
{
"DirectoryChildren": [
{
"objectType": "profile",
"id": "20467",
"link": {
"rel": "profile",
"href": "https://172.30.91.227:8443/umsapi/v3/profiles/20467"
}
},
{
"objectType": "profile",
"id": "20452",
"link": {
"rel": "profile",
"href": "https://172.30.91.227:8443/umsapi/v3/profiles/20452"
}
},
{
"objectType": "profile",
"id": "20449",
"link": {
"rel": "profile",
"href": "https://172.30.91.227:8443/umsapi/v3/profiles/20449"
}
}
],
"id": "20707",
"name": "Standards",
"parentID": "-2",
"movedToBin": false,
"objectType": "profiledirectory",
"links": [
{
"rel": "self",
"href": "https://172.30.91.227:8443/umsapi/v3/directories/profiledirectories/20707"
},
{
"rel": "Parent",
"href": "root"
}
]
},
{
"DirectoryChildren": [
{
"objectType": "profiledirectory",
"id": "72068",
"link": {
"rel": "profiledirectory",
"href": "https://172.30.91.227:8443/umsapi/v3/directories/profiledirectories/72068"
}
},
{
"objectType": "profile",
"id": "6592",
"link": {
"rel": "profile",
"href": "https://172.30.91.227:8443/umsapi/v3/profiles/6592"
}
},
{
"objectType": "profile",
"id": "6585",
"link": {
"rel": "profile",
"href": "https://172.30.91.227:8443/umsapi/v3/profiles/6585"
}
}
],
"id": "20453",
"name": "Benchmarks",
"parentID": "-2",
"movedToBin": false,
"objectType": "profiledirectory",
"links": [
{
"rel": "self",
"href": "https://172.30.91.227:8443/umsapi/v3/directories/profiledirectories/20453"
},
{
"rel": "Parent",
"href": "root"
}
]
},
{
"DirectoryChildren": [],
"id": "72068",
"name": "A Subdirectory",
"parentID": "20453",
"movedToBin": false,
"objectType": "profiledirectory",
"links": [
{
"rel": "self",
"href": "https://172.30.91.227:8443/umsapi/v3/directories/profiledirectories/72068"
},
{
"rel": "Parent",
"href": "https://172.30.91.227:8443/umsapi/v3/directories/profiledirectories/20453"
}
]
}
]
