ReportsApi

interface ReportsApi

Functions

Link copied to clipboard
abstract suspend fun createReport(postRepostRequest: PostRepostRequest): PostReportsResponse

Create a Report

Link copied to clipboard
abstract suspend fun deleteReport(id: Long): DeleteReportsResponse

Delete a Report Only non-core reports can be deleted. Responses:

Link copied to clipboard

Retrieve Report Template This is a convenience resource. It can be useful when building maintenance user interface screens for client applications. The template data returned consists of any or all of: Field Defaults Allowed description Lists Example Request : reports/template Responses:

Link copied to clipboard
abstract suspend fun retrieveReport(id: Long): GetReportsResponse

Retrieve a Report Example Requests: reports/1 reports/1?template=true Responses:

Link copied to clipboard
abstract suspend fun retrieveReportList(): List<GetReportsResponse>

List Reports Lists all reports and their parameters. Example Request: reports Responses:

Link copied to clipboard
abstract suspend fun updateReport(id: Long, putReportRequest: PutReportRequest): PutReportResponse

Update a Report Only the useReport description can be updated for core reports. Responses: