GET folders/{id}?include={include}
Gets the information of the folder with the specified identifier.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
id |
The identifier of the folder. |
integer |
Required |
include |
Defines the properties to be included (separated by comma). |
string |
None. |
Body Parameters
None.
Response Information
Resource Description
FolderViewModelName | Description | Type | Additional information |
---|---|---|---|
Id | integer |
None. |
|
Name | string |
Filterable Settable |
|
Level | integer |
Filterable |
|
Owner | BaseViewModel |
Filterable Includable |
|
ParentFolder | BaseViewModel |
Includable Settable |
|
ChildFolders | IGenericPaginatedListViewModelOfBaseViewModel |
Includable |
|
ContainedObjects | IGenericPaginatedListViewModelOfBaseViewModel |
Includable |
|
ContainedObjectRelations | IGenericPaginatedListViewModelOfBaseViewModel |
Includable |
|
FolderGroupRights | Collection of BaseViewModel |
Includable |
|
FolderUserRights | Collection of BaseViewModel |
Includable |
|
SelfUrl | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "id": 1, "name": "sample string 2", "level": 3, "owner": { "selfUrl": "sample string 1" }, "parentFolder": { "selfUrl": "sample string 1" }, "childFolders": null, "containedObjects": null, "containedObjectRelations": null, "folderGroupRights": [ { "selfUrl": "sample string 1" }, { "selfUrl": "sample string 1" } ], "folderUserRights": [ { "selfUrl": "sample string 1" }, { "selfUrl": "sample string 1" } ], "selfUrl": "sample string 4" }