Sharing tasks

Download OpenAPI spec

For scheduled capabilities such as reports, data alerts, subscriptions, and more, sharing tasks defines when these tasks execute, and tie together the resource definition with any conditions on execution.

Deprecation notice

The reporting template subscription toggle (enable-reporting-template-subscription) is deprecated and will be removed on or after April 28, 2026. After removal, template reporting access will be controlled exclusively by permissions. Since the permission was enabled by default for all users, most users will experience no functional change. If you manage this tenant setting programmatically, update your API calls to remove any enable-reporting-template-subscription toggle configuration.

For more information, see Setting permissions for metered reporting features on Qlik Help.

List sharing tasks

Retrieves all sharing tasks accessible to the user. Users assigned the TenantAdmin or AnalyticsAdmin role can view all tasks.

Facts

Rate limit Tier 1 (1000 requests per minute)

Query Parameters

  • appid string

    the filter by sharing task resource app id. TenantAdmin users may omit this parameter to list all sharing-tasks in the tenant.

  • excludeDeleting boolean

    Indicates if task with the status DELETING should be excluded from the list

    default = false

  • limit integer

    Limit the returned result set

    minimum = 1, maximum = 100, default = 20, default = 20

  • offset integer

    Offset for finding a list of entities - used for pagination

    minimum = 0, default = 0, default = 0

  • owner string

    the filter by sharing task resource owner id.

  • ownername string

    the filter by sharing task resource owner name.

  • page string

    The cursor to the page of data.

  • role array of strings

    the filter by sharing task resource role.

    Values may be any of: "owner""recipient"

  • sort array of strings

    Sort the returned result set by the specified field

    Values may be any of: "-datecreated""datecreated""+datecreated""-name""name""+name""-ownername""ownername""+ownername""-enabled""enabled""+enabled""-status""status""+status""-type""type""+type""-sent""sent""+sent""-scheduled""scheduled""+scheduled""-appname""appname""+appname""-appid""appid""+appid"

  • templateId array of strings

    array of template ids to filter by

  • type array of strings

    the filter by sharing task resource type. If type is template-sharing only and user is not tenant admin, appid is also required.

    Values may be any of: "chart-monitoring""chart-sharing""sheet-sharing""template-sharing"

  • next string Deprecated

    The cursor to the next page of data. Only one of next or previous may be specified.

  • prev string Deprecated

    The cursor to the previous page of data. Only one of next or previous may be specified.

Responses

200

The sharing task list has been successfully returned.

  • application/json object

    properties that should be added to every list response

    Show application/json properties
    • totalCount integer
      Required

      total count of entries in the collection as a whole

    • currentPageCount integer
      Required

      count of entries on the currently shown page

    • links object
      Show links properties
      • next object
        Show next properties
        • href string

          URL to particular set of elements

        • type string

          Page type, can be next or prev

          Can be one of: "prev""next"

        • token string

          Page unique token
      • prev object
        Show prev properties
        • href string

          URL to particular set of elements

        • type string

          Page type, can be next or prev

          Can be one of: "prev""next"

        • token string

          Page unique token
      • self object

        Object with Href to a particular element or set of elements

        Show self properties
        • href string
    • recipients object

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

      Show recipients properties
      • DLUsers array
      • userIds array of objects

        an internal recipient based on its user id.

        Show userIds properties
        • value string

          User ID of recipient (internal user).

        • groups array of strings

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

        • enabled boolean

          Whether this recipient can receive alerts.

        • subscribed boolean

          Whether this recipient is subscribed to alerts of a task

        • taskRecipientErrors array of objects
          Show taskRecipientErrors properties
          • value string

            Identifier for type of error occurring on sharing task specific for recipient

            Can be one of: "USER_IS_DELETED""USER_DISABLED_IN_QCS""NO_ACCESS_TO_APP""UNSUBSCRIBED_FROM_SHARING""USER_DISABLED_IN_SHARING_BY_OWNER""CHART_NOT_FOUND""APP_NOT_FOUND""SHEET_NOT_FOUND""ENGINE_POD_NOT_AVAILABLE""CHART_TYPE_NOT_ALLOWED""GENERIC_EXECUTION_FAILURE""USER_NOT_FOUND_DL""USER_DISABLED_IN_DL""FILTER_NOT_FOUND""BOOKMARK_NOT_FOUND"

          • timestamp string

            Timestamp for the creation of the error
        • alertingTaskRecipientErrors array of objects
          Show alertingTaskRecipientErrors properties
          • added string

            Timestamp for the creation of the error

          • value string

            Identifier for type of error occurring on alerting task

            Can be one of: "USER_IS_DELETED""USER_DISABLED_IN_QCS""NO_ACCESS_TO_APP""UNSUBSCRIBED_FROM_ALERT""CONDITION_EVAL_ERROR""USER_DISABLED_IN_ALERT_BY_OWNER""MAX_ALERTS_LIMIT_REACHED"

      • DLGroups array
      • emailAddresses array of strings

        Email of recipient (external user).
    • sharingTasks array of objects

      Gets a list of recurring sharing tasks.

      Show sharingTasks properties
      • id string

        Gets the sharing task resource identifier.

      • name string

        Name of this sharing task

      • tags array of strings
      • type string

        The sharing task resource type

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

      • appId string

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

      • owner string

        User id of owner of the sharing task

      • state object

        State of the selections and jsOpts

        Show state properties
        • fields array of objects

          Selected fields that led to discovery of monitored Insight Advisor chart

        • queryItems array of objects

          Query that led to discovery of monitored Insight Advisor chart

        • selections array of objects
          Show selections properties
          • name string
            Required

            Name of the field the selection applies to.

          • values array of strings
            Required

            A selected value for the field.

          • isNumeric boolean
            Required

            Whether the selected values are numeric.

          • stateName string
            Required

            Name of the selection state the values belong to.

          • displayName string

            Human-readable name of the field the selection applies to.

          • displayValues array of strings

            A human-readable selected value for the field.
      • tenant string

        Tenant of the sharing task

      • appName string

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

      • lastRun string

        The last execution start date time timestamp of the task

      • message string

        Message along with sharing task

        maxLength = 280

      • spaceId string

        spaceId of the app associated to this task definition

      • subType string Deprecated

        Mashup subType of sharing task

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

      • trigger object
        Show trigger properties
        • recurrence array 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.

        • chronosJobID string

          The chronosJobId which triggers the sharing task

        • executeOnAppReload boolean

          Toggle for executing sharing task on app reload.

          default = true

        • executionHistoryInterval string

          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"

      • createdBy string

        ID of creator

      • insightID string

        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)

      • ownerName string

        User name of owner of the sharing task

      • startTime string

        Time to start capturing the history

      • templates array of objects

        Depending on the value of type, sharing service will internally validate a specific property regarding its data. Type "file" validates property "fileData", type "chart" validates property "chartData", type "story" validates property "storyData". Check description of each of the models for their required properties.

        Show templates properties
        • type string
          Required

          The type of template used to generate the report output.

          Can be one of: "file""chart""story""sheet""multi-sheet""excel""pixel-perfect""html""powerpoint""word"

        • subType string

          The output sub-type produced for the template.

          Can be one of: "image""snapshot""pdf""pptx""xlsx""qpxp""qhtml""docx"

          default = "image"

        • fileName string

          fileName to be used when generating the report

        • chartData object

          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
          • appId string

            ID of app

          • jsOpts object

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

          • outDpi integer

            outDpi of chart

          • outZoom number

            outZoom of chart

          • patches array of objects

            Soft property changes on chart

          • sheetId string

            sheetId of app

          • widthPx integer

            widthPx of chart

          • heightPx integer

            heightPx of chart

          • objectId string

            ID of object

          • objectDef object

            Session chart object definition

          • persistentBookmarkIncludeVariables boolean

            Flag to configure the persistent bookmark to use variables.
        • fileAlias string

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

        • sheetData object Deprecated
          Show sheetData properties
          • appId string

            ID of app

          • jsOpts object

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

          • sheetId string

            ID of sheet

          • widthPx integer

            widthPx of chart

          • heightPx integer

            heightPx of chart

          • isPrivate boolean Deprecated

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

          • sheetName string Deprecated

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

          • jsOptsById object

            Map of Qlik Sense object id to rendering options applied when generating the report.

            Show additional optional properties
            • object object

              Visualizations state from client as a string json value. Can include language, theme, viewState etc.
          • patchesById object

            Map of Qlik Sense object id to patches applied when generating the report.

            Show additional optional properties
            • object[] array of objects

              Soft property changes on charts
        • storyData object
          Show storyData properties
          • appId string

            ID of app

          • storyId string

            ID of story
        • templateId string Deprecated

          ID of unique template

        • fileTimeStamp string

          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"

        • multiSheetData array of objects

          array of sheet data for multi-sheet type template

          Show multiSheetData properties
          • appId string

            ID of app

          • jsOpts object

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

          • sheetId string

            ID of sheet

          • widthPx integer

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

          • heightPx integer

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

          • isPrivate boolean

            optional value to indicate that this sheet is private

          • sheetName string

            an optional name for the sheet

          • jsOptsById object

            Map of Qlik Sense object id to rendering options applied when generating the report.

            Show additional optional properties
            • object object

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

            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"

          • patchesById object

            Map of Qlik Sense object id to patches applied when generating the report.

            Show additional optional properties
            • object[] array of objects

              Soft property changes on charts
          • persistentBookmarkIncludeVariables boolean

            Flag to configure the persistent bookmark to use variables
      • thumbnail string
      • updatedBy string

        ID of a user that updated this task last

      • expiration string

        Time for the termination of the task

      • lastViewed string

        Timestamp of the most recent view by the user.

      • recipients object

        List of persisted recipients.

        Show recipients properties
        • DLUsers array
        • userIds array of objects

          recipient object model that is directly persisted in the DB

          Show userIds properties
          • value string

            User ID of recipient (internal user).

          • groups array of strings

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

          • subscribed boolean

            Whether this user is subscribed to alerts in this task

          • enabledByUser boolean

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

          • enabledBySystem boolean

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

          • taskRecipientErrors array of objects
            Show taskRecipientErrors properties
            • value string

              Identifier for type of error occurring on sharing task specific for recipient

              Can be one of: "USER_IS_DELETED""USER_DISABLED_IN_QCS""NO_ACCESS_TO_APP""UNSUBSCRIBED_FROM_SHARING""USER_DISABLED_IN_SHARING_BY_OWNER""CHART_NOT_FOUND""APP_NOT_FOUND""SHEET_NOT_FOUND""ENGINE_POD_NOT_AVAILABLE""CHART_TYPE_NOT_ALLOWED""GENERIC_EXECUTION_FAILURE""USER_NOT_FOUND_DL""USER_DISABLED_IN_DL""FILTER_NOT_FOUND""BOOKMARK_NOT_FOUND"

            • timestamp string

              Timestamp for the creation of the error
          • alertingTaskRecipientErrors array of objects
            Show alertingTaskRecipientErrors properties
            • added string

              Timestamp for the creation of the error

            • value string

              Identifier for type of error occurring on alerting task

              Can be one of: "USER_IS_DELETED""USER_DISABLED_IN_QCS""NO_ACCESS_TO_APP""UNSUBSCRIBED_FROM_ALERT""CONDITION_EVAL_ERROR""USER_DISABLED_IN_ALERT_BY_OWNER""MAX_ALERTS_LIMIT_REACHED"

        • DLGroups array
        • groupIds array of objects

          recipient object model that is directly persisted in the DB

          Show groupIds properties
          • value string

            Group ID of recipient.

          • enabledByUser boolean

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

          • enabledBySystem boolean

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

          • taskGroupRecipientErrors array of objects
            Show taskGroupRecipientErrors properties
            • value string

              Identifier for type of error occurring on sharing task specific for group recipient

              Can be one of: "GROUP_IS_DISABLED""MAX_ALERTS_LIMIT_REACHED""GROUP_WITH_NO_APP_ACCESS""GROUP_IS_DELETED""GROUP_NOT_FOUND_DL""GROUP_DISABLED_IN_DL"

            • timestamp string

              Timestamp for the creation of the error
          • alertingTaskGroupRecipientErrors array of objects
            Show alertingTaskGroupRecipientErrors properties
            • added string

              Timestamp for the creation of the error

            • value string

              Identifier for type of error occurring on alerting task

              Can be one of: "GROUP_IS_DISABLED""MAX_ALERTS_LIMIT_REACHED""GROUP_WITH_NO_APP_ACCESS""GROUP_IS_DELETED"

        • emailAddresses array of objects

          recipient object model that is directly persisted in the DB

          Show emailAddresses properties
          • value string

            Email of recipient (external user).

            format = "email"

          • enabled boolean

            Whether this recipient can receive alerts.

          • taskRecipientErrors array of objects
            Show taskRecipientErrors properties
            • value string

              Identifier for type of error occurring on sharing task specific for recipient

              Can be one of: "USER_IS_DELETED""USER_DISABLED_IN_QCS""NO_ACCESS_TO_APP""UNSUBSCRIBED_FROM_SHARING""USER_DISABLED_IN_SHARING_BY_OWNER""CHART_NOT_FOUND""APP_NOT_FOUND""SHEET_NOT_FOUND""ENGINE_POD_NOT_AVAILABLE""CHART_TYPE_NOT_ALLOWED""GENERIC_EXECUTION_FAILURE""USER_NOT_FOUND_DL""USER_DISABLED_IN_DL""FILTER_NOT_FOUND""BOOKMARK_NOT_FOUND"

            • timestamp string

              Timestamp for the creation of the error
        • netRecipientCount integer

          Net count of recipients in DLGroups and DLUsers.
      • statusCode string

        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""REPORTING_DAILY_QUOTA_EXCEEDED""WARNING"

      • taskErrors array of objects
        Show taskErrors properties
        • value string

          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""MISSING_DISTRIBUTION_LIST""SECTION_ACCESS_NOT_SUPPORTED""REPORTING_DAILY_QUOTA_EXCEEDED""EMAIL_DELIVERY_FAILURE"

        • timestamp string

          Timestamp for the creation of the error
      • templateId string Deprecated

        ID of unique template

      • dateCreated string

        Timestamp for the creation of the task

      • description string

        A description of this sharing task

      • lastUpdated string

        Timestamp of the most recent update.

      • statusLabel string

        error message indicating the underlying failure

      • emailContent object
        Show emailContent properties
        • body string

          Body content of the email sent to recipients.

        • subject string

          Subject line of the email sent to recipients.
      • enabledByUser boolean

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

      • encryptedState object

        Encrypted property in DB

        Show encryptedState properties
        • value any
        • cipher string
      • byokMigrationId string

        internal identifier used when migrating keys

      • enabledBySystem boolean

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

      • retentionPolicy object
        Show retentionPolicy properties
        • historySize integer

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

        • overrideInterval string

          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"

      • scheduleOptions object
        Show scheduleOptions properties
        • timezone string

          The timezone for time calculations in SCHEDULED triggers, optional.

        • recurrence array 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.

        • endDateTime string

          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 = ""

        • chronosJobID string

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

        • startDateTime string

          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.

        • lastExecutionTime string

          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.

        • nextExecutionTime string

          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.
      • selectionErrors object

        reporting service returns rendering errors for missing selections

      • dataConnectionID string

        the id of the data connection

      • hasSectionAccess boolean

        true if the associated app has section access enabled

      • insightDirectURL string

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

      • multiInsightURLs array 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
        • status string

          the status of the creation for this insight URL

          Can be one of: "successful""failed"

        • directURL string
        • insightID string
        • resourceID string

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

        • templateID string Deprecated

          an identifier for the template that this insight link points to

        • fallbackURL string
      • nextScheduledRun string

        Time for the next scheduled run

      • reportProperties object
      • sharePointFolder string

        the SharePoint folder to upload the report to

      • executeOnCreation boolean

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

      • lastExecutionDate string

        The last execution end date time timestamp of the task

      • transportChannels array of strings

        the transport type for the report

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

      • distributionListId string

        the id of the distribution list associated to the app

      • encryptedTemplates object

        Encrypted property in DB

        Show encryptedTemplates properties
        • value any
        • cipher string
      • insightFallbackURL string

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

      • encryptedEmailContent object

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

        Show encryptedEmailContent properties
        • body object

          Encrypted property in DB

          Show body properties
          • value any
          • cipher string
        • subject object

          Encrypted property in DB

          Show subject properties
          • value any
          • cipher string
      • failedExecutionsCount integer

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

      • failedVerificationsCount integer

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

      • isCandidateForVerification boolean

        true if the sharing task is a candidate for verification

      • persistentBookmarkIncludeVariables boolean Deprecated

        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.

      • links object
        Show links properties
        • self object

          Object with Href to a particular element or set of elements

          Show self properties
          • href string
      • enabled boolean

        true if the sharing task is enabled

      • latestExecutionURL string

        URL to querying the latest execution tied to this sharing task

      • latestExecutionFilesURL array of strings

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

400

Bad request, malformed syntax or errors in parameters.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string

        Error code specific to sharing service.

      • meta object
        Show meta properties
        • httpCode integer

          HTTP error code.
      • title string

        Error title.

      • detail string

        Error cause.
    • traceId string

500

Internal server error.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string

        Error code specific to sharing service.

      • meta object
        Show meta properties
        • httpCode integer

          HTTP error code.
      • title string

        Error title.

      • detail string

        Error cause.
    • traceId string

default

Error response.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string

        Error code specific to sharing service.

      • meta object
        Show meta properties
        • httpCode integer

          HTTP error code.
      • title string

        Error title.

      • detail string

        Error cause.
    • traceId string
GET /api/v1/sharing-tasks 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.sharingTasks.getSharingTasks({})
qlik sharing-task ls
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/sharing-tasks" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "totalCount": 42,
  "currentPageCount": 42,
  "links": {
    "next": {
      "href": "http://localhost:8787/v1/items?limit=12",
      "type": "next",
      "token": "JwAAAAJfaWQAGQAAADVjZjUwM2NjMjVkYzlhMTM1MzYwZTVjZAAA"
    },
    "prev": {
      "href": "http://localhost:8787/v1/items?limit=12",
      "type": "next",
      "token": "JwAAAAJfaWQAGQAAADVjZjUwM2NjMjVkYzlhMTM1MzYwZTVjZAAA"
    },
    "self": {
      "href": "http://localhost:8787/v1/items/5da5825325dc9a0dd0260af9"
    }
  },
  "recipients": {
    "DLUsers": [],
    "userIds": [
      {
        "value": "1b263bs8m0mm_s21s3f",
        "groups": [
          "addedIndividually",
          "group1",
          "group2"
        ],
        "enabled": true,
        "subscribed": true,
        "taskRecipientErrors": [
          {
            "value": "NO_ACCESS_TO_APP",
            "timestamp": "2019-10-15T16:07:01.492Z"
          }
        ],
        "alertingTaskRecipientErrors": [
          {
            "added": "2019-10-15T16:07:01.492Z",
            "value": "NO_ACCESS_TO_APP"
          }
        ]
      }
    ],
    "DLGroups": [],
    "emailAddresses": [
      "abc@xyz.com"
    ]
  },
  "sharingTasks": [
    {
      "id": "string",
      "name": "string",
      "tags": [
        "string"
      ],
      "type": "chart-monitoring",
      "appId": "string",
      "owner": "pXVNKqotgEMwbKwhz2agPE4yFelnPcWO",
      "state": {
        "fields": [
          {}
        ],
        "queryItems": [
          {}
        ],
        "selections": [
          {
            "name": "Country",
            "values": [
              "Germany"
            ],
            "isNumeric": false,
            "stateName": "$",
            "displayName": "Country",
            "displayValues": [
              "Germany"
            ]
          }
        ]
      },
      "tenant": "_mpoXaH22_vLR1pStfI7oUdGya1nKK24",
      "appName": "string",
      "lastRun": "2019-10-15T16:07:01.492Z",
      "message": "Look at the presentation.",
      "spaceId": "string",
      "subType": "pdf",
      "trigger": {
        "recurrence": [
          "RRULE:FREQ=WEEKLY;INTERVAL=1"
        ],
        "chronosJobID": "chronos-job-123",
        "executeOnAppReload": true,
        "executionHistoryInterval": "daily"
      },
      "createdBy": "string",
      "insightID": "string",
      "ownerName": "Harley Kiffe",
      "startTime": "2019-10-15T16:07:01.492Z",
      "templates": [
        {
          "type": "file",
          "subType": "image",
          "fileName": "sales-report",
          "chartData": {
            "appId": "bdf2efee-815e-4eb7-9e1e-c42d516baf29",
            "jsOpts": {},
            "outDpi": 96,
            "outZoom": 1,
            "patches": [
              {}
            ],
            "sheetId": "bdf2efee-815e-4eb7-9e1e-asdfasdfasdf",
            "widthPx": 1584,
            "heightPx": 587,
            "objectId": "167f3e67-ff3b-4ead-a09e-e8cc81d8ad78",
            "objectDef": {},
            "persistentBookmarkIncludeVariables": true
          },
          "fileAlias": "file1",
          "sheetData": {
            "appId": "bdf2efee-815e-4eb7-9e1e-c42d516baf29",
            "jsOpts": {},
            "sheetId": "39a671a-5f58-468c-bb49-dff933294774",
            "widthPx": 1584,
            "heightPx": 587,
            "isPrivate": false,
            "sheetName": "My new sheet",
            "jsOptsById": {},
            "patchesById": {}
          },
          "storyData": {
            "appId": "bdf2efee-815e-4eb7-9e1e-c42d516baf29",
            "storyId": "39a671a-5f58-468c-bb49-dff933294774"
          },
          "templateId": "da5825325dc9a0dd0260af9",
          "fileTimeStamp": "yyyy-MM-dd",
          "multiSheetData": [
            {
              "appId": "bdf2efee-815e-4eb7-9e1e-c42d516baf29",
              "jsOpts": {},
              "sheetId": "39a671a-5f58-468c-bb49-dff933294774",
              "widthPx": 1584,
              "heightPx": 587,
              "isPrivate": false,
              "sheetName": "My new sheet",
              "jsOptsById": {},
              "resizeType": "none",
              "patchesById": {},
              "persistentBookmarkIncludeVariables": true
            }
          ]
        }
      ],
      "thumbnail": "string",
      "updatedBy": "string",
      "expiration": "2019-10-15T16:07:01.492Z",
      "lastViewed": "2019-10-15T16:07:01.492Z",
      "recipients": {
        "DLUsers": [],
        "userIds": [
          {
            "value": "1b263bs8m0mm_s21s3f",
            "groups": [
              "addedIndividually",
              "group1",
              "group2"
            ],
            "subscribed": true,
            "enabledByUser": true,
            "enabledBySystem": true,
            "taskRecipientErrors": [
              {
                "value": "NO_ACCESS_TO_APP",
                "timestamp": "2019-10-15T16:07:01.492Z"
              }
            ],
            "alertingTaskRecipientErrors": [
              {
                "added": "2019-10-15T16:07:01.492Z",
                "value": "NO_ACCESS_TO_APP"
              }
            ]
          }
        ],
        "DLGroups": [],
        "groupIds": [
          {
            "value": "group1",
            "enabledByUser": true,
            "enabledBySystem": true,
            "taskGroupRecipientErrors": [
              {
                "value": "GROUP_WITH_NO_APP_ACCESS",
                "timestamp": "2019-10-15T16:07:01.492Z"
              }
            ],
            "alertingTaskGroupRecipientErrors": [
              {
                "added": "2019-10-15T16:07:01.492Z",
                "value": "GROUP_WITH_NO_APP_ACCESS"
              }
            ]
          }
        ],
        "emailAddresses": [
          {
            "value": "abc@xyz.com",
            "enabled": true,
            "taskRecipientErrors": [
              {
                "value": "NO_ACCESS_TO_APP",
                "timestamp": "2019-10-15T16:07:01.492Z"
              }
            ]
          }
        ],
        "netRecipientCount": 10
      },
      "statusCode": "CHART_NOT_FOUND",
      "taskErrors": [
        {
          "value": "OWNER_DISABLED",
          "timestamp": "2019-10-15T16:07:01.492Z"
        }
      ],
      "templateId": "da5825325dc9a0dd0260af9",
      "dateCreated": "2019-10-15T16:07:01.492Z",
      "description": "string",
      "lastUpdated": "2019-10-15T16:07:01.492Z",
      "statusLabel": "string",
      "emailContent": {
        "body": "report body string",
        "subject": "report subject"
      },
      "enabledByUser": true,
      "encryptedState": {
        "cipher": "string"
      },
      "byokMigrationId": "string",
      "enabledBySystem": true,
      "retentionPolicy": {
        "historySize": 10,
        "overrideInterval": "FREQ=DAILY;INTERVAL=1"
      },
      "scheduleOptions": {
        "timezone": "Canada/Pacific",
        "recurrence": [
          "RRULE:FREQ=HOURLY;INTERVAL=2"
        ],
        "endDateTime": "",
        "chronosJobID": "chronos-job-123",
        "startDateTime": "2006-01-02T16:04:05",
        "lastExecutionTime": "2020-11-20T12:00:55.000Z",
        "nextExecutionTime": "2020-11-20T12:00:55.000Z"
      },
      "selectionErrors": {},
      "dataConnectionID": "string",
      "hasSectionAccess": true,
      "insightDirectURL": "string",
      "multiInsightURLs": [
        {
          "status": "successful",
          "directURL": "string",
          "insightID": "string",
          "resourceID": "string",
          "templateID": "string",
          "fallbackURL": "string"
        }
      ],
      "nextScheduledRun": "2019-10-15T16:07:01.492Z",
      "reportProperties": {},
      "sharePointFolder": "string",
      "executeOnCreation": true,
      "lastExecutionDate": "2019-10-15T16:09:01.492Z",
      "transportChannels": [
        "email"
      ],
      "distributionListId": "vXVNKqotgEMwbKwhz2agPE4yFelnPcWX",
      "encryptedTemplates": {
        "cipher": "string"
      },
      "insightFallbackURL": "string",
      "encryptedEmailContent": {
        "body": {
          "cipher": "string"
        },
        "subject": {
          "cipher": "string"
        }
      },
      "failedExecutionsCount": 42,
      "failedVerificationsCount": 42,
      "isCandidateForVerification": true,
      "persistentBookmarkIncludeVariables": true,
      "links": {
        "self": {
          "href": "http://localhost:8787/v1/items/5da5825325dc9a0dd0260af9"
        }
      },
      "enabled": true,
      "latestExecutionURL": "string",
      "latestExecutionFilesURL": [
        "string"
      ]
    }
  ]
}

Create sharing task

Creates a new recurring sharing task.

Facts

Rate limit Tier 2 (100 requests per minute)

Request Body

Required

