sharing

Supports chart sharing, chart monitoring and alerting features. The legacy sharing APIs refer to chart sharing and chart monitoring, which is a feature that allows the user to send an e-mail with an embedded chart either manually (chart sharing) or in a recurring manner (chart monitoring). It also stores the history related to these actions. The alerting/ data-alerts APIs support the alerting feature, where a user is able to create alerts that trigger notifications in case a condition in the dataset of an app is fulfilled.

Endpoints

Skip to section
GET/sharing/tasks/{taskId}/recipient-stats

Get the recipient stats for a sharing task

Path Parameters GET /sharing/tasks/{taskId}/recipient-stats

taskId
string

The sharing task identifier.

Responses GET /sharing/tasks/{taskId}/recipient-stats

200

Sharing tasks recipient stats have been successfully returned.

400
application/json

Bad request, malformed syntax or errors in parameters.

404
application/json

Task or execution not found.

500
application/json

Internal server error.

default
application/json

Error response.

GET/sharing/tasks/{taskId}/recipient-stats

curl "https://your-tenant.us.qlikcloud.com/api/v1/sharing/tasks/{taskId}/recipient-stats" \
 -H "Authorization: Bearer <API-key>"

Response GET /sharing/tasks/{taskId}/recipient-stats

{
  "recipientStats": [
    {
      "type": "userid",
      "value": "string",
      "enabled": true,
      "subscribed": true,
      "lastExecutionTime": "string",
      "nextExecutionTime": "string",
      "errors": [
        {
          "value": "USER_IS_DELETED",
          "timestamp": "2019-10-15T16:07:01.492Z"
        }
      ]
    }
  ]
}

JsonPatches

Array<JsonPatch>

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

Properties

op
string

The operation to be performed.

Enum:

replace

remove

add

path
string

The path for the given resource field to patch.

value
optional
object

The value to be used for this operation.

SharingSettings

object

Properties

tenantId
optional
string

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

enable-sharing
boolean

Whether API endpoints for sharing are enabled

enable-report-subscription
boolean

true if report-subscription feature is enabled for this tenant

maxRecipients
optional
number

Maximum number of recipients when creating a sharing task

maxSubscriptionRecipients
optional
integer

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

reportSubscriptionStatus
optional
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

Enum:

none

enabling

disabling

reportSubscriptionStatusChangeTime
optional
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.

APISettingsUpload

object

Properties

enable-sharing
boolean

Whether API endpoints for sharing are enabled

maxRecipients
optional
number

Maximum number of recipients when creating a sharing task

SharingSettingsPatchCompliantList

Array<SharingSettingsPatchCompliant>

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

Properties

op
string

The operation to be performed.

Enum:

replace

path
string

The path for the given resource field to patch.

Enum:

/enable-sharing

/enable-report-subscription

value
optional
object

The value to be used for this operation.

SharingSettingsPatchCompliant

object

Properties

op
string

The operation to be performed.

Enum:

replace

path
string

The path for the given resource field to patch.

Enum:

/enable-sharing

/enable-report-subscription

value
optional
object

The value to be used for this operation.

SharingSettingsPatch

object

Properties

enable-sharing
boolean

true to enable the chart sharing via email feature, false to disable it

enable-report-subscription
boolean

true to enable report subscription feature, false to disable it. A status change could potentially result in a considerable amount of API operations to enable/disable chronos jobs.

AlertingSettings

object

Properties

tenantId
optional
string

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

enable-data-alerting
boolean

true if data-alerting feature is enabled for this tenant. Enabling this feature also requires that the license has this feature enabled.

data-alerting-license-status
optional
string

Whether the license for the tenant has the data alerting feature enabled.

Enum:

enabled

disabled

data-alerting-feature-operation-status
optional
string

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

Enum:

none

enabling

disabling

data-alerting-feature-operation-status-change
optional
string

UTC timestamp of the most recent change of data-alerting-feature-operation-status. If there has not been any such change, this is the timestamp of the initial creation of the record.

max-recipients-in-target-access
optional
integer

The maximum number of recipients that can be present in an alerting task in TARGET_ACCESS mode. New recipients cannot be added when this limit is exceeded

dataAlertsConsumed
optional
number

Represents the number of data alerts consumed by the user either as an owner or recipient

dataAlertsLimits
optional
number

Represents the number of data alerts limit to be consumed by the user either as an owner or recipient

AlertingSettingsUpload

object

Properties

enable-data-alerting
boolean

true if data-alerting feature is enabled. A status change could potentially result in a considerable amount of API operations to enable/disable triggers. Enabling this feature also requires that the license has this feature enabled.

TemplatePersist

object

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.

Properties

type
string

No description

Enum:

file

chart

story

sheet

subType
optional, default='image'
string

No description

Enum:

image

snapshot

pdf

fileAlias
optional
string

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

templateId
optional
string

ID of unique template

storyData

No description

chartData

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

sheetData

No description

TemplateResult

Properties

type
string

No description

Enum:

file

chart

story

sheet

subType
default='image'
string

No description

Enum:

image

snapshot

pdf

fileAlias
string

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

templateId
string

ID of unique template

storyData

No description

chartData

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

sheetData

No description

ReportPersist

object

Properties

id
string

Gets the report identifier.

