Request Extended Report


All report times are based on UTC time.

The extended report call will generate a report based on data available when the report is run.

Program Guid is not a mandatory input.

Request
Security:
path Parameters
version
required
string
Request Body schema: application/json
report_name
required
string non-empty
Array of objects or null (ReportArgs)
override_flag
string or null
overwrite_flag
string or null
redis_key
string or null
redis_url
string or null
reference_id
string <uuid>
program_guid
string or null <uuid>
date_from
string or null <date-time>
date_to
string or null <date-time>
sponsor_name
string or null
send_completion_email
boolean
Responses
200

Returns the Report Guid

400

Bad request

401

Unauthorized

404

Report name not found

500

Server Error

post/api/{version}/reports/extended
Request samples
application/json
{
  • "report_name": "string",
  • "report_args": [
    • {
      • "arg_name": "string",
      • "arg_type": "GUID",
      • "arg_value": "string"
      }
    ],
  • "override_flag": "string",
  • "overwrite_flag": "string",
  • "redis_key": "string",
  • "redis_url": "string",
  • "reference_id": "97c1ff22-6e4f-4821-b1d3-5236781d37b8",
  • "program_guid": "3fa0d2ea-ffcf-485d-94ed-dbf4f861ad2f",
  • "date_from": "2019-08-24T14:15:22Z",
  • "date_to": "2019-08-24T14:15:22Z",
  • "sponsor_name": "string",
  • "send_completion_email": true
}
Response samples
application/json
{
  • "reference_id": "97c1ff22-6e4f-4821-b1d3-5236781d37b8",
  • "program_guid": "3fa0d2ea-ffcf-485d-94ed-dbf4f861ad2f",
  • "program_name": "string",
  • "ext_name": "string",
  • "status": "string",
  • "filename": "string",
  • "error": "string",
  • "rpt_lastgenerated": "2019-08-24T14:15:22Z"
}
Copyright © 2023 KeyBank & Qolo. All rights reserved.