GET folders/{id}?include={include}

Gets the information of the folder with the specified identifier.

Request Information

URI Parameters

NameDescriptionTypeAdditional 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

FolderViewModel
NameDescriptionTypeAdditional information
Id

integer

None.

Name

string

None.

Level

integer

None.

ParentFolder

BaseViewModel

None.

ChildFolders

Collection of BaseViewModel

None.

ContainedObjects

Collection of BaseViewModel

None.

FolderGroupRights

Collection of BaseViewModel

None.

FolderUserRights

Collection of BaseViewModel

None.

SelfUrl

string

None.

Response Formats

application/json, text/json

Sample:
{
  "id": 1,
  "name": "sample string 2",
  "level": 3,
  "parentFolder": {
    "selfUrl": "sample string 1"
  },
  "childFolders": [
    {
      "selfUrl": "sample string 1"
    },
    {
      "selfUrl": "sample string 1"
    }
  ],
  "containedObjects": [
    {
      "selfUrl": "sample string 1"
    },
    {
      "selfUrl": "sample string 1"
    }
  ],
  "folderGroupRights": [
    {
      "selfUrl": "sample string 1"
    },
    {
      "selfUrl": "sample string 1"
    }
  ],
  "folderUserRights": [
    {
      "selfUrl": "sample string 1"
    },
    {
      "selfUrl": "sample string 1"
    }
  ],
  "selfUrl": "sample string 4"
}