links

No description

type
string

Report Type (file, chart, story)

Enum:

file

chart

story

sheet

subType
string

File type for report

executionID
string

The execution to which this report belongs

userID
string

The user which this report belongs to

data

No description

ReportResult

SharingExecutionPersist

object

Properties

id
string

Gets the execution identifier.

files

No description

tenantId
string

The tenant that this execution belongs to

ownerId
string

Owner of the execution

appId
string

appId associated to sharing task 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.

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.

status
string

Status of the task execution

Enum:

initialized

in-progress

successful

failed

cancelled

invalid

presuccessful

totalCount
integer

Total count of reports in this execution

successCount
integer

Total count of successfully generated reports in this execution

failedCount
integer

Total count of failed reports in this execution

startTime
string

Timestamp of execution start

endTime
string

Timestamp of execution successful stop

failedTime
string

Timestamp of execution stop

sharingTaskID
string

ID for the sharing task that this execution references

eventID
string

eventID of the chronos NATS event

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.

errors

No description

SharingTasksRecipientStatsResponse

object

Properties

recipientStats

No description

SharingTasksRecipientStats

object

Properties

type
string

No description

Enum:

userid

value
string

No description

enabled
boolean

Whether the recipient is enabled.

subscribed
boolean

Whether the recipient is subscribed.

lastExecutionTime
string

last time an execution had been executed for this recipient

nextExecutionTime
string

next time an execution will be executed for this recipient

errors

No description

SharingExecutionResponse

Properties

id
string

Gets the execution identifier.

files

No description

tenantId
string

The tenant that this execution belongs to

ownerId
string

Owner of the execution

appId
string

appId associated to sharing task 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.

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.

status
string

Status of the task execution

Enum:

initialized

in-progress

successful

failed

cancelled

invalid

presuccessful

totalCount
integer

Total count of reports in this execution

successCount
integer

Total count of successfully generated reports in this execution

failedCount
integer

Total count of failed reports in this execution

startTime
string

Timestamp of execution start

endTime
string

Timestamp of execution successful stop

failedTime
string

Timestamp of execution stop

sharingTaskID
string

ID for the sharing task that this execution references

eventID
string

eventID of the chronos NATS event

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.

errors

No description

links

No description

fileLocations
array

No description

SharingExecutionFile

object

Properties

tempContentsLocation
string

No description

fileID
string

No description

fileAlias
string

No description

type
string

No description

Enum:

image

pdf

userId
string

userId associated with the file

SharingExecutionListResponse

Properties

totalCount
integer

total count of entries in the collection as a whole

currentPageCount
integer

count of entries on the currently shown page

executions

Gets a list of sharing-executions.

links

No description

SharingExecutionStatus

object

Properties

links

No description

status
string

Status of the task execution

SharingTaskRecurringRecipients

object

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

Properties

userIds

No description

SharingTaskRecurringRecipient

object

Single recipient to be subscribed/unsubscribed. If present, the whole list SharingTaskRecipients takes the precedence over it.

Properties

userId
string

User ID of recipient (internal user).

subscribed
boolean

Whether this recipient is subscribed to alerts of a task

SharingTaskRecipients

object

List of recipients. For internal user a list of userids, for external users a list of email addresses.

Properties

emails
Array<string<email>>

No description

userids
Array<string>

No description

RecipientsPersist

object

List of persisted recipients.

Properties

userIds

No description

Recipients

object

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

Properties

userIds

No description

UserIDRecipientPersist

object

recipient object model that is directly persisted in the DB

Properties

value
string

User ID of recipient (internal user).

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.

alertingTaskRecipientErrors

No description

taskRecipientErrors

No description

UserIDRecipient

object

an internal recipient based on its user id.

Properties

value
string

User ID of recipient (internal user).

enabled
boolean

Whether this recipient can receive alerts.

subscribed
boolean

Whether this recipient is subscribed to alerts of a task

alertingTaskRecipientErrors

No description

taskRecipientErrors

No description

EmailRecipientPersist

object

Properties

value
string<email>

Email of recipient (external user).

enabled
boolean

Whether this recipient can receive alerts.

SharingTaskOnetime

object

Properties

id
optional
string

Gets the sharing task resource identifier.

template

No description

recipients

List of recipients. For internal user a list of userids, for external users a list of email addresses.

owner
optional
string

User id of the sharing task owner

tenant
optional
string

Tenant of the sharing task

message
optional
string

Message along with sharing task

creation-time
optional
string

Timestamp for the creation of the task

state

State of the selections and jsOpts

SharingTaskOnetimeCreate

object

Properties

template

No description

recipients

List of recipients. For internal user a list of userids, for external users a list of email addresses.

message
optional
string

Message along with sharing task

state

State of the selections and jsOpts

State

object

State of the selections and jsOpts

Properties

selections

No description

fields
Array<object>

Selected fields that led to discovery of monitored Insight Advisor chart

queryItems
Array<object>

Query that led to discovery of monitored Insight Advisor chart

EncryptedProperty

object

Encrypted property in DB

Properties

value

No description

cipher
string

No description

SharingTaskRecurringResponse

Whatever is persisted in the db + links

Properties

id
string

Gets the sharing task resource identifier.

type
string

the sharing task resource type.

