Comment:
Corrected mistake with FrequencyUnit details and updated FrequencyCode to be more meaningful
Anchor
ReportComment
ReportComment
...
Expand
title
ScheduleRecord
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 Condition37061460)
getConditionList()
AdvancedTimezoneCode
String
Timezone in which the subscription happens
getAdvancedTimezoneCode()
AdvancedTime
Integer
Local run time for the subscription
getAdvancedTime()
...
Expand
title
DashboardDefinition
DashboardDefinition Element
Data Type
Description
Retrieval Code
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 DashboardElement37061460)
getElements()
Filters
Array (DashboardFilterDefinition)
A DashboardFilterDefinition object contains format records pertaining the dashboard tab, analytic filters, and filter groups (See DashboardFilterDefinition37061460)
getFilters()
Fields
Array (DashboardFieldDefinition)
A DashboardFieldDefinition object contains format records pertaining fields being displayed as drilldowns on the dashboard tab
getFields()
...
Expand
title
DashboardFilterDefinition
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: