Sharing tasks

• application/jsonobject
  Show application/json properties

  • totalCountinteger

    Required

    total count of entries in the collection as a whole

  • currentPageCountinteger

    Required

    count of entries on the currently shown page

  • linksobject
    Show links properties

    • nextobject
      Show next properties

      • hrefstring

        URL to particular set of elements

      • typestring

        Page type, can be next or prev

        Can be one of: "prev""next"

      • tokenstring

        Page unique token

    • prevobject
      Show prev properties

      • hrefstring

        URL to particular set of elements

      • typestring

        Page type, can be next or prev

        Can be one of: "prev""next"

      • tokenstring

        Page unique token

    • selfobject

      Object with Href to a particular element or set of elements

      Show self properties

      • hrefstring
  • recipientsobject

    List of recipients. An internal recipient is represented by their user id.

    Show recipients properties

    • DLUsersarray
    • userIdsarray of objects
    • DLGroupsarray
    • emailAddressesarray of strings

      Email of recipient (external user).

  • sharingTasksarray of objects

    Gets a list of recurring sharing tasks.

    Show sharingTasks properties

    • idstring

      Gets the sharing task resource identifier.

    • namestring

      Name of this sharing task

    • tagsarray of strings
    • typestring

      The sharing task resource type

      Can be one of: "chart-monitoring""chart-sharing""sheet-sharing""template-sharing"

    • appIdstring

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

    • ownerstring

      User id of owner of the sharing task

    • stateobject

      State of the selections and jsOpts

      Show state properties

      • fieldsarray of objects

        Selected fields that led to discovery of monitored Insight Advisor chart

      • queryItemsarray of objects

        Query that led to discovery of monitored Insight Advisor chart

      • selectionsarray of objects
        Show selections properties

        • namestring

          Required
        • valuesarray of strings

          Required
        • isNumericboolean

          Required
        • stateNamestring

          Required
        • displayNamestring
        • displayValuesarray of strings
    • tenantstring

      Tenant of the sharing task

    • appNamestring

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

    • lastRunstring

      The last execution start date time timestamp of the task

    • messagestring

      Message along with sharing task

      maxLength = 280

    • spaceIdstring

      spaceId of the app associated to this task definition

    • subTypestring

      Mashup subType of sharing task

      Can be one of: "pdf""pptx""xlsx"

    • triggerobject
      Show trigger properties

      • recurrencearray of strings

        Required

        List of RRULE lines for a recurring event, as specified in RFC5545. Note that DTSTART and DTEND, UNTIL lines are not allowed in this field; event start and end times are specified in the start and end fields. RDATE and EXDATE lines are not currently supported. EXRULE is not supported since it is deprecated by RFC5545. This field is omitted for single events.

      • chronosJobIDstring

        The chronosJobId which triggers the sharing task

      • executeOnAppReloadboolean

        Toggle for executing sharing task on app reload.

        default = true

      • executionHistoryIntervalstring

        To prevent overflow in the history, setting this to daily store the chart of a previous day in the history and maintain the live version with the tag latest.

        Can be one of: "minutely""hourly""daily""weekly""monthly""quarterly""yearly"

    • createdBystring

      ID of creator

    • insightIDstring

      The identifier for the insight URLs in this sharing task. Needed to remove the permanent insight upon task deletion. (currently not used in multi-sheet scenarios)

    • ownerNamestring

      User name of owner of the sharing task

    • startTimestring

      Time to start capturing the history

    • templatesarray of object,s
      Show templates properties

      • typestring

        Required

        Can be one of: "file""chart""story""sheet""multi-sheet""excel"

      • subTypestring

        Can be one of: "image""snapshot""pdf""pptx""xlsx"

        default = "image"

      • fileNamestring

        fileName to be used when generating the report

      • chartDataobject

        If the template type is not "chart", this can be null. Otherwise, the following properties are required: appId, sheetId, objectId, widthPx, heightPx, language. The following properties are optional: outZoom, outDpi

        Show chartData properties

        • appIdstring

          ID of app

        • jsOptsobject

          Visualization state from client as a string json value. Can include language, theme, viewState etc.

        • outDpiinteger

          outDpi of chart

        • outZoomnumber

          outZoom of chart

        • patchesarray of objects

          Soft property changes on chart

        • sheetIdstring

          sheetId of app

        • widthPxinteger

          widthPx of chart

        • heightPxinteger

          heightPx of chart

        • objectIdstring

          ID of object

        • objectDefobject

          Session chart object definition

      • fileAliasstring

        fileAlias provide an opaqueId for the client which can be used to filter and select the report generated

      • sheetDataobjectDeprecated
        Show sheetData properties

        • appIdstring

          ID of app

        • jsOptsobject

          Sheet state from client as a string json value. Can include language, theme, viewState etc.

        • sheetIdstring

          ID of sheet

        • widthPxinteger

          widthPx of chart

        • heightPxinteger

          heightPx of chart

        • isPrivatebooleanDeprecated

          optional value to indicate that this sheet is private (used in multi-sheet sharing)

        • sheetNamestringDeprecated

          an optional name for the sheet (used in multi-sheet sharing)

        • jsOptsByIdobject

          additional properties

        • patchesByIdobject

          additional properties

      • storyDataobject
        Show storyData properties

        • appIdstring

          ID of app

        • storyIdstring

          ID of story

      • templateIdstringDeprecated

        ID of unique template

      • fileTimeStampstring

        file name timestamp to be used when generating the report

        Can be one of: "yyyy-MM-dd""yyyy-MM-dd_HH-mm""yyyyMMdd""yyyyMMdd_HH-mm"

      • multiSheetDataarray of objects

        array of sheet data for multi-sheet type template

        Show multiSheetData properties

        • appIdstring

          ID of app

        • jsOptsobject

          Sheet state from client as a string json value. Can include language, theme, viewState etc.

        • sheetIdstring

          ID of sheet

        • widthPxinteger

          widthPx of chart, must be 0 or omitted for autofit.

        • heightPxinteger

          heightPx of chart, must be 0 or omitted for autofit.

        • isPrivateboolean

          optional value to indicate that this sheet is private

        • sheetNamestring

          an optional name for the sheet

        • jsOptsByIdobject

          additional properties

        • resizeTypestring

          Currently only autofit is supported. If omitted, autofit is the default. The type of resize to be performed:

          • none is used to export a visualization, sheet as is (e.g. normal size), regardless its size. This may result in cropping.
          • autofit automatically fits the visualization, sheet into the output size (i.e. A4, A3 etc.). Any provided resizeData parameter will be ignored for this configuration.
          • fit fits the visualization, sheet into the area specified in resizeData. The content will be rescaled to fit in that area.

          Can be one of: "none""fit""autofit"

        • patchesByIdobject

          additional properties

    • thumbnailstring
    • updatedBystring

      ID of a user that updated this task last

    • expirationstring

      Time for the termination of the task

    • recipientsobject

      List of persisted recipients.

      Show recipients properties

      • DLUsersarray
      • userIdsarray of objects

        recipient object model that is directly persisted in the DB

        Show userIds properties

        • valuestring

          User ID of recipient (internal user).

        • groupsarray of strings

          A list of associated groups. If a user is added individually the "addedIndividually" pseudo group is included

        • subscribedboolean

          Whether this user is subscribed to alerts in this task

        • enabledByUserboolean

          Whether this recipient can receive alerts, set by api calls.

        • enabledBySystemboolean

          Whether this recipient can receive alerts, set by external settings.

        • taskRecipientErrorsarray of objects
        • alertingTaskRecipientErrorsarray of objects
      • DLGroupsarray
      • groupIdsarray of objects

        recipient object model that is directly persisted in the DB

        Show groupIds properties

        • valuestring

          Group ID of recipient.

        • enabledByUserboolean

          Whether this recipient can receive alerts, set by api calls.

        • enabledBySystemboolean

          Whether this recipient can receive alerts, set by external settings.

        • taskGroupRecipientErrorsarray of objects
        • alertingTaskGroupRecipientErrorsarray of objects
      • emailAddressesarray of objects

        recipient object model that is directly persisted in the DB

        Show emailAddresses properties

        • valuestring

          Email of recipient (external user).

          format = "email"

        • enabledboolean

          Whether this recipient can receive alerts.

        • taskRecipientErrorsarray of objects
    • statusCodestring

      the status of this recurring sharing task

      Can be one of: "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"

    • taskErrorsarray of objects
      Show taskErrors properties

      • valuestring

        Identifier for type of error occurring on sharing task

        Can be one of: "OWNER_DISABLED""OWNER_ACCESS""OWNER_LICENSE""APP_DELETED""NO_RECIPIENTS""PARTIAL_ACCESS""ORPHAN""PARTIAL_SENT""FATAL_SENT_ERROR""SECTION_ACCESS_MODIFIED""INVALID_DISTRIBUTION_LIST""MAX_DL_RECIPIENTS_LIMIT_REACHED""TEMPLATE_NOT_FOUND""REPORTING_BOOKMARK_NOT_FOUND""DATA_CONNECTION_NOT_FOUND""INVALID_SHAREPOINT_DIRECTORY""GENERIC_FILE_UPLOAD_ERROR""DISABLED_DUE_TO_OWNERSHIP_CHANGE""REPORTING_CONSUMPTION_EXCEEDED""REPORTING_CAPABILITY_NOT_FOUND""EXECUTION_TIME_OUT""OWNER_INSUFFICIENT_PERMISSIONS""MAX_UNIQUE_REPORTS_LIMIT_REACHED"

      • timestampstring

        Timestamp for the creation of the error

    • templateIdstring

      ID of unique template

    • dateCreatedstring

      Timestamp for the creation of the task

    • descriptionstring

      A description of this sharing task

    • lastUpdatedstring

      Timestamp of the most recent update.

    • statusLabelstring

      error message indicating the underlying failure

    • emailContentobject
      Show emailContent properties

      • bodystring
      • subjectstring
    • enabledByUserboolean

      Toggle for enabling sharing task (user level). Example: user chooses to enable/ disable task.

    • encryptedStateobject

      Encrypted property in DB

      Show encryptedState properties

      • valueany
      • cipherstring
    • byokMigrationIdstring

      internal identifier used when migrating keys

    • enabledBySystemboolean

      Toggle for enabling sharing task (system level). Example: when task owner gets enabled/ disabled.

    • retentionPolicyobject
      Show retentionPolicy properties

      • historySizeinteger

        Number indicating the size of the window which stores the history. For Chart monitoring, the size should be 10.

      • overrideIntervalstring

        Using RFC-5545 provide the time interval in which the previous generated can be overridden with the newly generated report. For Chart monitoring, interval should be FREQ=DAILY;INTERVAL=1

        default = "FREQ=DAILY;INTERVAL=1"

    • scheduleOptionsobject
      Show scheduleOptions properties

      • timezonestring

        The timezone for time calculations in SCHEDULED triggers, optional.

      • recurrencearray of strings

        List of RRULEs for SCHEDULED triggers, as specified in RFC5545. Note that DTSTART and DTEND, UNTIL lines are not allowed in this field; start and end times are specified in the start and end fields. RDATE and EXDATE lines are not currently supported. EXRULE is not supported since it is deprecated by RFC5545. It is mandatory if the trigger type is SCHEDULED. At least 1 rule must be set and maximum 5 rules are allowed.

      • endDateTimestring

        EndDateTime is a local date time with respect to the above timezone parameter. If the timezone parameter is missing, then the timezone used is the one retrieved from user infos. Therefore ISO8601 time offsets are not allowed (e.g. "2026-01-02T16:04:05Z" or "2026-01-02T16:04:05+01"), if passed an error will be returned. EndDateTime is an optional parameter, when not set or when it's an empty string, the recurrence is intended to be never ending.

        default = ""

      • chronosJobIDstring

        The chronos job identifier. It is set once the related chronos job is created.

      • startDateTimestring

        StartDateTime is a local date time with respect to the above timezone parameter. If the timezone parameter is missing, then the timezone used is the one retrieved from user infos. Therefore ISO8601 time offsets are not allowed (e.g. "2026-01-02T16:04:05Z" or "2026-01-02T16:04:05+01"), if passed an error will be returned. StartDateTime should not be older than 1 year from current date. StartDateTime is an optional parameter, when not set or when it's an empty string, its value is set to the current local date time.

      • lastExecutionTimestring

        lastExecutionTime is the time of the chronos job last execution in RFC3339 format (a time with a fixed UTC offset). Could be empty if job has not run yet.

      • nextExecutionTimestring

        nextExecutionTime is the time of the chronos job next execution in RFC3339 format (a time with a fixed UTC offset). Could be empty if the job is completed.

    • selectionErrorsobject

      reporting service returns rendering errors for missing selections

    • dataConnectionIDstring

      the id of the data connection

    • hasSectionAccessboolean

      true if the associated app has section access enabled

    • insightDirectURLstring

      The direct insights URL for the first template of this sharing task. (currently not used in multi-sheet scenarios)

    • multiInsightURLsarray of objects

      Contains one or more insight links. Currently only used in multi sheet scenarios. Sharing will ensure that the persisted sort order is aligned to the order of sheets provided.

      Show multiInsightURLs properties

      • statusstring

        the status of the creation for this insight URL

        Can be one of: "successful""failed"

      • directURLstring
      • insightIDstring
      • resourceIDstring

        an identifier for the object within the template that this insight link points to

      • templateIDstringDeprecated

        an identifier for the template that this insight link points to

      • fallbackURLstring
    • nextScheduledRunstring

      Time for the next scheduled run

    • reportPropertiesobject
    • sharePointFolderstring

      the SharePoint folder to upload the report to

    • executeOnCreationboolean

      making this true will execute the sharing task upon creation regardless of next trigger

    • lastExecutionDatestring

      The last execution end date time timestamp of the task

    • transportChannelsarray of strings

      the transport type for the report

      Values may be any of: "email""sharepoint"

    • distributionListIdstring

      the id of the distribution list associated to the app

    • encryptedTemplatesobject

      Encrypted property in DB

      Show encryptedTemplates properties

      • valueany
      • cipherstring
    • insightFallbackURLstring

      The insights fallback URL for the first template of this sharing task. (currently not used in multi-sheet scenarios)

    • encryptedEmailContentobject

      the subject and body content for the email to send on report subscriptions

      Show encryptedEmailContent properties

      • bodyobject

        Encrypted property in DB

        Show body properties

        • valueany
        • cipherstring
      • subjectobject

        Encrypted property in DB

        Show subject properties

        • valueany
        • cipherstring
    • failedExecutionsCountinteger

      the number of consecutive failed executions for all recipeints. This is reset on a successful execution for at least one recipient

    • failedVerificationsCountinteger

      the number of failed verifications. This is reset on a successful verification

    • isCandidateForVerificationboolean

      true if the sharing task is a candidate for verification

    • persistentBookmarkIncludeVariablesboolean

      flag sent by UI to configure the persistent bookmark to use variables

    • linksobject
      Show links properties

      • selfobject

        Object with Href to a particular element or set of elements

        Show self properties

        • hrefstring
    • enabledboolean

      true if the sharing task is enabled

    • latestExecutionURLstring

      URL to querying the latest execution tied to this sharing task

    • latestExecutionFilesURLarray of strings

      URL to querying the files of the latest execution tied to this sharing task

• application/jsonobject
  Show application/json properties

  • errorsarray of objects
  • traceIdstring

• application/jsonobject
  Show application/json properties

  • errorsarray of objects
  • traceIdstring

• application/jsonobject
  Show application/json properties

  • errorsarray of objects
  • traceIdstring

• application/jsonobject
  Show application/json properties

  • namestring

    Required

    Name of this sharing task

    minLength = 1

  • tagsarray of strings

    used to assign sharing task to a collection bucket (tags)

  • typestring

    Required

    the sharing task resource type.

    Can be one of: "chart-monitoring""chart-sharing""sheet-sharing""template-sharing"

  • stateobject

    Required

    State of the selections and jsOpts

    Show state properties

    • fieldsarray of objects

      Selected fields that led to discovery of monitored Insight Advisor chart

    • queryItemsarray of objects

      Query that led to discovery of monitored Insight Advisor chart

    • selectionsarray of objects
  • appNamestringDeprecated

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

    minLength = 1

  • enabledboolean

    Toggle for enabling sharing task.

    default = true

  • messagestring

    Message along with sharing task

    maxLength = 280

  • spaceIdstring

    Space ID of the sharing task

    maxLength = 255

  • subTypestring

    the sharing task resource mashup sub type.

    Can be one of: "pdf""pptx""xlsx"

  • triggerobject
    Show trigger properties

    • recurrencearray of strings

      Required

      List of RRULE lines for a recurring event, as specified in RFC5545. Note that DTSTART and DTEND, UNTIL lines are not allowed in this field; event start and end times are specified in the start and end fields. RDATE and EXDATE lines are not currently supported. EXRULE is not supported since it is deprecated by RFC5545. This field is omitted for single events.

    • chronosJobIDstring

      The chronosJobId which triggers the sharing task

    • executeOnAppReloadboolean

      Toggle for executing sharing task on app reload.

      default = true

    • executionHistoryIntervalstring

      To prevent overflow in the history, setting this to daily store the chart of a previous day in the history and maintain the live version with the tag latest.

      Can be one of: "minutely""hourly""daily""weekly""monthly""quarterly""yearly"

  • startTimestring

    Time to start capturing the history

  • templatesarray of objects

    Required
  • expirationstring

    Timestamp for the termination of the task

  • recipientsobject

    List of recipients. An internal recipient is represented by their user id.

    Show recipients properties

    • DLUsersarray
    • userIdsarray of objects
    • DLGroupsarray
    • emailAddressesarray of strings

      Email of recipient (external user).

  • descriptionstring

    Description of the sharing task

    maxLength = 255

  • emailContentobject
    Show emailContent properties

    • bodystring
    • subjectstring
  • retentionPolicyobject
    Show retentionPolicy properties

    • historySizeinteger

      Number indicating the size of the window which stores the history. For Chart monitoring, the size should be 10.

    • overrideIntervalstring

      Using RFC-5545 provide the time interval in which the previous generated can be overridden with the newly generated report. For Chart monitoring, interval should be FREQ=DAILY;INTERVAL=1

      default = "FREQ=DAILY;INTERVAL=1"

  • scheduleOptionsobject
    Show scheduleOptions properties

    • timezonestring

      The timezone for time calculations in SCHEDULED triggers, optional.

    • recurrencearray of strings

      List of RRULEs for SCHEDULED triggers, as specified in RFC5545. Note that DTSTART and DTEND, UNTIL lines are not allowed in this field; start and end times are specified in the start and end fields. RDATE and EXDATE lines are not currently supported. EXRULE is not supported since it is deprecated by RFC5545. It is mandatory if the trigger type is SCHEDULED. At least 1 rule must be set and maximum 5 rules are allowed.

    • endDateTimestring

      EndDateTime is a local date time with respect to the above timezone parameter. If the timezone parameter is missing, then the timezone used is the one retrieved from user infos. Therefore ISO8601 time offsets are not allowed (e.g. "2026-01-02T16:04:05Z" or "2026-01-02T16:04:05+01"), if passed an error will be returned. EndDateTime is an optional parameter, when not set or when it's an empty string, the recurrence is intended to be never ending.

      default = ""

    • chronosJobIDstring

      The chronos job identifier. It is set once the related chronos job is created.

    • startDateTimestring

      StartDateTime is a local date time with respect to the above timezone parameter. If the timezone parameter is missing, then the timezone used is the one retrieved from user infos. Therefore ISO8601 time offsets are not allowed (e.g. "2026-01-02T16:04:05Z" or "2026-01-02T16:04:05+01"), if passed an error will be returned. StartDateTime should not be older than 1 year from current date. StartDateTime is an optional parameter, when not set or when it's an empty string, its value is set to the current local date time.

    • lastExecutionTimestring

      lastExecutionTime is the time of the chronos job last execution in RFC3339 format (a time with a fixed UTC offset). Could be empty if job has not run yet.

    • nextExecutionTimestring

      nextExecutionTime is the time of the chronos job next execution in RFC3339 format (a time with a fixed UTC offset). Could be empty if the job is completed.

  • dataConnectionIDstring

    the id of the data connection

  • sharePointFolderstring

    the SharePoint folder to upload the report to

  • executeOnCreationboolean

    making this true will execute the sharing task upon creation regardless of next trigger

    default = true

  • transportChannelsarray of strings

    the transport type for the report

    Values may be any of: "email""sharepoint"

  • distributionListIdstring

    the id of the distribution list associated to the app