The sharing task create request definition.

  • application/json object
    Show application/json properties
    • name string
      Required

      Name of this sharing task

      minLength = 1

    • tags array of strings

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

    • type string
      Required

      the sharing task resource type.

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

    • state object
      Required

      State of the selections and jsOpts

      Show state properties
      • fields array of objects

        Selected fields that led to discovery of monitored Insight Advisor chart

      • queryItems array of objects

        Query that led to discovery of monitored Insight Advisor chart

      • selections array of objects
        Show selections properties
        • name string
          Required

          Name of the field the selection applies to.

        • values array of strings
          Required

          A selected value for the field.

        • isNumeric boolean
          Required

          Whether the selected values are numeric.

        • stateName string
          Required

          Name of the selection state the values belong to.

        • displayName string

          Human-readable name of the field the selection applies to.

        • displayValues array of strings

          A human-readable selected value for the field.
    • appName string Deprecated

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

      minLength = 1

    • enabled boolean

      Toggle for enabling sharing task.

      default = true

    • message string

      Message along with sharing task

      maxLength = 280

    • spaceId string

      Space ID of the sharing task

      maxLength = 255

    • subType string Deprecated

      the sharing task resource mashup sub type.

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

    • trigger object
      Show trigger properties
      • recurrence array 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.

      • executeOnAppReload boolean

        Toggle for executing sharing task on app reload.

        default = true

      • executionHistoryInterval string

        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"

    • startTime string

      Time to start capturing the history

    • templates array of objects
      Required

      Templates associated with the sharing task

      Show templates properties
      • type string
        Required

        The type of template used to generate the report output.

        Can be one of: "file""chart""story""sheet""multi-sheet""excel""pixel-perfect""html""powerpoint""word"

      • subType string

        The output sub-type produced for the template.

        Can be one of: "image""snapshot""pdf""pptx""xlsx""qpxp""qhtml""docx"

        default = "image"

      • fileName string

        fileName to be used when generating the report

      • chartData object

        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
        • appId string

          ID of app

        • jsOpts object

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

        • outDpi integer

          outDpi of chart

        • outZoom number

          outZoom of chart

        • patches array of objects

          Soft property changes on chart

        • sheetId string

          sheetId of app

        • widthPx integer

          widthPx of chart

        • heightPx integer

          heightPx of chart

        • objectId string

          ID of object

        • objectDef object

          Session chart object definition

        • persistentBookmarkIncludeVariables boolean

          Flag to configure the persistent bookmark to use variables.
      • fileAlias string

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

      • sheetData object Deprecated
        Show sheetData properties
        • appId string

          ID of app

        • jsOpts object

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

        • sheetId string

          ID of sheet

        • widthPx integer

          widthPx of chart

        • heightPx integer

          heightPx of chart

        • isPrivate boolean Deprecated

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

        • sheetName string Deprecated

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

        • jsOptsById object

          Map of Qlik Sense object id to rendering options applied when generating the report.

          Show additional optional properties
          • object object

            Visualizations state from client as a string json value. Can include language, theme, viewState etc.
        • patchesById object

          Map of Qlik Sense object id to patches applied when generating the report.

          Show additional optional properties
          • object[] array of objects

            Soft property changes on charts
      • storyData object
        Show storyData properties
        • appId string

          ID of app

        • storyId string

          ID of story
      • templateId string Deprecated

        ID of unique template

      • fileTimeStamp string

        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"

      • multiSheetData array of objects

        array of sheet data for multi-sheet type template

        Show multiSheetData properties
        • appId string

          ID of app

        • jsOpts object

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

        • sheetId string

          ID of sheet

        • widthPx integer

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

        • heightPx integer

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

        • isPrivate boolean

          optional value to indicate that this sheet is private

        • sheetName string

          an optional name for the sheet

        • jsOptsById object

          Map of Qlik Sense object id to rendering options applied when generating the report.

          Show additional optional properties
          • object object

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

          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"

        • patchesById object

          Map of Qlik Sense object id to patches applied when generating the report.

          Show additional optional properties
          • object[] array of objects

            Soft property changes on charts
        • persistentBookmarkIncludeVariables boolean

          Flag to configure the persistent bookmark to use variables
    • expiration string

      Timestamp for the termination of the task

    • recipients object

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

      Show recipients properties
      • DLUsers array
      • userIds array of objects

        an internal recipient based on its user id.

        Show userIds properties
        • value string

          User ID of recipient (internal user).

        • groups array of strings

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

        • enabled boolean

          Whether this recipient can receive alerts.

        • subscribed boolean

          Whether this recipient is subscribed to alerts of a task

        • taskRecipientErrors array of objects
          Show taskRecipientErrors properties
          • value string

            Identifier for type of error occurring on sharing task specific for recipient

            Can be one of: "USER_IS_DELETED""USER_DISABLED_IN_QCS""NO_ACCESS_TO_APP""UNSUBSCRIBED_FROM_SHARING""USER_DISABLED_IN_SHARING_BY_OWNER""CHART_NOT_FOUND""APP_NOT_FOUND""SHEET_NOT_FOUND""ENGINE_POD_NOT_AVAILABLE""CHART_TYPE_NOT_ALLOWED""GENERIC_EXECUTION_FAILURE""USER_NOT_FOUND_DL""USER_DISABLED_IN_DL""FILTER_NOT_FOUND""BOOKMARK_NOT_FOUND"

          • timestamp string

            Timestamp for the creation of the error
        • alertingTaskRecipientErrors array of objects
          Show alertingTaskRecipientErrors properties
          • added string

            Timestamp for the creation of the error

          • value string

            Identifier for type of error occurring on alerting task

            Can be one of: "USER_IS_DELETED""USER_DISABLED_IN_QCS""NO_ACCESS_TO_APP""UNSUBSCRIBED_FROM_ALERT""CONDITION_EVAL_ERROR""USER_DISABLED_IN_ALERT_BY_OWNER""MAX_ALERTS_LIMIT_REACHED"

      • DLGroups array
      • emailAddresses array of strings

        Email of recipient (external user).
    • description string

      Description of the sharing task

      maxLength = 255

    • emailContent object
      Show emailContent properties
      • body string

        Body content of the email sent to recipients.

      • subject string

        Subject line of the email sent to recipients.
    • cleanupStrategy string

      A bookmark is considered old if its modification date is older than the app creation date.

      Can be one of: "noCleanup""removeOldBookmarks"

      default = "noCleanup"

    • retentionPolicy object
      Show retentionPolicy properties
      • historySize integer

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

      • overrideInterval string

        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"

    • scheduleOptions object
      Show scheduleOptions properties
      • timezone string

        The timezone for time calculations in SCHEDULED triggers, optional.

      • recurrence array 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.

      • endDateTime string

        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 = ""

      • startDateTime string

        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.
    • dataConnectionID string

      the id of the data connection

    • sharePointFolder string

      the SharePoint folder to upload the report to

    • executeOnCreation boolean

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

      default = true

    • transportChannels array of strings

      the transport type for the report

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

    • distributionListId string

      the id of the distribution list associated to the app

Responses

201

The sharing task has been successfully created.

  • application/json object

    Whatever is persisted in the db + links

    Show application/json properties
    • id string

      Gets the sharing task resource identifier.

    • name string

      Name of this sharing task

    • tags array of strings
    • type string

      The sharing task resource type

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

    • appId string

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

    • owner string

      User id of owner of the sharing task

    • state object

      State of the selections and jsOpts

      Show state properties
      • fields array of objects

        Selected fields that led to discovery of monitored Insight Advisor chart

      • queryItems array of objects

        Query that led to discovery of monitored Insight Advisor chart

      • selections array of objects
        Show selections properties
        • name string
          Required

          Name of the field the selection applies to.

        • values array of strings
          Required

          A selected value for the field.

        • isNumeric boolean
          Required

          Whether the selected values are numeric.

        • stateName string
          Required

          Name of the selection state the values belong to.

        • displayName string

          Human-readable name of the field the selection applies to.

        • displayValues array of strings

          A human-readable selected value for the field.
    • tenant string

      Tenant of the sharing task

    • appName string

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

    • lastRun string

      The last execution start date time timestamp of the task

    • message string

      Message along with sharing task

      maxLength = 280

    • spaceId string

      spaceId of the app associated to this task definition

    • subType string Deprecated

      Mashup subType of sharing task

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

    • trigger object
      Show trigger properties
      • recurrence array 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.

      • chronosJobID string

        The chronosJobId which triggers the sharing task

      • executeOnAppReload boolean

        Toggle for executing sharing task on app reload.

        default = true

      • executionHistoryInterval string

        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"

    • createdBy string

      ID of creator

    • insightID string

      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)

    • ownerName string

      User name of owner of the sharing task

    • startTime string

      Time to start capturing the history

    • templates array of objects

      Depending on the value of type, sharing service will internally validate a specific property regarding its data. Type "file" validates property "fileData", type "chart" validates property "chartData", type "story" validates property "storyData". Check description of each of the models for their required properties.

      Show templates properties
      • type string
        Required

        The type of template used to generate the report output.

        Can be one of: "file""chart""story""sheet""multi-sheet""excel""pixel-perfect""html""powerpoint""word"

      • subType string

        The output sub-type produced for the template.

        Can be one of: "image""snapshot""pdf""pptx""xlsx""qpxp""qhtml""docx"

        default = "image"

      • fileName string

        fileName to be used when generating the report

      • chartData object

        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
        • appId string

          ID of app

        • jsOpts object

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

        • outDpi integer

          outDpi of chart

        • outZoom number

          outZoom of chart

        • patches array of objects

          Soft property changes on chart

        • sheetId string

          sheetId of app

        • widthPx integer

          widthPx of chart

        • heightPx integer

          heightPx of chart

        • objectId string

          ID of object

        • objectDef object

          Session chart object definition

        • persistentBookmarkIncludeVariables boolean

          Flag to configure the persistent bookmark to use variables.
      • fileAlias string

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

      • sheetData object Deprecated
        Show sheetData properties
        • appId string

          ID of app

        • jsOpts object

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

        • sheetId string

          ID of sheet

        • widthPx integer

          widthPx of chart

        • heightPx integer

          heightPx of chart

        • isPrivate boolean Deprecated

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

        • sheetName string Deprecated

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

        • jsOptsById object

          Map of Qlik Sense object id to rendering options applied when generating the report.

          Show additional optional properties
          • object object

            Visualizations state from client as a string json value. Can include language, theme, viewState etc.
        • patchesById object

          Map of Qlik Sense object id to patches applied when generating the report.

          Show additional optional properties
          • object[] array of objects

            Soft property changes on charts
      • storyData object
        Show storyData properties
        • appId string

          ID of app

        • storyId string

          ID of story
      • templateId string Deprecated

        ID of unique template

      • fileTimeStamp string

        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"

      • multiSheetData array of objects

        array of sheet data for multi-sheet type template

        Show multiSheetData properties
        • appId string

          ID of app

        • jsOpts object

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

        • sheetId string

          ID of sheet

        • widthPx integer

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

        • heightPx integer

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

        • isPrivate boolean

          optional value to indicate that this sheet is private

        • sheetName string

          an optional name for the sheet

        • jsOptsById object

          Map of Qlik Sense object id to rendering options applied when generating the report.

          Show additional optional properties
          • object object

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

          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"

        • patchesById object

          Map of Qlik Sense object id to patches applied when generating the report.

          Show additional optional properties
          • object[] array of objects

            Soft property changes on charts
        • persistentBookmarkIncludeVariables boolean

          Flag to configure the persistent bookmark to use variables
    • thumbnail string
    • updatedBy string

      ID of a user that updated this task last

    • expiration string

      Time for the termination of the task

    • lastViewed string

      Timestamp of the most recent view by the user.

    • recipients object

      List of persisted recipients.

      Show recipients properties
      • DLUsers array
      • userIds array of objects

        recipient object model that is directly persisted in the DB

        Show userIds properties
        • value string

          User ID of recipient (internal user).

        • groups array of strings

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

        • subscribed boolean

          Whether this user is subscribed to alerts in this task

        • enabledByUser boolean

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

        • enabledBySystem boolean

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

        • taskRecipientErrors array of objects
          Show taskRecipientErrors properties
          • value string

            Identifier for type of error occurring on sharing task specific for recipient

            Can be one of: "USER_IS_DELETED""USER_DISABLED_IN_QCS""NO_ACCESS_TO_APP""UNSUBSCRIBED_FROM_SHARING""USER_DISABLED_IN_SHARING_BY_OWNER""CHART_NOT_FOUND""APP_NOT_FOUND""SHEET_NOT_FOUND""ENGINE_POD_NOT_AVAILABLE""CHART_TYPE_NOT_ALLOWED""GENERIC_EXECUTION_FAILURE""USER_NOT_FOUND_DL""USER_DISABLED_IN_DL""FILTER_NOT_FOUND""BOOKMARK_NOT_FOUND"

          • timestamp string

            Timestamp for the creation of the error
        • alertingTaskRecipientErrors array of objects
          Show alertingTaskRecipientErrors properties
          • added string

            Timestamp for the creation of the error

          • value string

            Identifier for type of error occurring on alerting task

            Can be one of: "USER_IS_DELETED""USER_DISABLED_IN_QCS""NO_ACCESS_TO_APP""UNSUBSCRIBED_FROM_ALERT""CONDITION_EVAL_ERROR""USER_DISABLED_IN_ALERT_BY_OWNER""MAX_ALERTS_LIMIT_REACHED"

      • DLGroups array
      • groupIds array of objects

        recipient object model that is directly persisted in the DB

        Show groupIds properties
        • value string

          Group ID of recipient.

        • enabledByUser boolean

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

        • enabledBySystem boolean

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

        • taskGroupRecipientErrors array of objects
          Show taskGroupRecipientErrors properties
          • value string

            Identifier for type of error occurring on sharing task specific for group recipient

            Can be one of: "GROUP_IS_DISABLED""MAX_ALERTS_LIMIT_REACHED""GROUP_WITH_NO_APP_ACCESS""GROUP_IS_DELETED""GROUP_NOT_FOUND_DL""GROUP_DISABLED_IN_DL"

          • timestamp string

            Timestamp for the creation of the error
        • alertingTaskGroupRecipientErrors array of objects
          Show alertingTaskGroupRecipientErrors properties
          • added string

            Timestamp for the creation of the error

          • value string

            Identifier for type of error occurring on alerting task

            Can be one of: "GROUP_IS_DISABLED""MAX_ALERTS_LIMIT_REACHED""GROUP_WITH_NO_APP_ACCESS""GROUP_IS_DELETED"

      • emailAddresses array of objects

        recipient object model that is directly persisted in the DB

        Show emailAddresses properties
        • value string

          Email of recipient (external user).

          format = "email"

        • enabled boolean

          Whether this recipient can receive alerts.

        • taskRecipientErrors array of objects
          Show taskRecipientErrors properties
          • value string

            Identifier for type of error occurring on sharing task specific for recipient

            Can be one of: "USER_IS_DELETED""USER_DISABLED_IN_QCS""NO_ACCESS_TO_APP""UNSUBSCRIBED_FROM_SHARING""USER_DISABLED_IN_SHARING_BY_OWNER""CHART_NOT_FOUND""APP_NOT_FOUND""SHEET_NOT_FOUND""ENGINE_POD_NOT_AVAILABLE""CHART_TYPE_NOT_ALLOWED""GENERIC_EXECUTION_FAILURE""USER_NOT_FOUND_DL""USER_DISABLED_IN_DL""FILTER_NOT_FOUND""BOOKMARK_NOT_FOUND"

          • timestamp string

            Timestamp for the creation of the error
      • netRecipientCount integer

        Net count of recipients in DLGroups and DLUsers.
    • statusCode string

      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""REPORTING_DAILY_QUOTA_EXCEEDED""WARNING"

    • taskErrors array of objects
      Show taskErrors properties
      • value string

        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""MISSING_DISTRIBUTION_LIST""SECTION_ACCESS_NOT_SUPPORTED""REPORTING_DAILY_QUOTA_EXCEEDED""EMAIL_DELIVERY_FAILURE"

      • timestamp string

        Timestamp for the creation of the error
    • templateId string Deprecated

      ID of unique template

    • dateCreated string

      Timestamp for the creation of the task

    • description string

      A description of this sharing task

    • lastUpdated string

      Timestamp of the most recent update.

    • statusLabel string

      error message indicating the underlying failure

    • emailContent object
      Show emailContent properties
      • body string

        Body content of the email sent to recipients.

      • subject string

        Subject line of the email sent to recipients.
    • enabledByUser boolean

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

    • encryptedState object

      Encrypted property in DB

      Show encryptedState properties
      • value any
      • cipher string
    • byokMigrationId string

      internal identifier used when migrating keys

    • enabledBySystem boolean

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

    • retentionPolicy object
      Show retentionPolicy properties
      • historySize integer

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

      • overrideInterval string

        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"

    • scheduleOptions object
      Show scheduleOptions properties
      • timezone string

        The timezone for time calculations in SCHEDULED triggers, optional.

      • recurrence array 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.

      • endDateTime string

        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 = ""

      • chronosJobID string

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

      • startDateTime string

        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.

      • lastExecutionTime string

        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.

      • nextExecutionTime string

        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.
    • selectionErrors object

      reporting service returns rendering errors for missing selections

    • dataConnectionID string

      the id of the data connection

    • hasSectionAccess boolean

      true if the associated app has section access enabled

    • insightDirectURL string

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

    • multiInsightURLs array 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
      • status string

        the status of the creation for this insight URL

        Can be one of: "successful""failed"

      • directURL string
      • insightID string
      • resourceID string

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

      • templateID string Deprecated

        an identifier for the template that this insight link points to

      • fallbackURL string
    • nextScheduledRun string

      Time for the next scheduled run

    • reportProperties object
    • sharePointFolder string

      the SharePoint folder to upload the report to

    • executeOnCreation boolean

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

    • lastExecutionDate string

      The last execution end date time timestamp of the task

    • transportChannels array of strings

      the transport type for the report

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

    • distributionListId string

      the id of the distribution list associated to the app

    • encryptedTemplates object

      Encrypted property in DB

      Show encryptedTemplates properties
      • value any
      • cipher string
    • insightFallbackURL string

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

    • encryptedEmailContent object

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

      Show encryptedEmailContent properties
      • body object

        Encrypted property in DB

        Show body properties
        • value any
        • cipher string
      • subject object

        Encrypted property in DB

        Show subject properties
        • value any
        • cipher string
    • failedExecutionsCount integer

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

    • failedVerificationsCount integer

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

    • isCandidateForVerification boolean

      true if the sharing task is a candidate for verification

    • persistentBookmarkIncludeVariables boolean Deprecated

      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.

    • links object
      Show links properties
      • self object

        Object with Href to a particular element or set of elements

        Show self properties
        • href string
    • enabled boolean

      true if the sharing task is enabled

    • latestExecutionURL string

      URL to querying the latest execution tied to this sharing task

    • latestExecutionFilesURL array of strings

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

