Represents a collection of functions to interact with the API endpoints More...

Inheritance diagram for DocuSign.eSign.Api.DiagnosticsApi:

Classes
class	ListRequestLogsOptions
	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. If the Accept header is set to application/zip, the response is a zip file containing individual text files, each representing an API request. If 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. More...

Public Member Functions
	DiagnosticsApi (DocuSignClient aplClient)
	Initializes a new instance of the DiagnosticsApi class using AplClient object More...

String	GetBasePath ()
	Gets the base path of the API client. More...

void	DeleteRequestLogs ()
	Deletes the request log files. Deletes the request log files. More...

ApiResponse< Object >	DeleteRequestLogsWithHttpInfo ()
	Deletes the request log files. Deletes the request log files. More...

async System.Threading.Tasks.Task	DeleteRequestLogsAsync ()
	Deletes the request log files. Deletes the request log files. More...

async System.Threading.Tasks.Task< ApiResponse< Object > >	DeleteRequestLogsAsyncWithHttpInfo ()
	Deletes the request log files. Deletes the request log files. More...

System.IO.Stream	GetRequestLog (string requestLogId)
	Gets a request logging log file. Retrieves information for a single log entry. Request The `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. Response If the Content-Transfer-Encoding header was set to base64, the log is returned as a base64 string. More...

ApiResponse< System.IO.Stream >	GetRequestLogWithHttpInfo (string requestLogId)
	Gets a request logging log file. Retrieves information for a single log entry. Request The `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. Response If the Content-Transfer-Encoding header was set to base64, the log is returned as a base64 string. More...

async System.Threading.Tasks.Task< System.IO.Stream >	GetRequestLogAsync (string requestLogId)
	Gets a request logging log file. Retrieves information for a single log entry. Request The `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. Response If the Content-Transfer-Encoding header was set to base64, the log is returned as a base64 string. More...

async System.Threading.Tasks.Task< ApiResponse< System.IO.Stream > >	GetRequestLogAsyncWithHttpInfo (string requestLogId)
	Gets a request logging log file. Retrieves information for a single log entry. Request The `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. Response If the Content-Transfer-Encoding header was set to base64, the log is returned as a base64 string. More...

DiagnosticsSettingsInformation	GetRequestLogSettings ()
	Gets the API request logging settings. Retrieves the current API request logging setting for the user and remaining log entries. Response The response includes the current API request logging setting for the user, along with the maximum log entries and remaining log entries. More...

ApiResponse< DiagnosticsSettingsInformation >	GetRequestLogSettingsWithHttpInfo ()
	Gets the API request logging settings. Retrieves the current API request logging setting for the user and remaining log entries. Response The response includes the current API request logging setting for the user, along with the maximum log entries and remaining log entries. More...

async System.Threading.Tasks.Task< DiagnosticsSettingsInformation >	GetRequestLogSettingsAsync ()
	Gets the API request logging settings. Retrieves the current API request logging setting for the user and remaining log entries. Response The response includes the current API request logging setting for the user, along with the maximum log entries and remaining log entries. More...

async System.Threading.Tasks.Task< ApiResponse< DiagnosticsSettingsInformation > >	GetRequestLogSettingsAsyncWithHttpInfo ()
	Gets the API request logging settings. Retrieves the current API request logging setting for the user and remaining log entries. Response The response includes the current API request logging setting for the user, along with the maximum log entries and remaining log entries. More...

ResourceInformation	GetResources ()
	Lists resources for REST version specified Retrieves the base resources available for the DocuSign REST APIs. You do not need an integrator key to view the REST API versions and resources. Example: 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. To view descriptions and samples of the service operations for all versions, remove the version number and add /help to the URL. Example: https://demo.docusign.net/restapi/help lists the REST API operations on the DocuSign Demo system with XML and JSON request and response samples. More...

ApiResponse< ResourceInformation >	GetResourcesWithHttpInfo ()
	Lists resources for REST version specified Retrieves the base resources available for the DocuSign REST APIs. You do not need an integrator key to view the REST API versions and resources. Example: 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. To view descriptions and samples of the service operations for all versions, remove the version number and add /help to the URL. Example: https://demo.docusign.net/restapi/help lists the REST API operations on the DocuSign Demo system with XML and JSON request and response samples. More...

async System.Threading.Tasks.Task< ResourceInformation >	GetResourcesAsync ()
	Lists resources for REST version specified Retrieves the base resources available for the DocuSign REST APIs. You do not need an integrator key to view the REST API versions and resources. Example: 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. To view descriptions and samples of the service operations for all versions, remove the version number and add /help to the URL. Example: https://demo.docusign.net/restapi/help lists the REST API operations on the DocuSign Demo system with XML and JSON request and response samples. More...

async System.Threading.Tasks.Task< ApiResponse< ResourceInformation > >	GetResourcesAsyncWithHttpInfo ()
	Lists resources for REST version specified Retrieves the base resources available for the DocuSign REST APIs. You do not need an integrator key to view the REST API versions and resources. Example: 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. To view descriptions and samples of the service operations for all versions, remove the version number and add /help to the URL. Example: https://demo.docusign.net/restapi/help lists the REST API operations on the DocuSign Demo system with XML and JSON request and response samples. More...

ServiceInformation	GetService ()
	Retrieves the available REST API versions. Retrieves the available REST API versions. DocuSign Production system: https://www.docusign.net/restapi/service_information DocuSign Demo system: https://demo.docusign.net/restapi/service_information You do not need an integrator key to view the REST API versions and resources. More...

ApiResponse< ServiceInformation >	GetServiceWithHttpInfo ()
	Retrieves the available REST API versions. Retrieves the available REST API versions. DocuSign Production system: https://www.docusign.net/restapi/service_information DocuSign Demo system: https://demo.docusign.net/restapi/service_information You do not need an integrator key to view the REST API versions and resources. More...

async System.Threading.Tasks.Task< ServiceInformation >	GetServiceAsync ()
	Retrieves the available REST API versions. Retrieves the available REST API versions. DocuSign Production system: https://www.docusign.net/restapi/service_information DocuSign Demo system: https://demo.docusign.net/restapi/service_information You do not need an integrator key to view the REST API versions and resources. More...

async System.Threading.Tasks.Task< ApiResponse< ServiceInformation > >	GetServiceAsyncWithHttpInfo ()
	Retrieves the available REST API versions. Retrieves the available REST API versions. DocuSign Production system: https://www.docusign.net/restapi/service_information DocuSign Demo system: https://demo.docusign.net/restapi/service_information You do not need an integrator key to view the REST API versions and resources. More...

ApiRequestLogsResult	ListRequestLogs (DiagnosticsApi.ListRequestLogsOptions options=null)
	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. If the Accept header is set to application/zip, the response is a zip file containing individual text files, each representing an API request. If 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. More...

ApiResponse< ApiRequestLogsResult >	ListRequestLogsWithHttpInfo (DiagnosticsApi.ListRequestLogsOptions options=null)
	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. If the Accept header is set to application/zip, the response is a zip file containing individual text files, each representing an API request. If 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. More...

async System.Threading.Tasks.Task< ApiRequestLogsResult >	ListRequestLogsAsync (DiagnosticsApi.ListRequestLogsOptions options=null)
	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. If the Accept header is set to application/zip, the response is a zip file containing individual text files, each representing an API request. If 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. More...

async System.Threading.Tasks.Task< ApiResponse< ApiRequestLogsResult > >	ListRequestLogsAsyncWithHttpInfo (DiagnosticsApi.ListRequestLogsOptions options=null)
	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. If the Accept header is set to application/zip, the response is a zip file containing individual text files, each representing an API request. If 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. More...

DiagnosticsSettingsInformation	UpdateRequestLogSettings (DiagnosticsSettingsInformation diagnosticsSettingsInformation=null)
	Enables or disables API request logging for troubleshooting. Enables or disables API request logging for troubleshooting. When 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. You 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. Private information, such as passwords and integrator key information, which is normally located in the call header is omitted from the request/response log. ###### 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. More...