Whatever is persisted in the db + links

• application/jsonobject

  Whatever is persisted in the db + links

  Show application/json properties

  • idstring

    Gets the sharing task resource identifier.

  • namestring

    Name of this sharing task

  • tagsarray of strings
  • typestring

    The sharing task resource type

    Can be one of: "chart-monitoring""chart-sharing""sheet-sharing""template-sharing"

  • appIdstring

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

  • ownerstring

    User id of owner of the sharing task

  • stateobject

    State of the selections and jsOpts

    Show state properties

    • fieldsarray of objects

      Selected fields that led to discovery of monitored Insight Advisor chart

    • queryItemsarray of objects

      Query that led to discovery of monitored Insight Advisor chart

    • selectionsarray of objects
  • tenantstring

    Tenant of the sharing task

  • appNamestring

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

  • lastRunstring

    The last execution start date time timestamp of the task

  • messagestring

    Message along with sharing task

    maxLength = 280

  • spaceIdstring

    spaceId of the app associated to this task definition

  • subTypestring

    Mashup subType of sharing task

    Can be one of: "pdf""pptx""xlsx"

  • triggerobject
    Show trigger properties

    • recurrencearray of strings

      Required

      List of RRULE lines for a recurring event, as specified in RFC5545. Note that DTSTART and DTEND, UNTIL lines are not allowed in this field; event start and end times are specified in the start and end fields. RDATE and EXDATE lines are not currently supported. EXRULE is not supported since it is deprecated by RFC5545. This field is omitted for single events.

    • chronosJobIDstring

      The chronosJobId which triggers the sharing task

    • executeOnAppReloadboolean

      Toggle for executing sharing task on app reload.

      default = true

    • executionHistoryIntervalstring

      To prevent overflow in the history, setting this to daily store the chart of a previous day in the history and maintain the live version with the tag latest.

      Can be one of: "minutely""hourly""daily""weekly""monthly""quarterly""yearly"

  • createdBystring

    ID of creator

  • insightIDstring

    The identifier for the insight URLs in this sharing task. Needed to remove the permanent insight upon task deletion. (currently not used in multi-sheet scenarios)

  • ownerNamestring

    User name of owner of the sharing task

  • startTimestring

    Time to start capturing the history

  • templatesarray of objects
  • thumbnailstring
  • updatedBystring

    ID of a user that updated this task last

  • expirationstring

    Time for the termination of the task

  • recipientsobject

    List of persisted recipients.

    Show recipients properties

    • DLUsersarray
    • userIdsarray of objects
    • DLGroupsarray
    • groupIdsarray of objects
    • emailAddressesarray of objects
  • statusCodestring

    the status of this recurring sharing task

    Can be one of: "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"

  • taskErrorsarray of objects
  • templateIdstring

    ID of unique template

  • dateCreatedstring

    Timestamp for the creation of the task

  • descriptionstring

    A description of this sharing task

  • lastUpdatedstring

    Timestamp of the most recent update.

  • statusLabelstring

    error message indicating the underlying failure

  • emailContentobject
    Show emailContent properties

    • bodystring
    • subjectstring
  • enabledByUserboolean

    Toggle for enabling sharing task (user level). Example: user chooses to enable/ disable task.

  • encryptedStateobject

    Encrypted property in DB

    Show encryptedState properties

    • valueany
    • cipherstring
  • byokMigrationIdstring

    internal identifier used when migrating keys

  • enabledBySystemboolean

    Toggle for enabling sharing task (system level). Example: when task owner gets enabled/ disabled.

  • retentionPolicyobject
    Show retentionPolicy properties

    • historySizeinteger

      Number indicating the size of the window which stores the history. For Chart monitoring, the size should be 10.

    • overrideIntervalstring

      Using RFC-5545 provide the time interval in which the previous generated can be overridden with the newly generated report. For Chart monitoring, interval should be FREQ=DAILY;INTERVAL=1

      default = "FREQ=DAILY;INTERVAL=1"

  • scheduleOptionsobject
    Show scheduleOptions properties

    • timezonestring

      The timezone for time calculations in SCHEDULED triggers, optional.

    • recurrencearray of strings

      List of RRULEs for SCHEDULED triggers, as specified in RFC5545. Note that DTSTART and DTEND, UNTIL lines are not allowed in this field; start and end times are specified in the start and end fields. RDATE and EXDATE lines are not currently supported. EXRULE is not supported since it is deprecated by RFC5545. It is mandatory if the trigger type is SCHEDULED. At least 1 rule must be set and maximum 5 rules are allowed.

    • endDateTimestring

      EndDateTime is a local date time with respect to the above timezone parameter. If the timezone parameter is missing, then the timezone used is the one retrieved from user infos. Therefore ISO8601 time offsets are not allowed (e.g. "2026-01-02T16:04:05Z" or "2026-01-02T16:04:05+01"), if passed an error will be returned. EndDateTime is an optional parameter, when not set or when it's an empty string, the recurrence is intended to be never ending.

      default = ""

    • chronosJobIDstring

      The chronos job identifier. It is set once the related chronos job is created.

    • startDateTimestring

      StartDateTime is a local date time with respect to the above timezone parameter. If the timezone parameter is missing, then the timezone used is the one retrieved from user infos. Therefore ISO8601 time offsets are not allowed (e.g. "2026-01-02T16:04:05Z" or "2026-01-02T16:04:05+01"), if passed an error will be returned. StartDateTime should not be older than 1 year from current date. StartDateTime is an optional parameter, when not set or when it's an empty string, its value is set to the current local date time.

    • lastExecutionTimestring

      lastExecutionTime is the time of the chronos job last execution in RFC3339 format (a time with a fixed UTC offset). Could be empty if job has not run yet.

    • nextExecutionTimestring

      nextExecutionTime is the time of the chronos job next execution in RFC3339 format (a time with a fixed UTC offset). Could be empty if the job is completed.

  • selectionErrorsobject

    reporting service returns rendering errors for missing selections

  • dataConnectionIDstring

    the id of the data connection

  • hasSectionAccessboolean

    true if the associated app has section access enabled

  • insightDirectURLstring

    The direct insights URL for the first template of this sharing task. (currently not used in multi-sheet scenarios)

  • multiInsightURLsarray of objects
  • nextScheduledRunstring

    Time for the next scheduled run

  • reportPropertiesobject
  • sharePointFolderstring

    the SharePoint folder to upload the report to

  • executeOnCreationboolean

    making this true will execute the sharing task upon creation regardless of next trigger

  • lastExecutionDatestring

    The last execution end date time timestamp of the task

  • transportChannelsarray of strings

    the transport type for the report

    Values may be any of: "email""sharepoint"

  • distributionListIdstring

    the id of the distribution list associated to the app

  • encryptedTemplatesobject

    Encrypted property in DB

    Show encryptedTemplates properties

    • valueany
    • cipherstring
  • insightFallbackURLstring

    The insights fallback URL for the first template of this sharing task. (currently not used in multi-sheet scenarios)

  • encryptedEmailContentobject

    the subject and body content for the email to send on report subscriptions

    Show encryptedEmailContent properties

    • bodyobject

      Encrypted property in DB

      Show body properties

      • valueany
      • cipherstring
    • subjectobject

      Encrypted property in DB

      Show subject properties

      • valueany
      • cipherstring
  • failedExecutionsCountinteger

    the number of consecutive failed executions for all recipeints. This is reset on a successful execution for at least one recipient

  • failedVerificationsCountinteger

    the number of failed verifications. This is reset on a successful verification

  • isCandidateForVerificationboolean

    true if the sharing task is a candidate for verification

  • persistentBookmarkIncludeVariablesboolean

    flag sent by UI to configure the persistent bookmark to use variables

  • linksobject
    Show links properties

    • selfobject

      Object with Href to a particular element or set of elements

      Show self properties

      • hrefstring
  • enabledboolean

    true if the sharing task is enabled

  • latestExecutionURLstring

    URL to querying the latest execution tied to this sharing task

  • latestExecutionFilesURLarray of strings

    URL to querying the files of the latest execution tied to this sharing task

