Type Alias SharingTaskRecurringPersist

Type of object stored in the database. Required fields mean that property cannot be null

type SharingTaskRecurringPersist = {
    appId?: string;
    appName?: string;
    byokMigrationId?: string;
    createdBy?: string;
    dataConnectionID?: string;
    dateCreated?: string;
    description?: string;
    distributionListId?: string;
    emailContent?: EmailComposition;
    enabledBySystem?: boolean;
    enabledByUser?: boolean;
    encryptedEmailContent?: SharingTaskRecurringPersistEncryptedEmailContent;
    encryptedState?: EncryptedProperty;
    encryptedTemplates?: EncryptedProperty;
    executeOnCreation?: boolean;
    expiration?: string;
    failedExecutionsCount?: number;
    failedVerificationsCount?: number;
    hasSectionAccess?: boolean;
    id?: string;
    insightDirectURL?: string;
    insightFallbackURL?: string;
    insightID?: string;
    isCandidateForVerification?: boolean;
    lastExecutionDate?: string;
    lastRun?: string;
    lastUpdated?: string;
    lastViewed?: string;
    message?: string;
    multiInsightURLs?: InsightURL[];
    name?: string;
    nextScheduledRun?: string;
    owner?: string;
    ownerName?: string;
    persistentBookmarkIncludeVariables?: boolean;
    recipients?: RecipientsPersist;
    reportProperties?: unknown;
    retentionPolicy?: RetentionPolicy;
    scheduleOptions?: ScheduleOptions;
    selectionErrors?: unknown;
    sharePointFolder?: string;
    spaceId?: string;
    startTime?: string;
    state?: State;
    statusCode?:
        | "CHART_NOT_FOUND"
        | "APP_NOT_FOUND"
        | "STORY_NOT_FOUND"
        | "SHEET_NOT_FOUND"
        | "ENGINE_POD_NOT_AVAILABLE"
        | "APP_FORBIDDEN"
        | "CHART_TYPE_NOT_ALLOWED"
        | "FAILED"
        | "DELETING"
        | "IN_PROGRESS"
        | "VALID"
        | "MAX_FAILURES_REACHED"
        | "BOOKMARK_NOT_FOUND"
        | "CANCELLING"
        | "CANCELLED"
        | "REPORTING_CONSUMPTION_EXCEEDED"
        | "REPORTING_CAPABILITY_NOT_FOUND";
    statusLabel?: string;
    subType?: "pdf"
    | "pptx"
    | "xlsx"
    | "html"
    | "docx";
    tags?: string[];
    taskErrors?: TaskError[];
    templateId?: string;
    templates?: TemplateResult[];
    tenant?: string;
    thumbnail?: string;
    transportChannels?: ("email" | "sharepoint")[];
    trigger?: Trigger;
    type?:
        | "chart-monitoring"
        | "chart-sharing"
        | "sheet-sharing"
        | "template-sharing";
    updatedBy?: string;
}
Index

Properties

appId?: string

ID of the app associated (through the templates) with this sharing task

appName?: string
byokMigrationId?: string
createdBy?: string
dataConnectionID?: string
dateCreated?: string
description?: string
distributionListId?: string
emailContent?: EmailComposition
enabledBySystem?: boolean
enabledByUser?: boolean
encryptedState?: EncryptedProperty
encryptedTemplates?: EncryptedProperty
executeOnCreation?: boolean
expiration?: string
failedExecutionsCount?: number
failedVerificationsCount?: number
hasSectionAccess?: boolean
id?: string
insightDirectURL?: string
insightFallbackURL?: string
insightID?: string
isCandidateForVerification?: boolean
lastExecutionDate?: string
lastRun?: string
lastUpdated?: string
lastViewed?: string
message?: string
multiInsightURLs?: InsightURL[]
name?: string
nextScheduledRun?: string
owner?: string
ownerName?: string
persistentBookmarkIncludeVariables?: boolean

Flag to configure the persistent bookmark to use variables. it is valid for subscriptions with type chart-sharing or sheet-sharing. Deprecated: please use the same field defined in the template instead.

recipients?: RecipientsPersist
reportProperties?: unknown
retentionPolicy?: RetentionPolicy
scheduleOptions?: ScheduleOptions
selectionErrors?: unknown
sharePointFolder?: string
spaceId?: string
startTime?: string
state?: State
statusCode?:
    | "CHART_NOT_FOUND"
    | "APP_NOT_FOUND"
    | "STORY_NOT_FOUND"
    | "SHEET_NOT_FOUND"
    | "ENGINE_POD_NOT_AVAILABLE"
    | "APP_FORBIDDEN"
    | "CHART_TYPE_NOT_ALLOWED"
    | "FAILED"
    | "DELETING"
    | "IN_PROGRESS"
    | "VALID"
    | "MAX_FAILURES_REACHED"
    | "BOOKMARK_NOT_FOUND"
    | "CANCELLING"
    | "CANCELLED"
    | "REPORTING_CONSUMPTION_EXCEEDED"
    | "REPORTING_CAPABILITY_NOT_FOUND"
statusLabel?: string
subType?: "pdf" | "pptx" | "xlsx" | "html" | "docx"

Mashup subType of sharing task

tags?: string[]
taskErrors?: TaskError[]
templateId?: string

ID of unique template

templates?: TemplateResult[]
tenant?: string
thumbnail?: string
transportChannels?: ("email" | "sharepoint")[]
trigger?: Trigger
type?:
    | "chart-monitoring"
    | "chart-sharing"
    | "sheet-sharing"
    | "template-sharing"
updatedBy?: string