v1

latestOpenAPI 3.0.02026-08-041353104.2 KB

sharing tasks

List sharing tasks

Retrieves all sharing tasks accessible to the user. Users assigned the TenantAdmin or AnalyticsAdmin role can view all tasks.

get/api/v1/sharing-tasks

Query parameters

appidstring

the filter by sharing task resource app id. TenantAdmin users may omit this parameter to list all sharing-tasks in the tenant.

excludeDeletingboolean

Indicates if task with the status DELETING should be excluded from the list

limitinteger

Limit the returned result set

offsetinteger

Offset for finding a list of entities - used for pagination

ownerstring

the filter by sharing task resource owner id.

ownernamestring

the filter by sharing task resource owner name.

pagestring

The cursor to the page of data.

rolestring[]

the filter by sharing task resource role.

sortstring[]

Sort the returned result set by the specified field

templateIdstring[]

array of template ids to filter by

typestring[]

the filter by sharing task resource type. If type is template-sharing only and user is not tenant admin, appid is also required.

nextstring

The cursor to the next page of data. Only one of next or previous may be specified.

prevstring

The cursor to the previous page of data. Only one of next or previous may be specified.

Response

The sharing task list has been successfully returned.

totalCountinteger required

total count of entries in the collection as a whole

currentPageCountinteger required

count of entries on the currently shown page

Example response

{
  "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"
    }
  },
  "recipients": {
    "userIds": [
      {
        "value": "1b263bs8m0mm_s21s3f",
        "groups": [
          "addedIndividually",
          "group1",
          "group2"
        ],
        "enabled": true,
        "subscribed": true,
        "taskRecipientErrors": [
          {
            "timestamp": "2019-10-15T16:07:01.492Z"
          }
        ],
        "alertingTaskRecipientErrors": [
          {
            "added": "2019-10-15T16:07:01.492Z"
          }
        ]
      }
    ],
    "emailAddresses": [
      "abc@xyz.com"
    ]
  },
  "sharingTasks": [
    {
      "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"
        }
      }
    }
  ]
}

All 13 operations