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 Condition)
getConditionList()
AdvancedTimezoneCode
String
Timezone in which the subscription happens
getAdvancedTimezoneCode()
AdvancedTime
Integer
Local run time for the subscription
getAdvancedTime()
...
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: