Api

Class ReportDownloadsApi

java.lang.Object

Api.ReportDownloadsApi

public class ReportDownloadsApi
extends Object

Constructor Summary

Constructors

Constructor and Description
ReportDownloadsApi()
ReportDownloadsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
void	downloadReport(org.joda.time.LocalDate reportDate, String reportName, String organizationId) Download a Report Download a report using the unique report name and date.
okhttp3.Call	downloadReportAsync(org.joda.time.LocalDate reportDate, String reportName, String organizationId, ApiCallback<Void> callback) Download a Report (asynchronously) Download a report using the unique report name and date.
okhttp3.Call	downloadReportCall(org.joda.time.LocalDate reportDate, String reportName, String organizationId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for downloadReport
ApiResponse<InputStream>	downloadReportWithHttpInfo(org.joda.time.LocalDate reportDate, String reportName, String organizationId) Download a Report Download a report using the unique report name and date.
ApiClient	getApiClient()
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ReportDownloadsApi

public ReportDownloadsApi()

ReportDownloadsApi

public ReportDownloadsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

downloadReportCall

public okhttp3.Call downloadReportCall(org.joda.time.LocalDate reportDate,
                                       String reportName,
                                       String organizationId,
                                       ProgressResponseBody.ProgressListener progressListener,
                                       ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                throws ApiException

Build call for downloadReport

Parameters:

reportDate - Valid date on which to download the report in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example date format:** yyyy-mm-dd For reports that span multiple days, this value would be the end date of the report in the time zone of the report subscription. Example 1: If your report start date is 2020-03-06 and the end date is 2020-03-09, the reportDate passed in the query is 2020-03-09. Example 2: If your report runs from midnight to midnight on 2020-03-09, the reportDate passed in the query is 2020-03-10 (required)

reportName - Name of the report to download (required)

organizationId - Valid Organization Id (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

downloadReport

public void downloadReport(org.joda.time.LocalDate reportDate,
                           String reportName,
                           String organizationId)
                    throws ApiException

Download a Report Download a report using the unique report name and date.

Parameters:

reportDate - Valid date on which to download the report in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example date format:** yyyy-mm-dd For reports that span multiple days, this value would be the end date of the report in the time zone of the report subscription. Example 1: If your report start date is 2020-03-06 and the end date is 2020-03-09, the reportDate passed in the query is 2020-03-09. Example 2: If your report runs from midnight to midnight on 2020-03-09, the reportDate passed in the query is 2020-03-10 (required)

reportName - Name of the report to download (required)

organizationId - Valid Organization Id (optional)

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

downloadReportWithHttpInfo

public ApiResponse<InputStream> downloadReportWithHttpInfo(org.joda.time.LocalDate reportDate,
                                                           String reportName,
                                                           String organizationId)
                                                    throws ApiException

Download a Report Download a report using the unique report name and date.

Parameters:

reportDate - Valid date on which to download the report in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example date format:** yyyy-mm-dd For reports that span multiple days, this value would be the end date of the report in the time zone of the report subscription. Example 1: If your report start date is 2020-03-06 and the end date is 2020-03-09, the reportDate passed in the query is 2020-03-09. Example 2: If your report runs from midnight to midnight on 2020-03-09, the reportDate passed in the query is 2020-03-10 (required)

reportName - Name of the report to download (required)

organizationId - Valid Organization Id (optional)

Returns:

ApiResponse<Void>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

downloadReportAsync

public okhttp3.Call downloadReportAsync(org.joda.time.LocalDate reportDate,
                                        String reportName,
                                        String organizationId,
                                        ApiCallback<Void> callback)
                                 throws ApiException

Download a Report (asynchronously) Download a report using the unique report name and date.

Parameters:

reportDate - Valid date on which to download the report in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example date format:** yyyy-mm-dd For reports that span multiple days, this value would be the end date of the report in the time zone of the report subscription. Example 1: If your report start date is 2020-03-06 and the end date is 2020-03-09, the reportDate passed in the query is 2020-03-09. Example 2: If your report runs from midnight to midnight on 2020-03-09, the reportDate passed in the query is 2020-03-10 (required)

reportName - Name of the report to download (required)

organizationId - Valid Organization Id (optional)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object