GET 1.0/{InstanceId}/Folders/{FolderId}/DocumentTypeResults?IncludeSubFolders={IncludeSubFolders}
Returns a list of Document Type Results for a specific folder Retrieves a list of Document Types and corresponding document count for each type, specific to a folder
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| InstanceId |
The instance ID relating to a specific ADM database |
string |
Required |
| FolderId |
The ID of the folder whose document type results should be returned |
integer |
Required |
| IncludeSubFolders |
Indicates results should recurse through sub folders |
boolean |
Default value is False |
Body Parameters
None.
Response Information
Resource Description
A list of DocumentTypeResult objects
Collection of DocTypeSearchResult| Name | Description | Type | Additional information |
|---|---|---|---|
| DocTypeId |
The Document Type ID of search result item |
integer |
None. |
| DocTypeName |
The name of the document type corresponding to the DocTypeId |
string |
None. |
| DocTypeUrl |
A URL which can be used to retrieve details on the Document Type related to this result |
string |
None. |
| Count |
The number of document search results contained within this document type |
integer |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"DocTypeId": 1,
"DocTypeName": "sample string 2",
"DocTypeUrl": "sample string 3",
"Count": 4
},
{
"DocTypeId": 1,
"DocTypeName": "sample string 2",
"DocTypeUrl": "sample string 3",
"Count": 4
}
]