POST applications/{app_id}/docs/containers/{container_id}/documents/query

Get a list of documents given the input arguments.

Request Information

URI Parameters

Name	Description	Type	Additional information
app_id		string	Required
container_id		string	Required

Body Parameters

DocumentQuery

Name	Type	Additional information
related_to	Collection of DocumentUploadContent	None.
order_by	Collection of string	None.
offset	integer	None.
limit	integer	None.
return_count_only	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "related_to": [
    {
      "entity_type_id": "sample string 1",
      "entity_keys": [
        "sample string 1",
        "sample string 2"
      ]
    },
    {
      "entity_type_id": "sample string 1",
      "entity_keys": [
        "sample string 1",
        "sample string 2"
      ]
    }
  ],
  "order_by": [
    "sample string 1",
    "sample string 2"
  ],
  "offset": 1,
  "limit": 1,
  "return_count_only": true
}

multipart/form-data

Sample:

{"related_to":[{"entity_type_id":"sample string 1","entity_keys":["sample string 1","sample string 2"]},{"entity_type_id":"sample string 1","entity_keys":["sample string 1","sample string 2"]}],"order_by":["sample string 1","sample string 2"],"offset":1,"limit":1,"return_count_only":true}

application/xml, text/xml

Sample:

<DocumentQuery xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/application_api.Models.Documents">
  <Limit>1</Limit>
  <Offset>1</Offset>
  <OrderBy xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </OrderBy>
  <RelatedTo xmlns:d2p1="http://schemas.datacontract.org/2004/07/IVFS.Models.Documents">
    <d2p1:DocumentUploadContent>
      <d2p1:EntityKeys xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </d2p1:EntityKeys>
      <d2p1:EntityTypeId>sample string 1</d2p1:EntityTypeId>
    </d2p1:DocumentUploadContent>
    <d2p1:DocumentUploadContent>
      <d2p1:EntityKeys xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </d2p1:EntityKeys>
      <d2p1:EntityTypeId>sample string 1</d2p1:EntityTypeId>
    </d2p1:DocumentUploadContent>
  </RelatedTo>
  <ReturnCountOnly>true</ReturnCountOnly>
</DocumentQuery>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

DocumentQueryResult

Name	Type	Additional information
total	integer	None.
documents	Collection of DocumentMetadata	None.
more	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "total": 1,
  "documents": [
    {
      "document_id": "sample string 1",
      "file_name": "sample string 2",
      "kind": "sample string 3",
      "size": "sample string 4",
      "uploaded_by": "sample string 5",
      "uploaded_time": 6
    },
    {
      "document_id": "sample string 1",
      "file_name": "sample string 2",
      "kind": "sample string 3",
      "size": "sample string 4",
      "uploaded_by": "sample string 5",
      "uploaded_time": 6
    }
  ],
  "more": true
}

multipart/form-data

Sample:

{"total":1,"documents":[{"document_id":"sample string 1","file_name":"sample string 2","kind":"sample string 3","size":"sample string 4","uploaded_by":"sample string 5","uploaded_time":6},{"document_id":"sample string 1","file_name":"sample string 2","kind":"sample string 3","size":"sample string 4","uploaded_by":"sample string 5","uploaded_time":6}],"more":true}

application/xml, text/xml

Sample:

<DocumentQueryResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/application_api.Models.Documents">
  <Documents xmlns:d2p1="http://schemas.datacontract.org/2004/07/">
    <d2p1:DocumentMetadata>
      <d2p1:DocumentId>sample string 1</d2p1:DocumentId>
      <d2p1:FileName>sample string 2</d2p1:FileName>
      <d2p1:Kind>sample string 3</d2p1:Kind>
      <d2p1:Size>sample string 4</d2p1:Size>
      <d2p1:UploadedBy>sample string 5</d2p1:UploadedBy>
      <d2p1:UploadedTime>6</d2p1:UploadedTime>
    </d2p1:DocumentMetadata>
    <d2p1:DocumentMetadata>
      <d2p1:DocumentId>sample string 1</d2p1:DocumentId>
      <d2p1:FileName>sample string 2</d2p1:FileName>
      <d2p1:Kind>sample string 3</d2p1:Kind>
      <d2p1:Size>sample string 4</d2p1:Size>
      <d2p1:UploadedBy>sample string 5</d2p1:UploadedBy>
      <d2p1:UploadedTime>6</d2p1:UploadedTime>
    </d2p1:DocumentMetadata>
  </Documents>
  <More>true</More>
  <Total>1</Total>
</DocumentQueryResult>