Some of the parameters of ReportServiceResponse object consists of:
Response Element | Data Type | Description | Retrieval Code |
---|---|---|---|
Chart | Array of ReportChart objects that contains multiple chart bitmaps when attached to a report response. |
| |
ReportBinaryObject | Array of ReportBinaryObject objects that contain BLOBs and CLOBs. |
| |
ReportStyles | String | CSS styles. |
|
Breadcrumbs | Breadcrumb[] | Array of Breadcrumb objects. |
|
SeriesSelection | SeriesSelection[] | Array of SeriesSelection objects. |
|
TimeAggregationSelection | TimeAggregationSelection[] | Array of TimeAggregationSelection objects. |
|
ReportTabSelection | ReportTabSelection[] | Array of ReportTabSelection objects. |
|
ReportPageSelection | ReportPageSelection[] | Array of ReportPageSelection objects. |
|
TimeSliderSelection | TimeSliderSelection[] | Array of TimeSliderSelection objects. |
|
SortableColumns | SortableTableColumn[] | Array of SortableTableColumn objects. |
|
SelectedSortColumn | Integer | Column used for sorting. The index here applies to the column index within the report. |
|
SelectedSortOrder | Integer | The sort order of the column used for sorting (0 for ascending and 1 for descending). |
|
DrillCode | String | Drill type if available on the report. |
|
RelatedReports | RelatedReport[] | Array of RelatedReport objects. These are reports that are tabbed/codisplayed to the main report. |
|
BinaryData | String | Base64 encoded binary chunk of the report data/document. |
|
Private |
| Determines if the report is a private or a public one. |
|
ContentType | String | MIME ContentType of the returned object. |
|
CanDrill | Boolean | If the report is able to drill or not. |
|
GoogleMaps | GMap | Array of GMap objects. |
|
ReportName | String | Name of the specified report. | |
ReportDescription | String | Description of the specified report. | |
ReportId | Integer | Unique ID of the specified report. | |
ReportUUID | String | The UUID of the specified report. | |
HitCount | Integer | Number of times the report was accessed. | |
FormatCode | String | Format code of the report. | |
AverageRunTime | Integer | Average run time of the report. | |
Category | String | Category where report is present. | |
SubCategory | String | Sub category of the report. | |
ReportUsage | Integer | The number of times the report has been used or accessed. | |
ViewName | String | Name of the view. | |
Datasource | String | Name of the data source. | |
Author | String | User who created the report. | |
AuthoringMode | String | Mode in which the report was created. | |
ReportTemplate | String | Template of the report. | |
DataOutput | String | Data output. E.g. column. | |
DashboardEnabled | Boolean | True if the dashboard is enabled. | |
LastModifiedDate | Date | Date the report was last modified. |
ReportComment Element | Data Type | Description | Retrieval Code |
---|---|---|---|
CommentId | Integer | ID of comment |
|
AuthorId | Integer | ID of comment author |
|
Comment | String | Comment value |
|
ReportId | Integer | Report ID of which the comment resides on |
|
ParentCommentId | Integer | Main ID of comment it is connected to. This applies if the particular comment is a reply to a parent comment |
|
StatusCode | String | Comment status |
|
CommentDate | DateTime | Date and time value for comment creation |
|
LastActivityDate | DateTime | Date and time value for the most current update to that particular comment |
|
ReportRow Element | Data Type | Description | Retrieval Code |
---|---|---|---|
DataValue | String[] | Array of Strings with data for each column in the report result set. |
|
ReportChart Element | Data Type | Description | Retrieval Code |
---|---|---|---|
ReportIndex | Integer | Index of image in the embedded delivered HTML |
|
Content Type | String | MIME Content Type of this chart. Possible values include:
|
|
Data | String | Base64 binary image data |
|
Filename | String | Filename of embedded file in HTML |
|
ReportSchema Element | Data Type | Description | Retrieval Code |
---|---|---|---|
ColumnName | String | Column Name |
|
DisplayName | String | Display name of column |
|
FieldId | Integer | Field Id of column |
|
DataType | String | Data type of column |
|
ColumnLength | String | Column length |
|
Hidden | Boolean | Whether the column is displayed in the report or not |
|
Prompt | Boolean | Whether the column is a prompt field or not |
|
FilterId | Integer | Filter Id if the column is a filter |
|
FilterType | String | Determines the filter type and what data would have to be posted to engage the prompt |
|
AllowPrompt | Boolean |
|
|
FilterOmittable | Boolean |
|
|
ParentFilterId | Integer | Filter Id of parent filter if a filter dependency is in place |
|
DefaultValue1 |
| First default value for filter if set |
|
DefaultValue2 |
| Second default value for filter if set |
|
ValueUnitCode |
| Time units for the filter if set |
|
FilterDisplayType |
| Filter Display Type if the column is a filter |
|
MinimumValue |
| Minimum value for filter if set |
|
MaximumValue |
| Maximum value for filter if set |
|
ReportBinaryObject Element | Data Type | Description | Retrieval Code |
---|---|---|---|
ContentType | String | MIME Content Type |
|
Data | String | Base64 binary data |
|
Key | String | Key of the ReportBinaryObject object |
|
KPI Element | Data Type | Description | Retrieval Code |
---|---|---|---|
Actual | String | The actual value for a KPI metric |
|
Target | String | The target value for a KPI metric |
|
Variance | String | The variance value for a KPI metric |
|
DrillAnywhereTarget Element | Data Type | Description | Retrieval Code |
---|---|---|---|
ParentCategory | String | Parent Category value |
|
Targets | Array (String) | Array of String values which are the targets for a particular parent category |
|
ScheduleRecord Element | Data Type | Description | Retrieval Code |
---|---|---|---|
Recipient | Integer | ID of recipient of the subscription |
|
Subject | String | Subscription subject |
|
BodyText | String | Subscription message |
|
FrequencyTypeCode | String | Subscription frequency. Values include:
|
|
FrequencyCode | String | Additional frequency codes depending on the frequency type code |
|
FrequencyUnit | String | Additional frequency units depending on the frequency type code |
|
Format | String | Subscription File Type. Values include:
|
|
ConditionList | Array (Condition) | Array of Condition objects that store delivery rules (see Condition) |
|
AdvancedTimezoneCode | String | Timezone in which the subscription happens |
|
AdvancedTime | Integer | Local run time for the subscription |
|
Condition Element | Data Type | Description | Retrieval Code |
---|---|---|---|
Operator | String | Filter operator for the column(s). Values include:
|
|
FieldId | Integer | Field Id of column |
|
Value1 | String | First conditional value |
|
Value2 | String | Second conditional value. This is needed if the operators are BETWEEN, NOTBETWEEN, etc. |
|
DashboardDefinition Element | Data Type | Description | Retrieval Code |
---|---|---|---|
TabId | Integer | ID of the dashboard tab |
|
GroupTypeCode | String | Type of dashboard tab. Values include:
|
|
Owner | Integer | ID of dashboard owner |
|
OwnerTypeCode | String | Type of dashboard owner. Value defaults to ORGANISATION |
|
AccessCode | String | Security level of the dashboard tab |
|
StartDate | Date | Creation Date |
|
EndDate | Date | End Date (if applicable) |
|
StatusCode | String | Status of the dashboard tab |
|
ShortDescription | String | Name of the dashboard tab |
|
LongDescription | String | Business description of the dashboard tab |
|
LanguageCode | String | Two letter language code |
|
StyleCode | String | Layout code. Values include:
|
|
Audience | String | Audience description |
|
ParentGroupId | Integer | If the dashboard tab is in draft mode, the original tab ID is saved into this column |
|
Elements | Array (DashboardElement) | A DashboardElement object contains portlet information for reports that reside within the dashboard tab (See DashboardElement) |
|
Filters | Array (DashboardFilterDefinition) | A DashboardFilterDefinition object contains format records pertaining the dashboard tab, analytic filters, and filter groups (See DashboardFilterDefinition) |
|
Fields | Array (DashboardFieldDefinition) | A DashboardFieldDefinition object contains format records pertaining fields being displayed as drilldowns on the dashboard tab |
|
DashboardElement Element | Data Type | Description | Retrieval Code |
---|---|---|---|
TabId | Integer | ID of the dashboard tab |
|
EntityId | Integer | ID of the portlet, which also happens to be the Report ID |
|
EntityTypeCode | String | Portlet entity type. Value defaults to REPORT |
|
ColumnNumber | Integer | Indicating where the portlet is column-wise. The first column starts at the value 1 |
|
RowNumber | Integer | Indicating where the portlet is row-wise. The first row starts at the value 1 |
|
SequenceNumber | Integer | Portlet loading sequence within the dashboard tab |
|
StartDate | Date | Date the portlet was added |
|
PortletStatus | String | Portlet status |
|
PortletHeight | Integer | Portlet height in pixels |
|
DashboardFieldDefinition Element | Data Type | Description | Retrieval Code |
---|---|---|---|
TabId | Integer | ID of the dashboard tab |
|
FieldId | Integer | Field ID of column |
|
FieldType | String | Field data type. Values include:
|
|
ReportId | Integer | ID of report |
|
TemplateId | Integer | ID of corresponding field template record |
|
FieldName | String | Column name |
|
FieldDescription | String | Column name |
|
DashboardFilterDefinition Element | Data Type | Description | Retrieval Code |
---|---|---|---|
GroupId | Integer | ID of the dashboard tab |
|
ComponentId | Integer | Numeric ID for the component based on the component type |
|
ComponentTypeCode | String | Component types for a DashboardFilterDefinition object include:
|
|
EntityId | Integer |
|
|
EntityTypeCode | String | Entity types for a DashboardFilterDefinition object include:
|
|
FormatKey | String | Format Code |
|
FormatValue | String | Format Value |
|
ReportFilter Element | Data Type | Description | Retrieval Code |
---|---|---|---|
FilterId | Integer | ID of the filter |
|
IsOmitted | Boolean | If the filter is omitted by default |
|
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 |
|
DashboardFilter Element | Data Type | Description | Retrieval Code |
---|---|---|---|
ReportId | Integer | ID of the report that the filter belongs to |
|
FilterType | String | Filter operator |
|
FilterId | Integer | ID of the filter |
|
TabId | Integer | ID of the dashboard tab that the report |
|
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 |
|
TemplateId | Integer | ID of the field template record. This applies if the Filter Type is DRILL, etc |
|