REST API - getFolderContent - POST

The tables summarize the REST API - getFolderContent - POST.

Request - POST

Format POST <baseurl>/document/folder
Body The document reference is embedded in the request body.

Response - POST

JSON Returns a JSON representation of the content of the GetFolderContentResponse element.
XML Returns the content of the GetFolderContentResponse element (from the DocumentService schema).

Example - POST

Request 
POST <baseurl>/document/folder
Body 
{
  "GetFolderContentRequest": {
    "-returnMetadata": "true",
    "owner": { "caseReference": "BDS-1-com.example.ordermodel.Order-1-0" },
    "depth": "2"
  }
}
Response 
{
  "xml-fragment": {
    "item": [
      {
        "document": {
          "reference": "DocumentID-e50c2653-0fd7-4fef-ad6f-2ee460ba52cf;1.0",
          "metadata": {
            "specifier": { "id": "e50c2653-0fd7-4fef-ad6f-2ee460ba52cf;1.0" },
            "name": "Proposal.docx",
            "version": "1.0",
            "mimeType": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
            "createdDateTime": "2014-10-03T12:12:54.809",
            "createdBy": "admin",
            "lastModifiedDateTime": "2014-10-07T11:07:55.630",
            "lastModifiedBy": "admin"
          }
        }
      },
            .
            .
            .

      {
        "folder": {
          "reference": "FolderID-c9085f79-2efc-4835-a8f5-d43bcd892bbf",
          "metadata": {
            "id": "c9085f79-2efc-4835-a8f5-d43bcd892bbf",
            "name": "Contracts"
          }
        },
        "content": {
          "folder": {
            "reference": "FolderID-0fd5c876-906d-43b3-9889-92e67933c5e3",
            "metadata": {
              "id": "0fd5c876-906d-43b3-9889-92e67933c5e3",
              "name": "Contracts discussion"
            }
          }
        }
      }
    ]
  }
}