REST API - findDocuments - GET with Path Parameters

The table summarizes the REST API - findDocuments - GET with path parameters.

Request - GET with Path Parameters

Format GET <baseurl>/document/findbycaseref/<caseref>/<name>
Path parameters
Query Parameters metadata=Boolean: Controls whether metadata for the documents is included in the response. Default=false.

Response - GET with Path Parameters

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

Example - GET with Path Parameters

Request 
GET <baseurl>/document/findbycaseref/BDS-1-com.example.ordermodel.Order-1-0/Proposal.docx?metadata=true
Response 
{
  "result": {
    "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",
      "byteSize": "24008"
    }
  }
}