Sign in

v1

latestOpenAPI 3.0.02026-08-064311,0881.3 MB
folderManagement

Update a folder.

Update an existing folder with the given identifier. Set the header parameter isAdminMode to "true" if updating a folder inside "Admin Recommended" folder.

put/v2/content/folders/{id}

Path parameters

idstring required

Identifier of the folder to update.

Headers

isAdminModestring

Set this to "true" if you want to perform the request as a Content Administrator.

Request body

namestring required

The name of the folder.

descriptionstring

The description of the folder.

Example request

{
  "name": "SampleFolder",
  "description": "This is a sample folder."
}

Response

The folder was successfully updated.

createdAtstring date-time required

Creation timestamp in UTC in RFC3339 format.

createdBystring required

Identifier of the user who created the resource.

modifiedAtstring date-time required

Last modification timestamp in UTC.

modifiedBystring required

Identifier of the user who last modified the resource.

idstring required

Identifier of the content item.

namestring required

The name of the content item.

itemTypestring required

Type of the content item. Supported values are:

  1. Folder
  2. Search
  3. Report (for old dashboards)
  4. Dashboard (for new dashboards)
  5. Lookups
parentIdstring required

Identifier of the parent content item.

permissionsstring[] required

List of permissions the user has on the content item.

descriptionstring

The description of the folder.

isScheduledboolean

Indicates whether the content item refers to scheduled search. This field is only relevant to Search content type.

Example response

{
  "createdAt": "2018-10-16T09:10:00Z",
  "createdBy": "0000000006743FDD",
  "modifiedAt": "2018-10-16T09:10:00Z",
  "modifiedBy": "0000000006743FE8",
  "id": "000000000C1C17C6",
  "name": "Personal",
  "itemType": "Folder",
  "parentId": "0000000001C41EF2",
  "permissions": [
    "View",
    "GrantView",
    "Edit"
  ],
  "description": "This is a sample folder.",
  "children": [
    {
      "createdAt": "2018-10-16T09:10:00Z",
      "createdBy": "0000000006743FDD",
      "modifiedAt": "2018-10-16T09:10:00Z",
      "modifiedBy": "0000000006743FE8",
      "id": "000000000C1C17C6",
      "name": "Personal",
      "itemType": "Folder",
      "parentId": "0000000001C41EF2",
      "permissions": [
        "View",
        "GrantView",
        "Edit"
      ],
      "description": "Personal folder for John Doe"
    }
  ]
}