ApiResponse< DiagnosticsSettingsInformation >	UpdateRequestLogSettingsWithHttpInfo (DiagnosticsSettingsInformation diagnosticsSettingsInformation=null)
	Enables or disables API request logging for troubleshooting. Enables or disables API request logging for troubleshooting. When 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. You 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. Private information, such as passwords and integrator key information, which is normally located in the call header is omitted from the request/response log. ###### 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. More...

async System.Threading.Tasks.Task< DiagnosticsSettingsInformation >	UpdateRequestLogSettingsAsync (DiagnosticsSettingsInformation diagnosticsSettingsInformation=null)
	Enables or disables API request logging for troubleshooting. Enables or disables API request logging for troubleshooting. When 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. You 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. Private information, such as passwords and integrator key information, which is normally located in the call header is omitted from the request/response log. ###### 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. More...

async System.Threading.Tasks.Task< ApiResponse< DiagnosticsSettingsInformation > >	UpdateRequestLogSettingsAsyncWithHttpInfo (DiagnosticsSettingsInformation diagnosticsSettingsInformation=null)
	Enables or disables API request logging for troubleshooting. Enables or disables API request logging for troubleshooting. When 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. You 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. Private information, such as passwords and integrator key information, which is normally located in the call header is omitted from the request/response log. ###### 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. More...

Public Member Functions inherited from DocuSign.eSign.Api.IDiagnosticsApi
ApiRequestLogsResult	ListRequestLogs (DiagnosticsApi.ListRequestLogsOptions options=null)
	Gets the API request logging log files. More...

ApiResponse< ApiRequestLogsResult >	ListRequestLogsWithHttpInfo (DiagnosticsApi.ListRequestLogsOptions options=null)
	Gets the API request logging log files. More...

System.Threading.Tasks.Task< ApiRequestLogsResult >	ListRequestLogsAsync (DiagnosticsApi.ListRequestLogsOptions options=null)
	Gets the API request logging log files. More...

System.Threading.Tasks.Task< ApiResponse< ApiRequestLogsResult > >	ListRequestLogsAsyncWithHttpInfo (DiagnosticsApi.ListRequestLogsOptions options=null)
	Gets the API request logging log files. More...

Properties
DocuSignClient	ApiClient `[get, set]`
	Gets or sets the ApiClient object More...

DocuSign.eSign.Client.ExceptionFactory	ExceptionFactory `[get, set]`
	Provides a factory method hook for the creation of exceptions. More...

Properties inherited from DocuSign.eSign.Client.IApiAccessor
DocuSignClient	ApiClient `[get, set]`
	Gets or sets the ApiClient object More...

ExceptionFactory	ExceptionFactory `[get, set]`
	Provides a factory method hook for the creation of exceptions. More...

Detailed Description

Represents a collection of functions to interact with the API endpoints

Constructor & Destructor Documentation

◆ DiagnosticsApi()

DocuSign.eSign.Api.DiagnosticsApi.DiagnosticsApi ( DocuSignClient aplClient )

inline

Initializes a new instance of the DiagnosticsApi class using AplClient object

Parameters

aplClient An instance of AplClient

Returns

Member Function Documentation

◆ DeleteRequestLogs()

void DocuSign.eSign.Api.DiagnosticsApi.DeleteRequestLogs ( )

inline

Deletes the request log files. Deletes the request log files.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Returns

Implements DocuSign.eSign.Api.IDiagnosticsApi.

◆ DeleteRequestLogsAsync()

async System.Threading.Tasks.Task DocuSign.eSign.Api.DiagnosticsApi.DeleteRequestLogsAsync ( )

inline

Deletes the request log files. Deletes the request log files.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Returns: Task of void

Implements DocuSign.eSign.Api.IDiagnosticsApi.

◆ DeleteRequestLogsAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<Object> > DocuSign.eSign.Api.DiagnosticsApi.DeleteRequestLogsAsyncWithHttpInfo ( )

inline

Deletes the request log files. Deletes the request log files.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Returns: Task of ApiResponse

Implements DocuSign.eSign.Api.IDiagnosticsApi.

◆ DeleteRequestLogsWithHttpInfo()

ApiResponse<Object> DocuSign.eSign.Api.DiagnosticsApi.DeleteRequestLogsWithHttpInfo ( )

inline

Deletes the request log files. Deletes the request log files.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Returns: ApiResponse of Object(void)

Implements DocuSign.eSign.Api.IDiagnosticsApi.

◆ GetBasePath()

String DocuSign.eSign.Api.DiagnosticsApi.GetBasePath ( )

inline

Gets the base path of the API client.

The base path

Implements DocuSign.eSign.Client.IApiAccessor.

◆ GetRequestLog()

System.IO.Stream DocuSign.eSign.Api.DiagnosticsApi.GetRequestLog ( string requestLogId )

inline

Gets a request logging log file. Retrieves information for a single log entry. Request The `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. Response If the Content-Transfer-Encoding header was set to base64, the log is returned as a base64 string.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

requestLogId

Returns: System.IO.Stream

Implements DocuSign.eSign.Api.IDiagnosticsApi.

◆ GetRequestLogAsync()

async System.Threading.Tasks.Task<System.IO.Stream> DocuSign.eSign.Api.DiagnosticsApi.GetRequestLogAsync ( string requestLogId )

inline

Gets a request logging log file. Retrieves information for a single log entry. Request The `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. Response If the Content-Transfer-Encoding header was set to base64, the log is returned as a base64 string.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

requestLogId

Returns: Task of System.IO.Stream

Implements DocuSign.eSign.Api.IDiagnosticsApi.

◆ GetRequestLogAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<System.IO.Stream> > DocuSign.eSign.Api.DiagnosticsApi.GetRequestLogAsyncWithHttpInfo ( string requestLogId )

inline

Gets a request logging log file. Retrieves information for a single log entry. Request The `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. Response If the Content-Transfer-Encoding header was set to base64, the log is returned as a base64 string.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

requestLogId

Returns: Task of ApiResponse (System.IO.Stream)

Implements DocuSign.eSign.Api.IDiagnosticsApi.

◆ GetRequestLogSettings()

DiagnosticsSettingsInformation DocuSign.eSign.Api.DiagnosticsApi.GetRequestLogSettings ( )

inline

Gets the API request logging settings. Retrieves the current API request logging setting for the user and remaining log entries. Response The response includes the current API request logging setting for the user, along with the maximum log entries and remaining log entries.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Returns: DiagnosticsSettingsInformation

Implements DocuSign.eSign.Api.IDiagnosticsApi.

◆ GetRequestLogSettingsAsync()

async System.Threading.Tasks.Task<DiagnosticsSettingsInformation> DocuSign.eSign.Api.DiagnosticsApi.GetRequestLogSettingsAsync ( )

inline

Gets the API request logging settings. Retrieves the current API request logging setting for the user and remaining log entries. Response The response includes the current API request logging setting for the user, along with the maximum log entries and remaining log entries.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Returns: Task of DiagnosticsSettingsInformation

Implements DocuSign.eSign.Api.IDiagnosticsApi.

◆ GetRequestLogSettingsAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<DiagnosticsSettingsInformation> > DocuSign.eSign.Api.DiagnosticsApi.GetRequestLogSettingsAsyncWithHttpInfo ( )

inline

Gets the API request logging settings. Retrieves the current API request logging setting for the user and remaining log entries. Response The response includes the current API request logging setting for the user, along with the maximum log entries and remaining log entries.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Returns: Task of ApiResponse (DiagnosticsSettingsInformation)

Implements DocuSign.eSign.Api.IDiagnosticsApi.

◆ GetRequestLogSettingsWithHttpInfo()

ApiResponse<DiagnosticsSettingsInformation> DocuSign.eSign.Api.DiagnosticsApi.GetRequestLogSettingsWithHttpInfo ( )

inline

Gets the API request logging settings. Retrieves the current API request logging setting for the user and remaining log entries. Response The response includes the current API request logging setting for the user, along with the maximum log entries and remaining log entries.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Returns: ApiResponse of DiagnosticsSettingsInformation

Implements DocuSign.eSign.Api.IDiagnosticsApi.

◆ GetRequestLogWithHttpInfo()

ApiResponse<System.IO.Stream> DocuSign.eSign.Api.DiagnosticsApi.GetRequestLogWithHttpInfo ( string requestLogId )

inline

Gets a request logging log file. Retrieves information for a single log entry. Request The `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. Response If the Content-Transfer-Encoding header was set to base64, the log is returned as a base64 string.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

