POST api/Document/Search

Searches for documents based on the provided search request.

Request Information

URI Parameters

None.

Body Parameters

The search request containing the parameters for the search.

Name	Type	Additional information
ArchiveGuid	string	None.
Searchfields	Collection of SearchField	None.
Columns	Collection of string	None.
RowCount	integer	None.
DocIds	Collection of integer	None.
CustomFilter	string	None.
OrderField	string	None.
DocumentCountOnly	boolean	None.
HideLockedDocuments	boolean	None.
Token	Token	None.

Request Formats

application/json, text/json

Sample:

{
  "ArchiveGuid": "sample string 1",
  "Searchfields": [
    {
      "Fieldname": "sample string 1",
      "Criterion": "sample string 2",
      "Value": {},
      "ValueTo": {},
      "ValueType": 5
    },
    {
      "Fieldname": "sample string 1",
      "Criterion": "sample string 2",
      "Value": {},
      "ValueTo": {},
      "ValueType": 5
    }
  ],
  "Columns": [
    "sample string 1",
    "sample string 2"
  ],
  "RowCount": 2,
  "DocIds": [
    1,
    2
  ],
  "CustomFilter": "sample string 3",
  "OrderField": "sample string 4",
  "DocumentCountOnly": true,
  "HideLockedDocuments": true,
  "Token": {
    "OrgId": 1,
    "OrgGuid": "sample string 2",
    "UserId": 3,
    "UserGuid": "sample string 4",
    "Username": "sample string 5",
    "UserNumber": "sample string 6",
    "EMail": "sample string 7",
    "CreatedAt": "2026-09-15T11:35:39.6236199+02:00",
    "ValidTo": "2026-09-15T11:35:39.6236199+02:00",
    "Realm": "sample string 10",
    "IsDelegated": true,
    "AccessKey": "sample string 12"
  }
}

application/bson

Sample:

Binary JSON content. See http://bsonspec.org for details.

Response Information

Resource Description

An representing the result of the search operation. Returns a 200 OK response with the search results if successful, a 400 Bad Request if authentication fails or if the access key is invalid, or a 400 Bad Request with an error message if an exception occurs during the search.

IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.

application/bson

Sample:

Binary JSON content. See http://bsonspec.org for details.