Rename Folder

Renames the folder with the new name provided in the request payload. The provided new name has the following naming restrictions:

• Name cannot be / , .
• Length should be less than 255 characters
• Cannot contain reserved keywords like com[1-9], lpt[1-9], con, nul, prn, aux, ?, <, >, *, |

The provided name should also be unique under the parent folder. When the rename operation is performed, the path of the folder and its children will be updated accordingly in an async fashion. The rename operation can only be performed on an active resource. The rename operation is an asynchronous operation and the response will contain the job identifier. The status of the job can be checked using the job status API. The rename operation can only be performed when there is no outstanding job for the source identifier. Major version will be incremented whenever a rename operation is performed on the folder.

Prerequisites

• A folder should be created. To know more about creating a folder refer here

Request

POST {baseUrl}/spaces/{spaceId}/folders/{folderId}/rename

• HEADER:

  • Authorization: Bearer {tid token}

• Body:

  • name - new name of folder

Example request body:

{
    "name":"newFolderName"
}

Response

Example Response:

{
  "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "status": "RUNNING",
  "type": "RENAME",
  "createdAt": "2024-06-25T06:37:31Z",
  "createdByTrn": "trn:tid:application:<applicationId>",
  "message": "Rename job is in progress"
}

To know more about rename folder refer here