Sharing tasks

Download OpenAPI spec

The Sharing tasks API in the alerting namespace provides access to the execution history of sharing tasks. Use it to list task executions and retrieve the details of a specific execution.

This API exposes a subset of the functionality available in the v1 Sharing tasks API.

Endpoints

GET

/api/alerting/sharing-tasks/{taskId}/task-executions
GET

/api/alerting/sharing-tasks/{taskId}/task-executions/{taskExecutionId}

Returns the execution history of a sharing task. Executions that are in progress are not included.

Facts

Rate limit

Tier 1 (1000 requests per minute)

Query Parameters

filterstring

The filter for finding entries.
limitinteger

The maximum number of entries to return.

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

The number of elements to skip for pagination.

minimum = 0, default = 0, default = 0
pagestring

The cursor to the page of data.
sortarray of strings

Sort the returned result set by the specified field

Values may be any of: "status""-status""+status""startedAt""-startedAt""+startedAt"

Path Parameters

taskIdstring
Required

The sharing task identifier.

Responses

200

The task executions list has been successfully returned.

application/jsonobject

properties that should be added to every list response
Show application/json properties
- totalCountinteger
  Required
  
  total count of entries in the collection as a whole
- currentPageCountinteger
  Required
  
  count of entries on the currently shown page
- dataarray of objects
  
  The list of task executions.
  
  Show data properties
  
  idstring
  
  The task execution ID.
  
  errorsarray of objects
  
  The errors that occurred during the task execution.
  
  Show errors properties
  
  codestring
  
  The error code.
  
  titlestring
  
  The title of the error.
  
  detailstring
  
  The details about the error.
  
  statusstring
  Filterable
  
  The status of the task execution.
  
  eventIdstring
  
  The event ID.
  
  tenantIdstring
  
  The tenant ID.
  
  createdBystring
  Filterable
  
  The creator of the task, represented by user ID.
  
  startedAtstring
  Filterable
  
  The start timestamp.
  
  updatedAtstring
  
  The update timestamp.
  
  finishedAtstring
  Filterable
  
  The finish timestamp.
  
  triggerTypestring
  Filterable
  
  The type of trigger.
  
  Can be one of: "manual""onSchedule""onReload"
  
  sharingTaskIdstring
  
  The sharing task ID.
  
  eventTimestampstring
  
  The event timestamp.
  
  recipientsCountinteger
  Filterable
  
  The number of recipients.
  
  templateMetadataobject
  
  A map of template metadata, where the key is the task template ID.
  
  Show additional optional properties
  
  objectobject
  
  Show object properties
  
  namestring
  
  The name of the template.
  
  typestring
  
  The template type.
  
  fileNamestring
  
  The file name to use when generating the report.
  
  cycleFieldsarray of strings
  
  The fields used for report cycles.
  
  outputFormatstring
  
  The output format of the template
  
  failedReportCountinteger
  Filterable
  
  The number of failed reports.
  
  transportChannelsarray of strings
  
  A list of transport channels.
  
  Values may be any of: "email""sharepoint"
  
  successReportCountinteger
  Filterable
  
  The number of successful reports.
  
  recurrenceFrequencystring
  
  The 'FREQ' component of the RRULE at execution time, empty when triggered by a non-scheduled execution.
  
  Can be one of: "SECONDLY""MINUTELY""HOURLY""DAILY""WEEKLY""MONTHLY""YEARLY"
  
  cancelledReportCountinteger
  Filterable
  
  The number of cancelled reports.
  
  reportOnSharePointCountinteger
  
  The number of reports on SharePoint.
- linksobject
  
  Show links properties
  
  nextobject
  
  Show next properties
  
  hrefstring
  
  URL to particular set of elements
  
  typestring
  
  Page type, can be next or prev
  
  Can be one of: "prev""next"
  
  tokenstring
  
  Page unique token
  
  prevobject
  
  Show prev properties
  
  hrefstring
  
  URL to particular set of elements
  
  typestring
  
  Page type, can be next or prev
  
  Can be one of: "prev""next"
  
  tokenstring
  
  Page unique token
  
  selfobject
  
  Object with Href to a particular element or set of elements
  
  Show self properties
  
  hrefstring

400

Bad request, malformed syntax or errors in parameters.

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  
  Error code specific to sharing service.
  
  metaobject
  
  Show meta properties
  
  httpCodeinteger
  
  HTTP error code.
  
  titlestring
  
  Error title.
  
  detailstring
  
  Error cause.
- traceIdstring

404

Resource does not exist.

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  
  Error code specific to sharing service.
  
  metaobject
  
  Show meta properties
  
  httpCodeinteger
  
  HTTP error code.
  
  titlestring
  
  Error title.
  
  detailstring
  
  Error cause.
- traceIdstring

500

Internal server error.

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  
  Error code specific to sharing service.
  
  metaobject
  
  Show meta properties
  
  httpCodeinteger
  
  HTTP error code.
  
  titlestring
  
  Error title.
  
  detailstring
  
  Error cause.
- traceIdstring

default

Error response.

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  
  Error code specific to sharing service.
  
  metaobject
  
  Show meta properties
  
  httpCodeinteger
  
  HTTP error code.
  
  titlestring
  
  Error title.
  
  detailstring
  
  Error cause.
- traceIdstring

GET /api/alerting/sharing-tasks/{taskId}/task-executions

// qlik-api has not implemented support for `GET /api/alerting/sharing-tasks/{taskId}/task-executions` yet.
// In the meantime, you can use fetch like this:

const response = await fetch(
  '/api/alerting/sharing-tasks/{taskId}/task-executions',
  {
    method: 'GET',
    headers: {
      'Content-Type': 'application/json',
    },
  },
)

# qlik-cli has not implemented support for GET /api/alerting/sharing-tasks/{taskId}/task-executions yet.

curl "https://{tenant}.{region}.qlikcloud.com/api/alerting/sharing-tasks/{taskId}/task-executions" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "totalCount": 42,
  "currentPageCount": 42,
  "data": [
    {
      "id": "string",
      "errors": [
        {
          "code": "string",
          "title": "string",
          "detail": "string"
        }
      ],
      "status": "string",
      "eventId": "string",
      "tenantId": "string",
      "createdBy": "string",
      "startedAt": "string",
      "updatedAt": "string",
      "finishedAt": "string",
      "triggerType": "manual",
      "sharingTaskId": "string",
      "eventTimestamp": "string",
      "recipientsCount": 42,
      "templateMetadata": {},
      "failedReportCount": 42,
      "transportChannels": [
        "email",
        "sharepoint"
      ],
      "successReportCount": 42,
      "recurrenceFrequency": "SECONDLY",
      "cancelledReportCount": 42,
      "reportOnSharePointCount": 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"
    }
  }
}