400

Bad request, malformed syntax or errors in parameters.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string

        Error code specific to sharing service.

      • meta object
        Show meta properties
        • httpCode integer

          HTTP error code.
      • title string

        Error title.

      • detail string

        Error cause.
    • traceId string

500

Internal server error.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string

        Error code specific to sharing service.

      • meta object
        Show meta properties
        • httpCode integer

          HTTP error code.
      • title string

        Error title.

      • detail string

        Error cause.
    • traceId string

default

Error response.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string

        Error code specific to sharing service.

      • meta object
        Show meta properties
        • httpCode integer

          HTTP error code.
      • title string

        Error title.

      • detail string

        Error cause.
    • traceId string
POST /api/v1/sharing-tasks 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.sharingTasks.createSharingTask({
  appName: 'Sales Dashboard',
  cleanupStrategy: 'noCleanup',
  dataConnectionID: 'data-connection-123',
  description:
    'Weekly sales report subscription.',
  distributionListId:
    'mpoXaH22_vLR1pStfI7oUdGya1nKK24',
  emailContent: {
    body: 'report body string',
    subject: 'report subject',
  },
  enabled: true,
  executeOnCreation: true,
  expiration: '2019-10-15T16:07:01.492Z',
  message: 'Look at the presentation.',
  name: 'Example Sharing Task',
  recipients: {
    emailAddresses: ['abc@xyz.com'],
    userIds: [
      {
        alertingTaskRecipientErrors: [
          {
            added: '2019-10-15T16:07:01.492Z',
            value: 'NO_ACCESS_TO_APP',
          },
        ],
        enabled: true,
        groups: [
          'addedIndividually',


          'group1',


          'group2',
        ],
        subscribed: true,
        taskRecipientErrors: [
          {
            value: 'NO_ACCESS_TO_APP',
            timestamp: '2019-10-15T16:07:01.492Z',
          },
        ],
        value: '1b263bs8m0mm_s21s3f',
      },
    ],
  },
  retentionPolicy: {
    historySize: 10,
    overrideInterval: 'FREQ=DAILY;INTERVAL=1',
  },
  scheduleOptions: {
    recurrence: ['RRULE:FREQ=HOURLY;INTERVAL=2'],
    startDateTime: '2006-01-02T16:04:05',
    timezone: 'Canada/Pacific',
  },
  sharePointFolder: 'Shared Documents/Reports',
  spaceId: '5f7b1a2c3d4e5f6a7b8c9d0e',
  startTime: '2019-10-15T16:07:01.492Z',
  state: {
    fields: [{}],
    queryItems: [{}],
    selections: [
      {
        displayName: 'Country',
        displayValues: ['Germany'],
        name: 'Country',
        stateName: '$',
        values: ['Germany'],
      },
    ],
  },
  subType: 'pdf',
  tags: ['finance'],
  templates: [
    {
      chartData: {
        appId:
          'bdf2efee-815e-4eb7-9e1e-c42d516baf29',
        heightPx: 587,
        jsOpts: {},
        objectDef: {},
        objectId:
          '167f3e67-ff3b-4ead-a09e-e8cc81d8ad78',
        outDpi: 96,
        outZoom: 1,
        patches: [{}],
        persistentBookmarkIncludeVariables: true,
        sheetId:
          'bdf2efee-815e-4eb7-9e1e-asdfasdfasdf',
        widthPx: 1584,
      },
      fileAlias: 'file1',
      fileName: 'sales-report',
      fileTimeStamp: 'yyyy-MM-dd',
      multiSheetData: [
        {
          appId:
            'bdf2efee-815e-4eb7-9e1e-c42d516baf29',
          heightPx: 587,
          jsOpts: {},
          jsOptsById: {},
          patchesById: {},
          persistentBookmarkIncludeVariables: true,
          resizeType: 'none',
          sheetId:
            '39a671a-5f58-468c-bb49-dff933294774',
          sheetName: 'My new sheet',
          widthPx: 1584,
        },
      ],
      sheetData: {
        appId:
          'bdf2efee-815e-4eb7-9e1e-c42d516baf29',
        heightPx: 587,
        jsOpts: {},
        jsOptsById: {},
        patchesById: {},
        sheetId:
          '39a671a-5f58-468c-bb49-dff933294774',
        sheetName: 'My new sheet',
        widthPx: 1584,
      },
      storyData: {
        appId:
          'bdf2efee-815e-4eb7-9e1e-c42d516baf29',
        storyId:
          '39a671a-5f58-468c-bb49-dff933294774',
      },
      subType: 'image',
      type: 'file',
    },
  ],
  transportChannels: ['email'],
  trigger: {
    executeOnAppReload: true,
    executionHistoryInterval: 'daily',
    recurrence: ['RRULE:FREQ=WEEKLY;INTERVAL=1'],
  },
  type: 'chart-monitoring',
})
qlik sharing-task create \
  --name 'Example Sharing Task' \
  --state-selections-displayName '' \
  --state-selections-displayValues '' \
  --state-selections-isNumeric  \
  --state-selections-name '' \
  --state-selections-stateName '' \
  --state-selections-values '' \
  --templates-chartData-appId '' \
  --templates-chartData-heightPx  \
  --templates-chartData-jsOpts  \
  --templates-chartData-objectDef  \
  --templates-chartData-objectId '' \
  --templates-chartData-outDpi  \
  --templates-chartData-outZoom  \
  --templates-chartData-persistentBookmarkIncludeVariables  \
  --templates-chartData-sheetId '' \
  --templates-chartData-widthPx  \
  --templates-fileAlias '' \
  --templates-fileName '' \
  --templates-fileTimeStamp '' \
  --templates-multiSheetData-appId '' \
  --templates-multiSheetData-heightPx  \
  --templates-multiSheetData-isPrivate  \
  --templates-multiSheetData-jsOpts  \
  --templates-multiSheetData-persistentBookmarkIncludeVariables  \
  --templates-multiSheetData-resizeType '' \
  --templates-multiSheetData-sheetId '' \
  --templates-multiSheetData-sheetName '' \
  --templates-multiSheetData-widthPx  \
  --templates-sheetData-appId '' \
  --templates-sheetData-heightPx  \
  --templates-sheetData-isPrivate  \
  --templates-sheetData-jsOpts  \
  --templates-sheetData-sheetId '' \
  --templates-sheetData-sheetName '' \
  --templates-sheetData-widthPx  \
  --templates-storyData-appId '' \
  --templates-storyData-storyId '' \
  --templates-subType '' \
  --templates-type '' \
  --trigger-recurrence 'RRULE:FREQ=WEEKLY;INTERVAL=1' \
  --type 'chart-monitoring'
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/sharing-tasks" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"name":"Example Sharing Task","tags":["finance"],"type":"chart-monitoring","state":{"fields":[{}],"queryItems":[{}],"selections":[{"name":"Country","values":["Germany"],"isNumeric":false,"stateName":"$","displayName":"Country","displayValues":["Germany"]}]},"appName":"Sales Dashboard","enabled":true,"message":"Look at the presentation.","spaceId":"5f7b1a2c3d4e5f6a7b8c9d0e","subType":"pdf","trigger":{"recurrence":["RRULE:FREQ=WEEKLY;INTERVAL=1"],"executeOnAppReload":true,"executionHistoryInterval":"daily"},"startTime":"2019-10-15T16:07:01.492Z","templates":[{"type":"file","subType":"image","fileName":"sales-report","chartData":{"appId":"bdf2efee-815e-4eb7-9e1e-c42d516baf29","jsOpts":{},"outDpi":96,"outZoom":1,"patches":[{}],"sheetId":"bdf2efee-815e-4eb7-9e1e-asdfasdfasdf","widthPx":1584,"heightPx":587,"objectId":"167f3e67-ff3b-4ead-a09e-e8cc81d8ad78","objectDef":{},"persistentBookmarkIncludeVariables":true},"fileAlias":"file1","sheetData":{"appId":"bdf2efee-815e-4eb7-9e1e-c42d516baf29","jsOpts":{},"sheetId":"39a671a-5f58-468c-bb49-dff933294774","widthPx":1584,"heightPx":587,"isPrivate":false,"sheetName":"My new sheet","jsOptsById":{},"patchesById":{}},"storyData":{"appId":"bdf2efee-815e-4eb7-9e1e-c42d516baf29","storyId":"39a671a-5f58-468c-bb49-dff933294774"},"fileTimeStamp":"yyyy-MM-dd","multiSheetData":[{"appId":"bdf2efee-815e-4eb7-9e1e-c42d516baf29","jsOpts":{},"sheetId":"39a671a-5f58-468c-bb49-dff933294774","widthPx":1584,"heightPx":587,"isPrivate":false,"sheetName":"My new sheet","jsOptsById":{},"resizeType":"none","patchesById":{},"persistentBookmarkIncludeVariables":true}]}],"expiration":"2019-10-15T16:07:01.492Z","recipients":{"DLUsers":[],"userIds":[{"value":"1b263bs8m0mm_s21s3f","groups":["addedIndividually","group1","group2"],"enabled":true,"subscribed":true,"taskRecipientErrors":[{"value":"NO_ACCESS_TO_APP","timestamp":"2019-10-15T16:07:01.492Z"}],"alertingTaskRecipientErrors":[{"added":"2019-10-15T16:07:01.492Z","value":"NO_ACCESS_TO_APP"}]}],"DLGroups":[],"emailAddresses":["abc@xyz.com"]},"description":"Weekly sales report subscription.","emailContent":{"body":"report body string","subject":"report subject"},"cleanupStrategy":"noCleanup","retentionPolicy":{"historySize":10,"overrideInterval":"FREQ=DAILY;INTERVAL=1"},"scheduleOptions":{"timezone":"Canada/Pacific","recurrence":["RRULE:FREQ=HOURLY;INTERVAL=2"],"endDateTime":"","startDateTime":"2006-01-02T16:04:05"},"dataConnectionID":"data-connection-123","sharePointFolder":"Shared Documents/Reports","executeOnCreation":true,"transportChannels":["email"],"distributionListId":"mpoXaH22_vLR1pStfI7oUdGya1nKK24"}'

Example Response

