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

Inheritance diagram for DocuSign.eSign.Api.IDiagnosticsApi:

Public Member Functions
void	DeleteRequestLogs ()
	Deletes the request log files. More...

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

System.IO.Stream	GetRequestLog (string requestLogId)
	Gets a request logging log file. More...

ApiResponse< System.IO.Stream >	GetRequestLogWithHttpInfo (string requestLogId)
	Gets a request logging log file. More...

DiagnosticsSettingsInformation	GetRequestLogSettings ()
	Gets the API request logging settings. More...

ApiResponse< DiagnosticsSettingsInformation >	GetRequestLogSettingsWithHttpInfo ()
	Gets the API request logging settings. More...

ResourceInformation	GetResources ()
	Lists resources for REST version specified More...

ApiResponse< ResourceInformation >	GetResourcesWithHttpInfo ()
	Lists resources for REST version specified More...

ServiceInformation	GetService ()
	Retrieves the available REST API versions. More...

ApiResponse< ServiceInformation >	GetServiceWithHttpInfo ()
	Retrieves the available REST API versions. More...

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...

DiagnosticsSettingsInformation	UpdateRequestLogSettings (DiagnosticsSettingsInformation diagnosticsSettingsInformation=null)
	Enables or disables API request logging for troubleshooting. More...

ApiResponse< DiagnosticsSettingsInformation >	UpdateRequestLogSettingsWithHttpInfo (DiagnosticsSettingsInformation diagnosticsSettingsInformation=null)
	Enables or disables API request logging for troubleshooting. More...

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

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

System.Threading.Tasks.Task< System.IO.Stream >	GetRequestLogAsync (string requestLogId)
	Gets a request logging log file. More...

System.Threading.Tasks.Task< ApiResponse< System.IO.Stream > >	GetRequestLogAsyncWithHttpInfo (string requestLogId)
	Gets a request logging log file. More...

System.Threading.Tasks.Task< DiagnosticsSettingsInformation >	GetRequestLogSettingsAsync ()
	Gets the API request logging settings. More...

System.Threading.Tasks.Task< ApiResponse< DiagnosticsSettingsInformation > >	GetRequestLogSettingsAsyncWithHttpInfo ()
	Gets the API request logging settings. More...

System.Threading.Tasks.Task< ResourceInformation >	GetResourcesAsync ()
	Lists resources for REST version specified More...

System.Threading.Tasks.Task< ApiResponse< ResourceInformation > >	GetResourcesAsyncWithHttpInfo ()
	Lists resources for REST version specified More...

System.Threading.Tasks.Task< ServiceInformation >	GetServiceAsync ()
	Retrieves the available REST API versions. More...

System.Threading.Tasks.Task< ApiResponse< ServiceInformation > >	GetServiceAsyncWithHttpInfo ()
	Retrieves the available REST API versions. 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...

System.Threading.Tasks.Task< DiagnosticsSettingsInformation >	UpdateRequestLogSettingsAsync (DiagnosticsSettingsInformation diagnosticsSettingsInformation=null)
	Enables or disables API request logging for troubleshooting. More...

System.Threading.Tasks.Task< ApiResponse< DiagnosticsSettingsInformation > >	UpdateRequestLogSettingsAsyncWithHttpInfo (DiagnosticsSettingsInformation diagnosticsSettingsInformation=null)
	Enables or disables API request logging for troubleshooting. More...

Public Member Functions inherited from DocuSign.eSign.Client.IApiAccessor
String	GetBasePath ()
	Gets the base path of the API client. More...

Additional Inherited Members
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

Member Function Documentation

◆ DeleteRequestLogs()

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

Deletes the request log files.

Exceptions

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

Returns

Implemented in DocuSign.eSign.Api.DiagnosticsApi.

◆ DeleteRequestLogsAsync()

System.Threading.Tasks.Task DocuSign.eSign.Api.IDiagnosticsApi.DeleteRequestLogsAsync ( )

Deletes the request log files.

Exceptions

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

Returns: Task of void

Implemented in DocuSign.eSign.Api.DiagnosticsApi.

◆ DeleteRequestLogsAsyncWithHttpInfo()

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

Deletes the request log files.

Exceptions

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

Returns: Task of ApiResponse

