How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Qlik Sharing tasks API

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.

Qlik Sharing tasks API is one of 82 APIs that Qlik Sense APIs publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Business Intelligence, Export, REST, and Reporting. The published artifact set on APIs.io includes API documentation, an API reference, and an OpenAPI specification.

This API exposes 13 operations across 8 paths, organized into 4 resource areas, and defines 53 schemas. It is described by OpenAPI 3.0.0.

Requests are made against a single base URL, https://{tenant}.{region}.qlikcloud.com.

13 operations 8 paths 53 schemas 1 DELETE6 GET2 PATCH3 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
Base URL
https://{tenant}.{region}.qlikcloud.com/api/v1/sharing-tasks
Resource Areas
4

Paths & Operations 13

Across 8 paths, the API surfaces 13 operations — 1 DELETE, 6 GET, 2 PATCH, 3 POST, 1 PUT. They span 4 resource areas: sharing tasks, sharing tasks actions, sharing tasks executions, sharing settings. Each is listed below with its method, path, parameters, and response codes.

sharing tasks 5
GET
/api/v1/sharing-tasks
List sharing tasks
sharingTasksList 13 params → 200400500default
POST
/api/v1/sharing-tasks
Create sharing task
sharingTasksCreateRecurring body → 201400500default
GET
/api/v1/sharing-tasks/{taskId}
Get sharing task
sharingTasksIDGet 2 params → 200400404500default
PATCH
/api/v1/sharing-tasks/{taskId}
Update sharing task
sharingTasksUpdate 1 param body → 204400404500default
DELETE
/api/v1/sharing-tasks/{taskId}
Delete sharing task
sharingTasksDelete 1 param → 204400404500default
sharing tasks actions 2
POST
/api/v1/sharing-tasks/{taskId}/actions/cancel
Cancel sharing task execution
sharingTasksActionsCancel 1 param → 204400404500default
POST
/api/v1/sharing-tasks/actions/execute
Start sharing task execution
sharingTasksActionsRecurring body → 204400404500default
sharing tasks executions 3
GET
/api/v1/sharing-tasks/{taskId}/executions
List sharing task executions
SharingExecutionsList 7 params → 200400404500default
GET
/api/v1/sharing-tasks/{taskId}/executions/{executionId}
Get sharing task execution
sharingExecutionsIDGet 3 params → 200400404500default
GET
/api/v1/sharing-tasks/{taskId}/executions/{executionId}/files/{fileAlias}
Get sharing task execution file
sharingExecutionsFilesAliasGet 4 params → 200404500default
sharing settings 3
GET
/api/v1/sharing-tasks/settings
Get sharing settings
sharingSettingsGet → 200500default
PATCH
/api/v1/sharing-tasks/settings
Update sharing toggle settings
sharingSettingsPatch body → 204400500default
PUT
/api/v1/sharing-tasks/settings
Update sharing settings
sharingAPISettingsUpload body → 204400500default

Schemas 53

The contract defines 53 schemas that model the data the API accepts and returns. The most detailed are SharingTaskRecurringPersist (57 properties), SharingExecutionPersist (27 properties), SharingTaskRecurringCreateRequest (24 properties), MultiSheetTemplate (11 properties). Each schema is shown below with its type and property counts.

AlertingTaskGroupRecipientError
object
2 properties
AlertingTaskRecipientError
object
2 properties
APISettingsUpload
object
2 properties 1 required
ChartTemplate
object
If the template type is not "chart", this can be null. Otherwise, the following properties are required: appId, sheetId, objectId, widthPx, heightPx, language.…
11 properties
CleanupStrategy
string
A bookmark is considered old if its modification date is older than the app creation date.
EmailAddressRecipientPersist
object
recipient object model that is directly persisted in the DB
3 properties
EmailComposition
object
2 properties
EncryptedProperty
object
Encrypted property in DB
2 properties
Error
object
4 properties
Error_meta
object
1 property
Errors
object
2 properties
GroupIDRecipientPersist
object
recipient object model that is directly persisted in the DB
5 properties
InsightURL
object
In case of multiple insight urls for multi-sheet sharing (or subsequent multi types) this defines those URLs and a mapping to the correct object.
6 properties
Links
object
1 property
ListLinks
object
3 properties
MultiSheetTemplate
object
11 properties
Page
object
3 properties
RecipientsPersist
object
List of persisted recipients.
6 properties
RetentionPolicy
object
2 properties
ScheduleOptions
object
7 properties
Selection
object
6 properties 4 required
Self
object
Object with Href to a particular element or set of elements
1 property
SharingActionsTriggerCreateRequest
object
1 property 1 required
SharingExecutionError
object
3 properties
SharingExecutionErrors
array
SharingExecutionFile
object
6 properties
SharingExecutionListResponse
SharingExecutionPersist
object
27 properties
SharingExecutionResponse
SharingSettings
object
8 properties
SharingSettingsPatchCompliant
object
3 properties 2 required
SharingSettingsPatchCompliantList
array
A JSON Patch document as defined in https://datatracker.ietf.org/doc/html/rfc6902.
SharingTaskPatchRequestCompliantList
array
SharingTaskRecurringCreateRequest
object
24 properties 4 required
SharingTaskRecurringListResponse
SharingTaskRecurringPatchRequestCompliant
object
3 properties 2 required
SharingTaskRecurringPersist
object
Type of object stored in the database. Required fields mean that property cannot be null
57 properties
SharingTaskRecurringPersist_encryptedEmailContent
object
the subject and body content for the email to send on report subscriptions
2 properties
SharingTaskRecurringRecipients
object
List of recipients. An internal recipient is represented by their user id.
4 properties
SharingTaskRecurringResponse
Whatever is persisted in the db + links
SheetTemplate
object
9 properties
StandardListResponseProps
object
properties that should be added to every list response
2 properties 2 required
State
object
State of the selections and jsOpts
3 properties
StoryTemplate
object
2 properties
TargetUser
object
User that this execution is targeting as a recipient
5 properties
TaskError
object
2 properties
TaskGroupRecipientError
object
2 properties
TaskRecipientError
object
2 properties
TemplatePersist
object
Depending on the value of type, sharing service will internally validate a specific property regarding its data. Type "file" validates property "fileData", typ…
10 properties 1 required
TemplateResult
object
Trigger
object
4 properties 1 required
UserIDRecipient
object
an internal recipient based on its user id.
6 properties
UserIDRecipientPersist
object
recipient object model that is directly persisted in the DB
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

qliksense-sharing-tasks.json Raw ↑

Other APIs Qlik Sense APIs publishes across the network.

Qlik Engine API
Qlik Server-Side Extension Protocol
Qlik Cloud System Events
Qlik MCP Server
Qlik Apps API
Qlik Change stores API
Qlik Adaptive cards API
Qlik ODAG apps API
Qlik ODAG links API
Qlik ODAG requests API
Qlik ODAG settings API
Qlik API keys API
Where this information came from

This is an independent, third-party profile of Qlik Sharing tasks API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.