{
  "id": "string",
  "name": "string",
  "tags": [
    "string"
  ],
  "type": "chart-monitoring",
  "appId": "string",
  "owner": "pXVNKqotgEMwbKwhz2agPE4yFelnPcWO",
  "state": {
    "fields": [
      {}
    ],
    "queryItems": [
      {}
    ],
    "selections": [
      {
        "name": "Country",
        "values": [
          "Germany"
        ],
        "isNumeric": false,
        "stateName": "$",
        "displayName": "Country",
        "displayValues": [
          "Germany"
        ]
      }
    ]
  },
  "tenant": "_mpoXaH22_vLR1pStfI7oUdGya1nKK24",
  "appName": "string",
  "lastRun": "2019-10-15T16:07:01.492Z",
  "message": "Look at the presentation.",
  "spaceId": "string",
  "subType": "pdf",
  "trigger": {
    "recurrence": [
      "RRULE:FREQ=WEEKLY;INTERVAL=1"
    ],
    "chronosJobID": "chronos-job-123",
    "executeOnAppReload": true,
    "executionHistoryInterval": "daily"
  },
  "createdBy": "string",
  "insightID": "string",
  "ownerName": "Harley Kiffe",
  "startTime": "2019-10-15T16:07:01.492Z",
  "templates": [
    {
      "type": "file",
      "subType": "image",
      "fileName": "sales-report",
      "chartData": {
        "appId": "bdf2efee-815e-4eb7-9e1e-c42d516baf29",
        "jsOpts": {},
        "outDpi": 96,
        "outZoom": 1,
        "patches": [
          {}
        ],
        "sheetId": "bdf2efee-815e-4eb7-9e1e-asdfasdfasdf",
        "widthPx": 1584,
        "heightPx": 587,
        "objectId": "167f3e67-ff3b-4ead-a09e-e8cc81d8ad78",
        "objectDef": {},
        "persistentBookmarkIncludeVariables": true
      },
      "fileAlias": "file1",
      "sheetData": {
        "appId": "bdf2efee-815e-4eb7-9e1e-c42d516baf29",
        "jsOpts": {},
        "sheetId": "39a671a-5f58-468c-bb49-dff933294774",
        "widthPx": 1584,
        "heightPx": 587,
        "isPrivate": false,
        "sheetName": "My new sheet",
        "jsOptsById": {},
        "patchesById": {}
      },
      "storyData": {
        "appId": "bdf2efee-815e-4eb7-9e1e-c42d516baf29",
        "storyId": "39a671a-5f58-468c-bb49-dff933294774"
      },
      "templateId": "da5825325dc9a0dd0260af9",
      "fileTimeStamp": "yyyy-MM-dd",
      "multiSheetData": [
        {
          "appId": "bdf2efee-815e-4eb7-9e1e-c42d516baf29",
          "jsOpts": {},
          "sheetId": "39a671a-5f58-468c-bb49-dff933294774",
          "widthPx": 1584,
          "heightPx": 587,
          "isPrivate": false,
          "sheetName": "My new sheet",
          "jsOptsById": {},
          "resizeType": "none",
          "patchesById": {},
          "persistentBookmarkIncludeVariables": true
        }
      ]
    }
  ],
  "thumbnail": "string",
  "updatedBy": "string",
  "expiration": "2019-10-15T16:07:01.492Z",
  "lastViewed": "2019-10-15T16:07:01.492Z",
  "recipients": {
    "DLUsers": [],
    "userIds": [
      {
        "value": "1b263bs8m0mm_s21s3f",
        "groups": [
          "addedIndividually",
          "group1",
          "group2"
        ],
        "subscribed": true,
        "enabledByUser": true,
        "enabledBySystem": true,
        "taskRecipientErrors": [
          {
            "value": "NO_ACCESS_TO_APP",
            "timestamp": "2019-10-15T16:07:01.492Z"
          }
        ],
        "alertingTaskRecipientErrors": [
          {
            "added": "2019-10-15T16:07:01.492Z",
            "value": "NO_ACCESS_TO_APP"
          }
        ]
      }
    ],
    "DLGroups": [],
    "groupIds": [
      {
        "value": "group1",
        "enabledByUser": true,
        "enabledBySystem": true,
        "taskGroupRecipientErrors": [
          {
            "value": "GROUP_WITH_NO_APP_ACCESS",
            "timestamp": "2019-10-15T16:07:01.492Z"
          }
        ],
        "alertingTaskGroupRecipientErrors": [
          {
            "added": "2019-10-15T16:07:01.492Z",
            "value": "GROUP_WITH_NO_APP_ACCESS"
          }
        ]
      }
    ],
    "emailAddresses": [
      {
        "value": "abc@xyz.com",
        "enabled": true,
        "taskRecipientErrors": [
          {
            "value": "NO_ACCESS_TO_APP",
            "timestamp": "2019-10-15T16:07:01.492Z"
          }
        ]
      }
    ],
    "netRecipientCount": 10
  },
  "statusCode": "CHART_NOT_FOUND",
  "taskErrors": [
    {
      "value": "OWNER_DISABLED",
      "timestamp": "2019-10-15T16:07:01.492Z"
    }
  ],
  "templateId": "da5825325dc9a0dd0260af9",
  "dateCreated": "2019-10-15T16:07:01.492Z",
  "description": "string",
  "lastUpdated": "2019-10-15T16:07:01.492Z",
  "statusLabel": "string",
  "emailContent": {
    "body": "report body string",
    "subject": "report subject"
  },
  "enabledByUser": true,
  "encryptedState": {
    "cipher": "string"
  },
  "byokMigrationId": "string",
  "enabledBySystem": true,
  "retentionPolicy": {
    "historySize": 10,
    "overrideInterval": "FREQ=DAILY;INTERVAL=1"
  },
  "scheduleOptions": {
    "timezone": "Canada/Pacific",
    "recurrence": [
      "RRULE:FREQ=HOURLY;INTERVAL=2"
    ],
    "endDateTime": "",
    "chronosJobID": "chronos-job-123",
    "startDateTime": "2006-01-02T16:04:05",
    "lastExecutionTime": "2020-11-20T12:00:55.000Z",
    "nextExecutionTime": "2020-11-20T12:00:55.000Z"
  },
  "selectionErrors": {},
  "dataConnectionID": "string",
  "hasSectionAccess": true,
  "insightDirectURL": "string",
  "multiInsightURLs": [
    {
      "status": "successful",
      "directURL": "string",
      "insightID": "string",
      "resourceID": "string",
      "templateID": "string",
      "fallbackURL": "string"
    }
  ],
  "nextScheduledRun": "2019-10-15T16:07:01.492Z",
  "reportProperties": {},
  "sharePointFolder": "string",
  "executeOnCreation": true,
  "lastExecutionDate": "2019-10-15T16:09:01.492Z",
  "transportChannels": [
    "email"
  ],
  "distributionListId": "vXVNKqotgEMwbKwhz2agPE4yFelnPcWX",
  "encryptedTemplates": {
    "cipher": "string"
  },
  "insightFallbackURL": "string",
  "encryptedEmailContent": {
    "body": {
      "cipher": "string"
    },
    "subject": {
      "cipher": "string"
    }
  },
  "failedExecutionsCount": 42,
  "failedVerificationsCount": 42,
  "isCandidateForVerification": true,
  "persistentBookmarkIncludeVariables": true,
  "links": {
    "self": {
      "href": "http://localhost:8787/v1/items/5da5825325dc9a0dd0260af9"
    }
  },
  "enabled": true,
  "latestExecutionURL": "string",
  "latestExecutionFilesURL": [
    "string"
  ]
}

Get sharing task

Returns the details of a specific sharing task.

Facts

Rate limit Tier 1 (1000 requests per minute)

Query Parameters

  • isViewChart boolean

    Determines whether to update the lastViewed property for the sharing task, which is used to determine whether the sharing task is still in use. If set to true, this will be updated to current time.

    default = false

Path Parameters

  • taskId string
    Required

    The sharing task identifier.

Responses

200

Sharing task has been successfully returned.

  • application/json object

    Whatever is persisted in the db + links

    Show application/json properties
    • id string

      Gets the sharing task resource identifier.

    • name string

      Name of this sharing task

    • tags array of strings
    • type string

      The sharing task resource type

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

    • appId string

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

    • owner string

      User id of owner of the sharing task

    • state object

      State of the selections and jsOpts

      Show state properties
      • fields array of objects

        Selected fields that led to discovery of monitored Insight Advisor chart

      • queryItems array of objects

        Query that led to discovery of monitored Insight Advisor chart

      • selections array of objects
        Show selections properties
        • name string
          Required

          Name of the field the selection applies to.

        • values array of strings
          Required

          A selected value for the field.

        • isNumeric boolean
          Required

          Whether the selected values are numeric.

        • stateName string
          Required

          Name of the selection state the values belong to.

        • displayName string

          Human-readable name of the field the selection applies to.

        • displayValues array of strings

          A human-readable selected value for the field.
    • tenant string

      Tenant of the sharing task

    • appName string

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

    • lastRun string

      The last execution start date time timestamp of the task

    • message string

      Message along with sharing task

      maxLength = 280

    • spaceId string

      spaceId of the app associated to this task definition

    • subType string Deprecated

      Mashup subType of sharing task

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

    • trigger object
      Show trigger properties
      • recurrence array 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.

      • chronosJobID string

        The chronosJobId which triggers the sharing task

      • executeOnAppReload boolean

        Toggle for executing sharing task on app reload.

        default = true

      • executionHistoryInterval string

        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"

    • createdBy string

      ID of creator

    • insightID string

      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)

    • ownerName string

      User name of owner of the sharing task

    • startTime string

      Time to start capturing the history

    • templates array of objects

      Depending on the value of type, sharing service will internally validate a specific property regarding its data. Type "file" validates property "fileData", type "chart" validates property "chartData", type "story" validates property "storyData". Check description of each of the models for their required properties.

      Show templates properties
      • type string
        Required

        The type of template used to generate the report output.

        Can be one of: "file""chart""story""sheet""multi-sheet""excel""pixel-perfect""html""powerpoint""word"

      • subType string

        The output sub-type produced for the template.

        Can be one of: "image""snapshot""pdf""pptx""xlsx""qpxp""qhtml""docx"

        default = "image"

      • fileName string

        fileName to be used when generating the report

      • chartData object

        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
        • appId string

          ID of app

        • jsOpts object

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

        • outDpi integer

          outDpi of chart

        • outZoom number

          outZoom of chart

        • patches array of objects

          Soft property changes on chart

        • sheetId string

          sheetId of app

        • widthPx integer

          widthPx of chart

        • heightPx integer

          heightPx of chart

        • objectId string

          ID of object

        • objectDef object

          Session chart object definition

        • persistentBookmarkIncludeVariables boolean

          Flag to configure the persistent bookmark to use variables.
      • fileAlias string

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

      • sheetData object Deprecated
        Show sheetData properties
        • appId string

          ID of app

        • jsOpts object

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

        • sheetId string

          ID of sheet

        • widthPx integer

          widthPx of chart

        • heightPx integer

          heightPx of chart

        • isPrivate boolean Deprecated

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

        • sheetName string Deprecated

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

        • jsOptsById object

          Map of Qlik Sense object id to rendering options applied when generating the report.

          Show additional optional properties
          • object object

            Visualizations state from client as a string json value. Can include language, theme, viewState etc.
        • patchesById object

          Map of Qlik Sense object id to patches applied when generating the report.

          Show additional optional properties
          • object[] array of objects

            Soft property changes on charts
      • storyData object
        Show storyData properties
        • appId string

          ID of app

        • storyId string

          ID of story
      • templateId string Deprecated

        ID of unique template

      • fileTimeStamp string

        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"

      • multiSheetData array of objects

        array of sheet data for multi-sheet type template

        Show multiSheetData properties
        • appId string

          ID of app

        • jsOpts object

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

        • sheetId string

          ID of sheet

        • widthPx integer

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

        • heightPx integer

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

        • isPrivate boolean

          optional value to indicate that this sheet is private

        • sheetName string

          an optional name for the sheet

        • jsOptsById object

          Map of Qlik Sense object id to rendering options applied when generating the report.

          Show additional optional properties
          • object object

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

          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"

        • patchesById object

          Map of Qlik Sense object id to patches applied when generating the report.

          Show additional optional properties
          • object[] array of objects

            Soft property changes on charts
        • persistentBookmarkIncludeVariables boolean

          Flag to configure the persistent bookmark to use variables
    • thumbnail string
    • updatedBy string

      ID of a user that updated this task last

    • expiration string

      Time for the termination of the task

    • lastViewed string

      Timestamp of the most recent view by the user.

    • recipients object

      List of persisted recipients.

      Show recipients properties
      • DLUsers array
      • userIds array of objects

        recipient object model that is directly persisted in the DB

        Show userIds properties
        • value string

          User ID of recipient (internal user).

        • groups array of strings

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

        • subscribed boolean

          Whether this user is subscribed to alerts in this task

        • enabledByUser boolean

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

        • enabledBySystem boolean

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

        • taskRecipientErrors array of objects
          Show taskRecipientErrors properties
          • value string

            Identifier for type of error occurring on sharing task specific for recipient

            Can be one of: "USER_IS_DELETED""USER_DISABLED_IN_QCS""NO_ACCESS_TO_APP""UNSUBSCRIBED_FROM_SHARING""USER_DISABLED_IN_SHARING_BY_OWNER""CHART_NOT_FOUND""APP_NOT_FOUND""SHEET_NOT_FOUND""ENGINE_POD_NOT_AVAILABLE""CHART_TYPE_NOT_ALLOWED""GENERIC_EXECUTION_FAILURE""USER_NOT_FOUND_DL""USER_DISABLED_IN_DL""FILTER_NOT_FOUND""BOOKMARK_NOT_FOUND"

          • timestamp string

            Timestamp for the creation of the error
        • alertingTaskRecipientErrors array of objects
          Show alertingTaskRecipientErrors properties
          • added string

            Timestamp for the creation of the error

          • value string

            Identifier for type of error occurring on alerting task

            Can be one of: "USER_IS_DELETED""USER_DISABLED_IN_QCS""NO_ACCESS_TO_APP""UNSUBSCRIBED_FROM_ALERT""CONDITION_EVAL_ERROR""USER_DISABLED_IN_ALERT_BY_OWNER""MAX_ALERTS_LIMIT_REACHED"

      • DLGroups array
      • groupIds array of objects

        recipient object model that is directly persisted in the DB

        Show groupIds properties
        • value string

          Group ID of recipient.

        • enabledByUser boolean

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

        • enabledBySystem boolean

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

        • taskGroupRecipientErrors array of objects
          Show taskGroupRecipientErrors properties
          • value string

            Identifier for type of error occurring on sharing task specific for group recipient

            Can be one of: "GROUP_IS_DISABLED""MAX_ALERTS_LIMIT_REACHED""GROUP_WITH_NO_APP_ACCESS""GROUP_IS_DELETED""GROUP_NOT_FOUND_DL""GROUP_DISABLED_IN_DL"

          • timestamp string

            Timestamp for the creation of the error
        • alertingTaskGroupRecipientErrors array of objects
          Show alertingTaskGroupRecipientErrors properties
          • added string

            Timestamp for the creation of the error

          • value string

            Identifier for type of error occurring on alerting task

            Can be one of: "GROUP_IS_DISABLED""MAX_ALERTS_LIMIT_REACHED""GROUP_WITH_NO_APP_ACCESS""GROUP_IS_DELETED"

      • emailAddresses array of objects

        recipient object model that is directly persisted in the DB

        Show emailAddresses properties
        • value string

          Email of recipient (external user).

          format = "email"

        • enabled boolean

          Whether this recipient can receive alerts.

        • taskRecipientErrors array of objects
          Show taskRecipientErrors properties
          • value string

            Identifier for type of error occurring on sharing task specific for recipient

            Can be one of: "USER_IS_DELETED""USER_DISABLED_IN_QCS""NO_ACCESS_TO_APP""UNSUBSCRIBED_FROM_SHARING""USER_DISABLED_IN_SHARING_BY_OWNER""CHART_NOT_FOUND""APP_NOT_FOUND""SHEET_NOT_FOUND""ENGINE_POD_NOT_AVAILABLE""CHART_TYPE_NOT_ALLOWED""GENERIC_EXECUTION_FAILURE""USER_NOT_FOUND_DL""USER_DISABLED_IN_DL""FILTER_NOT_FOUND""BOOKMARK_NOT_FOUND"

          • timestamp string

            Timestamp for the creation of the error
      • netRecipientCount integer

        Net count of recipients in DLGroups and DLUsers.
    • statusCode string

      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""REPORTING_DAILY_QUOTA_EXCEEDED""WARNING"

    • taskErrors array of objects
      Show taskErrors properties
      • value string

        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""MISSING_DISTRIBUTION_LIST""SECTION_ACCESS_NOT_SUPPORTED""REPORTING_DAILY_QUOTA_EXCEEDED""EMAIL_DELIVERY_FAILURE"

      • timestamp string

        Timestamp for the creation of the error
    • templateId string Deprecated

      ID of unique template

    • dateCreated string

      Timestamp for the creation of the task

    • description string

      A description of this sharing task

    • lastUpdated string

      Timestamp of the most recent update.

    • statusLabel string

      error message indicating the underlying failure

    • emailContent object
      Show emailContent properties
      • body string

        Body content of the email sent to recipients.

      • subject string

        Subject line of the email sent to recipients.
    • enabledByUser boolean

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

    • encryptedState object

      Encrypted property in DB

      Show encryptedState properties
      • value any
      • cipher string
    • byokMigrationId string

      internal identifier used when migrating keys

    • enabledBySystem boolean

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

    • retentionPolicy object
      Show retentionPolicy properties
      • historySize integer

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

      • overrideInterval string

        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"

    • scheduleOptions object
      Show scheduleOptions properties
      • timezone string

        The timezone for time calculations in SCHEDULED triggers, optional.

      • recurrence array 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.

      • endDateTime string

        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 = ""

      • chronosJobID string

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

      • startDateTime string

        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.

      • lastExecutionTime string

        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.

      • nextExecutionTime string

        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.
    • selectionErrors object

      reporting service returns rendering errors for missing selections

    • dataConnectionID string

      the id of the data connection

    • hasSectionAccess boolean

      true if the associated app has section access enabled

    • insightDirectURL string

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

    • multiInsightURLs array 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
      • status string

        the status of the creation for this insight URL

        Can be one of: "successful""failed"

      • directURL string
      • insightID string
      • resourceID string

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

      • templateID string Deprecated

        an identifier for the template that this insight link points to

      • fallbackURL string
    • nextScheduledRun string

      Time for the next scheduled run

    • reportProperties object
    • sharePointFolder string

      the SharePoint folder to upload the report to

    • executeOnCreation boolean

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

    • lastExecutionDate string

      The last execution end date time timestamp of the task

    • transportChannels array of strings

      the transport type for the report

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

    • distributionListId string

      the id of the distribution list associated to the app

    • encryptedTemplates object

      Encrypted property in DB

      Show encryptedTemplates properties
      • value any
      • cipher string
    • insightFallbackURL string

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

    • encryptedEmailContent object

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

      Show encryptedEmailContent properties
      • body object

        Encrypted property in DB

        Show body properties
        • value any
        • cipher string
      • subject object

        Encrypted property in DB

        Show subject properties
        • value any
        • cipher string
    • failedExecutionsCount integer

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

    • failedVerificationsCount integer

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

    • isCandidateForVerification boolean

      true if the sharing task is a candidate for verification

    • persistentBookmarkIncludeVariables boolean Deprecated

      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.

    • links object
      Show links properties
      • self object

        Object with Href to a particular element or set of elements

        Show self properties
        • href string
    • enabled boolean

      true if the sharing task is enabled

    • latestExecutionURL string

      URL to querying the latest execution tied to this sharing task

    • latestExecutionFilesURL array of strings

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

