Skip to main content

Get Report File

GET 

/reports/:taskResultId

Gets a report in file format.

Request

Path Parameters

    taskResultId stringrequired

    Unique identifier of the task result which handled report

    Example: ef38f94347e94562b5bb8424a56397d8

Query Parameters

    fileFormat stringrequired

    Possible values: [csv, pdf]

    Output format of the requested report file

    Example: csv
    name string

    preferred Report file name, by default will be used report name from task result.

    Example: Identities Details Report
    auditable boolean

    Enables auditing for current report download. Will create an audit event and sent it to the REPORT cloud-audit kafka topic. Event will be created if there is any result present by requested taskResultId.

    Example: true

Responses

Report file in selected format. CSV by default.

Response Headers
  • Content-disposition string
    Example: attachment;filename=\"fileName"

    The requested report's filename

Schema

    string

Loading...