Enum:

office-template-sharing

chart-monitoring

chart-sharing

sheet-sharing

executeOnCreation
boolean

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

tags
array

No description

dateCreated
string

Timestamp for the creation of the task

name
string

Name of this sharing task

appName
string

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

appId
string

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

description
string

A description of this sharing task

statusCode
string

the status of this recurring sharing task

Enum:

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

statusLabel
string

error message indicating the underlying failure

enabledByUser
boolean

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

enabledBySystem
boolean

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

message
string

Message along with sharing task

owner
string

User id of owner of the sharing task

tenant
string

Tenant of the sharing task

startTime
string

Time to start capturing the history

expiration
string

Time for the termination of the task

lastRun
string

The last execution start date time timestamp of the task

nextScheduledRun
string

Time for the next scheduled run

reportProperties
object

No description

trigger

No description

scheduleOptions

No description

thumbnail
string

No description

createdBy
string

ID of creator

insightDirectURL
string

The direct insights URL for the first template of this sharing task.

insightFallbackURL
string

The insights fallback URL for the first template of this sharing task.

insightID
string

The identifier for the insight URLs in this sharing task. Needed to remove the permanent insight upon task deletion.

lastExecutionDate
string

The last execution end date time timestamp of the task

templates

No description

encryptedTemplates

Encrypted property in DB

state

State of the selections and jsOpts

encryptedState

Encrypted property in DB

retentionPolicy

No description

selectionErrors
object

reporting service returns rendering errors for missing selections

recipients

List of persisted recipients.

taskErrors

No description

lastUpdated
string

Timestamp of the most recent update.

ownerName
string

User name of owner of the sharing task

isCandidateForVerification
boolean

true if the sharing task is a candidate for verification

failedVerificationsCount
integer

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

failedExecutionsCount
integer

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

latestExecutionURL
string

URL to querying the latest execution tied to this sharing task

latestExecutionFilesURL
array

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

links

No description

enabled
boolean

true if the sharing task is enabled

SharingTaskRecurringResponseLite

object

ID of the sharing task + links

Properties

id
string

Gets the sharing task resource identifier.

links

No description

SharingTaskRecurringPersist

object

Type of object stored in the database. Required fields mean that property cannot be null

Properties

id
string

Gets the sharing task resource identifier.

type
string

the sharing task resource type.

Enum:

office-template-sharing

chart-monitoring

chart-sharing

sheet-sharing

executeOnCreation
boolean

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

tags
Array<string>

No description

dateCreated
string

Timestamp for the creation of the task

name
string

Name of this sharing task

appName
string

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

appId
string

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

description
string

A description of this sharing task

statusCode
string

the status of this recurring sharing task

Enum:

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

statusLabel
string

error message indicating the underlying failure

enabledByUser
boolean

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

enabledBySystem
boolean

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

message
string

Message along with sharing task

owner
string

User id of owner of the sharing task

tenant
string

Tenant of the sharing task

startTime
string

Time to start capturing the history

expiration
string

Time for the termination of the task

lastRun
string

The last execution start date time timestamp of the task

nextScheduledRun
string

Time for the next scheduled run

reportProperties
object

No description

trigger

No description

scheduleOptions

No description

thumbnail
string

No description

createdBy
string

ID of creator

insightDirectURL
string

The direct insights URL for the first template of this sharing task.

insightFallbackURL
string

The insights fallback URL for the first template of this sharing task.

insightID
string

The identifier for the insight URLs in this sharing task. Needed to remove the permanent insight upon task deletion.

lastExecutionDate
string

The last execution end date time timestamp of the task

templates

No description

encryptedTemplates

Encrypted property in DB

state

State of the selections and jsOpts

encryptedState

Encrypted property in DB

retentionPolicy

No description

selectionErrors
object

reporting service returns rendering errors for missing selections

recipients

List of persisted recipients.

taskErrors

No description

lastUpdated
string

Timestamp of the most recent update.

ownerName
string

User name of owner of the sharing task

isCandidateForVerification
boolean

true if the sharing task is a candidate for verification

failedVerificationsCount
integer

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

failedExecutionsCount
integer

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

SharingTaskRecurringCreateRequest

object

Properties

name
string

Name of this sharing task

appName
string

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

type
string

the sharing task resource type.

Enum:

office-template-sharing

chart-monitoring

chart-sharing

sheet-sharing

tags
optional
Array<string>

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

executeOnCreation
optional, default=true
boolean

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

enabled
optional, default=true
boolean

Toggle for enabling sharing task.

message
optional
string

Message along with sharing task

description
optional
string

Description of the sharing task

expiration
optional
string

Timestamp for the termination of the task

trigger

No description

scheduleOptions

No description

templates

No description

state

State of the selections and jsOpts

recipients

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

startTime
optional
string

Time to start capturing the history

retentionPolicy

No description

Trigger

object

Properties

chronosJobID
optional
string

The chronosJobId which triggers the sharing task

executeOnAppReload
optional, default=true
boolean

Toggle for executing sharing task on app reload.

recurrence
Array<string>

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.

executionHistoryInterval
optional
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.

Enum:

minutely

hourly

daily

weekly

monthly

quarterly

yearly

Selection

object

Properties

isNumeric
boolean

No description

name
string

