Api

Class RetrievalDetailsApi

java.lang.Object

Api.RetrievalDetailsApi

public class RetrievalDetailsApi
extends Object

Constructor Summary

Constructors

Constructor and Description
RetrievalDetailsApi()
RetrievalDetailsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
ReportingV3RetrievalDetailsGet200Response	getRetrievalDetails(org.joda.time.DateTime startTime, org.joda.time.DateTime endTime, String organizationId) Get Retrieval Details Retrieval Detail Report Description
okhttp3.Call	getRetrievalDetailsAsync(org.joda.time.DateTime startTime, org.joda.time.DateTime endTime, String organizationId, ApiCallback<ReportingV3RetrievalDetailsGet200Response> callback) Get Retrieval Details (asynchronously) Retrieval Detail Report Description
okhttp3.Call	getRetrievalDetailsCall(org.joda.time.DateTime startTime, org.joda.time.DateTime endTime, String organizationId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getRetrievalDetails
ApiResponse<ReportingV3RetrievalDetailsGet200Response>	getRetrievalDetailsWithHttpInfo(org.joda.time.DateTime startTime, org.joda.time.DateTime endTime, String organizationId) Get Retrieval Details Retrieval Detail Report Description
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

RetrievalDetailsApi

public RetrievalDetailsApi()

RetrievalDetailsApi

public RetrievalDetailsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getRetrievalDetailsCall

public okhttp3.Call getRetrievalDetailsCall(org.joda.time.DateTime startTime,
                                            org.joda.time.DateTime endTime,
                                            String organizationId,
                                            ProgressResponseBody.ProgressListener progressListener,
                                            ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                     throws ApiException

Build call for getRetrievalDetails

Parameters:

startTime - Valid report Start Time 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'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) (required)

endTime - Valid report End Time 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'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) (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

getRetrievalDetails

public ReportingV3RetrievalDetailsGet200Response getRetrievalDetails(org.joda.time.DateTime startTime,
                                                                     org.joda.time.DateTime endTime,
                                                                     String organizationId)
                                                              throws ApiException

Get Retrieval Details Retrieval Detail Report Description

Parameters:

startTime - Valid report Start Time 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'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) (required)

endTime - Valid report End Time 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'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) (required)

organizationId - Valid Organization Id (optional)

Returns:

ReportingV3RetrievalDetailsGet200Response

Throws:

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

getRetrievalDetailsWithHttpInfo

public ApiResponse<ReportingV3RetrievalDetailsGet200Response> getRetrievalDetailsWithHttpInfo(org.joda.time.DateTime startTime,
                                                                                              org.joda.time.DateTime endTime,
                                                                                              String organizationId)
                                                                                       throws ApiException

Get Retrieval Details Retrieval Detail Report Description

Parameters:

startTime - Valid report Start Time 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'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) (required)

endTime - Valid report End Time 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'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) (required)

organizationId - Valid Organization Id (optional)

Returns:

ApiResponse<ReportingV3RetrievalDetailsGet200Response>

Throws:

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

getRetrievalDetailsAsync

public okhttp3.Call getRetrievalDetailsAsync(org.joda.time.DateTime startTime,
                                             org.joda.time.DateTime endTime,
                                             String organizationId,
                                             ApiCallback<ReportingV3RetrievalDetailsGet200Response> callback)
                                      throws ApiException

Get Retrieval Details (asynchronously) Retrieval Detail Report Description

Parameters:

startTime - Valid report Start Time 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'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) (required)

endTime - Valid report End Time 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'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) (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