• application/jsonobject
  Show application/json properties

  • errorsarray of objects
  • traceIdstring

• application/jsonobject
  Show application/json properties

  • errorsarray of objects
  • traceIdstring

• application/jsonobject
  Show application/json properties

  • errorsarray of objects
  • traceIdstring

Whatever is persisted in the db + links

• application/jsonobject

  Whatever is persisted in the db + links

  Show application/json properties

  • idstring

    Gets the sharing task resource identifier.

  • namestring

    Name of this sharing task

  • tagsarray of strings
  • typestring

    The sharing task resource type

    Can be one of: "chart-monitoring""chart-sharing""sheet-sharing""template-sharing"

  • appIdstring

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

  • ownerstring

    User id of owner of the sharing task

  • stateobject

    State of the selections and jsOpts

    Show state properties

    • fieldsarray of objects

      Selected fields that led to discovery of monitored Insight Advisor chart

    • queryItemsarray of objects

      Query that led to discovery of monitored Insight Advisor chart

    • selectionsarray of objects
  • tenantstring

    Tenant of the sharing task

  • appNamestring

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

  • lastRunstring

    The last execution start date time timestamp of the task

  • messagestring

    Message along with sharing task

    maxLength = 280

  • spaceIdstring

    spaceId of the app associated to this task definition

  • subTypestring

    Mashup subType of sharing task

    Can be one of: "pdf""pptx""xlsx"

  • triggerobject
    Show trigger properties

    • recurrencearray of strings

      Required

      List of RRULE lines for a recurring event, as specified in RFC5545. Note that DTSTART and DTEND, UNTIL lines are not allowed in this field; event start and end times are specified in the start and end fields. RDATE and EXDATE lines are not currently supported. EXRULE is not supported since it is deprecated by RFC5545. This field is omitted for single events.

    • chronosJobIDstring

      The chronosJobId which triggers the sharing task

    • executeOnAppReloadboolean

      Toggle for executing sharing task on app reload.

      default = true

    • executionHistoryIntervalstring

      To prevent overflow in the history, setting this to daily store the chart of a previous day in the history and maintain the live version with the tag latest.

      Can be one of: "minutely""hourly""daily""weekly""monthly""quarterly""yearly"

  • createdBystring

    ID of creator

  • insightIDstring

    The identifier for the insight URLs in this sharing task. Needed to remove the permanent insight upon task deletion. (currently not used in multi-sheet scenarios)

  • ownerNamestring

    User name of owner of the sharing task

  • startTimestring

    Time to start capturing the history

  • templatesarray of objects
  • thumbnailstring
  • updatedBystring

    ID of a user that updated this task last

  • expirationstring

    Time for the termination of the task

  • recipientsobject

    List of persisted recipients.

    Show recipients properties

    • DLUsersarray
    • userIdsarray of objects
    • DLGroupsarray
    • groupIdsarray of objects
    • emailAddressesarray of objects
  • statusCodestring

    the status of this recurring sharing task

    Can be one of: "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"

  • taskErrorsarray of objects
  • templateIdstring

    ID of unique template

  • dateCreatedstring

    Timestamp for the creation of the task

  • descriptionstring

    A description of this sharing task

  • lastUpdatedstring

    Timestamp of the most recent update.

  • statusLabelstring

    error message indicating the underlying failure

  • emailContentobject
    Show emailContent properties

    • bodystring
    • subjectstring
  • enabledByUserboolean

    Toggle for enabling sharing task (user level). Example: user chooses to enable/ disable task.

  • encryptedStateobject

    Encrypted property in DB

    Show encryptedState properties

    • valueany
    • cipherstring
  • byokMigrationIdstring

    internal identifier used when migrating keys

  • enabledBySystemboolean

    Toggle for enabling sharing task (system level). Example: when task owner gets enabled/ disabled.

  • retentionPolicyobject
    Show retentionPolicy properties

    • historySizeinteger

      Number indicating the size of the window which stores the history. For Chart monitoring, the size should be 10.

    • overrideIntervalstring

      Using RFC-5545 provide the time interval in which the previous generated can be overridden with the newly generated report. For Chart monitoring, interval should be FREQ=DAILY;INTERVAL=1

      default = "FREQ=DAILY;INTERVAL=1"

  • scheduleOptionsobject
    Show scheduleOptions properties

    • timezonestring

      The timezone for time calculations in SCHEDULED triggers, optional.

    • recurrencearray of strings

      List of RRULEs for SCHEDULED triggers, as specified in RFC5545. Note that DTSTART and DTEND, UNTIL lines are not allowed in this field; start and end times are specified in the start and end fields. RDATE and EXDATE lines are not currently supported. EXRULE is not supported since it is deprecated by RFC5545. It is mandatory if the trigger type is SCHEDULED. At least 1 rule must be set and maximum 5 rules are allowed.

    • endDateTimestring

      EndDateTime is a local date time with respect to the above timezone parameter. If the timezone parameter is missing, then the timezone used is the one retrieved from user infos. Therefore ISO8601 time offsets are not allowed (e.g. "2026-01-02T16:04:05Z" or "2026-01-02T16:04:05+01"), if passed an error will be returned. EndDateTime is an optional parameter, when not set or when it's an empty string, the recurrence is intended to be never ending.

      default = ""

    • chronosJobIDstring

      The chronos job identifier. It is set once the related chronos job is created.

    • startDateTimestring

      StartDateTime is a local date time with respect to the above timezone parameter. If the timezone parameter is missing, then the timezone used is the one retrieved from user infos. Therefore ISO8601 time offsets are not allowed (e.g. "2026-01-02T16:04:05Z" or "2026-01-02T16:04:05+01"), if passed an error will be returned. StartDateTime should not be older than 1 year from current date. StartDateTime is an optional parameter, when not set or when it's an empty string, its value is set to the current local date time.

    • lastExecutionTimestring

      lastExecutionTime is the time of the chronos job last execution in RFC3339 format (a time with a fixed UTC offset). Could be empty if job has not run yet.

    • nextExecutionTimestring

      nextExecutionTime is the time of the chronos job next execution in RFC3339 format (a time with a fixed UTC offset). Could be empty if the job is completed.

  • selectionErrorsobject

    reporting service returns rendering errors for missing selections

  • dataConnectionIDstring

    the id of the data connection

  • hasSectionAccessboolean

    true if the associated app has section access enabled

  • insightDirectURLstring

    The direct insights URL for the first template of this sharing task. (currently not used in multi-sheet scenarios)

  • multiInsightURLsarray of objects
  • nextScheduledRunstring

    Time for the next scheduled run

  • reportPropertiesobject
  • sharePointFolderstring

    the SharePoint folder to upload the report to

  • executeOnCreationboolean

    making this true will execute the sharing task upon creation regardless of next trigger

  • lastExecutionDatestring

    The last execution end date time timestamp of the task

  • transportChannelsarray of strings

    the transport type for the report

    Values may be any of: "email""sharepoint"

  • distributionListIdstring

    the id of the distribution list associated to the app

  • encryptedTemplatesobject

    Encrypted property in DB

    Show encryptedTemplates properties

    • valueany
    • cipherstring
  • insightFallbackURLstring

    The insights fallback URL for the first template of this sharing task. (currently not used in multi-sheet scenarios)

  • encryptedEmailContentobject

    the subject and body content for the email to send on report subscriptions

    Show encryptedEmailContent properties

    • bodyobject

      Encrypted property in DB

      Show body properties

      • valueany
      • cipherstring
    • subjectobject

      Encrypted property in DB

      Show subject properties

      • valueany
      • cipherstring
  • failedExecutionsCountinteger

    the number of consecutive failed executions for all recipeints. This is reset on a successful execution for at least one recipient

  • failedVerificationsCountinteger

    the number of failed verifications. This is reset on a successful verification

  • isCandidateForVerificationboolean

    true if the sharing task is a candidate for verification

  • persistentBookmarkIncludeVariablesboolean

    flag sent by UI to configure the persistent bookmark to use variables

  • linksobject
    Show links properties

    • selfobject

      Object with Href to a particular element or set of elements

      Show self properties

      • hrefstring
  • enabledboolean

    true if the sharing task is enabled

  • latestExecutionURLstring

    URL to querying the latest execution tied to this sharing task

  • latestExecutionFilesURLarray of strings

    URL to querying the files of the latest execution tied to this sharing task

