GET api/Search?archiveguid={archiveguid}&search={search}&columns={columns}&count={count}&countOnly={countOnly}
Searches for documents in the specified archive using the provided search criteria and returns the matching results or the count of matching documents.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| archiveguid |
The unique identifier of the archive to search within. Must be a valid GUID string. |
string |
Required |
| search |
The search criteria, specified as a semicolon-separated list of field-value pairs in the format 'Field=Value'. Each pair defines a search condition. |
string |
Required |
| columns |
A comma-separated list of document fields to include in the results. If empty, all fields are returned. |
string |
Default value is |
| count |
The maximum number of documents to return. The value must be between 1 and 10,000. Defaults to 10,000. |
integer |
Default value is 10000 |
| countOnly |
If set to , only the count of matching documents is returned; otherwise, the matching documents are returned. |
boolean |
Default value is False |
Body Parameters
None.
Response Information
Resource Description
An HTTP response containing the search results or the count of matching documents. Returns a bad request response if authentication fails or if the request is invalid.
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample not available.
application/bson
Binary JSON content. See http://bsonspec.org for details.