Method: DocuSign_eSign::DiagnosticsApi#update_request_log_settings_with_http_info

Defined in:
lib/docusign_esign/api/diagnostics_api.rb

#update_request_log_settings_with_http_info(diagnostics_settings_information) ⇒ Array<(DiagnosticsSettingsInformation, Fixnum, Hash)>

Enables or disables API request logging for troubleshooting. Enables or disables API request logging for troubleshooting. When enabled (&#x60;apiRequestLogging&#x60; 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&#39;t logged. Meaning that login_information, NewAccounts, or other distributor-credential calls are not logged.

Parameters:

  • diagnostics_settings_information (optional parameter)

Returns:



322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
 
# File 'lib/docusign_esign/api/diagnostics_api.rb', line 322

def update_request_log_settings_with_http_info(diagnostics_settings_information)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: DiagnosticsApi.update_request_log_settings ..."
  end
  # resource path
  local_var_path = "/v2.1/diagnostics/settings".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(diagnostics_settings_information)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'DiagnosticsSettingsInformation')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DiagnosticsApi#update_request_log_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end