400

Bad request, malformed syntax or errors in parameters.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string

        Error code specific to sharing service.

      • meta object
        Show meta properties
        • httpCode integer

          HTTP error code.
      • title string

        Error title.

      • detail string

        Error cause.
    • traceId string

404

Task or execution not found.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string

        Error code specific to sharing service.

      • meta object
        Show meta properties
        • httpCode integer

          HTTP error code.
      • title string

        Error title.

      • detail string

        Error cause.
    • traceId string

500

Internal server error.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string

        Error code specific to sharing service.

      • meta object
        Show meta properties
        • httpCode integer

          HTTP error code.
      • title string

        Error title.

      • detail string

        Error cause.
    • traceId string

default

Error response.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string

        Error code specific to sharing service.

      • meta object
        Show meta properties
        • httpCode integer

          HTTP error code.
      • title string

        Error title.

      • detail string

        Error cause.
    • traceId string
GET /api/v1/sharing-tasks/{taskId} 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.sharingTasks.getSharingTask(
  'string',
  {},
)
qlik sharing-task get 'string'
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/sharing-tasks/{taskId}" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "id": "string",
  "name": "string",
  "tags": [
    "string"
  ],
  "type": "chart-monitoring",
  "appId": "string",
  "owner": "pXVNKqotgEMwbKwhz2agPE4yFelnPcWO",
  "state": {
    "fields": [
      {}
    ],
    "queryItems": [
      {}
    ],
    "selections": [
      {
        "name": "Country",
        "values": [
          "Germany"
        ],
        "isNumeric": false,
        "stateName": "$",
        "displayName": "Country",
        "displayValues": [
          "Germany"
        ]
      }
    ]
  },
  "tenant": "_mpoXaH22_vLR1pStfI7oUdGya1nKK24",
  "appName": "string",
  "lastRun": "2019-10-15T16:07:01.492Z",
  "message": "Look at the presentation.",
  "spaceId": "string",
  "subType": "pdf",
  "trigger": {
    "recurrence": [
      "RRULE:FREQ=WEEKLY;INTERVAL=1"
    ],
    "chronosJobID": "chronos-job-123",
    "executeOnAppReload": true,
    "executionHistoryInterval": "daily"
  },
  "createdBy": "string",
  "insightID": "string",
  "ownerName": "Harley Kiffe",
  "startTime": "2019-10-15T16:07:01.492Z",
  "templates": [
    {
      "type": "file",
      "subType": "image",
      "fileName": "sales-report",
      "chartData": {
        "appId": "bdf2efee-815e-4eb7-9e1e-c42d516baf29",
        "jsOpts": {},
        "outDpi": 96,
        "outZoom": 1,
        "patches": [
          {}
        ],
        "sheetId": "bdf2efee-815e-4eb7-9e1e-asdfasdfasdf",
        "widthPx": 1584,
        "heightPx": 587,
        "objectId": "167f3e67-ff3b-4ead-a09e-e8cc81d8ad78",
        "objectDef": {},
        "persistentBookmarkIncludeVariables": true
      },
      "fileAlias": "file1",
      "sheetData": {
        "appId": "bdf2efee-815e-4eb7-9e1e-c42d516baf29",
        "jsOpts": {},
        "sheetId": "39a671a-5f58-468c-bb49-dff933294774",
        "widthPx": 1584,
        "heightPx": 587,
        "isPrivate": false,
        "sheetName": "My new sheet",
        "jsOptsById": {},
        "patchesById": {}
      },
      "storyData": {
        "appId": "bdf2efee-815e-4eb7-9e1e-c42d516baf29",
        "storyId": "39a671a-5f58-468c-bb49-dff933294774"
      },
      "templateId": "da5825325dc9a0dd0260af9",
      "fileTimeStamp": "yyyy-MM-dd",
      "multiSheetData": [
        {
          "appId": "bdf2efee-815e-4eb7-9e1e-c42d516baf29",
          "jsOpts": {},
          "sheetId": "39a671a-5f58-468c-bb49-dff933294774",
          "widthPx": 1584,
          "heightPx": 587,
          "isPrivate": false,
          "sheetName": "My new sheet",
          "jsOptsById": {},
          "resizeType": "none",
          "patchesById": {},
          "persistentBookmarkIncludeVariables": true
        }
      ]
    }
  ],
  "thumbnail": "string",
  "updatedBy": "string",
  "expiration": "2019-10-15T16:07:01.492Z",
  "lastViewed": "2019-10-15T16:07:01.492Z",
  "recipients": {
    "DLUsers": [],
    "userIds": [
      {
        "value": "1b263bs8m0mm_s21s3f",
        "groups": [
          "addedIndividually",
          "group1",
          "group2"
        ],
        "subscribed": true,
        "enabledByUser": true,
        "enabledBySystem": true,
        "taskRecipientErrors": [
          {
            "value": "NO_ACCESS_TO_APP",
            "timestamp": "2019-10-15T16:07:01.492Z"
          }
        ],
        "alertingTaskRecipientErrors": [
          {
            "added": "2019-10-15T16:07:01.492Z",
            "value": "NO_ACCESS_TO_APP"
          }
        ]
      }
    ],
    "DLGroups": [],
    "groupIds": [
      {
        "value": "group1",
        "enabledByUser": true,
        "enabledBySystem": true,
        "taskGroupRecipientErrors": [
          {
            "value": "GROUP_WITH_NO_APP_ACCESS",
            "timestamp": "2019-10-15T16:07:01.492Z"
          }
        ],
        "alertingTaskGroupRecipientErrors": [
          {
            "added": "2019-10-15T16:07:01.492Z",
            "value": "GROUP_WITH_NO_APP_ACCESS"
          }
        ]
      }
    ],
    "emailAddresses": [
      {
        "value": "abc@xyz.com",
        "enabled": true,
        "taskRecipientErrors": [
          {
            "value": "NO_ACCESS_TO_APP",
            "timestamp": "2019-10-15T16:07:01.492Z"
          }
        ]
      }
    ],
    "netRecipientCount": 10
  },
  "statusCode": "CHART_NOT_FOUND",
  "taskErrors": [
    {
      "value": "OWNER_DISABLED",
      "timestamp": "2019-10-15T16:07:01.492Z"
    }
  ],
  "templateId": "da5825325dc9a0dd0260af9",
  "dateCreated": "2019-10-15T16:07:01.492Z",
  "description": "string",
  "lastUpdated": "2019-10-15T16:07:01.492Z",
  "statusLabel": "string",
  "emailContent": {
    "body": "report body string",
    "subject": "report subject"
  },
  "enabledByUser": true,
  "encryptedState": {
    "cipher": "string"
  },
  "byokMigrationId": "string",
  "enabledBySystem": true,
  "retentionPolicy": {
    "historySize": 10,
    "overrideInterval": "FREQ=DAILY;INTERVAL=1"
  },
  "scheduleOptions": {
    "timezone": "Canada/Pacific",
    "recurrence": [
      "RRULE:FREQ=HOURLY;INTERVAL=2"
    ],
    "endDateTime": "",
    "chronosJobID": "chronos-job-123",
    "startDateTime": "2006-01-02T16:04:05",
    "lastExecutionTime": "2020-11-20T12:00:55.000Z",
    "nextExecutionTime": "2020-11-20T12:00:55.000Z"
  },
  "selectionErrors": {},
  "dataConnectionID": "string",
  "hasSectionAccess": true,
  "insightDirectURL": "string",
  "multiInsightURLs": [
    {
      "status": "successful",
      "directURL": "string",
      "insightID": "string",
      "resourceID": "string",
      "templateID": "string",
      "fallbackURL": "string"
    }
  ],
  "nextScheduledRun": "2019-10-15T16:07:01.492Z",
  "reportProperties": {},
  "sharePointFolder": "string",
  "executeOnCreation": true,
  "lastExecutionDate": "2019-10-15T16:09:01.492Z",
  "transportChannels": [
    "email"
  ],
  "distributionListId": "vXVNKqotgEMwbKwhz2agPE4yFelnPcWX",
  "encryptedTemplates": {
    "cipher": "string"
  },
  "insightFallbackURL": "string",
  "encryptedEmailContent": {
    "body": {
      "cipher": "string"
    },
    "subject": {
      "cipher": "string"
    }
  },
  "failedExecutionsCount": 42,
  "failedVerificationsCount": 42,
  "isCandidateForVerification": true,
  "persistentBookmarkIncludeVariables": true,
  "links": {
    "self": {
      "href": "http://localhost:8787/v1/items/5da5825325dc9a0dd0260af9"
    }
  },
  "enabled": true,
  "latestExecutionURL": "string",
  "latestExecutionFilesURL": [
    "string"
  ]
}

Update sharing task

Updates one or more properties of a specific sharing task.

Facts

Rate limit Tier 2 (100 requests per minute)

Path Parameters

  • taskId string
    Required

    The sharing task identifier.

Request Body

Required

The sharing task definition.

  • application/json array of objects
    Show application/json properties
    • op string
      Required

      The operation to be performed

      Can be one of: "replace""remove"

    • path string
      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""/bookmarkId"

    • value object

      The value to be used for this operation.

Responses

204

The sharing task has been successfully updated.

400

