ACacculynx
reports

Get Report Instance Recipients

Changed on

Use this endpoint to get a list of recipients for a specific instance of a given scheduled report by it's unique identifier. If the scheduled report requested is not available the response will be a Not Found error. The instance of the report should be a valid instance of the scheduled report. If the scheduled report doesn't have any recipient the response will be an Empty response.

get/reports/scheduled-reports/{scheduledReportId}/runs/{instanceRunId}/recipients

Request

  • Base URL
    https://api.acculynx.com/api/v2
  • URL
    https://api.acculynx.com/api/v2/reports/scheduled-reports/{scheduledReportId}/runs/{instanceRunId}/recipients
  • Auth
    HTTP bearer

Path parameters

scheduledReportIdstring uuid required

The scheduled report's unique identifier

instanceRunIdstring uuid required

The scheduled report's instance run unique identifier

Query parameters

pageSizeinteger

How many items to be returned at a time.

pageStartIndexinteger

The index of the page to return

Response

OK

countinteger

The total number of items matching the current query.

pageSizeinteger

The requested or default page size.

pageStartIndexinteger

The requested or default index of the first element to return.

Example response

{
  "items": [
    {
      "recipientId": "5fafa5a5-74ad-4c31-8b33-005e16841d87",
      "reportId": "db672560-00f0-405d-af6e-8d0aa17a94df",
      "runInstanceId": "be6f252d-5aa6-49e3-a2e2-470a67f88711",
      "date": "2022-06-22T19:47:10Z",
      "files": [
        {
          "fileId": "bd110e4f-1b06-464c-b9cb-901d80ddc137",
          "fileUrl": "https://assets.acculynx.com/scheduledReports/reports/d8afe5c0-b2ad-46f5-b9a1-0c6e966632c9/reports/db672560-00f0-405d-af6e-8d0aa17a94df.csv"
        }
      ]
    }
  ]
}

Changes

  • 443924b00f43Revision changes
    • breaking

      for the query request parameter pageSize, default value 25 was removed

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added the optional property to the response with the status