Scroll

Constants and Enumerators

There are many variables in the APIs which require a specific type of value from a set of values. These sets of values are called Enumerated Types, and each value in a Type is called an Enumerator, or enum. Enumerated types are no more than a set of named values, which act as Constants in the API.

When an API variable requires an enum, it must be set to one of the constants that are defined in the specified enumerated type. For example, if a variable requires a Report Type enum, it accepts the values "Advanced", "Express", "Dashboard", "Chained", or "ExpressView". Other values will cause an invalid type error.

Some API variables are not enumerated types, but may require a set of constants regardless. These constants have no integer equivalent.

The following article is a reference guide that lists the most important enumerated types and lists of constants that are used throughout the API.

JSON object properties accept the enum name as a string constant:

{ "ApiAction": "ExecuteReport" }

Don't use the integer equivalent unless the doc for that property says otherwise.

{ "ApiAction": "3" } or { "ApiAction": 3 }

 

Report Type

Value Name Description
0 Advanced Advanced Report (CrossTab Reports are considered Advanced Reports)
0 Standard Deprecated: Use Advanced instead.
1 Express Express Report
2 Dashboard Dashboard
3 Chained Chained Report
5 ExpressView ExpressView

 

Api Action

Value Name Description
0 Default If a report is loaded, this is equivalent to ExecuteReport. Otherwise, this is equivalent to Home. 
1 Home Open the home page.
2 ExecuteReport Execute the loaded report (specify format with wrExportType).
3 EditReport Open the loaded report in the appropriate editor.
4 NewAdvancedReport Open the New Advanced Report Wizard.
4 NewReport Deprecated: Use NewAdvancedReport instead.
5 NewCrossTabReport Open the New CrossTab Report Wizard.
6 NewExpressReport Open the New Express Report Wizard.
7 NewDashboardReport Open the Dashboard Designer for a new dashboard.
8 NewExpressView Open the ExpressView Designer for a new ExpressView.
9 ScheduleReport Open the Schedule Report Wizard for the loaded report.
10 ScheduledReportsManager Open the Scheduled Report Manager.

 

Export Type

Value Name Description
0 Html Run in the browser, using the appropriate viewer.
1 Excel Export as an Excel file.
2 Pdf Export as a PDF file.
3 Rtf Export as an RTF file.
4 Csv Export as a CSV file.
5 Word Export as a Word file.
6 Default Default type specified by the loaded report; if not specified, default type specified by the current config.

 

Data Source Type

Value Name Description
0 MsSql Microsoft SQL Server
1 MySql MySQL
2 ODBC ODBC
3 Postgres PostreSQL
4 Oracle Oracle
5 DB2 IBM DB2
6 Informix IBM Informix
7 Assembly .NET Assembly
8 WebService Web Service
9 File Excel file
10 MsOlap OLAP

 

Data Field Type

Value Name Description
0 String String
1 Date Date, i.e. day, month, year
2 DateTime Date & time
3 Time Time, i.e. hour, minute, second (am/pm)
4 Integer Integer number
5 Decimal Decimal number
6 Float Floating-point number
7 Bit Bit
8 Guid Globally (universally) unique identifier, aka. UUID
9 Image Image
10 Currency Currency

 

Data Object Type

Name Description
Assembly .NET Assembly method
File Excel file
Function User-defined function
Procedure Stored procedure
SqlStmt Custom SQL statement
Table Data table
View SQL view 
WebSvc Web Service method
MdxStmt MDX query (OLAP)

 

Join Type

Name Description
Inner Inner join
LeftOuter Left outer join
RightOuter Right outer join
FullOuter Full outer join (left outer join + right outer join)

 

Join Relation Type

Name Description
OneToOne One-to-one relationship
OneToMany One-to-many relationship

 

Schedule Manager View Level

Value Name Description
0 User Filter schedules by current UserId parameter
1 Company Filter schedules by current CompanyId parameter
2 All Show all schedules

 

Parameter Type

Value Name Description
0 String String
1 Date Date, i.e. day, month, year
2 Integer Integer number
3 Decimal Decimal number 

 

Code Language

Note. Each value has multiple names.

Value Name Description
0 c#
cs
csharp
C Sharp
1 js
javascript
JavaScript
2 vb
visualbasic
Visual Basic

 

Filter Operator Type

Value Name Description
0 EqualTo Data value is equal to the filter value
1 LessThan Data value is less than the filter value (number, date)
2 LessThanOrEqualTo Data value is less than or equal to the filter value (number, date)
3 GreaterThan Data value is greater than the filter value (number, date)
4 GreaterThanOrEqualTo Data value is greater than or equal to the filter value (number, date)
5 NotEqualTo Data value is not equal to the filter value
6 StartsWith Data value starts with the filter value (string, number)
7 NotStartsWith Data value does not start with the filter value (string, number)
8 EndsWith Data value ends with the filter value (string, number)
9 NotEndsWith Data value does not end with the filter value (string, number)
10 Contains Data value contains the filter value (string, number)
11 NotContains Data value does not contain the filter value (string, number)
12 Between Data value is between the two filter values
13 NotBetween Data value is not between the two filter values
14 OneOf Data value is equal to one of the filter values
15 NotOneOf Data value is not equal to any of the filter values

 

Folder Status

Name Description
Exists This folder exists
DoesNotExist This folder does not exist
Created This folder was successfully created
Deleted This folder was successfully deleted
Renamed This folder was successfully renamed

 

Report Validation Errors

Name
DataObjectNotFound
SortDataFieldNotFound
FilterDataFieldNotFound
LinkedDataFieldNotFound
MinMaxFilterDataFieldNotFound
JoinDataObjectNotFound
JoinNotFound
JoinDataFieldNotFound
ChartDataFieldNotFound
MapDataFieldNotFound
CellDataFieldNotFound
RowGroupNameNotFound
RowGroupFormulaNameNotFound
ChartCellIdNotFound
MapCellIdNotFound
MergedCellsAcrossSections
CrossTabIdNotFound
CrossTabCellIdNotFound
ColumnSortByFieldNotFound
ChildReportNotFound
ExpressViewColumnMissingEntity
ExpressViewColumnMissingField
ExpressViewGroupMissingField
ExpressViewFilterMissingField

Hidden Article Information

Article Author
Exago Development
created 2017-03-16 17:28:24 UTC
updated 2017-05-16 14:40:05 UTC

Labels
no labels yet!
Have more questions? Submit a request