The specified task ID or body is invalid (e.g. not a number).

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string

        Error code specific to sharing service.

      • meta object
        Show meta properties
        • httpCode integer

          HTTP error code.
      • title string

        Error title.

      • detail string

        Error cause.
    • traceId string

404

A task with the specified ID was not found.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string

        Error code specific to sharing service.

      • meta object
        Show meta properties
        • httpCode integer

          HTTP error code.
      • title string

        Error title.

      • detail string

        Error cause.
    • traceId string

500

Internal server error.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string

        Error code specific to sharing service.

      • meta object
        Show meta properties
        • httpCode integer

          HTTP error code.
      • title string

        Error title.

      • detail string

        Error cause.
    • traceId string

default

Error response.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string

        Error code specific to sharing service.

      • meta object
        Show meta properties
        • httpCode integer

          HTTP error code.
      • title string

        Error title.

      • detail string

        Error cause.
    • traceId string
PATCH /api/v1/sharing-tasks/{taskId} 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.sharingTasks.patchSharingTask(
  'string',
  [
    {
      op: 'replace',
      path: '/name',
      value: 'new name',
    },


    {
      op: 'replace',
      path: '/tags',
      value: ['tag1', 'tag2'],
    },


    {
      op: 'replace',
      path: '/tags',
      value: 'new-tag',
    },


    {
      op: 'replace',
      path: '/tags',
      value: 'deleted-tag',
    },


    {
      op: 'replace',
      path: '/ownerId',
      value: 'new-owner',
    },


    {
      op: 'replace',
      path: '/enabled',
      value: true,
    },


    {
      op: 'replace',
      path: '/description',
      value: 'new-description',
    },
  ],
)
qlik sharing-task patch 'string' \
  --op 'replace' \
  --path '/name'
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/sharing-tasks/{taskId}" \
-X PATCH \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '[{"op":"replace","path":"/name","value":"new name"},{"op":"replace","path":"/tags","value":["tag1","tag2"]},{"op":"replace","path":"/tags","value":"new-tag"},{"op":"replace","path":"/tags","value":"deleted-tag"},{"op":"replace","path":"/ownerId","value":"new-owner"},{"op":"replace","path":"/enabled","value":true},{"op":"replace","path":"/description","value":"new-description"}]'

Delete sharing task

Deletes a specific sharing task.

Facts

Rate limit Tier 2 (100 requests per minute)

Path Parameters

  • taskId string
    Required

    The sharing task identifier.

Responses

204

The sharing task has been successfully deleted.

400

The specified task ID is invalid (e.g. not a number).

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string

        Error code specific to sharing service.

      • meta object
        Show meta properties
        • httpCode integer

          HTTP error code.
      • title string

        Error title.

      • detail string

        Error cause.
    • traceId string

404

A task with the specified ID was not found.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string

        Error code specific to sharing service.

      • meta object
        Show meta properties
        • httpCode integer

          HTTP error code.
      • title string

        Error title.

      • detail string

        Error cause.
    • traceId string

500

Internal server error.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string

        Error code specific to sharing service.

      • meta object
        Show meta properties
        • httpCode integer

          HTTP error code.
      • title string

        Error title.

      • detail string

        Error cause.
    • traceId string

default

Error response.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string

        Error code specific to sharing service.

      • meta object
        Show meta properties
        • httpCode integer

          HTTP error code.
      • title string

        Error title.

      • detail string

        Error cause.
    • traceId string
DELETE /api/v1/sharing-tasks/{taskId} 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.sharingTasks.deleteSharingTask(
  'string',
)
qlik sharing-task rm 'string'
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/sharing-tasks/{taskId}" \
-X DELETE \
-H "Authorization: Bearer <access_token>"

Cancel sharing task execution

Requests cancellation of an execution of the specified recurring sharing task.

Facts

Rate limit Tier 2 (100 requests per minute)

Path Parameters

  • taskId string
    Required

    The sharing task identifier.

Responses

204

The sharing task has been successfully cancelled.

400

Bad request, malformed syntax or errors in parameters.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string

        Error code specific to sharing service.

      • meta object
        Show meta properties
        • httpCode integer

          HTTP error code.
      • title string

        Error title.

      • detail string

        Error cause.
    • traceId string

404

Task not found, if the provided sharing task cannot be found or otherwise unable to be cancelled

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string

        Error code specific to sharing service.

      • meta object
        Show meta properties
        • httpCode integer

          HTTP error code.
      • title string

        Error title.

      • detail string

        Error cause.
    • traceId string

500

Internal server error.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string

        Error code specific to sharing service.

      • meta object
        Show meta properties
        • httpCode integer

          HTTP error code.
      • title string

        Error title.

      • detail string

        Error cause.
    • traceId string

default

Error response.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string

        Error code specific to sharing service.

      • meta object
        Show meta properties
        • httpCode integer

          HTTP error code.
      • title string

        Error title.

      • detail string

        Error cause.
    • traceId string
POST /api/v1/sharing-tasks/{taskId}/actions/cancel 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.sharingTasks.cancelSharingTask(
  'string',
)
qlik sharing-task cancel 'string'
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/sharing-tasks/{taskId}/actions/cancel" \
-X POST \
-H "Authorization: Bearer <access_token>"

List sharing task executions

Lists executions for the specified sharing task.

Facts

Rate limit Tier 1 (1000 requests per minute)

Query Parameters

  • limit integer

    Limit the returned result set

    minimum = 1, maximum = 200, default = 20, default = 20

  • next string

    The cursor to the next page of data. Only one of next or previous may be specified.

  • offset integer

    Offset for pagination - how many elements to skip

    minimum = 0, default = 0, default = 0

  • prev string

    The cursor to the previous page of data. Only one of next or previous may be specified.

  • sort array of strings

    Sort the returned result set by the specified field

    Values may be any of: "starttime""-starttime""+starttime"

  • status string

    Specifies a filter for a particular field and value of an execution

    Can be one of: "successful""failed"

Path Parameters

  • taskId string
    Required

    The sharing task identifier.

Responses

200

The sharing-executions list has been successfully returned.

  • application/json object

    properties that should be added to every list response

    Show application/json properties
    • totalCount integer
      Required

      total count of entries in the collection as a whole

    • currentPageCount integer
      Required

      count of entries on the currently shown page

    • links object
      Show links properties
      • next object
        Show next properties
        • href string

          URL to particular set of elements

        • type string

          Page type, can be next or prev

          Can be one of: "prev""next"

        • token string

          Page unique token
      • prev object
        Show prev properties
        • href string

          URL to particular set of elements

        • type string

          Page type, can be next or prev

          Can be one of: "prev""next"

        • token string

          Page unique token
      • self object

        Object with Href to a particular element or set of elements

        Show self properties
        • href string
    • executions array of objects

      Gets a list of sharing-executions.

      Show executions properties
      • id string

        Gets the execution identifier.

      • appId string

        appId associated to sharing task execution

      • files array of objects
        Show files properties
        • type string

          Can be one of: "image""pdf""pptx""xlsx""html""docx"

        • fileID string
        • userId string

          userId associated with the file

        • fileAlias string
        • templateId string

          identify the source task template

          format = "uuid"

        • tempContentsLocation string
      • errors array of objects
        Show errors properties
        • code string

          Error code specific to sharing service.

        • title string

          Error title.

        • detail string

          Error cause.
      • status string

        Status of the task execution

        Can be one of: "initialized""in-progress""successful""failed""cancelled""invalid""presuccessful""cancelling"

      • endTime string

        Timestamp of execution successful stop

      • eventID string

        eventID of the trigger NATS event

      • ownerId string

        Owner of the execution

      • reloadId string

        If this execution was triggered by an app reload. This will contain the reloadId from reloads service. Otherwise it is empty or omitted.

      • tenantId string

        The tenant that this execution belongs to

      • eventTime string

        eventTime of the trigger NATS event

      • startTime string

        Timestamp of execution start

      • bookmarkId string Deprecated

        The ID of a filter in a reporting request

      • failedTime string

        Timestamp of execution stop

      • reloadTime string

        If this execution was triggered by an app reload. This will contain the reload time to compare with reporting service when the report is requested.

      • targetUser object

        User that this execution is targeting as a recipient

        Show targetUser properties
        • type string

          type of user eg email, userId, groupId

        • value string

          contains the value of user type e.g. abc@xyz.com, 213efewr3

        • timezone string

          timezone for the timestamp on the attached file name

        • filterName string Deprecated
        • filterNames array of strings

          contains the value of the user filter
      • totalCount integer

        Total count of reports in this execution

      • workflowID string

        Workflow that the execution belongs to. Note that in a multi-recipient context we can have multiple executions (one per recipient) that share the same unique workflow.

      • bookmarkIds array of strings

        The ID of a filter in a reporting request

      • failedCount integer

        Total count of failed reports in this execution

      • successCount integer

        Total count of successfully generated reports in this execution

      • cancelledTime string

        Timestamp of execution cancel

      • sharingTaskID string

        ID for the sharing task that this execution references

      • cancelledCount integer

        Total count of cancelled reports in this execution

      • totalUploadCount integer

        Total count of reports to be uploaded in this execution

      • failedUploadCount integer

        Total count of failed uploaded reports in this execution

      • successUploadCount integer

        Total count of successfully uploaded reports in this execution

      • links object
        Show links properties
        • self object

          Object with Href to a particular element or set of elements

          Show self properties
          • href string
      • fileLocations array of strings

400

Bad request, malformed syntax or errors in parameters.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string

        Error code specific to sharing service.

      • meta object
        Show meta properties
        • httpCode integer

          HTTP error code.
      • title string

        Error title.

      • detail string

        Error cause.
    • traceId string

404

Task or execution not found.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string

        Error code specific to sharing service.

      • meta object
        Show meta properties
        • httpCode integer

          HTTP error code.
      • title string

        Error title.

      • detail string

        Error cause.
    • traceId string

500

Internal server error.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string

        Error code specific to sharing service.

      • meta object
        Show meta properties
        • httpCode integer

          HTTP error code.
      • title string

        Error title.

      • detail string

        Error cause.
    • traceId string

default

Error response.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string

        Error code specific to sharing service.

      • meta object
        Show meta properties
        • httpCode integer

          HTTP error code.
      • title string

        Error title.

      • detail string

        Error cause.
    • traceId string
GET /api/v1/sharing-tasks/{taskId}/executions 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.sharingTasks.getSharingTaskExecutions(
  'string',
  {},
)
qlik sharing-task execution ls \
  --sharing-taskId 'string'
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/sharing-tasks/{taskId}/executions" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "totalCount": 42,
  "currentPageCount": 42,
  "links": {
    "next": {
      "href": "http://localhost:8787/v1/items?limit=12",
      "type": "next",
      "token": "JwAAAAJfaWQAGQAAADVjZjUwM2NjMjVkYzlhMTM1MzYwZTVjZAAA"
    },
    "prev": {
      "href": "http://localhost:8787/v1/items?limit=12",
      "type": "next",
      "token": "JwAAAAJfaWQAGQAAADVjZjUwM2NjMjVkYzlhMTM1MzYwZTVjZAAA"
    },
    "self": {
      "href": "http://localhost:8787/v1/items/5da5825325dc9a0dd0260af9"
    }
  },
  "executions": [
    {
      "id": "string",
      "appId": "string",
      "files": [
        {
          "type": "image",
          "fileID": "za1b2c3d4z",
          "userId": "string",
          "fileAlias": "small-image",
          "templateId": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
          "tempContentsLocation": "string"
        }
      ],
      "errors": [
        {
          "code": "string",
          "title": "string",
          "detail": "string"
        }
      ],
      "status": "initialized",
      "endTime": "string",
      "eventID": "string",
      "ownerId": "string",
      "reloadId": "string",
      "tenantId": "string",
      "eventTime": "string",
      "startTime": "string",
      "bookmarkId": "string",
      "failedTime": "string",
      "reloadTime": "string",
      "targetUser": {
        "type": "string",
        "value": "string",
        "timezone": "string",
        "filterName": "string",
        "filterNames": [
          "string"
        ]
      },
      "totalCount": 42,
      "workflowID": "string",
      "bookmarkIds": [
        "string"
      ],
      "failedCount": 42,
      "successCount": 42,
      "cancelledTime": "string",
      "sharingTaskID": "string",
      "cancelledCount": 42,
      "totalUploadCount": 42,
      "failedUploadCount": 42,
      "successUploadCount": 42,
      "links": {
        "self": {
          "href": "http://localhost:8787/v1/items/5da5825325dc9a0dd0260af9"
        }
      },
      "fileLocations": [
        "string"
      ]
    }
  ]
}

Get sharing task execution

Retrieves a specific sharing task execution.

Facts

Rate limit Tier 1 (1000 requests per minute)

Query Parameters

  • status string

    Filter by status. If not present then no filtering is done on the status. This is only relevant when requesting latest execution.

    Can be one of: "successful""failed""cancelled"

Path Parameters

  • executionId string
    Required

    The execution identifier. If value is "latest", the latest execution will be returned

  • taskId string
    Required

    The sharing task identifier.

Responses

200

