ComponentOne Studio Web API Edition
GetInstanceSupportedFormatByName Method

The full path of the report.
The report instance id.
The name of the export format.
Gets the export format with specified name supported by the report instance with specified instance id.
Syntax
'Declaration
 
<HttpGetAttribute()>
<PathRouteAttribute(Template="{*reportPath}$instances/{instanceId}/supportedformats/{formatName}", 
   Name="", 
   ExcludingKeywords=, 
   Order=0)>
Public Overridable Function GetInstanceSupportedFormatByName( _
   ByVal reportPath As String, _
   ByVal instanceId As String, _
   ByVal formatName As String _
) As IHttpActionResult
[HttpGet()]
[PathRoute(Template="{*reportPath}$instances/{instanceId}/supportedformats/{formatName}", 
   Name="", 
   ExcludingKeywords=, 
   Order=0)]
public virtual IHttpActionResult GetInstanceSupportedFormatByName( 
   string reportPath,
   string instanceId,
   string formatName
)

Parameters

reportPath
The full path of the report.
instanceId
The report instance id.
formatName
The name of the export format.

Return Value

An System.Web.Http.IHttpActionResult type object with content of C1.Web.Api.Document.Models.ExportDescription type object.
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

See Also

Reference

ReportController Class
ReportController Members

 

 


Copyright © GrapeCity, inc. All rights reserved.