GET v1/documents
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| IncludeRelatedTo | boolean |
None. |
|
| IncludeSystem | boolean |
None. |
|
| IncludeEntityDocuments | boolean |
None. |
|
| CaseId | integer |
None. |
|
| ParentCaseId | integer |
None. |
|
| EntityId | integer |
None. |
|
| FolderIds | Collection of integer |
None. |
|
| isFilteredByMaxAttachmentSize | boolean |
None. |
|
| Owner | string |
None. |
|
| columns | Collection of Column |
None. |
|
| order | Collection of SearchOrder |
None. |
|
| searchColumns | Collection of Column |
None. |
|
| search | RegExSearch |
None. |
|
| draw | integer |
None. |
|
| start | integer |
None. |
|
| length | integer |
None. |
|
| searchTerm | string |
None. |
|
| term | string |
None. |
|
| sortBy | string |
None. |
|
| sortDirection | string |
None. |
|
| ClientEntityId | integer |
None. |
|
| ForHost | boolean |
None. |
|
| ForSearch | boolean |
None. |
|
| ForSearchList | boolean |
None. |
|
| UseAzureSearch | boolean |
None. |
|
| VendorId | string |
None. |
|
| VendorType | Vendor_Type |
None. |
|
| IsExternal | boolean |
None. |
|
| IncludeExternal | boolean |
None. |
|
| IncludeExternalOnly | boolean |
None. |
|
| ExportToCSV | boolean |
None. |
|
| SearchTermConditionOption | SearchTermCondition_Option |
None. |
|
| SearchTermFilterType | SearchFilter_Type |
None. |
Body Parameters
None.
Response Information
Resource Description
SearchResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| Draw | integer |
None. |
|
| RecordsTotal | integer |
None. |
|
| RecordsFiltered | integer |
None. |
|
| Data | Object |
None. |
|
| NextPageUrl | string |
None. |
Response Formats
application/json, text/json
Sample:
Sample not available.