1. REST API for Oracle Responsys Marketing Cloud Service
  2. Tasks
  3. Content Library Folders

List contents of a Content Library Folder

get

/rest/api/v1.3/clFolders/{folderPath}

Request

Supported Media Types
Path Parameters
Query Parameters
  • Specify what content of a folder needs to be listed. Allowed values are 'all', 'folders', 'docs' or 'items'. Defaults to 'all'
Back to Top

Response

Default Response

Body ()
Root Schema : List Content Library Folders Response
Type: object
Title: List Content Library Folders Response
Show Source
Nested Schema : documents
Type: array
Content Library Documents within the Content Library Folder
Show Source
Nested Schema : folders
Type: array
Folders within the Content Library Folder
Show Source
Nested Schema : items
Type: array
Media files within the Content Library Folder
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top

Examples

This interface is used to list the contents of a content library folder. To get the objects at the root level (that is, for the entire account), replace the folderPath parameter with the value "contentlibrary".

A successful request requires the following headers:

FIELDS DESCRIPTION
Authorization <AUTH_TOKEN>
FIELDS DESCRIPTION
type Determines what content of a folder needs to be listed. Allowed values are "all", "folders", "docs" or "items". Value defaults to "all", so all contents of a folder need to be listed.

Sample Request URL:

     /rest/api/v1.3/clFolders/contentlibrary/f1

Sample Response:Success

    {
   "folders":    [
            {
         "folderPath": "/contentlibrary/f1/sublevel-1",
         "links":          [
            {
               "rel": "listContentLibraryFolders",
               "href": "/rest/api/v1.3/clFolders/contentlibrary/f1/sublevel-1",
               "method": "GET"
            },
            {
               "rel": "deleteContentLibraryFolder",
               "href": "/rest/api/v1.3/clFolders/contentlibrary/f1/sublevel-1",
               "method": "DELETE"
            },
            {
               "rel": "createContentLibraryFolder",
               "href": "/rest/api/v1.3/clFolders",
               "method": "POST"
            }
         ]
      }wsrest_clwsrest_clwsrest_clwsrest_clwsrest_clwsrest_cl
   ],
   "documents":    [
            {
         "documentPath": "/contentlibrary/f1/doc2.htm",
         "content": null,
         "links":          [
            {
               "rel": "deleteDocument",
               "href": "/rest/api/v1.3/clDocs/contentlibrary/f1/doc2.htm",
               "method": "DELETE"
            },
            {
               "rel": "createDocument",
               "href": "/rest/api/v1.3/clDocs",
               "method": "POST"
            },
            {
               "rel": "setDocumentContent",
               "href": "/rest/api/v1.3/clDocs/contentlibrary/f1/doc2.htm",
               "method": "POST"
            },
            {
               "rel": "getDocumentContent",
               "href": "/rest/api/v1.3/clDocs/contentlibrary/f1/doc2.htm",
               "method": "GET"
            }
         ]
      }wsrest_clwsrest_clwsrest_clwsrest_clwsrest_clwsrest_clwsrest_clwsrest_cl
   ],
   "items":    [
            {
         "itemPath": "/contentlibrary/f1/testcreate2050.png",
         "itemData": null,
         "links":          [
            {
               "rel": "getContentLibraryItem",
               "href": "/rest/api/v1.3/clItems/contentlibrary/f1/testcreate2050.png",
               "method": "GET"
            },
            {
               "rel": "setContentLibraryItem",
               "href": "/rest/api/v1.3/clItems/contentlibrary/f1/testcreate2050.png",
               "method": "POST"
            },
            {
               "rel": "deleteContentLibraryItem",
               "href": "/rest/api/v1.3/clItems/contentlibrary/f1/testcreate2050.png",
               "method": "DELETE"
            },
            {
               "rel": "createContentLibraryItem",
               "href": "/rest/api/v1.3/clItems",
               "method": "POST"
            }
         ]
      }
   ],
   "links":    [
            {
         "rel": "self",
         "href": "/rest/api/v1.3/clFolders/contentlibrary/f1",
         "method": "GET"
      },
      {
         "rel": "deleteContentLibraryFolder",
         "href": "/rest/api/v1.3/clFolders/contentlibrary/f1",
         "method": "DELETE"
      }
   ]
}

Sample Response:Failure

   {
   "type": "",
   "title": "Invalid request parameters",
   "errorCode": "INVALID_PARAMETER",
   "detail": "Type should be either folders, items or docs",
   "errorDetails": []
}
Back to Top