requestLogId

Returns: ApiResponse of System.IO.Stream

Implements DocuSign.eSign.Api.IDiagnosticsApi.

◆ GetResources()

ResourceInformation DocuSign.eSign.Api.DiagnosticsApi.GetResources ( )

inline

Lists resources for REST version specified Retrieves the base resources available for the DocuSign REST APIs. You do not need an integrator key to view the REST API versions and resources. Example: 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. To view descriptions and samples of the service operations for all versions, remove the version number and add /help to the URL. Example: https://demo.docusign.net/restapi/help lists the REST API operations on the DocuSign Demo system with XML and JSON request and response samples.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Returns: ResourceInformation

Implements DocuSign.eSign.Api.IDiagnosticsApi.

◆ GetResourcesAsync()

async System.Threading.Tasks.Task<ResourceInformation> DocuSign.eSign.Api.DiagnosticsApi.GetResourcesAsync ( )

inline

Lists resources for REST version specified Retrieves the base resources available for the DocuSign REST APIs. You do not need an integrator key to view the REST API versions and resources. Example: 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. To view descriptions and samples of the service operations for all versions, remove the version number and add /help to the URL. Example: https://demo.docusign.net/restapi/help lists the REST API operations on the DocuSign Demo system with XML and JSON request and response samples.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Returns: Task of ResourceInformation

Implements DocuSign.eSign.Api.IDiagnosticsApi.

◆ GetResourcesAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<ResourceInformation> > DocuSign.eSign.Api.DiagnosticsApi.GetResourcesAsyncWithHttpInfo ( )

inline

Lists resources for REST version specified Retrieves the base resources available for the DocuSign REST APIs. You do not need an integrator key to view the REST API versions and resources. Example: 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. To view descriptions and samples of the service operations for all versions, remove the version number and add /help to the URL. Example: https://demo.docusign.net/restapi/help lists the REST API operations on the DocuSign Demo system with XML and JSON request and response samples.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Returns: Task of ApiResponse (ResourceInformation)

Implements DocuSign.eSign.Api.IDiagnosticsApi.

◆ GetResourcesWithHttpInfo()

ApiResponse<ResourceInformation> DocuSign.eSign.Api.DiagnosticsApi.GetResourcesWithHttpInfo ( )

inline

Lists resources for REST version specified Retrieves the base resources available for the DocuSign REST APIs. You do not need an integrator key to view the REST API versions and resources. Example: 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. To view descriptions and samples of the service operations for all versions, remove the version number and add /help to the URL. Example: https://demo.docusign.net/restapi/help lists the REST API operations on the DocuSign Demo system with XML and JSON request and response samples.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Returns: ApiResponse of ResourceInformation

Implements DocuSign.eSign.Api.IDiagnosticsApi.

◆ GetService()

ServiceInformation DocuSign.eSign.Api.DiagnosticsApi.GetService ( )

inline

Retrieves the available REST API versions. Retrieves the available REST API versions. DocuSign Production system: https://www.docusign.net/restapi/service_information DocuSign Demo system: https://demo.docusign.net/restapi/service_information You do not need an integrator key to view the REST API versions and resources.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Returns: ServiceInformation

Implements DocuSign.eSign.Api.IDiagnosticsApi.

◆ GetServiceAsync()

async System.Threading.Tasks.Task<ServiceInformation> DocuSign.eSign.Api.DiagnosticsApi.GetServiceAsync ( )

inline

