ComponentOne Studio Web API Edition
Installation
System Requirements
Uninstall Web API
Licensing
Adding Web API Client JavaScript
Working with Web API
Configuring Web API
Configuring Server-side Data
Configuring Storage
Configuring .NET Collections
Configuring the Client Application
Client Application for Export and Import Services
Client Application for REST Api Services
Redistributable Files
Web API Edition Limitations
About this Documentation
Technical Support
Security in WebAPI Service
Step 1: Configure Report Services
Step 2: Add Custom Authorization
Services
Data Engine Services
Configuring Data Engine Web API
Using ComponentOne Web API Template
Using Visual Studio Web API Template
Data Engine WebApi using SSAS Service
DataEngine Client Application
Consuming Data Engine Service
Aggregated Data
Manage Data Sources
Data Source Customization
Fields
Raw Data
Analyses
Detail Data
Unique Values
Status
PDF Services
Configure PDF Web API Service
Info
Export
Supported Formats
Features
Report Services
Configuring FlexReports Web API
Using ComponentOne Web API Edition Template
Using Standard Visual Studio Web API Template
Register Report Provider
Report Service
Report Info
Catalog
Parameters Information
Export
Supported Formats
Report Instances
Instance
Parameters
Page Settings
Supported Formats
Features
Export
Bookmarks and Search
Excel Services
Export Service
Export FlexGrid to Excel
Import Service
Import Excel into FlexGrid
Generate Excel Service
Generate Excel from XML in Storage
Generate Excel from Data Sources in Storage
Convert Workbook Formats using Data from Storage
Generate Excel from XML Posted from Client
Generate Excel from JSON Data Posted from Client
Convert Workbook Formats using Data Posted from Client
Merge Excel Service
Merge Multiple Excel Files Present in Storage
Merge Multiple Excel Files Posted from Client
Split Excel File
Find/Replace Text
Add/Delete Row
Add/Delete Columns
Image Services
Export Services
Export BulletGraph to Image
Export RadialGauge to Image
Export FlexPie to Image
Export FlexChart to Image
Export LinearGauge to Image
Barcode Services
Generate Barcode from Texts
Supported Barcode Symbologies
Barcode Features
Assembly References
C1.Web.Api Assembly
C1.Web.Api Namespace
Overview
Classes
AttachmentContent
Overview
Members
AttachmentContent Constructor
BodyModelBinder<T>
Overview
Members
BodyModelBinder<T> Constructor
Methods
BindModel Method
C1ApiController
Overview
Members
ExporterResult
Overview
Members
ExporterResult Constructor
Methods
ExecuteAsync Method
Properties
ExportSource Property
ExportSource
Overview
Members
ExportSource Constructor
Properties
FileName Property
Type Property
FormFile
Overview
Members
FormFile Constructor
Methods
GetStream Method
Properties
Extension Property
FromFormExAttribute
Overview
Members
FromFormExAttribute Constructor
ImportModelBinderAttribute
Overview
Members
ImportModelBinderAttribute Constructor
ImportSource
Overview
Members
ImportSource Constructor
Methods
GetFileStream Method
Properties
FileName Property
ImportSourceModelBinder
Overview
Members
ImportSourceModelBinder Constructor
Methods
BindModel Method
Owin
Overview
Members
Methods
GetApplicationRoot Method
MapPath Method
RequestModelBinder<T>
Overview
Members
RequestModelBinder<T> Constructor
Methods
BindModel Method
StringModelBinder
Overview
Members
StringModelBinder Constructor
Methods
BindModel Method
Enumerations
ExportFileType
Interfaces
IExporter
Overview
Members
Methods
ExportAsync Method
IExporter<T>
Overview
Members
Methods
ExportAsync Method
IImporter<TSource,TResult>
Overview
Members
Methods
ImportAsync Method
C1.Web.Api.Configuration Namespace
Overview
Classes
Manager<T>
Overview
Members
Manager<T> Constructor
Methods
Add Method
Contains Method
Get Method
Remove Method
TryGet Method
Properties
Items Property
C1.Web.Api.Data Namespace
Overview
Classes
DataProviderManager
Overview
Members
Methods
Read Method
Properties
Current Property
ItemsSourceDataProvider
Overview
Members
ItemsSourceDataProvider Constructor
ItemsSourceDataProvider Constructor(Func<IEnumerable>)
ItemsSourceDataProvider Constructor(IEnumerable)
Methods
Read Method
Interfaces
IDataProvider
Overview
Members
Methods
Read Method
C1.Web.Api.Storage Namespace
Overview
Classes
DiskStorageProvider
Overview
Members
DiskStorageProvider Constructor
Methods
GetDirectoryStorage Method
GetFileStorage Method
Properties
Root Property
StorageController
Overview
Members
StorageController Constructor
Methods
DeleteFile Method
GetFile Method
UploadFile Method
StorageProviderManager
Overview
Members
Methods
GetDirectoryStorage Method
GetFileStorage Method
GetProvider Method
Properties
Current Property
UploadRequest
Overview
Members
UploadRequest Constructor
Properties
File Property
Interfaces
IDirectoryStorage
Overview
Members
Methods
Create Method
Delete Method
GetDirectories Method
GetFiles Method
IFileStorage
Overview
Members
Methods
Delete Method
Read Method
Write Method
Properties
ReadOnly Property
IStorage
Overview
Members
Properties
Exists Property
Name Property
IStorageProvider
Overview
Members
Methods
GetDirectoryStorage Method
GetFileStorage Method
C1.Web.Api.BarCode Assembly
C1.BarCode Namespace
Overview
Classes
BarCodeException
Overview
Members
BarCodeException Constructor
BarCodeException Constructor()
BarCodeException Constructor(String)
BarCodeException Constructor(String,Exception)
Properties
ErrorCode Property
Message Property
BarCodeOptionsBase
Overview
Members
Methods
AssignFrom Method
Clone Method
Equals Method
GetHashCode Method
BarEngine.Ean13Encoder
Overview
Members
BarEngine.Ean13Encoder Constructor
BarEngine.UpcE0Encoder
Overview
Members
BarEngine.UpcE0Encoder Constructor
BarEngine.UpcE1Encoder
Overview
Members
BarEngine.UpcE1Encoder Constructor
BarEngine.UpcEEncoder
Overview
Members
BarEngine.UpcEEncoder Constructor
Code25intlvOptions
Overview
Members
Code25intlvOptions Constructor
Methods
AssignFrom Method
Clone Method
Reset Method
ShouldSerialize Method
Properties
BearBar Property
LineStroke Property
LineStrokeThickness Property
Code49Options
Overview
Members
Code49Options Constructor
Code49Options Constructor()
Code49Options Constructor(String)
Methods
AssignFrom Method
Clone Method
Reset Method
ShouldSerialize Method
ToString Method
Properties
Group Property
Grouping Property
ComplexProperty
Overview
Members
ComplexProperty Constructor
Events
PropertyChanged Event
DataMatrixOptions
Overview
Members
DataMatrixOptions Constructor
DataMatrixOptions Constructor()
DataMatrixOptions Constructor(String)
Methods
AssignFrom Method
Clone Method
Reset Method
ShouldSerialize Method
ToString Method
Properties
Ecc000_140SymbolSize Property
Ecc200EncodingMode Property
Ecc200SymbolSize Property
EccMode Property
FileIdentifier Property
StructuredAppend Property
StructureNumber Property
Ean128Fnc1Options
Overview
Members
Ean128Fnc1Options Constructor
Ean128Fnc1Options Constructor()
Ean128Fnc1Options Constructor(String)
Methods
AssignFrom Method
Clone Method
ToString Method
Properties
BarAdjust Property
Dpi Property
ModuleSize Property
GS1CompositeOptions
Overview
Members
GS1CompositeOptions Constructor
Methods
AssignFrom Method
Clone Method
Reset Method
ShouldSerialize Method
ToString Method
Properties
Type Property
Value Property
MicroPDF417Options
Overview
Members
MicroPDF417Options Constructor
MicroPDF417Options Constructor()
MicroPDF417Options Constructor(String)
Methods
AssignFrom Method
Clone Method
Reset Method
ShouldSerialize Method
ToString Method
Properties
CompactionMode Property
FileID Property
SegmentCount Property
SegmentIndex Property
Version Property
ModuleSize
Overview
Members
ModuleSize Constructor
ModuleSize Constructor()
ModuleSize Constructor(Int32,Int32)
Methods
ToString Method
Properties
BarNarrow Property
BarWide Property
PDF417Options
Overview
Members
PDF417Options Constructor
PDF417Options Constructor()
PDF417Options Constructor(String)
Methods
AssignFrom Method
Clone Method
Reset Method
ShouldSerialize Method
ToString Method
Properties
Column Property
ErrorLevel Property
Row Property
Type Property
QRCodeOptions
Overview
Members
QRCodeOptions Constructor
QRCodeOptions Constructor()
QRCodeOptions Constructor(String)
Methods
AssignFrom Method
Clone Method
Reset Method
ShouldSerialize Method
ToString Method
Properties
Connection Property
ConnectionNumber Property
Encoding Property
ErrorLevel Property
Mask Property
Model Property
Version Property
QuietZone
Overview
Members
QuietZone Constructor
QuietZone Constructor(Double,Double,Double,Double)
QuietZone Constructor()
Methods
ToString Method
Properties
Bottom Property
Left Property
Right Property
Top Property
RssExpandedStackedOptions
Overview
Members
RssExpandedStackedOptions Constructor
RssExpandedStackedOptions Constructor()
RssExpandedStackedOptions Constructor(String)
Methods
AssignFrom Method
Clone Method
Reset Method
ShouldSerialize Method
ToString Method
Properties
RowCount Property
WholeSize
Overview
Members
WholeSize Constructor
WholeSize Constructor()
WholeSize Constructor(Single,Single)
Properties
WholeHeight Property
WholeWidth Property
Enumerations
BarCodeCaptionPosition
BarCodeDirection
BarCodeException.EnumErrorCode
CodeType
DataMatrixEcc000_140SymbolSize
DataMatrixEcc200EncodingMode
DataMatrixEcc200SymbolSize
DataMatrixEccMode
GS1CompositeType
MicroPDF417SymbolCompactionMode
MicroPDF417SymbolVersion
PDF417Type
QRCodeErrorLevel
QRCodeMask
QRCodeModel
TextAlignment
C1.Web.Api.BarCode Namespace
Overview
Classes
BarCodeController
Overview
Members
BarCodeController Constructor
Methods
Get Method
BarCodeGenerator
Overview
Members
BarCodeGenerator Constructor
BarCodeGenerator Constructor()
BarCodeGenerator Constructor(BarCodeRequest)
Methods
GetResult Method
BarCodeRequest
Overview
Members
BarCodeRequest Constructor
Properties
AdditionalNumber Property
BackColor Property
BarDirection Property
BarHeight Property
BarWidth Property
CaptionAlignment Property
CaptionGrouping Property
CaptionPosition Property
CheckSumEnabled Property
Code25intlvOptions Property
Code49Options Property
CodeType Property
DataMatrixOptions Property
Ean128Fnc1Options Property
Font Property
ForeColor Property
GS1CompositeOptions Property
MicroPDF417Options Property
ModuleSize Property
PDF417Options Property
QRCodeOptions Property
QuietZone Property
RssExpandedStackedOptions Property
Text Property
TextFixedLength Property
Code25intlvOptions
Overview
Members
Code25intlvOptions Constructor
Properties
BearBar Property
LineStroke Property
LineStrokeThickness Property
Code49Options
Overview
Members
Code49Options Constructor
Properties
Group Property
Grouping Property
DataMatrixOptions
Overview
Members
DataMatrixOptions Constructor
Properties
Ecc000_140SymbolSize Property
Ecc200EncodingMode Property
Ecc200SymbolSize Property
EccMode Property
FileIdentifier Property
StructuredAppend Property
StructureNumber Property
Ean128Fnc1Options
Overview
Members
Ean128Fnc1Options Constructor
Properties
BarAdjust Property
Dpi Property
ModuleSize Property
Font
Overview
Members
Font Constructor
Properties
Bold Property
Family Property
Italic Property
Size Property
Strikeout Property
Underline Property
GS1CompositeOptions
Overview
Members
GS1CompositeOptions Constructor
Properties
Type Property
Value Property
MicroPDF417Options
Overview
Members
MicroPDF417Options Constructor
Properties
CompactionMode Property
FileID Property
SegmentCount Property
SegmentIndex Property
Version Property
PDF417Options
Overview
Members
PDF417Options Constructor
Properties
Column Property
ErrorLevel Property
Row Property
Type Property
QRCodeOptions
Overview
Members
QRCodeOptions Constructor
Properties
CodePage Property
Connection Property
ConnectionNumber Property
ErrorLevel Property
Mask Property
Model Property
Version Property
QuietZone
Overview
Members
QuietZone Constructor
Properties
Bottom Property
Left Property
Right Property
Top Property
RssExpandedStackedOptions
Overview
Members
RssExpandedStackedOptions Constructor
Properties
RowCount Property
Enumerations
BarCodeCaptionPosition
BarCodeDirection
CodeType
DataMatrixEcc000_140SymbolSize
DataMatrixEcc200EncodingMode
DataMatrixEcc200SymbolSize
DataMatrixEccMode
GS1CompositeType
MicroPDF417SymbolCompactionMode
MicroPDF417SymbolVersion
PDF417Type
QRCodeErrorLevel
QRCodeMask
QRCodeModel
TextAlignment
C1.Web.Api.DataEngine Assembly
C1.Web.Api.DataEngine Namespace
Overview
Classes
DataEngineController
Overview
Members
DataEngineController Constructor
Methods
AnalyzeData Method
GetAnalysis Method
GetAnalysisResult Method
GetAnalysisStatus Method
GetDetail Method
GetFields Method
GetRawData Method
GetUniqueValues Method
RemoveAnalysis Method
C1.Web.Api.DataEngine.Data Namespace
Overview
Classes
FlexPivotEngineProviderManager
Overview
Members
Methods
AddCube Method
AddDataEngine Method
AddDataEngine(String,String,String) Method
AddDataEngine(String,DbCommand,DbConnection,String,String) Method
AddDataEngine<T>(String,Func<IEnumerable<T>>,String,String) Method
AddDataSource Method
AddDataSource(String,Func<IEnumerable>) Method
AddDataSource(String,IEnumerable) Method
Interfaces
IFlexPivotEngineProvider
Overview
Members
Methods
GetAggregatedData Method
GetDetail Method
GetUniqueValues Method
Properties
Fields Property
RawData Property
C1.Web.Api.DataEngine.Models Namespace
Overview
Classes
DetailRequest
Overview
Members
DetailRequest Constructor
Properties
Keys Property
EngineRequest
Overview
Members
EngineRequest Constructor
Properties
View Property
EngineRequestWithPaging
Overview
Members
EngineRequestWithPaging Constructor
EngineRequestWithPaging Constructor(EngineRequest)
EngineRequestWithPaging Constructor()
Properties
Skip Property
Top Property
Field
Overview
Members
Field Constructor
Methods
ShouldSerializeSubFields Method
Properties
Binding Property
DataType Property
DimensionType Property
Header Property
Lookup Property
SubFields Property
Enumerations
DataType
Interfaces
IRawData
Overview
Members
Properties
TotalCount Property
Value Property
C1.Web.Api.Document Assembly
C1.Web.Api.Document Namespace
Overview
Classes
DocumentController
Overview
Members
C1.Web.Api.Document.Models Namespace
Overview
Classes
DocumentPosition
Overview
Members
DocumentPosition Constructor
Properties
PageBounds Property
PageIndex Property
ExecutionInfo
Overview
Members
Properties
ExpiredDateTime Property
Features Property
FeaturesLocation Property
LoadedDateTime Property
OutlinesLocation Property
PageSettings Property
PageSettingsLocation Property
Path Property
Status Property
StatusLocation Property
SupportedFormatsLocation Property
PageSettings
Overview
Members
PageSettings Constructor
Properties
BottomMargin Property
Height Property
Landscape Property
LeftMargin Property
Paginated Property
PaperSize Property
RightMargin Property
TopMargin Property
Width Property
C1.Web.Api.Excel Assembly
C1.Web.Api.Excel Namespace
Overview
Classes
Border
Overview
Members
Border Constructor
Border Constructor()
Border Constructor(String)
Properties
Color Property
Type Property
BorderCollection
Overview
Members
BorderCollection Constructor
BorderCollection Constructor()
BorderCollection Constructor(String)
Properties
Bottom Property
Diagonal Property
Left Property
Right Property
Top Property
C1ExcelHost
Overview
Members
C1ExcelHost Constructor
CamelStringEnumConverter
Overview
Members
CamelStringEnumConverter Constructor
Methods
ReadJson Method
Cell
Overview
Members
Cell Constructor
Properties
ColSpan Property
Formula Property
RowSpan Property
Style Property
Value Property
CellPosition
Overview
Members
CellPosition Constructor
CellPosition Constructor(String)
CellPosition Constructor(Int32,Int32)
Properties
Col Property
Row Property
Column
Overview
Members
Column Constructor
Properties
AutoWidth Property
Style Property
Visible Property
Width Property
ExcelController
Overview
Members
ExcelController Constructor
Methods
DeleteOperation Method
Export Method
Get Method
GetOperation Method
Import Method
Merge Method
MergePost Method
Post Method
PostOperation Method
PutOperation Method
ExcelExporter
Overview
Members
ExcelExporter Constructor
Methods
ExportAsync Method
ExcelExportModelBinderAttribute
Overview
Members
ExcelExportModelBinderAttribute Constructor
ExcelExportSource
Overview
Members
ExcelExportSource Constructor
Properties
Workbook Property
ExcelImporter
Overview
Members
ExcelImporter Constructor
Methods
ImportAsync Method
ExcelRequest
Overview
Members
ExcelRequest Constructor
Properties
Data Property
DataFile Property
DataFileName Property
DataName Property
Workbook Property
WorkbookFile Property
WorkbookFileName Property
Fill
Overview
Members
Fill Constructor
Properties
Color Property
Pattern Property
FloatRoundConverter
Overview
Members
FloatRoundConverter Constructor
Methods
CanConvert Method
ReadJson Method
WriteJson Method
Font
Overview
Members
Font Constructor
Properties
Bold Property
Color Property
Family Property
Italic Property
Size Property
Strikethrough Property
Subscript Property
Superscript Property
Underline Property
FrozenPane
Overview
Members
FrozenPane Constructor
Properties
Columns Property
Rows Property
MergeRequest
Overview
Members
MergeRequest Constructor
Properties
FileNamesToMerge Property
FilesToMerge Property
Range
Overview
Members
Range Constructor
Range Constructor(String)
Range Constructor(Int32,Int32,Int32,Int32)
Properties
From Property
To Property
Row
Overview
Members
Row Constructor
Row Constructor()
Row Constructor(Object[])
Properties
Cells Property
Collapsed Property
GroupLevel Property
Height Property
Style Property
Visible Property
Style
Overview
Members
Style Constructor
Properties
BaseOn Property
Border Property
Fill Property
Font Property
Format Property
FormatCode Property
HAlign Property
Indent Property
Locked Property
ShrinkToFit Property
TextDirection Property
TextRotation Property
VAlign Property
WrapText Property
Workbook
Overview
Members
Workbook Constructor
Properties
ActiveWorksheet Property
Application Property
Company Property
Created Property
Creator Property
LastModifiedBy Property
Modified Property
Sheets Property
Styles Property
Worksheet
Overview
Members
Worksheet Constructor
Properties
Cols Property
Columns Property
FrozenPane Property
IsGroupHeaderAbove Property
Name Property
Rows Property
SummaryBelow Property
Visible Property
Enumerations
BorderLinetype
HAlignType
PatternStyle
TextDirectionType
VAlignType
Interfaces
IExcelHost
Overview
Members
Methods
Read Method
Write Method
C1.Web.Api.Image Assembly
C1.Web.Api.Image Namespace
Overview
Classes
ImageController
Overview
Members
ImageController Constructor
Methods
Export Method
ImageExporter
Overview
Members
ImageExporter Constructor
Methods
ExportAsync Method
ImageExportModelBinderAttribute
Overview
Members
ImageExportModelBinderAttribute Constructor
ImageExportSource
Overview
Members
ImageExportSource Constructor
Properties
ControlConstructor Property
ControlType Property
Height Property
State Property
Width Property
Enumerations
ImageControlType
C1.Web.Api.Pdf Assembly
C1.Web.Api.Pdf Namespace
Overview
Classes
PdfController
Overview
Members
PdfController Constructor
Methods
ExportPdf_Get Method
ExportPdf_Post Method
GetPdfFeatures Method
GetPdfInfo Method
GetPdfSupportedFormats Method
GetSearchResults Method
GetStatus Method
C1.Web.Api.Report Assembly
C1.Web.Api.Report Namespace
Overview
Classes
CustomReportProvider
Overview
Members
CustomReportProvider Constructor
Methods
GetCatalogItem Method
FlexReportProvider
Overview
Members
FlexReportProvider Constructor
Methods
GetCatalogItem Method
Properties
Storage Property
ReportController
Overview
Members
ReportController Constructor
Methods
CreateInstance Method
DeleteInstanceById Method
ExportInstance_Get Method
ExportInstance_Post Method
ExportReport_Get Method
ExportReport_Post Method
GetCatalogInfo Method
GetInstanceBookmarkByName Method
GetInstanceBookmarks Method
GetInstanceById Method
GetInstanceFeatures Method
GetInstanceOutlines Method
GetInstancePageSettings Method
GetInstanceParameterByName Method
GetInstanceParameters Method
GetInstances Method
GetInstanceSearchResults Method
GetInstanceStatus Method
GetInstanceSupportedFormatByName Method
GetInstanceSupportedFormats Method
GetReport Method
GetReportPageSettings Method
GetReportParameterByName Method
GetReportParameters Method
GetReportSupportedFormatByName Method
GetReportSupportedFormats Method
RenderInstance Method
SetInstancePageSettings Method
SetInstanceParameterByName Method
SetInstanceParameters Method
StopInstanceRendering Method
UpdateInstancePageSettings Method
UpdateInstanceParameters Method
ReportProvider
Overview
Members
Methods
GetCatalogItem Method
ReportProviderManager
Overview
Members
Methods
AddFlexReportDiskStorage Method
AddFlexReportStorage Method
AddSsrsReportHost Method
AddSsrsReportHost(String,SsrsHost) Method
AddSsrsReportHost(String,String,NetworkCredential,AuthenticationType) Method
Properties
Current Property
SsrsHost
Overview
Members
SsrsHost Constructor
Properties
AuthenticationType Property
Credential Property
WebServiceUrl Property
SsrsReportProvider
Overview
Members
SsrsReportProvider Constructor
Methods
GetCatalogItem Method
Properties
Host Property
Enumerations
AuthenticationType
C1.Web.Api.Report.Models Namespace
Overview
Classes
CatalogItem
Overview
Members
CatalogItem Constructor
Properties
Items Property
Name Property
Path Property
Type Property
Parameter
Overview
Members
Parameter Constructor
Properties
AllowedValues Property
DataType Property
Error Property
Hidden Property
MultiValue Property
Name Property
Nullable Property
Prompt Property
Value Property
ReportInfo
Overview
Members
Properties
CreationLocation Property
HasParameters Property
PageSettings Property
PageSettingsLocation Property
ParametersLocation Property
Path Property
SupportedFormatsLocation Property
ReportStatus
Overview
Members
Properties
InitialPosition Property
Enumerations
CatalogItemType
Release History
2017 v2
2017 v1
2016 v3.5
2016 v3
2016 v2.5
2016 v2
2016 v1.5
2016 v1
2015 v3.5
2015 v3
2015 v2.5