No description

displayName
optional
string

No description

values
Array<string>

No description

displayValues
optional
Array<string>

No description

stateName
string

No description

SharingTaskRecurringListResponse

Properties

totalCount
integer

total count of entries in the collection as a whole

currentPageCount
integer

count of entries on the currently shown page

sharingTasks

Gets a list of recurring sharing tasks.

links

No description

recipients

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

SharingTaskPatchRequestCompliantList

Array<SharingTaskRecurringPatchRequestCompliant>

Properties

op
string

The operation to be performed

Enum:

replace

path
string

A JSON Patch document as defined in http://tools.ietf.org/html/rfc6902

Enum:

/name

/tags

/ownerId

/enabled

/description

/scheduleOptions

/templates

/recipients

/recipient

value
optional
object

The value to be used for this operation.

SharingTaskRecurringPatchRequestCompliant

object

Properties

op
string

The operation to be performed

Enum:

replace

path
string

A JSON Patch document as defined in http://tools.ietf.org/html/rfc6902

Enum:

/name

/tags

/ownerId

/enabled

/description

/scheduleOptions

/templates

/recipients

/recipient

value
optional
object

The value to be used for this operation.

SharingTaskRecurringPatchRequest

object

Properties

name
string

Name of sharing task

tags
Array<string>

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

ownerID
string

the new owner of this task. This change is allowed only for the owner

enabled
boolean

to enable or disable the task. The change is allowed only for the owner

description
string

Description of the sharing task

scheduleOptions

No description

templates

The templates to be applied.

recipients

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

recipient

Single recipient to be subscribed/unsubscribed. If present, the whole list SharingTaskRecipients takes the precedence over it.

FileTemplatePersist

object

Properties

id
string

Gets the file template resource identifier.

name
string

Name of file template

dateCreated
string

Timestamp for file template creation

owner
string

Owner of file template

tenantId
string

Tenant ID

templateType
string

Type of template.

subType
string

SubType of template.

valid
boolean

Result of the file template validation

fileId
string

ID of the file it references

storageEngine
string

storage engine identifier

size
integer

the size of the file in bytes

contentType
string

The content type of the file

FileTemplateCreate

FileTemplateGetResult

Properties

id
string

Gets the file template resource identifier.

name
string

Name of file template

dateCreated
string

Timestamp for file template creation

owner
string

Owner of file template

tenantId
string

Tenant ID

templateType
string

Type of template.

subType
string

SubType of template.

valid
boolean

Result of the file template validation

fileId
string

ID of the file it references

storageEngine
string

storage engine identifier

size
integer

the size of the file in bytes

contentType
string

The content type of the file

links

No description

FileTemplateCreateResult

object

Properties

id
string

ID of the created file template

links

No description

FileTemplatesListResult

object

Properties

fileTemplates

Gets a list of file templates.

links

No description

FileTemplatesUploadFileResult

object

Properties

id
string

ID of the uploaded file

links

No description

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. The following properties are optional: outZoom, outDpi

Properties

appId
string

ID of app

sheetId
string

sheetId of app

objectId
string

ID of object

objectDef
object

Session chart object definition

widthPx
integer

widthPx of chart

heightPx
integer

heightPx of chart

outZoom
number

outZoom of chart

outDpi
integer

outDpi of chart

jsOpts
object

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

patches
Array<object>

Soft property changes on chart

StoryTemplate

object

Properties

appId
string

ID of app

storyId
string

ID of story

SheetTemplate

object

Properties

appId
string

ID of app

sheetId
string

ID of sheet

widthPx
integer

widthPx of chart

heightPx
integer

heightPx of chart

jsOptsById
object

No description

patchesById
object

No description

Self

object

Object with Href to a particular element or set of elements

Properties

href
string

No description

Page

object

Properties

href
string

URL to particular set of elements

token
string

Page unique token

type
string

Page type, can be next or prev

Enum:

prev

next

Error

object

Properties

code
string

Error code specific to sharing service.

detail
string

Error cause.

title
string

Error title.

meta

No description

Errors

object

Properties

errors

No description

traceId
string

No description

SharingExecutionError

object

Properties

code
string

Error code specific to sharing service.

detail
string

Error cause.

title
string

Error title.

SharingExecutionErrors

Array<SharingExecutionError>

Properties

code
string

Error code specific to sharing service.

detail
string

Error cause.

title
string

Error title.

BinaryData

object

Properties

fileId
string

ID of the file it references

storageEngine
string

storage engine identifier

size
integer

the size of the file in bytes

contentType
string

The content type of the file

RetentionPolicy

object

Properties

historySize
integer

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

overrideInterval
default='FREQ=DAILY;INTERVAL=1'
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

AlertingTaskCreateRequest

object

a alerting task (a definition on an alert)

Properties

name
string

name associated to alerting task

enabled
optional, default=true
boolean

if the alerting task is enabled

description
optional
string

description associated to alerting task

appId
string

appId associated to this alert definition

sheetId
optional
string

sheetId associated to this alert definition

bookmarkId
optional
string

bookmarkId associated to this alert definition

throttling

The rules and setup for throttling

recipients

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

conditionId
string

the id of the condition that determines if this data alert should be triggered

triggerType
string

Type of job that triggered the task