Retrieves the available REST API versions. Retrieves the available REST API versions. DocuSign Production system: https://www.docusign.net/restapi/service_information DocuSign Demo system: https://demo.docusign.net/restapi/service_information You do not need an integrator key to view the REST API versions and resources.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Returns: Task of ServiceInformation

Implements DocuSign.eSign.Api.IDiagnosticsApi.

◆ GetServiceAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<ServiceInformation> > DocuSign.eSign.Api.DiagnosticsApi.GetServiceAsyncWithHttpInfo ( )

inline

Retrieves the available REST API versions. Retrieves the available REST API versions. DocuSign Production system: https://www.docusign.net/restapi/service_information DocuSign Demo system: https://demo.docusign.net/restapi/service_information You do not need an integrator key to view the REST API versions and resources.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Returns: Task of ApiResponse (ServiceInformation)

Implements DocuSign.eSign.Api.IDiagnosticsApi.

◆ GetServiceWithHttpInfo()

ApiResponse<ServiceInformation> DocuSign.eSign.Api.DiagnosticsApi.GetServiceWithHttpInfo ( )

inline

Retrieves the available REST API versions. Retrieves the available REST API versions. DocuSign Production system: https://www.docusign.net/restapi/service_information DocuSign Demo system: https://demo.docusign.net/restapi/service_information You do not need an integrator key to view the REST API versions and resources.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Returns: ApiResponse of ServiceInformation

Implements DocuSign.eSign.Api.IDiagnosticsApi.

◆ ListRequestLogs()

ApiRequestLogsResult DocuSign.eSign.Api.DiagnosticsApi.ListRequestLogs ( DiagnosticsApi.ListRequestLogsOptions options = null )

inline

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. If the Accept header is set to application/zip, the response is a zip file containing individual text files, each representing an API request. If 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.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

options Options for modifying the behavior of the function.

Returns: ApiRequestLogsResult

◆ ListRequestLogsAsync()

async System.Threading.Tasks.Task<ApiRequestLogsResult> DocuSign.eSign.Api.DiagnosticsApi.ListRequestLogsAsync ( DiagnosticsApi.ListRequestLogsOptions options = null )

inline

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. If the Accept header is set to application/zip, the response is a zip file containing individual text files, each representing an API request. If 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.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

options Options for modifying the behavior of the function.

Returns: Task of ApiRequestLogsResult

◆ ListRequestLogsAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<ApiRequestLogsResult> > DocuSign.eSign.Api.DiagnosticsApi.ListRequestLogsAsyncWithHttpInfo ( DiagnosticsApi.ListRequestLogsOptions options = null )

inline

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. If the Accept header is set to application/zip, the response is a zip file containing individual text files, each representing an API request. If 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.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

options Options for modifying the behavior of the function.

Returns: Task of ApiResponse (ApiRequestLogsResult)

◆ ListRequestLogsWithHttpInfo()

ApiResponse<ApiRequestLogsResult> DocuSign.eSign.Api.DiagnosticsApi.ListRequestLogsWithHttpInfo ( DiagnosticsApi.ListRequestLogsOptions options = null )

inline

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. If the Accept header is set to application/zip, the response is a zip file containing individual text files, each representing an API request. If 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.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

options Options for modifying the behavior of the function.

Returns: ApiResponse of ApiRequestLogsResult

◆ UpdateRequestLogSettings()

DiagnosticsSettingsInformation DocuSign.eSign.Api.DiagnosticsApi.UpdateRequestLogSettings ( DiagnosticsSettingsInformation diagnosticsSettingsInformation = null )

inline

Enables or disables API request logging for troubleshooting. Enables or disables API request logging for troubleshooting. When 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. You 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. Private information, such as passwords and integrator key information, which is normally located in the call header is omitted from the request/response log. ###### 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.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

diagnosticsSettingsInformation (optional)

Returns: DiagnosticsSettingsInformation

Implements DocuSign.eSign.Api.IDiagnosticsApi.

◆ UpdateRequestLogSettingsAsync()

