--- source: https://qlik.dev/toolkits/qlik-cli/sharing-task/sharing-task-create/ last_updated: 2025-06-18T09:34:47+02:00 --- # sharing-task create ## qlik sharing-task create Creates a new recurring sharing task ### Synopsis Creates a new recurring sharing task. ``` qlik sharing-task create [flags] ``` ### Options ``` --appName string (Deprecated) Name of the app associated (through the templates) with this sharing task --dataConnectionID string the id of the data connection --description string Description of the sharing task --distributionListId string the id of the distribution list associated to the app --emailContent-body string --emailContent-subject string --emailContent-templateId string ID of unique template --emailContent-type string Whether email uses plain text or an html report as body Allowed values: "text", "report" --enabled Toggle for enabling sharing task. --executeOnCreation making this true will execute the sharing task upon creation regardless of next trigger --expiration string Timestamp for the termination of the task -f, --file file Read request body from the specified file -h, --help help for create --interval int Duration in seconds to wait between retries, at least 1 (default 1) --message string Message along with sharing task --name string (Required) Name of this sharing task -q, --quiet Return only IDs from the command --raw Return original response from server without any processing --recipients-DLGroups-enabled Whether this recipient is enabled. --recipients-DLGroups-filters-name string Filter name --recipients-DLGroups-filters-value string Filter value --recipients-DLGroups-membersCount int Number of members in this group --recipients-DLGroups-name string Name of the group --recipients-DLGroups-taskGroupRecipientErrors-timestamp string Timestamp for the creation of the error --recipients-DLGroups-taskGroupRecipientErrors-value string Identifier for type of error occurring on sharing task specific for group recipient Allowed values: "GROUP_IS_DISABLED", "MAX_ALERTS_LIMIT_REACHED", "GROUP_WITH_NO_APP_ACCESS", "GROUP_IS_DELETED", "GROUP_NOT_FOUND_DL", "GROUP_DISABLED_IN_DL" --recipients-DLUsers-email string Email of the user --recipients-DLUsers-enabled Whether this recipient is enabled. --recipients-DLUsers-filters-name string Filter name --recipients-DLUsers-filters-value string Filter value --recipients-DLUsers-groups-description string Group description --recipients-DLUsers-groups-enabled Whether the group is enabled --recipients-DLUsers-groups-name string Group name --recipients-DLUsers-name string Name of the user --recipients-DLUsers-taskRecipientErrors-timestamp string Timestamp for the creation of the error --recipients-DLUsers-taskRecipientErrors-value string Identifier for type of error occurring on sharing task specific for recipient Allowed values: "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" --recipients-emailAddresses strings List of recipients. An internal recipient is represented by their user id. --recipients-userIds-alertingTaskRecipientErrors-added string Timestamp for the creation of the error --recipients-userIds-alertingTaskRecipientErrors-value string Identifier for type of error occurring on alerting task Allowed values: "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" --recipients-userIds-enabled Whether this recipient can receive alerts. --recipients-userIds-groups strings A list of associated groups. If a user is added individually the "addedIndividually" pseudo group is included --recipients-userIds-subscribed Whether this recipient is subscribed to alerts of a task --recipients-userIds-taskRecipientErrors-timestamp string Timestamp for the creation of the error --recipients-userIds-taskRecipientErrors-value string Identifier for type of error occurring on sharing task specific for recipient Allowed values: "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" --recipients-userIds-value string User ID of recipient (internal user). --retentionPolicy-historySize int Number indicating the size of the window which stores the history. For Chart monitoring, the size should be 10. --retentionPolicy-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 --retry int Number of retries to do before failing, max 10 --scheduleOptions-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. --scheduleOptions-recurrence 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. --scheduleOptions-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. --scheduleOptions-timezone string The timezone for time calculations in SCHEDULED triggers, optional. --sharePointFolder string the SharePoint folder to upload the report to --spaceId string Space ID of the sharing task --startTime string Time to start capturing the history --state-fields unknowns (Required) Selected fields that led to discovery of monitored Insight Advisor chart --state-queryItems unknowns (Required) Query that led to discovery of monitored Insight Advisor chart --state-selections-displayName string (Required) State of the selections and jsOpts --state-selections-displayValues strings (Required) State of the selections and jsOpts --state-selections-isNumeric (Required) State of the selections and jsOpts --state-selections-name string (Required) State of the selections and jsOpts --state-selections-stateName string (Required) State of the selections and jsOpts --state-selections-values strings (Required) State of the selections and jsOpts --subType string (Deprecated) the sharing task resource mashup sub type. Allowed values: "pdf", "pptx", "xlsx", "html" --tags strings used to assign sharing task to a collection bucket (tags) --templates unknowns (Required) --templates-chartData-appId string (Required) ID of app --templates-chartData-groupStates unknowns (Required) The group states that will be applied for cyclic groups --templates-chartData-heightPx int (Required) heightPx of chart --templates-chartData-jsOpts unknown (Required) Visualization state from client as a string json value. Can include language, theme, viewState etc. --templates-chartData-objectDef unknown (Required) Session chart object definition --templates-chartData-objectId string (Required) ID of object --templates-chartData-outDpi int (Required) outDpi of chart --templates-chartData-outZoom int (Required) outZoom of chart --templates-chartData-patches unknowns (Required) Soft property changes on chart --templates-chartData-sheetId string (Required) sheetId of app --templates-chartData-widthPx int (Required) widthPx of chart --templates-excelData-appId string (Required) ID of app --templates-excelData-cycleFields strings (Required) The name of the fields to cycle on for report-cycles. If empty, a regular sense excel template will be requested. --templates-excelData-name string (Required) Name of template --templates-excelData-outputFormat string (Required) The output format of the template Allowed values: "pdf", "pptx", "xlsx", "html" --templates-excelData-persistentBookmark-id string (Required) Sense Persistence Bookmark id. --templates-excelData-selectionType string (Required) data for sense excel type template Allowed values: "persistentBookmark", "temporaryBookmarkV2" --templates-excelData-templateId string (Required) ID of template --templates-excelData-temporaryBookmarkV2-id string (Required) Sense Temporary Bookmark id. --templates-fileAlias string (Required) fileAlias provide an opaqueId for the client which can be used to filter and select the report generated --templates-fileName string (Required) fileName to be used when generating the report --templates-fileTimeStamp string (Required) file name timestamp to be used when generating the report Allowed values: "yyyy-MM-dd", "yyyy-MM-dd_HH-mm", "yyyyMMdd", "yyyyMMdd_HH-mm" --templates-htmlData-appId string (Required) ID of app --templates-htmlData-cycleFields strings (Required) The name of the fields to cycle on for report-cycles. If empty, a regular sense excel template will be requested. --templates-htmlData-name string (Required) Name of template --templates-htmlData-outputFormat string (Required) The output format of the template Allowed values: "pdf", "pptx", "xlsx", "html" --templates-htmlData-persistentBookmark-id string (Required) Sense Persistence Bookmark id. --templates-htmlData-selectionType string (Required) data for sense html type template Allowed values: "persistentBookmark", "temporaryBookmarkV2" --templates-htmlData-templateId string (Required) ID of template --templates-htmlData-temporaryBookmarkV2-id string (Required) Sense Temporary Bookmark id. --templates-language string (Required) language to be used when generating the report Allowed values: "de-DE", "en-US", "es-ES", "fr-FR", "it-IT", "ja-JP", "ko-KR", "nl-NL", "pl-PL", "pt-BR", "ru-RU", "sv-SE", "tr-TR", "zh-CN", "zh-TW" --templates-multiSheetData-appId string (Required) ID of app --templates-multiSheetData-groupStates unknowns (Required) The group states that will be applied for cyclic groups --templates-multiSheetData-heightPx int (Required) heightPx of chart, must be 0 or omitted for autofit. --templates-multiSheetData-isPrivate (Required) optional value to indicate that this sheet is private --templates-multiSheetData-jsOpts unknown (Required) Sheet state from client as a string json value. Can include language, theme, viewState etc. --templates-multiSheetData-jsOptsById key:unknown (Required) array of sheet data for multi-sheet type template --templates-multiSheetData-patchesById key:unknowns (Required) array of sheet data for multi-sheet type template --templates-multiSheetData-resizeType string (Required) 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. Allowed values: "none", "fit", "autofit" --templates-multiSheetData-sheetId string (Required) ID of sheet --templates-multiSheetData-sheetName string (Required) an optional name for the sheet --templates-multiSheetData-widthPx int (Required) widthPx of chart, must be 0 or omitted for autofit. --templates-pixelPerfectData-appId string (Required) ID of app --templates-pixelPerfectData-cycleFields strings (Required) The name of the fields to cycle on for report-cycles. If empty, a regular sense excel template will be requested. --templates-pixelPerfectData-name string (Required) Name of template --templates-pixelPerfectData-outputFormat string (Required) The output format of the template Allowed values: "pdf", "pptx", "xlsx", "html" --templates-pixelPerfectData-persistentBookmark-id string (Required) Sense Persistence Bookmark id. --templates-pixelPerfectData-selectionType string (Required) data for sense pixel perfect type template Allowed values: "persistentBookmark", "temporaryBookmarkV2" --templates-pixelPerfectData-templateId string (Required) ID of template --templates-pixelPerfectData-temporaryBookmarkV2-id string (Required) Sense Temporary Bookmark id. --templates-sheetData-appId string (Required, Deprecated) ID of app --templates-sheetData-groupStates unknowns (Required, Deprecated) The group states that will be applied for cyclic groups --templates-sheetData-heightPx int (Required, Deprecated) heightPx of chart --templates-sheetData-isPrivate (Required, Deprecated) optional value to indicate that this sheet is private (used in multi-sheet sharing) --templates-sheetData-jsOpts unknown (Required, Deprecated) Sheet state from client as a string json value. Can include language, theme, viewState etc. --templates-sheetData-jsOptsById key:unknown (Required, Deprecated) --templates-sheetData-patchesById key:unknowns (Required, Deprecated) --templates-sheetData-sheetId string (Required, Deprecated) ID of sheet --templates-sheetData-sheetName string (Required, Deprecated) an optional name for the sheet (used in multi-sheet sharing) --templates-sheetData-widthPx int (Required, Deprecated) widthPx of chart --templates-storyData-appId string (Required) ID of app --templates-storyData-storyId string (Required) ID of story --templates-subType string (Required) Allowed values: "image", "snapshot", "pdf", "pptx", "xlsx", "qpxp", "qhtml" --templates-type string (Required) Allowed values: "file", "chart", "story", "sheet", "multi-sheet", "excel", "pixel-perfect", "html" --transportChannels strings the transport type for the report Allowed values: "email", "sharepoint" --trigger-executeOnAppReload Toggle for executing sharing task on app reload. --trigger-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. Allowed values: "minutely", "hourly", "daily", "weekly", "monthly", "quarterly", "yearly" --trigger-recurrence 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. --type string (Required) the sharing task resource type. Allowed values: "chart-monitoring", "chart-sharing", "sheet-sharing", "template-sharing" ``` ### Options inherited from parent commands ``` -c, --config string path/to/config.yml where parameters can be set instead of on the command line --context string Name of the context used when connecting to Qlik Associative Engine --headers stringToString HTTP headers to use when connecting to Qlik Associative Engine (default []) --insecure Allow connecting to hosts with self-signed certificates --json Returns output in JSON format, if possible. Disables verbose and traffic output -s, --server string URL to Qlik Cloud or directly to a Qlik Associative Engine --server-type string The type of server you are using: cloud, Windows (Enterprise on Windows) or engine -v, --verbose Log extra information ```