Enum:

RELOAD

SCHEDULED

scheduleOptions

No description

AlertingTaskPersist

object

a alerting task (a definition on an alert)

Properties

id
string

data alerting identifier (this is the alertID)

name
string

name associated to alerting task

enabledBySystem
boolean

true if the alerting task is enabled by system (a task needs to be both enabled by system and user, to be considered enabled)

enabledByUser
boolean

true if the alerting task is enabled by user (a task needs to be both enabled by system and user, to be considered enabled)

description
string

description associated to alerting task

appId
string

appId associated to this alert definition

sheetId
string

sheetId associated to this alert definition

spaceId
string

spaceId of the app associated to this alert definition

hasHistoryCondition
boolean

true if the alert has history condition enabled

hasSectionAccess
boolean

true if the associated app has section access enabled

bookmarkId
string

bookmarkId associated to this alert definition

lastTrigger
string

last time an execution had been created

lastScan
string

last time a trigger was detected, but not sure if executed

status
string

particular status of the alerting task

Enum:

creating

valid

invalid

deleting

errorStatus
string

error labels from the latest workflow that happened within the task

Enum:

OK

FATAL-ERROR

PARTIAL-TRIGGER

throttling

The rules and setup for throttling

recipients

List of persisted recipients.

recipientsChangeHistory

No description

accessMode
string

No description

Enum:

SOURCE_ACCESS

TARGET_ACCESS

conditionId
string

the id of the condition that determines if this data alert should be triggered

ownerId
string

the owner of this alert

ownerName
string

the owner name of this alert

tenantId
string

the tenant of this alert

dateCreated
string

Timestamp for the creation of the task (rfc3339 format)

lastUpdated
string

Timestamp of the most recent update.

triggerType
string

Type of job that triggered the task

Enum:

RELOAD

SCHEDULED

MANUAL

scheduleOptions

No description

underGoingConversion
boolean

set to true if this task is undergoing conversion

underGoingConversionUpdated
string

A RFC3339 UTC timestamp for them the undergoingConversion status was updated. Empty fields means that it never was updated.

underGoingConversionLastEventID
string

The eventID that last triggered a conversion.

isCandidateForOptimization
boolean

set to true if this task is a candate task to be optimized from TARGET_ACCESS to SOURCE_ACCESS

evaluationErrors

No description

alertingTaskErrors

No description

isCandidateForVerification
boolean

true if the alerting task is a candidate for verification

failedVerificationsCount
integer

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

evaluationCount
integer

the number of actual evaluations with engine this task has consumed in the current month

lastEvaluationCountUpdate
string

the date when the evaluation count was updated

AlertingTaskResponse

object

Properties

links
optional

No description

triggerStats

No description

lastExecutionStatus
optional
string

No description

Enum:

OK

FAILED

conditionResponse
optional
object

Should reference ConditionResponse type in condition-manager api docs

id
optional
string

data alerting identifier (this is the alertID)

name
optional
string

name associated to alerting task

enabled
optional
boolean

true if the alerting task is enabled

description
optional
string

description associated to alerting task

appId
optional
string

appId associated to this alert definition

sheetId
optional
string

sheetId associated to this alert definition

bookmarkId
optional
string

bookmarkId associated to this alert definition

hasHistoryCondition
optional
boolean

true if the alert has history condition enabled

hideSelections
optional
boolean

Whether the selection needs to be hidden.

lastTrigger
optional
string

last time an execution had been created

lastScan
optional
string

last time a trigger was detected, but not sure if executed

status
optional
string

particular status of the alerting task

Enum:

creating

deleting

errorStatus
optional
string

error labels from the latest workflow that happened within the task

Enum:

OK

FATAL-ERROR

PARTIAL-TRIGGER

throttling

The rules and setup for throttling

recipients

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

recipientsChangeHistory
optional

No description

accessMode
optional
string

No description

Enum:

SOURCE_ACCESS

TARGET_ACCESS

conditionId
optional
string

the id of the condition that determines if this data alert should be triggered

subscriptionIds
optional
Array<string>

list of subscriptions related to this alerting task

ownerId
optional
string

the owner of this alert

ownerName
optional
string

the owner name of this alert

tenantId
optional
string

the tenant of this alert

dateCreated
optional
string

Timestamp for the creation of the task (rfc3339 format)

lastUpdated
optional
string

Timestamp of the most recent update.

triggerType
optional
string

Type of job that triggered the task

Enum:

RELOAD

SCHEDULED

MANUAL

scheduleOptions

No description

alertingTaskErrors
optional

No description

evaluationCount
optional
integer

the number of actual evaluations with engine this task has consumed in the current month

lastEvaluationCountUpdate
optional
string

the date when the evaluation count was updated

AlertingTaskValidationResponse

object

Properties

status
string

No description

Enum:

FAILURE

SUCCESS

validations

No description

AlertingTaskTriggerStats

object

Properties

last10Scans
maximum=10
integer

The number of triggers out of the last 10 scans for the current condition.

last100Scans
maximum=100
integer

The number of triggers out of the last 100 scans for the current condition.

totalScans
maximum=100
integer

The number of scans for the current condition.

AlertingRecipientStatsResponse

object

Properties

recipientStats

No description

AlertingRecipientStats

