PUT folders/{id}

Updates or moves an existing folder.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

The identifier of the folder.

integer

Required

Body Parameters

The model containing the information to update or move a folder.

FolderViewModel
NameDescriptionTypeAdditional 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.

Request 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"
}

Response Information

Resource Description

FolderViewModel
NameDescriptionTypeAdditional 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"
}