Api

Class DownloadDTDApi

java.lang.Object

Api.DownloadDTDApi

public class DownloadDTDApi
extends Object

Constructor Summary

Constructors

Constructor and Description
DownloadDTDApi()
DownloadDTDApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
void	getDTDV2(String reportDefinitionNameVersion) Download DTD for Report Used to download DTDs for reports on no-auth.
okhttp3.Call	getDTDV2Async(String reportDefinitionNameVersion, ApiCallback<Void> callback) Download DTD for Report (asynchronously) Used to download DTDs for reports on no-auth.
okhttp3.Call	getDTDV2Call(String reportDefinitionNameVersion, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getDTDV2
ApiResponse<Void>	getDTDV2WithHttpInfo(String reportDefinitionNameVersion) Download DTD for Report Used to download DTDs for reports on no-auth.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

DownloadDTDApi

public DownloadDTDApi()

DownloadDTDApi

public DownloadDTDApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getDTDV2Call

public okhttp3.Call getDTDV2Call(String reportDefinitionNameVersion,
                                 ProgressResponseBody.ProgressListener progressListener,
                                 ProgressRequestBody.ProgressRequestListener progressRequestListener)
                          throws ApiException

Build call for getDTDV2

Parameters:

reportDefinitionNameVersion - Name and version of DTD file to download. Some DTDs only have one version. In that case version name is not needed. Some example values are ctdr-1.0, tdr, pbdr-1.1 (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getDTDV2

public void getDTDV2(String reportDefinitionNameVersion)
              throws ApiException

Download DTD for Report Used to download DTDs for reports on no-auth.

Parameters:

reportDefinitionNameVersion - Name and version of DTD file to download. Some DTDs only have one version. In that case version name is not needed. Some example values are ctdr-1.0, tdr, pbdr-1.1 (required)

Throws:

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

getDTDV2WithHttpInfo

public ApiResponse<Void> getDTDV2WithHttpInfo(String reportDefinitionNameVersion)
                                       throws ApiException

Download DTD for Report Used to download DTDs for reports on no-auth.

Parameters:

reportDefinitionNameVersion - Name and version of DTD file to download. Some DTDs only have one version. In that case version name is not needed. Some example values are ctdr-1.0, tdr, pbdr-1.1 (required)

Returns:

ApiResponse<Void>

Throws:

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

getDTDV2Async

public okhttp3.Call getDTDV2Async(String reportDefinitionNameVersion,
                                  ApiCallback<Void> callback)
                           throws ApiException

Download DTD for Report (asynchronously) Used to download DTDs for reports on no-auth.

Parameters:

reportDefinitionNameVersion - Name and version of DTD file to download. Some DTDs only have one version. In that case version name is not needed. Some example values are ctdr-1.0, tdr, pbdr-1.1 (required)

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