IReportsService.Reports

Collection of functions to interact with the Reports API endpoint.

All URI’s are relative to the VTN URL configured.

Method	HTTP request	Description
CreateReportAsync	POST /reports	Create a report
DeleteReportAsync	DELETE /reports/{reportID}	Delete a report
SearchReportsAsync	GET /reports	Searches all reports
FindReportByIdAsync	GET /reports/{reportID}	Searches reports by report ID
UpdateReportAsync	PUT /reports/{reportID}	Update a report

CreateReportAsync

Task<Report> CreateReportAsync(
    Report report,
    RequestOptions? options = default,
    CancellationToken cancellationToken = default)

Create a new report in the server.

DeleteReportAsync

Task<Report> DeleteReportAsync(
    string reportId,
    RequestOptions? options = default,
    CancellationToken cancellationToken = default)

Delete an existing report with the report ID.

SearchReportsAsync

Task<List<Report>> SearchReportsAsync(
    string? programId = default,
    string? eventId = default,
    string? clientName = default,
    int? skip = default,
    int? limit = default,
    RequestOptions? options = default,
    CancellationToken cancellationToken = default)

Searches all reports known to the server. Use skip and pagination query params to limit response size.

FindReportByIdAsync

Task<Report> FindReportByIdAsync(
    string reportId,
    RequestOptions? options = default,
    CancellationToken cancellationToken = default)

Find report associated by the report ID.

UpdateReportAsync

Task<Report> UpdateReportAsync(
    string reportId,
    Report report,
    RequestOptions? options = default,
    CancellationToken cancellationToken = default)

Update an existing report with specified report ID.