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

filter string

The filter for finding entries.
limit integer

The maximum number of entries to return.

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

The number of elements to skip for pagination.

minimum = 0, default = 0, default = 0
page string

The cursor to the page of data.
sort array of strings

Sort the returned result set by the specified field

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

Path Parameters

taskId string

Required

The sharing task identifier.

Responses

200

The task 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
- data array of objects
  
  The list of task executions.
  
  Show data properties
  
  id string
  
  The task execution ID.
  
  errors array of objects
  
  The errors that occurred during the task execution.
  
  Show errors properties
  
  code string
  
  The error code.
  
  title string
  
  The title of the error.
  
  detail string
  
  The details about the error.
  
  status string
  
  Filterable
  
  The status of the task execution.
  
  eventId string
  
  The event ID.
  
  tenantId string
  
  The tenant ID.
  
  createdBy string
  
  Filterable
  
  The creator of the task, represented by user ID.
  
  startedAt string
  
  Filterable
  
  The start timestamp.
  
  updatedAt string
  
  The update timestamp.
  
  finishedAt string
  
  Filterable
  
  The finish timestamp.
  
  triggerType string
  
  Filterable
  
  The type of trigger.
  
  Can be one of: "manual""onSchedule""onReload"
  
  sharingTaskId string
  
  The sharing task ID.
  
  eventTimestamp string
  
  The event timestamp.
  
  recipientsCount integer
  
  Filterable
  
  The number of recipients.
  
  templateMetadata object
  
  A map of template metadata, where the key is the task template ID.
  
  Show additional optional properties
  
  object object
  
  Show object properties
  
  name string
  
  The name of the template.
  
  type string
  
  The template type.
  
  fileName string
  
  The file name to use when generating the report.
  
  cycleFields array of strings
  
  The fields used for report cycles.
  
  outputFormat string
  
  The output format of the template
  
  failedReportCount integer
  
  Filterable
  
  The number of failed reports.
  
  transportChannels array of strings
  
  A list of transport channels.
  
  Values may be any of: "email""sharepoint"
  
  successReportCount integer
  
  Filterable
  
  The number of successful reports.
  
  recurrenceFrequency string
  
  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"
  
  cancelledReportCount integer
  
  Filterable
  
  The number of cancelled reports.
  
  reportOnSharePointCount integer
  
  The number of reports on SharePoint.
- 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

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

Resource does not exist.

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/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 alerting sharing-task task-execution ls \
  --sharing-taskId 'string'

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