The execution has been successfully returned.

  • application/json object
    Show application/json properties
    • id string

      Gets the execution identifier.

    • appId string

      appId associated to sharing task execution

    • files array of objects
      Show files properties
      • type string

        Can be one of: "image""pdf""pptx""xlsx""html""docx"

      • fileID string
      • userId string

        userId associated with the file

      • fileAlias string
      • templateId string

        identify the source task template

        format = "uuid"

      • tempContentsLocation string
    • errors array of objects
      Show errors properties
      • code string

        Error code specific to sharing service.

      • title string

        Error title.

      • detail string

        Error cause.
    • status string

      Status of the task execution

      Can be one of: "initialized""in-progress""successful""failed""cancelled""invalid""presuccessful""cancelling"

    • endTime string

      Timestamp of execution successful stop

    • eventID string

      eventID of the trigger NATS event

    • ownerId string

      Owner of the execution

    • reloadId string

      If this execution was triggered by an app reload. This will contain the reloadId from reloads service. Otherwise it is empty or omitted.

    • tenantId string

      The tenant that this execution belongs to

    • eventTime string

      eventTime of the trigger NATS event

    • startTime string

      Timestamp of execution start

    • bookmarkId string Deprecated

      The ID of a filter in a reporting request

    • failedTime string

      Timestamp of execution stop

    • reloadTime string

      If this execution was triggered by an app reload. This will contain the reload time to compare with reporting service when the report is requested.

    • targetUser object

      User that this execution is targeting as a recipient

      Show targetUser properties
      • type string

        type of user eg email, userId, groupId

      • value string

        contains the value of user type e.g. abc@xyz.com, 213efewr3

      • timezone string

        timezone for the timestamp on the attached file name

      • filterName string Deprecated
      • filterNames array of strings

        contains the value of the user filter
    • totalCount integer

      Total count of reports in this execution

    • workflowID string

      Workflow that the execution belongs to. Note that in a multi-recipient context we can have multiple executions (one per recipient) that share the same unique workflow.

    • bookmarkIds array of strings

      The ID of a filter in a reporting request

    • failedCount integer

      Total count of failed reports in this execution

    • successCount integer

      Total count of successfully generated reports in this execution

    • cancelledTime string

      Timestamp of execution cancel

    • sharingTaskID string

      ID for the sharing task that this execution references

    • cancelledCount integer

      Total count of cancelled reports in this execution

    • totalUploadCount integer

      Total count of reports to be uploaded in this execution

    • failedUploadCount integer

      Total count of failed uploaded reports in this execution

    • successUploadCount integer

      Total count of successfully uploaded reports in this execution

    • links object
      Show links properties
      • self object

        Object with Href to a particular element or set of elements

        Show self properties
        • href string
    • fileLocations array of strings

400

The specified task or execution ID is invalid (e.g. not a number).

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string

        Error code specific to sharing service.

      • meta object
        Show meta properties
        • httpCode integer

          HTTP error code.
      • title string

        Error title.

      • detail string

        Error cause.
    • traceId string

404

Task or execution not found.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string

        Error code specific to sharing service.

      • meta object
        Show meta properties
        • httpCode integer

          HTTP error code.
      • title string

        Error title.

      • detail string

        Error cause.
    • traceId string

500

Internal server error.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string

        Error code specific to sharing service.

      • meta object
        Show meta properties
        • httpCode integer

          HTTP error code.
      • title string

        Error title.

      • detail string

        Error cause.
    • traceId string

default

Error response.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string

        Error code specific to sharing service.

      • meta object
        Show meta properties
        • httpCode integer

          HTTP error code.
      • title string

        Error title.

      • detail string

        Error cause.
    • traceId string
GET /api/v1/sharing-tasks/{taskId}/executions/{executionId} 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.sharingTasks.getSharingTaskExecution(
  'string',
  'string',
  {},
)
qlik sharing-task execution get 'string' \
  --sharing-taskId 'string'
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/sharing-tasks/{taskId}/executions/{executionId}" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "id": "string",
  "appId": "string",
  "files": [
    {
      "type": "image",
      "fileID": "za1b2c3d4z",
      "userId": "string",
      "fileAlias": "small-image",
      "templateId": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
      "tempContentsLocation": "string"
    }
  ],
  "errors": [
    {
      "code": "string",
      "title": "string",
      "detail": "string"
    }
  ],
  "status": "initialized",
  "endTime": "string",
  "eventID": "string",
  "ownerId": "string",
  "reloadId": "string",
  "tenantId": "string",
  "eventTime": "string",
  "startTime": "string",
  "bookmarkId": "string",
  "failedTime": "string",
  "reloadTime": "string",
  "targetUser": {
    "type": "string",
    "value": "string",
    "timezone": "string",
    "filterName": "string",
    "filterNames": [
      "string"
    ]
  },
  "totalCount": 42,
  "workflowID": "string",
  "bookmarkIds": [
    "string"
  ],
  "failedCount": 42,
  "successCount": 42,
  "cancelledTime": "string",
  "sharingTaskID": "string",
  "cancelledCount": 42,
  "totalUploadCount": 42,
  "failedUploadCount": 42,
  "successUploadCount": 42,
  "links": {
    "self": {
      "href": "http://localhost:8787/v1/items/5da5825325dc9a0dd0260af9"
    }
  },
  "fileLocations": [
    "string"
  ]
}

Get sharing task execution file

Retrieves the file content for the requested execution and file type.

Facts

Rate limit Tier 1 (1000 requests per minute)

Query Parameters

  • status string

    Filter by status. If not present then no filtering is done on the status. This is only relevant when requesting latest execution.

    Can be one of: "successful""failed""cancelled"

Path Parameters

  • executionId string
    Required

    The execution identifier.

  • fileAlias string
    Required

    The execution identifier. If value is "latest", the latest execution will be returned

  • taskId string
    Required

    The sharing task identifier.

Responses

200

The content of the file has been successfully returned.

  • image/png string

    format = "binary"

200

The content of the file has been successfully returned.

  • application/json string

    format = "binary"

404

A task or execution with the specified ID was not found.

  • image/png object
    Show image/png properties
    • errors array of objects
      Show errors properties
      • code string

        Error code specific to sharing service.

      • meta object
        Show meta properties
        • httpCode integer

          HTTP error code.
      • title string

        Error title.

      • detail string

        Error cause.
    • traceId string

404

A task or execution with the specified ID was not found.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string

        Error code specific to sharing service.

      • meta object
        Show meta properties
        • httpCode integer

          HTTP error code.
      • title string

        Error title.

      • detail string

        Error cause.
    • traceId string

500

Internal server error.

  • image/png object
    Show image/png properties
    • errors array of objects
      Show errors properties
      • code string

        Error code specific to sharing service.

      • meta object
        Show meta properties
        • httpCode integer

          HTTP error code.
      • title string

        Error title.

      • detail string

        Error cause.
    • traceId string

500

Internal server error.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string

        Error code specific to sharing service.

      • meta object
        Show meta properties
        • httpCode integer

          HTTP error code.
      • title string

        Error title.

      • detail string

        Error cause.
    • traceId string

default

Error response.

  • image/png object
    Show image/png properties
    • errors array of objects
      Show errors properties
      • code string

        Error code specific to sharing service.

      • meta object
        Show meta properties
        • httpCode integer

          HTTP error code.
      • title string

        Error title.

      • detail string

        Error cause.
    • traceId string

default

Error response.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string

        Error code specific to sharing service.

      • meta object
        Show meta properties
        • httpCode integer

          HTTP error code.
      • title string

        Error title.

      • detail string

        Error cause.
    • traceId string
GET /api/v1/sharing-tasks/{taskId}/executions/{executionId}/files/{fileAlias} 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.sharingTasks.getSharingTaskExecutionFile(
  'string',
  'string',
  'string',
  {},
)
qlik sharing-task execution get-file 'string' \
  --sharing-taskId 'string' \
  --executionId 'string'
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/sharing-tasks/{taskId}/executions/{executionId}/files/{fileAlias}" \
-H "Authorization: Bearer <access_token>"

Example Response

"string"

Start sharing task execution

Requests execution of the specified recurring sharing task.

Facts

Rate limit Tier 2 (100 requests per minute)

Request Body

Required

The sharing task execute request definition.

  • application/json object
    Show application/json properties
    • sharingTaskID string
      Required

      Identifier of the sharing task to trigger.

Responses

204

The sharing task has been successfully set up for execution.

400

Bad request, malformed syntax or errors in parameters.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string

        Error code specific to sharing service.

      • meta object
        Show meta properties
        • httpCode integer

          HTTP error code.
      • title string

        Error title.

      • detail string

        Error cause.
    • traceId string

404

Task not found, if the provided sharing task cannot be found or otherwise unable to be executed

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string

        Error code specific to sharing service.

      • meta object
        Show meta properties
        • httpCode integer

          HTTP error code.
      • title string

        Error title.

      • detail string

        Error cause.
    • traceId string

500

Internal server error.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string

        Error code specific to sharing service.

      • meta object
        Show meta properties
        • httpCode integer

          HTTP error code.
      • title string

        Error title.

      • detail string

        Error cause.
    • traceId string

default

Error response.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string

        Error code specific to sharing service.

      • meta object
        Show meta properties
        • httpCode integer

          HTTP error code.
      • title string

        Error title.

      • detail string

        Error cause.
    • traceId string
POST /api/v1/sharing-tasks/actions/execute 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.sharingTasks.executeSharingTasks({
  sharingTaskID: 'a1b2c3d4f5',
})
qlik sharing-task execute \
  --sharingTaskID 'a1b2c3d4f5'
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/sharing-tasks/actions/execute" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"sharingTaskID":"a1b2c3d4f5"}'

Get sharing settings

Retrieves the current settings for sharing tasks, reports, and other related configuration.

Facts

Rate limit Tier 1 (1000 requests per minute)

Responses

200

The sharing settings have been successfully returned

  • application/json object
    Show application/json properties
    • tenantId string

      These persisted sharing settings are only available for this tenant. Extracted from request JWT.

    • maxRecipients number

      Maximum number of recipients when creating a sharing task

    • enable-sharing boolean

      Whether API endpoints for sharing are enabled

    • reportSubscriptionStatus string

      This indicates that there is an ongoing operation to either disable or enable the report subscription feature. none means that no such operation is ongoing. enabling/disabling means that system is currently enabling/disabling the feature

      Can be one of: "none""enabling""disabling"

    • maxSubscriptionRecipients integer

      Max Recipients accepted when creating a new subscription (excluding the owner)

    • enable-report-subscription boolean

      true if report-subscription feature is enabled for this tenant

    • reporting-service-license-status string

      Whether the license for the tenant has the reportingService feature enabled.

      Can be one of: "enabled""disabled"

    • reportSubscriptionStatusChangeTime string

      UTC timestamp of the most recent change of reportSubscriptionStatus. If there has not been any such change, this is the timestamp of the initial creation of the record.

500

Internal server error.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string

        Error code specific to sharing service.

      • meta object
        Show meta properties
        • httpCode integer

          HTTP error code.
      • title string

        Error title.

      • detail string

        Error cause.
    • traceId string

default

Error response.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string

        Error code specific to sharing service.

      • meta object
        Show meta properties
        • httpCode integer

          HTTP error code.
      • title string

        Error title.

      • detail string

        Error cause.
    • traceId string
GET /api/v1/sharing-tasks/settings 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.sharingTasks.getSharingTasksSettings()
qlik sharing-task settings get
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/sharing-tasks/settings" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "tenantId": "cgdsAumGmQ6l0Bi7CUKt9V8P_Y9GL0sC",
  "maxRecipients": 200,
  "enable-sharing": true,
  "reportSubscriptionStatus": "disabling",
  "maxSubscriptionRecipients": 42,
  "enable-report-subscription": true,
  "reporting-service-license-status": "enabled",
  "reportSubscriptionStatusChangeTime": "2020-09-02T13:44:33Z"
}

Update sharing toggle settings

Patches the toggle settings for sharing tasks, reports, and other related configuration in the tenant. User must be assigned the TenantAdmin role.

Facts

Rate limit Tier 2 (100 requests per minute)

Request Body

Required

Request for updating the API settings

  • application/json array of objects

    A JSON Patch document as defined in https://datatracker.ietf.org/doc/html/rfc6902.

    Show application/json properties
    • op string
      Required

      The operation to be performed.

      Can be one of: "replace"

    • path string
      Required

      The path for the given resource field to patch.

      Can be one of: "/enable-sharing""/enable-report-subscription"

    • value object

      The value to be used for this operation.

Responses

204

Sharing settings have been successfully updated.

400

Bad request body

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string

        Error code specific to sharing service.

      • meta object
        Show meta properties
        • httpCode integer

          HTTP error code.
      • title string

        Error title.

      • detail string

        Error cause.
    • traceId string

500

Internal server error.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string

        Error code specific to sharing service.

      • meta object
        Show meta properties
        • httpCode integer

          HTTP error code.
      • title string

        Error title.

      • detail string

        Error cause.
    • traceId string

default

Error response.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string

        Error code specific to sharing service.

      • meta object
        Show meta properties
        • httpCode integer

          HTTP error code.
      • title string

        Error title.

      • detail string

        Error cause.
    • traceId string
PATCH /api/v1/sharing-tasks/settings 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.sharingTasks.updateSharingTasksSettings(
  [
    {
      op: 'replace',
      path: '/enable-sharing',
      value: true,
    },


    { op: 'replace', path: '/enable-sharing' },


    {
      op: 'replace',
      path: '/enable-report-subscription',
      value: true,
    },


    {
      op: 'replace',
      path: '/enable-report-subscription',
    },
  ],
)
qlik sharing-task settings update \
  --op 'replace' \
  --path '/enable-sharing'
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/sharing-tasks/settings" \
-X PATCH \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '[{"op":"replace","path":"/enable-sharing","value":true},{"op":"replace","path":"/enable-sharing","value":false},{"op":"replace","path":"/enable-report-subscription","value":true},{"op":"replace","path":"/enable-report-subscription","value":false}]'

Update sharing settings

Updates the settings for sharing tasks, reports, and other related configuration in the tenant. User must be assigned the TenantAdmin role.

Facts

Rate limit Tier 2 (100 requests per minute)

Request Body

Required

Request for updating the API settings

  • application/json object
    Show application/json properties
    • enable-sharing boolean
      Required

      Whether API endpoints for sharing are enabled

Responses

204

API settings have been successfully updated.

400

Bad request body

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string

        Error code specific to sharing service.

      • meta object
        Show meta properties
        • httpCode integer

          HTTP error code.
      • title string

        Error title.

      • detail string

        Error cause.
    • traceId string

500

Internal server error.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string

        Error code specific to sharing service.

      • meta object
        Show meta properties
        • httpCode integer

          HTTP error code.
      • title string

        Error title.

      • detail string

        Error cause.
    • traceId string

default

Error response.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string

        Error code specific to sharing service.

      • meta object
        Show meta properties
        • httpCode integer

          HTTP error code.
      • title string

        Error title.

      • detail string

        Error cause.
    • traceId string
PUT /api/v1/sharing-tasks/settings 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.sharingTasks.configureSharingTasksSettings(
  { 'enable-sharing': true },
)
qlik sharing-task settings set \
  --enable-sharing true
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/sharing-tasks/settings" \
-X PUT \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"enable-sharing":true}'