Implemented in DocuSign.eSign.Api.DiagnosticsApi.

◆ DeleteRequestLogsWithHttpInfo()

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

Deletes the request log files.

Exceptions

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

Returns: ApiResponse of Object(void)

Implemented in DocuSign.eSign.Api.DiagnosticsApi.

◆ GetRequestLog()

System.IO.Stream DocuSign.eSign.Api.IDiagnosticsApi.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.

Exceptions

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

Parameters

requestLogId

Returns

Implemented in DocuSign.eSign.Api.DiagnosticsApi.

◆ GetRequestLogAsync()

System.Threading.Tasks.Task<System.IO.Stream> DocuSign.eSign.Api.IDiagnosticsApi.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.

Exceptions

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

Parameters

requestLogId

Returns: Task of System.IO.Stream

Implemented in DocuSign.eSign.Api.DiagnosticsApi.

◆ GetRequestLogAsyncWithHttpInfo()

System.Threading.Tasks.Task<ApiResponse<System.IO.Stream> > DocuSign.eSign.Api.IDiagnosticsApi.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.

Exceptions

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

Parameters

requestLogId

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

Implemented in DocuSign.eSign.Api.DiagnosticsApi.

◆ GetRequestLogSettings()

DiagnosticsSettingsInformation DocuSign.eSign.Api.IDiagnosticsApi.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.

Exceptions

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

Returns

Implemented in DocuSign.eSign.Api.DiagnosticsApi.

◆ GetRequestLogSettingsAsync()

System.Threading.Tasks.Task<DiagnosticsSettingsInformation> DocuSign.eSign.Api.IDiagnosticsApi.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.

Exceptions

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

Returns: Task of DiagnosticsSettingsInformation

Implemented in DocuSign.eSign.Api.DiagnosticsApi.

◆ GetRequestLogSettingsAsyncWithHttpInfo()

System.Threading.Tasks.Task<ApiResponse<DiagnosticsSettingsInformation> > DocuSign.eSign.Api.IDiagnosticsApi.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.

Exceptions

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

Returns: Task of ApiResponse (DiagnosticsSettingsInformation)

Implemented in DocuSign.eSign.Api.DiagnosticsApi.

◆ GetRequestLogSettingsWithHttpInfo()

ApiResponse<DiagnosticsSettingsInformation> DocuSign.eSign.Api.IDiagnosticsApi.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.

Exceptions

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

Returns: ApiResponse of

Implemented in DocuSign.eSign.Api.DiagnosticsApi.

◆ GetRequestLogWithHttpInfo()

ApiResponse<System.IO.Stream> DocuSign.eSign.Api.IDiagnosticsApi.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.

Exceptions

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

Parameters

requestLogId

Returns: ApiResponse of

Implemented in DocuSign.eSign.Api.DiagnosticsApi.

◆ GetResources()

ResourceInformation DocuSign.eSign.Api.IDiagnosticsApi.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.

Exceptions

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

Returns

Implemented in DocuSign.eSign.Api.DiagnosticsApi.

◆ GetResourcesAsync()

System.Threading.Tasks.Task<ResourceInformation> DocuSign.eSign.Api.IDiagnosticsApi.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.

Exceptions

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

Returns: Task of ResourceInformation

Implemented in DocuSign.eSign.Api.DiagnosticsApi.

◆ GetResourcesAsyncWithHttpInfo()

System.Threading.Tasks.Task<ApiResponse<ResourceInformation> > DocuSign.eSign.Api.IDiagnosticsApi.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.

Exceptions

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

Returns: Task of ApiResponse (ResourceInformation)

Implemented in DocuSign.eSign.Api.DiagnosticsApi.

◆ GetResourcesWithHttpInfo()

ApiResponse<ResourceInformation> DocuSign.eSign.Api.IDiagnosticsApi.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.

Exceptions

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

Returns: ApiResponse of

Implemented in DocuSign.eSign.Api.DiagnosticsApi.

◆ GetService()

ServiceInformation DocuSign.eSign.Api.IDiagnosticsApi.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.

Exceptions

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

Returns

Implemented in DocuSign.eSign.Api.DiagnosticsApi.

◆ GetServiceAsync()

System.Threading.Tasks.Task<ServiceInformation> DocuSign.eSign.Api.IDiagnosticsApi.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.

