Sign in
sharing tasks

Get sharing task

Returns the details of a specific sharing task.

get/api/v1/sharing-tasks/{taskId}

Path parameters

taskIdstring required

The sharing task identifier.

Query parameters

isViewChartboolean

Determines whether to update the lastViewed property for the sharing task, which is used to determine whether the sharing task is still in use. If set to true, this will be updated to current time.

Response

Sharing task has been successfully returned.

idstring

Gets the sharing task resource identifier.

namestring

Name of this sharing task

tagsstring[]
type'chart-monitoring' | 'chart-sharing' | 'sheet-sharing' | 'template-sharing'

The sharing task resource type

appIdstring

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

ownerstring

User id of owner of the sharing task

tenantstring

Tenant of the sharing task

appNamestring

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

lastRunstring

The last execution start date time timestamp of the task

messagestring

Message along with sharing task

spaceIdstring

spaceId of the app associated to this task definition

subType'pdf' | 'pptx' | 'xlsx' | 'html' | 'docx'

Mashup subType of sharing task

createdBystring

ID of creator

insightIDstring

The identifier for the insight URLs in this sharing task. Needed to remove the permanent insight upon task deletion. (currently not used in multi-sheet scenarios)

ownerNamestring

User name of owner of the sharing task

startTimestring

Time to start capturing the history

thumbnailstring
updatedBystring

ID of a user that updated this task last

expirationstring

Time for the termination of the task

lastViewedstring

Timestamp of the most recent view by the user.

statusCode'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' | 'MAX_FAILURES_REACHED' | 'BOOKMARK_NOT_FOUND' | 'CANCELLING' | 'CANCELLED' | 'REPORTING_CONSUMPTION_EXCEEDED' | 'REPORTING_CAPABILITY_NOT_FOUND' | 'REPORTING_DAILY_QUOTA_EXCEEDED'

the status of this recurring sharing task

templateIdstring

ID of unique template

dateCreatedstring

Timestamp for the creation of the task

descriptionstring

A description of this sharing task

lastUpdatedstring

Timestamp of the most recent update.

statusLabelstring

error message indicating the underlying failure

enabledByUserboolean

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

byokMigrationIdstring

internal identifier used when migrating keys

enabledBySystemboolean

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

selectionErrorsobject

reporting service returns rendering errors for missing selections

dataConnectionIDstring

the id of the data connection

hasSectionAccessboolean

true if the associated app has section access enabled

insightDirectURLstring

The direct insights URL for the first template of this sharing task. (currently not used in multi-sheet scenarios)

nextScheduledRunstring

Time for the next scheduled run

reportPropertiesobject
sharePointFolderstring

the SharePoint folder to upload the report to

executeOnCreationboolean

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

lastExecutionDatestring

The last execution end date time timestamp of the task

transportChannelsstring[]

the transport type for the report

distributionListIdstring

the id of the distribution list associated to the app

insightFallbackURLstring

The insights fallback URL for the first template of this sharing task. (currently not used in multi-sheet scenarios)

failedExecutionsCountinteger

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

failedVerificationsCountinteger

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

isCandidateForVerificationboolean

true if the sharing task is a candidate for verification

persistentBookmarkIncludeVariablesboolean

Flag to configure the persistent bookmark to use variables. it is valid for subscriptions with type chart-sharing or sheet-sharing. Deprecated: please use the same field defined in the template instead.

enabledboolean

true if the sharing task is enabled

latestExecutionURLstring

URL to querying the latest execution tied to this sharing task

latestExecutionFilesURLstring[]

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

Example response

