Update Folder

Updates the folder based on the provided identifier. Fields of the folder like metadata and acl can be updated. Major version will be incremented whenever a patch operation is performed on the folder. The update operation can only be performed on an active resource. Similar to GET FOLDER API it supports the query params complete and status.

Prerequisites

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

Request

PATCH {baseUrl}/spaces/{spaceId}/folders/{folderId}

• HEADER:

  • Authorization: Bearer {tid token}

• Body:

  • metadata - Metadata for the folder
  • acl - Access control list for the folder

Example request body:

    {
      "metadata": {
        "language": "Japanese"
      },
      "acl": {
        "contentContributor": [
          "trn:tid:application:f85bc802-5481-4581-b972-c4652d595ec7",
          "trn:tid:user:6529d0b3-5856-41ab-88b3-86f7955cddf1"
        ]
      }
    }

Response

Example Response:

  {
    "acl": {
      "contentContributor": [
          "trn:tid:application:f85bc802-5481-4581-b972-c4652d595ec7",
          "trn:tid:user:6529d0b3-5856-41ab-88b3-86f7955cddf1"
      ]
    },
    "createdAt": "2024-06-25T06:37:31Z",
    "createdByTrn": "trn:tid:application:fae7a6aa-cf9b-42ad-945b-a89d1c1ec580",
    "deleted": false,
    "id": "b93c5919-e3e8-47f9-bf26-d99c8864a19f",
    "name": "folder1",
    "metadata": {
      "language": "Japanese"
    },
    "parentId": "b93c5919-e3e8-47f9-bf26-d99c8864a19f",
    "path": "/folder1",
    "spaceId": "1edd3cf2-226c-42a0-b0d8-8fa828ed5d2b",
    "type": "FOLDER",
    "updatedAt": "2024-06-25T06:37:31Z",
    "updatedByTrn": "trn:tid:application:fae7a6aa-cf9b-42ad-945b-a89d1c1ec580",
    "version": "2.0"
  }

To know more about update folder API refer here