Like what you see? Have a play with our trial version.

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Corrected mistake with FrequencyUnit details and updated FrequencyCode to be more meaningful




 

...

Anchor
ReportServiceResponseReportServiceResponse

...

titleReportServiceResponse

Some of the parameters of ReportServiceResponse object consists of:

...

Response Element

...

Data Type

...

Description

...

Retrieval Code

...

Chart

...

ReportChart[]

...

Array of ReportChart objects that contains multiple chart bitmaps when attached to a report response.

...

getCharts()

...

ReportBinaryObject

...

ReportBinaryObject[]

...

Array of ReportBinaryObject objects that contain BLOBs and CLOBs.

...

getBinaryObjects()

...

ReportStyles

...

String

...

CSS styles.

...

getReportStyles()

...

Breadcrumbs

...

Breadcrumb[]

...

Array of Breadcrumb objects.

...

getBreadcrumbs()

...

SeriesSelection

...

SeriesSelection[]

...

Array of SeriesSelection objects.

...

getSeriesSelections()

...

TimeAggregationSelection[]

...

Array of TimeAggregationSelection objects.

...

getTimeAggregationSelection()

...

ReportTabSelection

...

ReportTabSelection[]

...

Array of ReportTabSelection objects.

...

getReportTabSelection()

...

ReportPageSelection

...

ReportPageSelection[]

...

Array of ReportPageSelection objects.

...

getReportPageSelection()

...

TimeSliderSelection

...

TimeSliderSelection[]

...

Array of TimeSliderSelection objects.

...

getTimeSliderSelection()

...

SortableColumns

...

SortableTableColumn[]

...

Array of SortableTableColumn objects.

...

getSortableColumns()

...

SelectedSortColumn

...

Integer

...

Column used for sorting. The index here applies to the column index within the report.

...

getSelectedSortColumn()

...

SelectedSortOrder

...

Integer

...

The sort order of the column used for sorting (0 for ascending and 1 for descending).

...

getSelectedSortOrder()

...

DrillCode

...

String

...

Drill type if available on the report.

...

getDrillCode()

...

RelatedReports

...

RelatedReport[]

...

Array of RelatedReport objects. These are reports that are tabbed/codisplayed to the main report.

...

getRelatedReports()

...

BinaryData

...

String

...

Base64 encoded binary chunk of the report data/document.

...

getBinaryData()

...

Private

...

 

...

Determines if the report is a private or a public one.

...

getPrivate()

...

ContentType

...

String

...

MIME ContentType of the returned object.

...

getContentType()

...

CanDrill

...

Boolean

...

If the report is able to drill or not.

...

getCanDrill()

...

GoogleMaps

...

GMap

...

Array of GMap objects.

...

getGoogleMaps()

...

 

Anchor
ReportComment
ReportComment

...

Anchor
ReportSchema
ReportSchema

Expand
titleReportSchema


Column ColumnLengthgetColumnLength()()getFilterOmittableFilter Id of parent filter if a filter dependency is in place  getMaximumValue

ReportSchema Element

Data Type

Description

Retrieval Code

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

 

()

ParentFilterId

Integer

getParentId()

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

()


Anchor
ReportBinaryObject
ReportBinaryObject

...

Expand
titleScheduleRecord


ScheduleRecord Element

Data Type

Description

Retrieval Code

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)

getConditionList()

AdvancedTimezoneCode

String

Timezone in which the subscription happens

getAdvancedTimezoneCode()

AdvancedTime

Integer

Local run time for the subscription

getAdvancedTime()


...

Expand
titleDashboardFilterDefinition


DashboardFilterDefinition Element

Data Type

Description

Retrieval Code

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


...