Sign in

v1

latestOpenAPI 3.0.0Proprietary2026-07-26130282259.8 KB
reports

Get Report Instance Recipient by ID

Use this endpoint to get a scheduled report recipient data of a given instance by it's recipient unique identifier. If the scheduled report requested is not available the response will be a not found error. If the instance of the scheduled report doesn't exists, the response will be a Not Found error If the recipient of the scheduled report doesn't exists, the response will be a Not Found error

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

Path parameters

scheduledReportIdstring uuid required

The scheduled report's unique identifier

instanceRunIdstring uuid required

The scheduled report's instance run unique identifier

recipientIdstring uuid required

The scheduled report's recipient unique identifier of a given instance run

Response

OK

recipientIdstring

The unique identifier of the report's instance recipient.

reportIdstring

The unique identifier of the report instance.

runInstanceIdstring uuid

The unique identifier of Report Recipient Instance.

datestring date-time

The generation of the report date and time in ISO 8601. https://en.wikipedia.org/wiki/ISO_8601

Example response

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