GetInstanceSearchResults Method

Gets the rearch result in the report instance with specified instance id.

Syntax

Visual Basic
C#

[PathRoute(Template="{*reportPath}$instances/{instanceId}/search", 
   Name="", 
   ExcludingKeywords=, 
   Order=0)]
[HttpGet()]
public virtual IHttpActionResult GetInstanceSearchResults( 
   string reportPath,
   string instanceId,
   string text,
   bool matchCase,
   bool wholeWord
)

'Declaration
 
<PathRouteAttribute(Template="{*reportPath}$instances/{instanceId}/search", 
   Name="", 
   ExcludingKeywords=, 
   Order=0)>
<HttpGetAttribute()>
Public Overridable Function GetInstanceSearchResults( _
   ByVal reportPath As String, _
   ByVal instanceId As String, _
   ByVal text As String, _
   Optional ByVal matchCase As Boolean, _
   Optional ByVal wholeWord As Boolean _
) As IHttpActionResult

Parameters

reportPath: The full path of the report.
instanceId: The report instance id.
text: The text used to be searched.
matchCase: A boolean value indicates if search the value with case sensitive.
wholeWord: A boolean value indicates if search the value with matching a whole word.

Return Value

An System.Web.Http.IHttpActionResult type object with content of collection of C1.Web.Api.Document.Models.SearchResult type object.

Remarks

Please ensure the report instance is rendered.

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

ReportController Class
ReportController Members