object

Properties

type
optional
string

No description

Enum:

userid

value
optional
string

No description

enabled
boolean

Whether the recipient is enabled.

subscribed
optional
boolean

Whether the recipient is subscribed.

lastTrigger
optional
string

last time an execution had been created

lastScan
optional
string

last time a trigger was detected, but not sure if executed

conditionStatus
optional
string

No description

Enum:

OK

FAILED

errors

No description

AlertingRecipientStatsErrors

Array<AlertingRecipientStatsError>

Properties

code
string

Error code specific to sharing service.

detail
string

Error cause.

title
string

Error title.

AlertingRecipientStatsError

object

Properties

code
string

Error code specific to sharing service.

detail
string

Error cause.

title
string

Error title.

AlertingTaskResponseLite

object

Properties

id
string

data alerting identifier (this is the alertID)

links

No description

AlertingTaskListResponse

Properties

totalCount
integer

total count of entries in the collection as a whole

currentPageCount
integer

count of entries on the currently shown page

tasks

Gets a list of alerting tasks.

links

No description

ExecutionStats

object

Properties

startTime
string

No description

endTime
string

No description

totalExecutions
string

No description

triggeredExecutions
string

No description

periodKey
string

No description

ExecutionStatsAggregated

object

Properties

startTime
string

No description

endTime
string

No description

totalExecutions
integer

No description

triggeredExecutions
integer

No description

periodKey
string

No description

AlertingTaskExecutionStats

deprecated

Properties

totalCount
integer

total count of entries in the collection as a whole

currentPageCount
integer

count of entries on the currently shown page

executionsStats

No description

links

No description

AlertingTaskAggregatedEvaluationStats

Properties

executionsStats

No description

AlertingTaskPatchRequest

object

Properties

ownerName
string

No description

ownerId
string

No description

conditionId
string

No description

enabledAction
string

Specify ENABLED or DISABLED if you want enable or disable the alerting task

Enum:

ENABLED

DISABLED

bookmarkId
default='NA'
string

Id of the bookmark associated with an alert

name
string

name associated to alerting task

description
string

description associated to alerting task

throttling

The rules and setup for throttling

recipients

A custom custom JSON Patch document, as an array of objects with operation, recipient type and value. Original defined in https://datatracker.ietf.org/doc/html/rfc6902.

triggerType
string

Type of job that triggered the task

Enum:

RELOAD

SCHEDULED

scheduleOptions

No description

AlertingTaskPatchRequestCompliantList

Array<AlertingTaskPatchRequestCompliant>

Properties

op
string

The operation to be performed

Enum:

replace

path
string

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

Enum:

/ownerName

/ownerId

/conditionId

/enabledAction

/bookmarkId

/name

/description

/throttling

/triggerType

/scheduleOptions

value
optional
object

The value to be used for this operation.

AlertingTaskPatchRequestCompliant

object

Properties

op
string

The operation to be performed

Enum:

replace

path
string

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

Enum:

/ownerName

/ownerId

/conditionId

/enabledAction

/bookmarkId

/name

/description

/throttling

/triggerType

/scheduleOptions

value
optional
object

The value to be used for this operation.

AlertingExecutionListResponse

Properties

totalCount
integer

total count of entries in the collection as a whole

currentPageCount
integer

count of entries on the currently shown page

executions

Gets a list of alerting-executions.

links

No description

AlertingExecutionResponse

Properties

id
string

Gets the execution identifier.

ownerId
string

The owner that this execution belongs to

tenantId
string

The tenant that this execution belongs to

conditionId
string

Id of the condition the alert is associated with

evaluationId
string

Id of the evaluation for the condition

bookmarkId
string

Id of the bookmark associated with an alert

measures
array

Measures applied in the condition

dimensions
array

Dimensions applied in the condition

triggerTime
string

Timestamp of execution start

alertId
string

ID for the alerting task that this execution references

workflowId
string

ID for the workflow, coming from eventing service

accessMode
string

No description

Enum:

SOURCE_ACCESS

TARGET_ACCESS

conditionStatus
string

No description

Enum:

FINISHED

FAILED

executionEvaluationStatus
string

No description

Enum:

CONDITION_MET

CONDITION_NOT_MET

FAILED

result

No description

errors

No description

links

No description

evaluation

No description

AlertingConditionResponse

object

Properties

conditionResponse
object

Should reference ConditionResponse type in condition-manager api docs

hideSelections
boolean

No description

AlertingExecutionPersist

object

Properties

id
string

Gets the execution identifier.

ownerId
string

The owner that this execution belongs to

tenantId
string

The tenant that this execution belongs to

conditionId
string

Id of the condition the alert is associated with

evaluationId
string

Id of the evaluation for the condition

bookmarkId
string

Id of the bookmark associated with an alert

measures
Array<string>

Measures applied in the condition

dimensions
Array<string>

Dimensions applied in the condition

triggerTime
string

Timestamp of execution start

alertId
string

ID for the alerting task that this execution references

workflowId
string

ID for the workflow, coming from eventing service

accessMode
string

No description

Enum:

SOURCE_ACCESS

TARGET_ACCESS

conditionStatus
string

No description

Enum:

FINISHED

FAILED

executionEvaluationStatus
string

No description

Enum:

CONDITION_MET

CONDITION_NOT_MET

FAILED

result

No description

errors

No description

EvaluationErrors

object

Properties

errors

No description

failCount
integer

amount of failed evaluation errors received

EvaluationError

object

Properties

code
string

Error code specific to condition smanager.

status

Error status.

title
string

Error title.

meta

No description

AlertingExecutionErrors

Array<AlertingExecutionError>

Properties

code
string

Error code specific to sharing service.

detail
string

Error cause.

title
string

Error title.

AlertingExecutionResult

object

Properties

alertTriggerStatus
string

No description

throttlerTokensLeft
integer

No description

AlertingExecutionError

object

Properties

code
string

Error code specific to sharing service.

detail
string

Error cause.

title
string

Error title.

ThrottlingResource

object

The rules and setup for throttling

Properties

recurrenceRule
string

A string that supports a subset of RFC5545 recurrence rule directives.

replenishRate
integer

the amount of tokens to insert into the bucket on the specified interval. (tokens exceeding capacity are discarded)

initialTokenCount
integer

the initial amount of tokens in the bucket upon creation. cannot exceed capacity.

capacity
integer

the maximum number of tokens that the bucket can contain

referenceTimestamp
string

a date and time reference specified in RFC3339 format

timezone
default='Etc/UTC'
string

the timezone for time calculations in this throttlingresource, for current time and time reference.

NatsEvent

object

defines an event that will be transmitted of NATS.

Properties

subject
string

the subject of the nats event. (in a system event this will be the eventType field)

data
string

valid json-data that will will be the payload of the transmitted nats event.

AlertingAppData

object

metadata about the app. Relevant if type is "appReload"

Properties

appId
string

No description

AlertDeliveryMethod

object

Properties

type
string

type of event that triggers an alert

Enum:

appReload

appData

metadata about the app. Relevant if type is "appReload"

StandardListResponseProps

object

properties that should be added to every list response

Properties

totalCount
integer

total count of entries in the collection as a whole

currentPageCount
integer

count of entries on the currently shown page

AlertingTaskRecipientPatch

Array<AlertingTaskRecipientPatch_inner>

A custom custom JSON Patch document, as an array of objects with operation, recipient type and value. Original defined in https://datatracker.ietf.org/doc/html/rfc6902.

Properties

op
string

The operation to be performed.

Enum:

remove

add

replace

enable

disable

subscribe

unsubscribe

recipientType
string

Defines the path for the given resource field to patch.

Enum:

userid

value
object

The value to be used for this operation.

RecipientsChange

object

Change in a recipient for an alerting task

Properties

patchAction

A custom custom JSON Patch document, as an array of objects with operation, recipient type and value. Original defined in https://datatracker.ietf.org/doc/html/rfc6902.

dateTime
string

time of recipient state change

TriggerDefinition

object

Properties

id
optional
string<uid>

No description

conditionId
string

No description

contextId
optional
string

Any extra data to identify this trigger or a group of triggers.

userId
string

link this trigger to a specific user. Used to validate conditions

owner
optional
string

owner of the associated trigger group

emitOnStatus
optional, default='success'
string

Specify on which condition status emitEvent is to be triggered. success, fail, or all

Enum:

all

conditionNotMet

throttleExceeded

anyFail

success

enabled
optional, default=true
boolean

No description

triggerEvent

No description

emitEvent

No description

stats

No description

throttling

No description

ThrottlingOptions

object

Properties

dryRun
boolean

No description

currentTime
string

No description

reset
boolean

No description

tokensToConsume
integer

No description

EvaluationGetResponse

object

Properties

evaluation

No description

condition
object

No description

hideSelections
boolean

No description

Evaluation

Properties

causalEvent
object

Representation of the event that caused the condition to be evaluated if one was included on when the evaluation was triggered

contextId
string

Extra context information to carry through to the result if one was included on when the evaluation was triggered

endTime
string<string>

The time the evaluation ended

id
string<uid>

The unique id for the resource

conditionId
string<uid>

The unique id of the associated condition

dataConditionEvaluatorId
string<uid>

The unique id for the resource given from Data Condition Evaluator

ownerId
string<uid>

userId of user being impersonated to evaluate the condition

result
string

The final result of the evalution

Enum:

success

failure

error

resultData
object

Condition type specific result, one of dataResult or compoundResult

startTime
string<string>

The time the evaluation started

status
string

The status of the evaluation execution

Enum:

RUNNING

FAILED

FINISHED

tenantId
string<uid>

The tenant id

AlertingActionsTriggerCreateRequest

object

Properties

alertingTaskID
string

No description

AlertingActionsTriggerCreateResponse

object

Properties

workflowID
string

the workflow id created for the manual triggering of alert

SharingActionsTriggerCreateRequest

object

Properties

sharingTaskID
string

No description

ScheduleOptions

object

Properties

recurrence
Array<string>

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.

timezone
string

The timezone for time calculations in SCHEDULED triggers, optional.

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.

endDateTime
default=''
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.

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.

AlertingTaskError

object

Properties

value
string

Identifier for type of error occurring on alerting task

Enum:

OWNER_DISABLED

OWNER_ACCESS

OWNER_LICENSE

APP_DELETED

NO_RECIPIENTS

