Views:
Question:
Why do I get the following error when searching via the Platform API?
 
Unhandled Exception: DocuWare.Services.Http.Client.HttpClientRequestException: 422 Unprocessable Entity (The requested search result count exceeds the system limit of 10000 per request. Please lower the count value and use paging of results.)

Answer:
A maximum of 10,000 results can be requested in a single search call via the Platform API. Search queries that are too large can put too much load on the cloud system, which can negatively impact your work processes and result in the search queries being rejected. To prevent this, please refer to the following examples and recommendations;
 
.NET API (C#)
Please check our updated examples for executing a Query using a dialog expression.

REST API:
The maximum value of the count parameter in the following calls is 10.000

  • /DocuWare/Platform/FileCabinets/{fileCabinetId}/Query/DialogExpression?dialogId={dialogId}&fields={fields}&sortOrder={sortOrder}&start={start}&count={count}
  • /DocuWare/Platform/FileCabinets/{fileCabinetId}/Query/FunctionExpression?fields={fields}&sortOrder={sortOrder}&start={start}&count={count}
  • /DocuWare/Platform/FileCabinets/{fileCabinetId}/Documents?q={q}&fields={fields}&sortOrder={sortOrder}&start={start}&msStart={msStart}&count={count}&format={format}&includeSuggestions={includeSuggestions}&csvDelimiter={csvDelimiter}&csvIsUtc={csvIsUtc}&calculateTotalCount={calculateTotalCount}
  • /DocuWare/Platform/FileCabinets/{fileCabinetId}/Query/Documents?q={q}&fields={fields}&sortOrder={sortOrder}&start={start}&count={count}&format={format}&additionalCabinets={additionalCabinets}&encodingName={encodingName}&csvDelimiter={csvDelimiter}&csvIsUtc={csvIsUtc}&includeSuggestions={includeSuggestions}&calculateTotalCount={calculateTotalCount}

If the count parameter exceeds the allowed value, you will receive the following response:

  • Status code: HTTP status code 422 (Unprocessable Entity)
  • Exception: SearchResultLimitExceededException

In this case, please adjust the count parameter to a valid value.

To continue to receive all documents, please use multiple continuous searches (paging). You can use the start parameter to control from which document of the total result set the delivery should start.

For examples, please check our updated Postman collection.

KBA is applicable to Cloud Organizations ONLY.

This article is valid for DocuWare versions: 7.7 7.8 7.9 7.10 | Count API; Parameter; Paging; 10,000 Results

Related Articles (2)

ERROR: "Value was either too large or too small for an Int32 [.NET API]" when storing with API How to do a Fulltext search using the .NET API
Comments (1)
  • Thomas Stephens
    Wed, 27 Mar 2024 12:45:38 GMT
    Just had a similar issue, the workflow history only reported "Reason: Unprocessable Entity!" however after running a test in the API, the HTML response below; Allowed me to remove required fields, and now it works. Hopefully this helps someone else, looking at the detail provided by the API can help troubleshooting.

    {
      "Message": "Fill out the required field \"Order #\"",
      "Exception": "RequiredFieldException: Fill out the required field \"Order #\"",
      "Uri": "http://xxxxxx.docuware.cloud/docuware/Platform/FileCabinets/xxxxxxxxxxxxxxxxxxxx/Task/Transfer",
      "Method": "POST",
      "StatusCode": 422,
      "Status": "Unprocessable Entity",
      "InternalCode": 0
    }