Page History

DataValue

Array (String)[]

Array of Strings with data for each column in the report result set.

getDataValue()

ColumnName

String

Name of the report column.

getColumnName()

DisplayName

String

Display name of column.

getDisplayName()

ColumnLength

String

Length of the report column.

getColumnLength()

FieldId

Integer

Field Id of column.

getFieldId()

DataType

String

Data type of the report column.

getDataType()

SortOrder

String

Column length

Integer

The order in which the column is sorted.

Hidden

Boolean

Whether the column is displayed in the report or not.

getHidden()

Prompt

Boolean

Only for filters. Whether the column is a prompt field or not.

getPrompt()

NumberOfDecimals

Integer

OutputLocation

String

AllowPrompt

Boolean

Only for filters.

getAllowPrompt()

CachedValues

Boolean

Only for filters. Whether or not the filter is set to use Cached Values.

FilterDisplayType

String

Only for filters. Filter Display Type if the column is a filter.

getFilterDisplayType()

FilterId

IntegerString

Only for filters. Filter Id if the column is a filter.

getFilterId()

FilterOmittable

Boolean

Only for filters

getFilterOmittable()

FilterType

String

Only for filters. Determines the filter type and what data would have to be posted to engage the prompt

getFilterType()

AllowPrompt

Boolean

getAllowPrompt()

FilterOmittable

Boolean

getFilterOmittable()

.

getFilterType

ParentFilterId

Integer

Filter Id of parent filter if a filter dependency is in place

()

DefaultValue1

String

Only for filters. First default value for filter if set.

getDefaultValue1()

DefaultValue2

String

Only for filters. Second default value for filter if set.

getDefaultValue2()

ValueUnitCode

Time units for the filter if set

getValueUnitCode()

FilterDisplayType

Filter Display Type if the column is a filter

getFilterDisplayType()

MinimumValue

Minimum value for filter if set

getMinimumValue()

FilterTypeCode

String

Only for filters

FilterUUID

String

Only for filters. The UUID of the filter.

MinimumValue

BigDecimal

Only for filters. Minimum value for filter if set.

getMinimumValue()

MaximumValue

BigDecimal

Only for filters. Maximum value for filter if set

getMaximumValue()

ParentFilterId

Integer

Only for filters. Filter ID of parent filter if a filter dependency is in place.

getParentId()

ValueUnitCode

String

Only for filters. Time units for the filter if set.

getValueUnitCode

MaximumValue

Maximum value for filter if set

()

Recipient

Integer

ID of recipient of the subscription

getRecipient()

Subject

String

Subscription subject

getSubject()

BodyText

String

Subscription message

getBodyText()

FrequencyTypeCode

String

Subscription frequency. Values include:

• MINUTES
• DAILY
• WEEKLY
• FORTNIGHTLY
• MONTHLY
• QUARTERLY
• BIANNUAL
• ANNUAL
• ENDOFMONTH

getFrequencyTypeCode()

FrequencyCode

StringAdditional frequency codes depending on the frequency type code

The name of the month (eg, "JANUARY") for a schedule to run

getFrequencyCode()

FrequencyUnit

String

Additional frequency units depending on the frequency type code

Integer

Frequency unit that describes the day of month for a schedule to run: it must be within the allowed values for the chosen month (so, no 31 for February)

getFrequencyUnitgetFrequencyCode()

Format

String

Subscription File Type. Values include:

• PDF
• HTML
• CSV
• DOC
• XLS
• RTF

getFormat()

ConditionList

Array (Condition)

Array of Condition objects that store delivery rules (see Condition 37061460)

getConditionList()

AdvancedTimezoneCode

String

Timezone in which the subscription happens

getAdvancedTimezoneCode()

AdvancedTime

Integer

Local run time for the subscription

getAdvancedTime()

TabId

Integer

ID of the dashboard tab

getTabId()

GroupTypeCode

String

Type of dashboard tab. Values include:

• ANALYTIC
• KPI
• STANDARD

getGroupTypeCode()

Owner

Integer

ID of dashboard owner

getOwner()

OwnerTypeCode

String

Type of dashboard owner. Value defaults to ORGANISATION

getOwnerTypeCode()

AccessCode

String

Security level of the dashboard tab

getAccessCode()

StartDate

Date

Creation Date

getStartDate()

EndDate

Date

End Date (if applicable)

getEndDate()

StatusCode

String

Status of the dashboard tab

getStatusCode()

ShortDescription

String

Name of the dashboard tab

getShortDescription()

LongDescription

String

Business description of the dashboard tab

getLongDescription()

LanguageCode

String

Two letter language code

getLanguageCode()

StyleCode

String

Layout code. Values include:

• SINGLE
• TWO
• THREE
• WIDENARROW
• NARROWWIDE

getStyleCode()

Audience

String

Audience description

getAudience()

ParentGroupId

Integer

If the dashboard tab is in draft mode, the original tab ID is saved into this column

getParentGroupId()

Elements

Array (DashboardElement)

A DashboardElement object contains portlet information for reports that reside within the dashboard tab (See DashboardElement 37061460)

getElements()

Filters

Array (DashboardFilterDefinition)

A DashboardFilterDefinition object contains format records pertaining the dashboard tab, analytic filters, and filter groups (See DashboardFilterDefinition 37061460)

getFilters()

Fields

Array (DashboardFieldDefinition)

A DashboardFieldDefinition object contains format records pertaining fields being displayed as drilldowns on the dashboard tab

getFields()

GroupId

Integer

ID of the dashboard tab

getGroupId()

ComponentId

Integer

Numeric ID for the component based on the component type

getComponentId()

ComponentTypeCode

String

Component types for a DashboardFilterDefinition object include:

• FILTER (individual analytic filter)
• FILTERGROUP (analytic filter group)
• NULL (general dashboard tab)

getComponentTypeCode()

EntityId

Integer 

getEntityId()

EntityTypeCode

String

Entity types for a DashboardFilterDefinition object include:

• REPORT (analytic filters)
• REPORTGROUP (general dashboard tab)

getEntityTypeCode()

FormatKey

String

Format Code

getFormatKey()

FormatValue

String

Format Value

getFormatValue()