PARTIAL_ACCESS

EVAL_ERROR

ORPHAN

CONVERSION_DENIED

EXPIRED

PARTIAL_SENT

added
string

Timestamp for the creation of the error

AlertingTaskRecipientError

object

Properties

value
string

Identifier for type of error occurring on alerting task

Enum:

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

added
string

Timestamp for the creation of the error

AlertingTaskValidation

object

Properties

validationErrors
Array<string>

No description

error
deprecated
string

Identifier for a validation error occurring on alerting task

Enum:

NO_ACCESS

USER_IS_DISABLED

INVALID_CONDITION

id
string

Identifies for user id or condition id

type
string

Identifier for type of a validation error occurring on alerting task

Enum:

RECIPIENT

CONDITION

description
string

Description of the error

TaskError

object

Properties

value
string

Identifier for type of error occurring on sharing task

Enum:

OWNER_DISABLED

OWNER_ACCESS

OWNER_LICENSE

APP_DELETED

NO_RECIPIENTS

PARTIAL_ACCESS

ORPHAN

PARTIAL_SENT

FATAL_SENT_ERROR

timestamp
string

Timestamp for the creation of the error

TaskRecipientError

object

Properties

value
string

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

Enum:

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

timestamp
string

Timestamp for the creation of the error

Condition

only one of compoundCondition or dataCondition should be set

Properties

type
string

Indicates the condition type

Enum:

data

dataCondition

A condition based on data within an app

DataCondition

A condition based on data within an app

Properties

history

History properties

HistoryProperties

History properties

Properties

enabled
boolean

No description

NotificationDigestCreateRequest

object

Properties

frequency
string

RRULE for SCHEDULED digest, as specified in RFC5545.

enabled
boolean

Whether the digest is enabled or not

NotificationDigest

object

Properties

id
string

id of digest

tenantId
string

The tenant that this execution belongs to

ownerId
string

Owner of the execution

chronosJobId
string

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

frequency
string

RRULE for SCHEDULED digest, as specified in RFC5545.

enabled
boolean

Whether the digest is enabled or not

timezone
string

the timezone for the chronos job

startTime
string

start time of the notification request

currentWorkflowId
string

current workflowID to be written in the executions

JsonPatch

object

Properties

op
string

The operation to be performed.

Enum:

replace

remove

add

path
string

The path for the given resource field to patch.

value
optional
object

The value to be used for this operation.

NotificationDigestExecutions

list of Notification Digest Executions.

Properties

totalCount
integer

total count of entries in the collection as a whole

currentPageCount
integer

count of entries on the currently shown page

executions

No description

links

No description

NotificationDigestExecution

object

Notification Digest Execution.

Properties

id
string

id of execution

tenantId
string

The tenant that this execution belongs to

ownerId
string

Owner of the execution

workflowId
string

workflow Id of related digest

content
object

digest buffer content received from notification-prep

secureContent
object

digest buffer secure content received from notification-prep

resourceId
string

resourceId for the digest execution

resourceType
string

resourceId for the digest execution

executionFlowStartTime
string

Timestamp of execution start

dateCreated
string

Timestamp for the creation of the task execution

expireAt
string

Timestamp for TTL document deleted after time stamp is reached

NotificationItem

object

notification received from notification prep

CommonRecipientValidationRequest

object

a request to validate one or more users

Properties

appId
string

appId used when validating access to app

recipients

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

CommonRecipientValidationResponse

object

Properties

status
string

No description

Enum:

FAILURE

SUCCESS

validations

No description

CommonRecipientValidation

object

Properties

error
string

Identifier for a validation error occurring when validating a recipient

Enum:

NO_ACCESS

USER_IS_DISABLED

MAX_ALERTS_LIMIT_REACHED

id
string

Identifies for user id

description
string

Description of the error

Error_meta

object

Properties

httpCode
integer

HTTP error code.

EvaluationError_meta

object

Properties

fatal
boolean

defines whether an error is recoverable or not

AlertingTaskRecipientPatch_inner

object

Properties

op
string

The operation to be performed.

Enum:

remove

add

replace

enable

disable

subscribe

unsubscribe

recipientType
string

Defines the path for the given resource field to patch.

Enum:

userid

value
object

The value to be used for this operation.

TriggerDefinition_triggerEvent

object

Properties

channel
string

No description

eventName
string

No description

matchId
optional
string

No description

matchProperties
optional
object

No description

TriggerDefinition_emitEvent

object

Properties

channel
string

The NATS channel to publish on

eventName
string

The name of the NATS event to publish

data
object

The data field of the message.

extensions
optional
object

The extensions field of the message.

TriggerDefinition_stats

object

Properties

successCount
integer

Number of times the condition has passed for this trigger

failedCount
integer

Number of times the condition has failed for this trigger

lastRun
string<date-time>

No description

TriggerDefinition_throttling

object

Properties

recurrenceRule
string

No description

replenishRate
integer

No description

capacity
integer

No description

initialTokenCount
integer

No description

recurrence
string

No description

timezone
string

No description

referenceTime
string

No description

alignWithSource
string

only used during creation of the trigger. Specifies the id of an existing throttling resource to have previous consume information migrated to this one

throttlingOptions

No description

v22.6.0
Was this page helpful?