Restore file

Restore a file from the deleted state. Minor version will be incremented for restore operation.

The file will be restored to the original location if the request body is empty. If there is already active file in original location, deleted file can be restored to different location by specifying targetParentId. To restore the file in same location during conflict, specify different name for the resource through name attribute.

Prerequisites

• A file should be in soft deleted state. To know more about deleting a file refer here
• Target parent folder should be created in case of conflict. To know more about creating a folder refer here

Request

POST {baseUrl}/spaces/{spaceId}/files/{fileId}/restore

Restore file will be synchronously restored to the location.

• HEADER:

  • Authorization: Bearer {tid token}

Response

Example response:

{
       "id": "f85bc802-5481-4581-b972-c4652d595ec7",
       "name": "name",
       "type": "FILE",
       "version": "1.1",
       "spaceId": "f85bc802-5481-4581-b972-c4652d595ec7",
       "createdAt": "2024-03-17T00:00:00Z",
       "updatedAt": "2023-03-19T11:00:00Z",
       "createdByTrn": "trn:tid:user:6529d0b3-5856-41ab-88b3-86f7955cddf1",
       "updatedByTrn": "trn:tid:user:7529d0b3-5856-41ab-88b3-86f7955cddf1",
       "deleted": false
   }

Restore File in different location

In case of conflict if user wants to restore the deleted file in different location with different name, user can provide those details.

Request

POST {baseUrl}/spaces/{spaceId}/files/{fileId}/restore

• HEADER:

  • Authorization: Bearer {tid token}

• BODY:

  • name - name of file to be restored
  • targetParentId - target where the source file need to be restored

Example request body:

{
    "name": "new_name",
    "targetParentId": "6529d0b3-5856-41ab-88b3-86f7955cddf1"
}

Response

Example response:

{
       "id": "f85bc802-5481-4581-b972-c4652d595ec7",
       "name": "new_name",
       "type": "FILE",
       "version": "1.2",
       "spaceId": "f85bc802-5481-4581-b972-c4652d595ec7",
       "createdAt": "2024-03-17T00:00:00Z",
       "updatedAt": "2023-03-19T11:00:00Z",
       "createdByTrn": "trn:tid:user:6529d0b3-5856-41ab-88b3-86f7955cddf1",
       "updatedByTrn": "trn:tid:user:7529d0b3-5856-41ab-88b3-86f7955cddf1",
       "deleted": false
   }

To know more about the restore file API refer here.