{
  "owner": "pXVNKqotgEMwbKwhz2agPE4yFelnPcWO",
  "tenant": "_mpoXaH22_vLR1pStfI7oUdGya1nKK24",
  "lastRun": "2019-10-15T16:07:01.492Z",
  "message": "Look at the presentation.",
  "ownerName": "Harley Kiffe",
  "startTime": "2019-10-15T16:07:01.492Z",
  "templates": [
    {
      "type": "file",
      "chartData": {
        "appId": "bdf2efee-815e-4eb7-9e1e-c42d516baf29",
        "outDpi": 96,
        "outZoom": 1,
        "sheetId": "bdf2efee-815e-4eb7-9e1e-asdfasdfasdf",
        "widthPx": 1584,
        "heightPx": 587,
        "objectId": "167f3e67-ff3b-4ead-a09e-e8cc81d8ad78"
      },
      "sheetData": {
        "appId": "bdf2efee-815e-4eb7-9e1e-c42d516baf29",
        "sheetId": "39a671a-5f58-468c-bb49-dff933294774",
        "widthPx": 1584,
        "heightPx": 587,
        "sheetName": "My new sheet"
      },
      "storyData": {
        "appId": "bdf2efee-815e-4eb7-9e1e-c42d516baf29",
        "storyId": "39a671a-5f58-468c-bb49-dff933294774"
      },
      "templateId": "da5825325dc9a0dd0260af9",
      "multiSheetData": [
        {
          "appId": "bdf2efee-815e-4eb7-9e1e-c42d516baf29",
          "sheetId": "39a671a-5f58-468c-bb49-dff933294774",
          "widthPx": 1584,
          "heightPx": 587,
          "sheetName": "My new sheet"
        }
      ]
    }
  ],
  "expiration": "2019-10-15T16:07:01.492Z",
  "lastViewed": "2019-10-15T16:07:01.492Z",
  "recipients": {
    "userIds": [
      {
        "value": "1b263bs8m0mm_s21s3f",
        "groups": [
          "addedIndividually",
          "group1",
          "group2"
        ],
        "enabledByUser": true,
        "enabledBySystem": true,
        "taskRecipientErrors": [
          {
            "timestamp": "2019-10-15T16:07:01.492Z"
          }
        ],
        "alertingTaskRecipientErrors": [
          {
            "added": "2019-10-15T16:07:01.492Z"
          }
        ]
      }
    ],
    "groupIds": [
      {
        "value": "group1",
        "enabledByUser": true,
        "enabledBySystem": true,
        "taskGroupRecipientErrors": [
          {
            "timestamp": "2019-10-15T16:07:01.492Z"
          }
        ],
        "alertingTaskGroupRecipientErrors": [
          {
            "added": "2019-10-15T16:07:01.492Z"
          }
        ]
      }
    ],
    "emailAddresses": [
      {
        "value": "abc@xyz.com",
        "enabled": true,
        "taskRecipientErrors": [
          {
            "timestamp": "2019-10-15T16:07:01.492Z"
          }
        ]
      }
    ],
    "netRecipientCount": 10
  },
  "taskErrors": [
    {
      "timestamp": "2019-10-15T16:07:01.492Z"
    }
  ],
  "templateId": "da5825325dc9a0dd0260af9",
  "dateCreated": "2019-10-15T16:07:01.492Z",
  "lastUpdated": "2019-10-15T16:07:01.492Z",
  "emailContent": {
    "body": "report body string",
    "subject": "report subject"
  },
  "enabledByUser": true,
  "enabledBySystem": true,
  "retentionPolicy": {
    "historySize": 10,
    "overrideInterval": "FREQ=DAILY;INTERVAL=1"
  },
  "scheduleOptions": {
    "timezone": "Canada/Pacific",
    "recurrence": [
      "RRULE:FREQ=HOURLY;INTERVAL=2"
    ],
    "endDateTime": "2026-01-02T16:04:05",
    "startDateTime": "2006-01-02T16:04:05",
    "lastExecutionTime": "2020-11-20T12:00:55.000Z",
    "nextExecutionTime": "2020-11-20T12:00:55.000Z"
  },
  "nextScheduledRun": "2019-10-15T16:07:01.492Z",
  "lastExecutionDate": "2019-10-15T16:09:01.492Z",
  "distributionListId": "vXVNKqotgEMwbKwhz2agPE4yFelnPcWX",
  "links": {
    "self": {
      "href": "http://localhost:8787/v1/items/5da5825325dc9a0dd0260af9"
    }
  }
}

Changes