Search in a Document Overview

Updated on Sep 15, 2026

Request

POST /api/reports/clients/{clientId}/instances/{instanceId}/documents/{documentId}/search

Path parameters

Name	Type	Description
clientId	String	ID of the service client. Returned by Register Client.
instanceId	String	ID of the report instance. Returned by Resolve Report Instance.
documentId	String	ID of the report document. Returned by Resolve Document.

Request Body

SearchInfo describing the search arguments.

Response

HTTP Status Code	Description
200 OK	Search is performed successfully and returns at least one result.
204 No Content	The search returned no results.
410 Gone	The specified clientId cannot be found (expired).
404 Not Found	The specified instanceId or documentId cannot be found.

Response Body

When the return status is OK the response body contains a JSON array of SearchResultsInfo objects representing the search results.

Sample

• Request

    POST /api/reports/clients/f3c380da635/instances/c71aeb824cf/documents/495ff8766803332209ef12/search HTTP/1.1
  
    {
    	"searchToken": "foo",
    	"matchCase": false,
    	"matchWholeWord": false,
    	"useRegularExpressions": true
    }

• Response

    HTTP/1.1 200 Ok
  
    {
    	"description": "Quarterly Sales Dashboard for 2003",
    	"id": "a082030a03fa4e349abe183d161a35ea",
    	"page": 1
    }