com.docusign.esign.api

Class DiagnosticsApi

java.lang.Object

com.docusign.esign.api.DiagnosticsApi

public class DiagnosticsApi
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	DiagnosticsApi.ListRequestLogsOptions

Constructor Summary

Constructors

Constructor and Description
DiagnosticsApi()
DiagnosticsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
void	deleteRequestLogs() Deletes the request log files.
ApiClient	getApiClient()
byte[]	getRequestLog(String requestLogId) Gets a request logging log file.
DiagnosticsSettingsInformation	getRequestLogSettings() Gets the API request logging settings.
ResourceInformation	getResources() Lists resources for REST version specified Retrieves the base resources available for the DocuSign REST APIs.\n\nYou do not need an integrator key to view the REST API versions and resources.\n\nExample: https://demo.docusign.net/restapi/v2 lists all of the base resources available in version 2 of the REST API on the DocuSign Demo system.\n\nTo view descriptions and samples of the service operations for all versions, remove the version number and add /help to the URL.\n\nExample: https://demo.docusign.net/restapi/help lists the REST API operations on the DocuSign Demo system with XML and JSON request and response samples.
ServiceInformation	getService() Retrieves the available REST API versions.
ApiRequestLogsResult	listRequestLogs() Gets the API request logging log files.
ApiRequestLogsResult	listRequestLogs(DiagnosticsApi.ListRequestLogsOptions options) Gets the API request logging log files.
void	setApiClient(ApiClient apiClient)
DiagnosticsSettingsInformation	updateRequestLogSettings(DiagnosticsSettingsInformation diagnosticsSettingsInformation) Enables or disables API request logging for troubleshooting.

Methods inherited from class java.lang.Object

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

Constructor Detail

DiagnosticsApi

public DiagnosticsApi()

DiagnosticsApi

public DiagnosticsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

deleteRequestLogs

public void deleteRequestLogs()
                       throws ApiException

Deletes the request log files. Deletes the request log files. DiagnosticsApi.DeleteRequestLogsOptions Options for modifying the method behavior.

Throws:

ApiException - if fails to make API call

getRequestLog

public byte[] getRequestLog(String requestLogId)
                     throws ApiException

Gets a request logging log file. Retrieves information for a single log entry.\n\n**Request**\nThe `requestLogfId` property can be retrieved by getting the list of log entries. The Content-Transfer-Encoding header can be set to base64 to retrieve the API request/response as base 64 string. Otherwise the bytes of the request/response are returned.\n\n**Response**\nIf the Content-Transfer-Encoding header was set to base64, the log is returned as a base64 string.

Parameters:

requestLogId - DiagnosticsApi.GetRequestLogOptions Options for modifying the method behavior.

Returns:

byte[]

Throws:

ApiException - if fails to make API call

getRequestLogSettings

public DiagnosticsSettingsInformation getRequestLogSettings()
                                                     throws ApiException

Gets the API request logging settings. Retrieves the current API request logging setting for the user and remaining log entries.\n\n**Response**\nThe response includes the current API request logging setting for the user, along with the maximum log entries and remaining log entries. DiagnosticsApi.GetRequestLogSettingsOptions Options for modifying the method behavior.

Returns:

DiagnosticsSettingsInformation

Throws:

ApiException - if fails to make API call

getResources

public ResourceInformation getResources()
                                 throws ApiException

Lists resources for REST version specified Retrieves the base resources available for the DocuSign REST APIs.\n\nYou do not need an integrator key to view the REST API versions and resources.\n\nExample: https://demo.docusign.net/restapi/v2 lists all of the base resources available in version 2 of the REST API on the DocuSign Demo system.\n\nTo view descriptions and samples of the service operations for all versions, remove the version number and add /help to the URL.\n\nExample: https://demo.docusign.net/restapi/help lists the REST API operations on the DocuSign Demo system with XML and JSON request and response samples. DiagnosticsApi.GetResourcesOptions Options for modifying the method behavior.

Returns:

ResourceInformation

Throws:

ApiException - if fails to make API call

getService

public ServiceInformation getService()
                              throws ApiException

Retrieves the available REST API versions. Retrieves the available REST API versions.\n\nDocuSign Production system: https://www.docusign.net/restapi/service_information\nDocuSign Demo system: https://demo.docusign.net/restapi/service_information\n\nYou do not need an integrator key to view the REST API versions and resources. DiagnosticsApi.GetServiceOptions Options for modifying the method behavior.

Returns:

ServiceInformation

Throws:

ApiException - if fails to make API call

listRequestLogs

public ApiRequestLogsResult listRequestLogs()
                                     throws ApiException

Gets the API request logging log files. Retrieves a list of log entries as a JSON or xml object or as a zip file containing the entries.\n\nIf the Accept header is set to application/zip, the response is a zip file containing individual text files, each representing an API request.\n\nIf the Accept header is set to `application/json` or `application/xml`, the response returns list of log entries in either JSON or XML. An example JSON response body is shown below.

Returns:

ApiRequestLogsResult

Throws:

ApiException

listRequestLogs

public ApiRequestLogsResult listRequestLogs(DiagnosticsApi.ListRequestLogsOptions options)
                                     throws ApiException

Gets the API request logging log files. Retrieves a list of log entries as a JSON or xml object or as a zip file containing the entries.\n\nIf the Accept header is set to application/zip, the response is a zip file containing individual text files, each representing an API request.\n\nIf the Accept header is set to `application/json` or `application/xml`, the response returns list of log entries in either JSON or XML. An example JSON response body is shown below. DiagnosticsApi.ListRequestLogsOptions Options for modifying the method behavior.

Returns:

ApiRequestLogsResult

Throws:

ApiException - if fails to make API call

updateRequestLogSettings

public DiagnosticsSettingsInformation updateRequestLogSettings(DiagnosticsSettingsInformation diagnosticsSettingsInformation)
                                                        throws ApiException

Enables or disables API request logging for troubleshooting. Enables or disables API request logging for troubleshooting.\n\nWhen enabled (`apiRequestLogging` is set to true), REST API requests and responses for the user are added to a log. A log can have up to 50 requests/responses and the current number of log entries can be determined by getting the settings. Logging is automatically disabled when the log limit of 50 is reached.\n\nYou can call [ML:GetRequestLog] or [ML:GetRequestLogs] to download the log files (individually or as a zip file). Call [ML:DeleteRequestLogs] to clear the log by deleting current entries.\n\nPrivate information, such as passwords and integrator key information, which is normally located in the call header is omitted from the request/response log.\n\n###### Note: API request logging only captures requests from the authenticated user. Any call that does not authenticate the user and resolve a userId isn't logged. Meaning that login_information, NewAccounts, or other distributor-credential calls are not logged.\n DiagnosticsApi.UpdateRequestLogSettingsOptions Options for modifying the method behavior.

Returns:

DiagnosticsSettingsInformation

Throws:

ApiException - if fails to make API call