Skip to main content

Subscription

  • Updated

Subscription

FieldNullDescriptionNote
name
string		 The name of the subscription 
type
string		 The subscription type, either “Subscription Report” or “Subscription Alert” 
deliveryType
string		 The delivery type (Email or File Location) 
deliveryMethod
string		 The delivery method (Link, Attachment, Embedded HTML, Send to disk) 
exportFileType
string		 The export file type (PDF, Word Doc, Excel, CSV) 
exportAttachmentType
string		 The export attachment type (PDF, Word Doc, Excel, CSV) 
emailSubject
string		 The email subject template 
emailBody
string		 The email body template 
reportId
string (GUID)		YThe id of the report 
draftId
string (GUID)		YThe id of the draft report 
dashboardId
string (GUID)		YThe id of the dashboard 
filterValueSelection
string		 The filter value selection 
recipients
string		 The recipients 
isSubscription
boolean		 Is this a subscription (or scheduling) 
createdById
string (GUID)		YThe id of the user creating this subscription 
tenantId
string (GUID)		YThe id of the tenant if available 
subscriptionFilterFields
array of objects		YAn array of SubscriptionFilterField objects.

When emailing a report with selected filter(s).		 
subscriptionCommonFilterFields
array of objects		YAn array of SubscriptionCommonFilterField objects.

When emailing a dashboard with selected common filter(s).		 
tempId
string (GUID)		 The temporary id 
reportingType
string		 The reporting type 
additionalRecipients
string		 Additional recipients 
reportDashboardName
string		 The name of the report or dashboard 
isSubscriptionTimeZoneUsed
string		 Is subscription timezone used for reports and dashboards 

Inherited fields:

ScheduleEntity

FieldNullDescriptionNote
schedule
string		 The schedule for display 
timeZoneName
string		 The display name of the timezone.
Example: (UTC-08:00)PacificTime(US&Canada)		 
timeZoneValue
string		 The internal value of the timezone.
Example: PacificStandardTime		 
startDate
datetime		 The start date 
startDateUtc
datetime		 The start date in UTC timezone 
startTime
datetime		 The start time 
recurrenceType
int		 

The recurrence type

  • 0 = AlertHourly
  • 1 = AlertDaily
  • 2 = EveryDay
  • 3 = EveryWeekday
  • 4 = EveryWeek
  • 5 = EveryTwoWeeks
  • 6 = EveryMonth
  • 7 = EveryQuarter
  • 8 = CustomRecurrence
 
recurrencePattern
int		 

The recurrence pattern

  • 0 = Daily
  • 1 = Weekly
  • 2 = Monthly
  • 3 = Yearly
 
recurrencePatternValue
string		 The selected recurrence pattern value, in json format.
For example: {"recurrenceWeek":1,"selectedDayValue":"2"}		 
recurrencePatternSetting
object		 A dynamic object to store the recurrence pattern value 
isEndless
boolean		 Does the recurrence have no end date 
isScheduled
boolean		 Is it scheduled to run 
occurence
integer		 The number of occurences to end after 
endDate
datetime		YThe end date 
endDateUtc
datetime		YThe end date in UTC timezone 
lastSuccessfulRun
string		 The last successful run date and time for display 
lastSuccessfulRunDate
datetime		 The last successful run date and time 
nextScheduleRun
string		 The next scheduled run date and time for display 
nextScheduleRunDate
datetime		YThe next scheduled run date and time 
isStartDateAdjusted
boolean		 Has the start date been updated 

Inherited fields:

Entity

FieldNULLDescriptionNote
id
string (GUID)		 The id of this object
Example: 572bd576-8c92-4901-ab2a-b16e38144813		Allow null incase insert a new entity
state
integer		 

The entity state of this object

  • 0 = None
  • 1 = Insert
  • 2 = Delete
  • 3 = Update
 
deleted
boolean		 Is this object deleted 
inserted
boolean		 Is this object inserted 
version
string		YThe version 
created
datetime in ISO 8601 format		YThe created datetime 
createdBy
string		 The creator 
modified
datetime in ISO 8601 format		YThe modification datetime 
modifiedBy
string		 The user who last modified this object 
Sample:
{"isDirty":false,"name":"Everyday at 2 PM","type":"Subscription Report","timeZoneName":"(UTC-06:00) Central Time (US & Canada)","timeZoneValue":"Central Standard Time","startDate":"08/11/2016","startTime":"8/11/2016 2:00 PM","recurrenceType":"2","recurrencePattern":1,"recurrencePatternSetting":{"recurrenceWeek":1,"selectedDayValue":"5"},"isEndless":true,"endDate":"11/11/2016","deliveryType":"Email","deliveryMethod":"Link","emailSubject":"{reportName}","subscriptionFilterFields":[],"subscriptionCommonFilterFields":[],"reportId":null,"createdBy":"","id":null,"state":1,"isSubscription":true,"isEndAfter":false,"isEndBy":false,"isEdit":false}

Related articles