GET 1.0/{InstanceId}/Documents/DocumentTypeResults?SimpleSearch={SimpleSearch}

Retrieves a list of Document Types and corresponding document count for each type representing the search results

Request Information

URI Parameters

API Parameter Details
NameDescriptionTypeAdditional information
InstanceId

The instance ID relating to a specific ADM database

 string

Required
DocTypes

A list of document Type IDs for use with search operation

 Collection of integer

None.
FolderId

The folder ID to search inside

 integer

Required
IncludeSubFolders

Flagged to True when search should recurse through sub folders

 boolean

None.
ContentSearchPhrase

Phrase to search for within the text of the actual files contained within the documents

 string

None.
AttributeFilterTree

A tree structure of document attributes used to construct the DocumentFilterTreeQueryBase

 AttributeFilterTree

None.
MetaDataFilterTree

A tree structure of Meta Data attributes used to construct the DocumentFilterTreeQueryBase

 MetaDataFilterTree

None.
SimpleSearch

Set to True if only Simple search parameters are being utilised

 boolean

Default value is False

Body Parameters

None.

Response Information

Resource Description

A List of DocTypeSearchResult objects

Collection of DocTypeSearchResult
API Parameter Details
NameDescriptionTypeAdditional 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
  }
]