Edit folder

Overview

This API edits an existing folder. The user must have the required permissions to edit a folder.

Permissions

  • 'Edit Folder' permission on each folder is required.

Preconditions

Last modified date present in the request body must match the same on the server for the given folder.

SecurityoAuthUser
Request
header Parameters
Accept-Language
required
string
Default: en-US

Language locale accepted by client (used for locale specific fields in resource representation and in error responses).

Enum: "en-US" "es-ES" "fr-FR" "it-IT" "de-DE" "nl-NL" "pt-BR" "pt-PT" "da-DK" "ru-RU" "fr-CA" "zh-CN" "ja-JP" "ko-KR" "sv-SE"
Request Body schema: application/json
Array of objects (link) >= 0 items
name
string (name) [ 1 .. 250 ] characters
description
string (description) [ 0 .. 250 ] characters
object (DateAndTime)
required
object (DateAndTime)
object (Folder)
object (Department)
access
string (access)
object (User)
translate
integer (translate)
object (ACL)
object (Permissions)
cascade
boolean (cascade)
required
object (language)

Language passed in the request must be assigned to user.

path
string (path)
isSystemCreated
boolean (isSystemCreated)
folderType
integer (folderType)
id
required
number (id)
Responses
204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

406

Not acceptable

409

Conflict

412

Preconditions failed

500

Internal server error

put/folders
Request samples
application/json
{
  • "name": "Egs21230Api1",
  • "lastModified": {
    },
  • "id": 40960000000096,
  • "language": {
    }
}
Response samples
application/json

Required query parameter is missing

{
  • "code": "400-112",
  • "developerMessage": "Required query parameter(s) is missing. The following parameters are required: <param name>"
}