async System.Threading.Tasks.Task<DiagnosticsSettingsInformation> DocuSign.eSign.Api.DiagnosticsApi.UpdateRequestLogSettingsAsync ( DiagnosticsSettingsInformation diagnosticsSettingsInformation = null )

inline

Enables or disables API request logging for troubleshooting. Enables or disables API request logging for troubleshooting. When 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. You 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. Private information, such as passwords and integrator key information, which is normally located in the call header is omitted from the request/response log. ###### 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.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

diagnosticsSettingsInformation (optional)

Returns: Task of DiagnosticsSettingsInformation

Implements DocuSign.eSign.Api.IDiagnosticsApi.

◆ UpdateRequestLogSettingsAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<DiagnosticsSettingsInformation> > DocuSign.eSign.Api.DiagnosticsApi.UpdateRequestLogSettingsAsyncWithHttpInfo ( DiagnosticsSettingsInformation diagnosticsSettingsInformation = null )

inline

Enables or disables API request logging for troubleshooting. Enables or disables API request logging for troubleshooting. When 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. You 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. Private information, such as passwords and integrator key information, which is normally located in the call header is omitted from the request/response log. ###### 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.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

diagnosticsSettingsInformation (optional)

Returns: Task of ApiResponse (DiagnosticsSettingsInformation)

Implements DocuSign.eSign.Api.IDiagnosticsApi.

◆ UpdateRequestLogSettingsWithHttpInfo()

ApiResponse<DiagnosticsSettingsInformation> DocuSign.eSign.Api.DiagnosticsApi.UpdateRequestLogSettingsWithHttpInfo ( DiagnosticsSettingsInformation diagnosticsSettingsInformation = null )

inline

Enables or disables API request logging for troubleshooting. Enables or disables API request logging for troubleshooting. When 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. You 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. Private information, such as passwords and integrator key information, which is normally located in the call header is omitted from the request/response log. ###### 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.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

diagnosticsSettingsInformation (optional)

Returns: ApiResponse of DiagnosticsSettingsInformation

Implements DocuSign.eSign.Api.IDiagnosticsApi.

Property Documentation

◆ ApiClient

DocuSignClient DocuSign.eSign.Api.DiagnosticsApi.ApiClient

getset

Gets or sets the ApiClient object

An instance of the ApiClient

◆ ExceptionFactory

DocuSign.eSign.Client.ExceptionFactory DocuSign.eSign.Api.DiagnosticsApi.ExceptionFactory

getset

Provides a factory method hook for the creation of exceptions.

The documentation for this class was generated from the following file:

sdk/src/DocuSign.eSign/Api/DiagnosticsApi.cs

Classes

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ DiagnosticsApi()

Member Function Documentation

◆ DeleteRequestLogs()

◆ DeleteRequestLogsAsync()

◆ DeleteRequestLogsAsyncWithHttpInfo()

◆ DeleteRequestLogsWithHttpInfo()

◆ GetBasePath()

◆ GetRequestLog()

◆ GetRequestLogAsync()

◆ GetRequestLogAsyncWithHttpInfo()

◆ GetRequestLogSettings()

◆ GetRequestLogSettingsAsync()

◆ GetRequestLogSettingsAsyncWithHttpInfo()

◆ GetRequestLogSettingsWithHttpInfo()

◆ GetRequestLogWithHttpInfo()

◆ GetResources()

◆ GetResourcesAsync()

◆ GetResourcesAsyncWithHttpInfo()

◆ GetResourcesWithHttpInfo()

◆ GetService()

◆ GetServiceAsync()

◆ GetServiceAsyncWithHttpInfo()

◆ GetServiceWithHttpInfo()

◆ ListRequestLogs()

◆ ListRequestLogsAsync()

◆ ListRequestLogsAsyncWithHttpInfo()

◆ ListRequestLogsWithHttpInfo()

◆ UpdateRequestLogSettings()

◆ UpdateRequestLogSettingsAsync()

◆ UpdateRequestLogSettingsAsyncWithHttpInfo()

◆ UpdateRequestLogSettingsWithHttpInfo()

Property Documentation

◆ ApiClient

◆ ExceptionFactory