Exceptions

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

Returns: Task of ServiceInformation

Implemented in DocuSign.eSign.Api.DiagnosticsApi.

◆ GetServiceAsyncWithHttpInfo()

System.Threading.Tasks.Task<ApiResponse<ServiceInformation> > DocuSign.eSign.Api.IDiagnosticsApi.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.

Exceptions

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

Returns: Task of ApiResponse (ServiceInformation)

Implemented in DocuSign.eSign.Api.DiagnosticsApi.

◆ GetServiceWithHttpInfo()

ApiResponse<ServiceInformation> DocuSign.eSign.Api.IDiagnosticsApi.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.

Exceptions

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

Returns: ApiResponse of

Implemented in DocuSign.eSign.Api.DiagnosticsApi.

◆ ListRequestLogs()

ApiRequestLogsResult DocuSign.eSign.Api.IDiagnosticsApi.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.

Exceptions

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

Parameters

options Options for modifying the behavior of the function.

Returns

◆ ListRequestLogsAsync()

System.Threading.Tasks.Task<ApiRequestLogsResult> DocuSign.eSign.Api.IDiagnosticsApi.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.

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()

System.Threading.Tasks.Task<ApiResponse<ApiRequestLogsResult> > DocuSign.eSign.Api.IDiagnosticsApi.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.

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.IDiagnosticsApi.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.

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

◆ UpdateRequestLogSettings()

DiagnosticsSettingsInformation DocuSign.eSign.Api.IDiagnosticsApi.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.

Exceptions

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

Parameters

diagnosticsSettingsInformation (optional)

Returns

Implemented in DocuSign.eSign.Api.DiagnosticsApi.

◆ UpdateRequestLogSettingsAsync()

System.Threading.Tasks.Task<DiagnosticsSettingsInformation> DocuSign.eSign.Api.IDiagnosticsApi.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.

Exceptions

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

Parameters

diagnosticsSettingsInformation (optional)

Returns: Task of DiagnosticsSettingsInformation

Implemented in DocuSign.eSign.Api.DiagnosticsApi.

◆ UpdateRequestLogSettingsAsyncWithHttpInfo()

System.Threading.Tasks.Task<ApiResponse<DiagnosticsSettingsInformation> > DocuSign.eSign.Api.IDiagnosticsApi.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.

Exceptions

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

Parameters

diagnosticsSettingsInformation (optional)

Returns: Task of ApiResponse (DiagnosticsSettingsInformation)

Implemented in DocuSign.eSign.Api.DiagnosticsApi.

◆ UpdateRequestLogSettingsWithHttpInfo()

ApiResponse<DiagnosticsSettingsInformation> DocuSign.eSign.Api.IDiagnosticsApi.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.

Exceptions

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

Parameters

diagnosticsSettingsInformation (optional)

Returns: ApiResponse of

Implemented in DocuSign.eSign.Api.DiagnosticsApi.

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

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

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ DeleteRequestLogs()

◆ DeleteRequestLogsAsync()

◆ DeleteRequestLogsAsyncWithHttpInfo()

◆ DeleteRequestLogsWithHttpInfo()

◆ GetRequestLog()

◆ GetRequestLogAsync()

◆ GetRequestLogAsyncWithHttpInfo()

◆ GetRequestLogSettings()

◆ GetRequestLogSettingsAsync()

◆ GetRequestLogSettingsAsyncWithHttpInfo()

◆ GetRequestLogSettingsWithHttpInfo()

◆ GetRequestLogWithHttpInfo()

◆ GetResources()

◆ GetResourcesAsync()

◆ GetResourcesAsyncWithHttpInfo()

◆ GetResourcesWithHttpInfo()

◆ GetService()

◆ GetServiceAsync()

◆ GetServiceAsyncWithHttpInfo()

◆ GetServiceWithHttpInfo()

◆ ListRequestLogs()

◆ ListRequestLogsAsync()

◆ ListRequestLogsAsyncWithHttpInfo()

◆ ListRequestLogsWithHttpInfo()

◆ UpdateRequestLogSettings()

◆ UpdateRequestLogSettingsAsync()

◆ UpdateRequestLogSettingsAsyncWithHttpInfo()

◆ UpdateRequestLogSettingsWithHttpInfo()