• application/jsonobject
  Show application/json properties

  • errorsarray of objects
  • traceIdstring

• application/jsonobject
  Show application/json properties

  • errorsarray of objects
  • traceIdstring

• application/jsonobject
  Show application/json properties

  • errorsarray of objects
  • traceIdstring

• application/jsonobject
  Show application/json properties

  • errorsarray of objects
  • traceIdstring

• application/jsonarray of objects
  Show application/json properties

  • opstring

    Required

    The operation to be performed

    Can be one of: "replace"

  • pathstring

    Required

    A JSON Patch document as defined in http://tools.ietf.org/html/rfc6902

    Can be one of: "/name""/tags""/ownerId""/enabled""/description""/scheduleOptions""/templates""/recipients""/recipient""/sharePointFolder""/dataConnectionID""/transportChannels"

  • valueobject

    The value to be used for this operation.

• application/jsonobject
  Show application/json properties

  • errorsarray of objects
  • traceIdstring

• application/jsonobject
  Show application/json properties

  • errorsarray of objects
  • traceIdstring

• application/jsonobject
  Show application/json properties

  • errorsarray of objects
  • traceIdstring

• application/jsonobject
  Show application/json properties

  • errorsarray of objects
  • traceIdstring

• application/jsonobject
  Show application/json properties

  • errorsarray of objects
  • traceIdstring

• application/jsonobject
  Show application/json properties

  • errorsarray of objects
  • traceIdstring

• application/jsonobject
  Show application/json properties

  • errorsarray of objects
  • traceIdstring

• application/jsonobject
  Show application/json properties

  • errorsarray of objects
  • traceIdstring

• application/jsonobject
  Show application/json properties

  • errorsarray of objects
  • traceIdstring

• application/jsonobject
  Show application/json properties

  • errorsarray of objects
  • traceIdstring