module:api/DiagnosticsApi

new module:api/DiagnosticsApi(apiClient)

Source:

api/DiagnosticsApi.js, line 41

Constructs a new DiagnosticsApi.

Parameters:

Name	Type	Description
`apiClient`	module:ApiClient	Optional API client implementation to use, default to `module:ApiClient#instance` if unspecified.

Methods

deleteRequestLogs(callback)

Source:

api/DiagnosticsApi.js, line 67

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

Parameters:

Name	Type	Description
`callback`	module:api/DiagnosticsApi~deleteRequestLogsCallback	The callback function, accepting three arguments: error, data, response

getRequestLog(requestLogId, callback)

Source:

api/DiagnosticsApi.js, line 119

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.

Parameters:

Name	Type	Description
`requestLogId`	String
`callback`	module:api/DiagnosticsApi~getRequestLogCallback	The callback function, accepting three arguments: error, data, response data is of type: `Object`

getRequestLogSettings(callback)

Source:

api/DiagnosticsApi.js, line 173

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.

Parameters:

Name	Type	Description
`callback`	module:api/DiagnosticsApi~getRequestLogSettingsCallback	The callback function, accepting three arguments: error, data, response data is of type: `module:model/DiagnosticsSettingsInformation`

getResources(callback)

Source:

api/DiagnosticsApi.js, line 226

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.

Parameters:

Name	Type	Description
`callback`	module:api/DiagnosticsApi~getResourcesCallback	The callback function, accepting three arguments: error, data, response data is of type: `module:model/ResourceInformation`

getService(callback)

Source:

api/DiagnosticsApi.js, line 276

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.

Parameters:

Name	Type	Description
`callback`	module:api/DiagnosticsApi~getServiceCallback	The callback function, accepting three arguments: error, data, response data is of type: `module:model/ServiceInformation`

listRequestLogs(optsOrCallback, callback)

Source:

api/DiagnosticsApi.js, line 327

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.

Parameters:

Name Type Description

optsOrCallback

Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties

Name	Type	Description
`encoding`	String

callback

module:api/DiagnosticsApi~listRequestLogsCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/ApiRequestLogsResult

updateRequestLogSettings(optsOrCallback, callback)

Source:

api/DiagnosticsApi.js, line 391

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.

Parameters:

Name Type Description

optsOrCallback

Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties

Name	Type	Description
`diagnosticsSettingsInformation`	module:model/DiagnosticsSettingsInformation

callback

module:api/DiagnosticsApi~updateRequestLogSettingsCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/DiagnosticsSettingsInformation

Type Definitions

deleteRequestLogsCallback(error, data, If)

Source:

api/DiagnosticsApi.js, line 54

(Optional) Callback function to receive the result of the deleteRequestLogs operation. If none specified a Promise will be returned.

Parameters:

Name	Type	Description
`error`	String	Error message, if any.
`data`		This operation does not return a value.
`If`	String	a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

getRequestLogCallback(error, data, If)

Source:

api/DiagnosticsApi.js, line 98

(Optional) Callback function to receive the result of the getRequestLog operation. If none specified a Promise will be returned.

Parameters:

Name	Type	Description
`error`	String	Error message, if any.
`data`	Object	The data returned by the service call.
`If`	String	a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

getRequestLogSettingsCallback(error, data, If)

Source:

api/DiagnosticsApi.js, line 156

(Optional) Callback function to receive the result of the getRequestLogSettings operation. If none specified a Promise will be returned.

Parameters:

Name	Type	Description
`error`	String	Error message, if any.
`data`	module:model/DiagnosticsSettingsInformation	The data returned by the service call.
`If`	String	a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

getResourcesCallback(error, data, If)

Source:

api/DiagnosticsApi.js, line 204

(Optional) Callback function to receive the result of the getResources operation. If none specified a Promise will be returned.

Parameters:

Name	Type	Description
`error`	String	Error message, if any.
`data`	module:model/ResourceInformation	The data returned by the service call.
`If`	String	a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

getServiceCallback(error, data, If)

Source:

api/DiagnosticsApi.js, line 257

(Optional) Callback function to receive the result of the getService operation. If none specified a Promise will be returned.

Parameters:

Name	Type	Description
`error`	String	Error message, if any.
`data`	module:model/ServiceInformation	The data returned by the service call.
`If`	String	a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

listRequestLogsCallback(error, data, If)

Source:

api/DiagnosticsApi.js, line 307

(Optional) Callback function to receive the result of the listRequestLogs operation. If none specified a Promise will be returned.

Parameters:

Name	Type	Description
`error`	String	Error message, if any.
`data`	module:model/ApiRequestLogsResult	The data returned by the service call.
`If`	String	a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

updateRequestLogSettingsCallback(error, data, If)

Source:

api/DiagnosticsApi.js, line 366

(Optional) Callback function to receive the result of the updateRequestLogSettings operation. If none specified a Promise will be returned.

Parameters:

Name	Type	Description
`error`	String	Error message, if any.
`data`	module:model/DiagnosticsSettingsInformation	The data returned by the service call.
`If`	String	a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.