# C1.Web.Api.Report.ReportController.GetInstanceSearchResults

## Content

<div class="doc-site-dotnet-api-container">



<h1 id="C1_Web_Api_Report_ReportController_GetInstanceSearchResults_" data-uid="C1.Web.Api.Report.ReportController.GetInstanceSearchResults*">GetInstanceSearchResults Method
</h1>
<div class="markdown level0 summary"></div>
<div class="markdown level0 conceptual"></div>



<a id="C1_Web_Api_Report_ReportController_GetInstanceSearchResults_" data-uid="C1.Web.Api.Report.ReportController.GetInstanceSearchResults*"></a>
<h4 id="C1_Web_Api_Report_ReportController_GetInstanceSearchResults_System_String_System_String_System_String_System_Boolean_System_Boolean_System_Int32_C1_Web_Api_Document_Models_SearchScope_" data-uid="C1.Web.Api.Report.ReportController.GetInstanceSearchResults(System.String,System.String,System.String,System.Boolean,System.Boolean,System.Int32,C1.Web.Api.Document.Models.SearchScope)">GetInstanceSearchResults(string, string, string, bool, bool, int, SearchScope)</h4>
<div class="markdown level1 summary"><p>Gets the search result in the report instance with specified instance id.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="declaration">Declaration</h5>
<div class="codewrapper">
  <pre><code class="lang-csharp hljs">[HttpGet]
public virtual IActionResult GetInstanceSearchResults(string reportPath, string instanceId, string text, bool matchCase = false, bool wholeWord = false, int startPageIndex = 0, SearchScope scope = SearchScope.WholeDocument)</code></pre>
</div>
<div class="codewrapper">
  <pre><code class="lang-vbnet hljs">&lt;HttpGet&gt;
Public Overridable Function GetInstanceSearchResults(reportPath As String, instanceId As String, text As String, Optional matchCase As Boolean = False, Optional wholeWord As Boolean = False, Optional startPageIndex As Integer = 0, Optional scope As SearchScope = SearchScope.WholeDocument) As IActionResult</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-condensed">
  <thead>
    <tr>
      <th>Type</th>
      <th>Name</th>
      <th>Description</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></td>
      <td><span class="parametername">reportPath</span></td>
      <td><p>The full path of the report.</p>
</td>
    </tr>
    <tr>
      <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></td>
      <td><span class="parametername">instanceId</span></td>
      <td><p>The report instance id.</p>
</td>
    </tr>
    <tr>
      <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></td>
      <td><span class="parametername">text</span></td>
      <td><p>The text used to be searched.</p>
</td>
    </tr>
    <tr>
      <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></td>
      <td><span class="parametername">matchCase</span></td>
      <td><p>A boolean value indicates if search the value with case sensitive.</p>
</td>
    </tr>
    <tr>
      <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></td>
      <td><span class="parametername">wholeWord</span></td>
      <td><p>A boolean value indicates if search the value with matching a whole word.</p>
</td>
    </tr>
    <tr>
      <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></td>
      <td><span class="parametername">startPageIndex</span></td>
      <td><p>0-based index of the first page to search.</p>
</td>
    </tr>
    <tr>
      <td><a class="xref" href="../C1.AspNetCore.Api.Document/C1.Web.Api.Document.Models.SearchScope.html">SearchScope</a></td>
      <td><span class="parametername">scope</span></td>
      <td><p>The search scope.</p>
</td>
    </tr>
  </tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-condensed">
  <thead>
    <tr>
      <th>Type</th>
      <th>Description</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/microsoft.aspnetcore.mvc.iactionresult">IActionResult</a></td>
      <td><p>An <a class="xref" href="https://learn.microsoft.com/dotnet/api/microsoft.aspnetcore.mvc.iactionresult">IActionResult</a> type object with content of collection of <a class="xref" href="../C1.AspNetCore.Api.Document/C1.Web.Api.Document.Models.SearchResult.html">SearchResult</a> type object.</p>
</td>
    </tr>
  </tbody>
</table>
<h5 id="C1_Web_Api_Report_ReportController_GetInstanceSearchResults_System_String_System_String_System_String_System_Boolean_System_Boolean_System_Int32_C1_Web_Api_Document_Models_SearchScope__remarks">Remarks</h5>
<div class="markdown level1 remarks"><p>Please ensure the report instance is rendered.</p>
</div>
</div>