Report Object Definitions

CommentId

Integer

ID of comment

getCommentId()

AuthorId

Integer

ID of comment author

getAuthorId()

Comment

String

Comment value

getComment()

ReportId

Integer

Report ID of which the comment resides on

getReportId()

ParentCommentId

Integer

Main ID of comment it is connected to. This applies if the particular comment is a reply to a parent comment

getParentCommentId()

StatusCode

String

Comment status

getStatusCode()

CommentDate

DateTime

Date and time value for comment creation

getCommentDate()

LastActivityDate

DateTime

Date and time value for the most current update to that particular comment

getLastActivityDate()

DataValue

String[]

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

getDataValue()

ReportIndex

Integer

Index of image in the embedded delivered HTML

getReportIndex()

Content Type

String

MIME Content Type of this chart. Possible values include:

• “image/png”
• “image/jpg”

getContentType()

Data

String

Base64 binary image data

getData()

Filename

String

Filename of embedded file in HTML

getFilename()

ColumnName

String

Column Name

getColumnName()

DisplayName

String

Display name of column

getDisplayName()

FieldId

Integer

Field Id of column

getFieldId()

DataType

String

Data type of column

getDataType()

ColumnLength

String

Column length

getColumnLength()

Hidden

Boolean

Whether the column is displayed in the report or not

getHidden()

Prompt

Boolean

Whether the column is a prompt field or not

getPrompt()

FilterId

Integer

Filter Id if the column is a filter

getFilterId()

FilterType

String

Determines the filter type and what data would have to be posted to engage the prompt

getFilterType()

AllowPrompt

Boolean

getAllowPrompt()

FilterOmittable

Boolean

getFilterOmittable()

ParentFilterId

Integer

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

getParentId()

DefaultValue1

First default value for filter if set

getDefaultValue1()

DefaultValue2

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()

MaximumValue

Maximum value for filter if set

getMaximumValue()

ContentType

String

MIME Content Type

getContentType()

Data

String

Base64 binary data

getData()

Key

String

Key of the ReportBinaryObject object

getKey()

Actual

String

The actual value for a KPI metric

getActual()

Target

String

The target value for a KPI metric

getTarget()

Variance

String

The variance value for a KPI metric

getVariance()

ParentCategory

String

Parent Category value

getParentCategory()

Targets

Array (String)

Array of String values which are the targets for a particular parent category

getTargets()

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

String

Additional frequency codes depending on the frequency type code

getFrequencyCode()

FrequencyUnit

String

Additional frequency units depending on the frequency type code

getFrequencyCode()

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)

getConditionList()

AdvancedTimezoneCode

String

Timezone in which the subscription happens

getAdvancedTimezoneCode()

AdvancedTime

Integer

Local run time for the subscription

getAdvancedTime()

Operator

String

Filter operator for the column(s). Values include:

• BETWEEN
• NOTBETWEEN
• EQUAL
• NOTEQUAL
• GREATER
• GREATEREQUAL
• INLIST
• NOTINLIST
• ISNULL
• ISNOTNULL
• LESS
• LESSEQUAL
• STARTSWITH
• NOTSTARTSWITH
• CONTAINS
• NOTCONTAINS
• ENDSWITH
• NOTENDSWITH

getOperator()

FieldId

Integer

Field Id of column

getFieldId()

Value1

String

First conditional value

getValue1()

Value2

String

Second conditional value. This is needed if the operators are BETWEEN, NOTBETWEEN, etc.

getValue2()

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)

getElements()

Filters

Array (DashboardFilterDefinition)

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

getFilters()

Fields

Array (DashboardFieldDefinition)

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

getFields()

TabId

Integer

ID of the dashboard tab

getTabId()

EntityId

Integer

ID of the portlet, which also happens to be the Report ID

getEntityId()

EntityTypeCode

String

Portlet entity type. Value defaults to REPORT

getEntityTypeCode()

ColumnNumber

Integer

Indicating where the portlet is column-wise. The first column starts at the value 1

getColumnNumber()

RowNumber

Integer

Indicating where the portlet is row-wise. The first row starts at the value 1

getRowNumber()

SequenceNumber

Integer

Portlet loading sequence within the dashboard tab

getSequenceNumber()

StartDate

Date

Date the portlet was added

getStartDate()

PortletStatus

String

Portlet status

getPortletStatus()

PortletHeight

Integer

Portlet height in pixels

getPortletHeight()

TabId

Integer

ID of the dashboard tab

getTabId()

FieldId

Integer

Field ID of column

getFieldId()

FieldType

String

Field data type. Values include:

• BOOLEAN
• DATE
• GISGEOMETRY
• GISMULTIPOLY
• GISPOINT
• NUMERIC
• TEXT
• TIMESTAMP

getFieldType()

ReportId

Integer

ID of report

getReportId()

TemplateId

Integer

ID of corresponding field template record

getTemplateId()

FieldName

String

Column name

getFieldName()

FieldDescription

String

Column name

getFieldDescription()

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()

FilterId

Integer

ID of the filter

getFilterId()

IsOmitted

Boolean

If the filter is omitted by default

getIsOmitted()

DataValue

String

Filter values for a particular filter. If there are two values (i.e if the filter operator is BETWEEN, etc) then they are concatenated with a pipe value

getDataValue()

ReportId

Integer

ID of the report that the filter belongs to

getReportId()

FilterType

String

Filter operator

getFilterType()

FilterId

Integer

ID of the filter

getFilterId()

TabId

Integer

ID of the dashboard tab that the report

getTabId()

FilterValue

String

Filter values for a particular filter. If the filter operator involves the usage of two values (i.e BETWEEN, etc) then both values are concatenated with a pipe value

getFilterValue()

TemplateId

Integer

ID of the field template record. This applies if the Filter Type is DRILL, etc

getTemplateId()