Chilkat Online Tools

Ruby / DocuSign eSignature REST API / Gets the API request logging log files.

Back to Collection Items

require 'chilkat'

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

http = Chilkat::CkHttp.new()

queryParams = Chilkat::CkJsonObject.new()
queryParams.UpdateString("encoding","{{encoding}}")

# Adds the "Authorization: Bearer {{accessToken}}" header.
http.put_AuthToken("{{accessToken}}")
http.SetRequestHeader("Accept","application/json")

# resp is a CkHttpResponse
resp = http.QuickRequestParams("GET","https://domain.com/v2.1/diagnostics/request_logs",queryParams)
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

print resp.get_StatusCode().to_s() + "\n";
print resp.bodyStr() + "\n";

Curl Command

curl -G -d "encoding=%7B%7Bencoding%7D%7D"
	-H "Accept: application/json"
	-H "Authorization: Bearer {{accessToken}}"
https://domain.com/v2.1/diagnostics/request_logs

Postman Collection Item JSON

{
  "name": "Gets the API request logging log files.",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      },
      {
        "key": "Authorization",
        "value": "Bearer {{accessToken}}"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/v2.1/diagnostics/request_logs?encoding={{encoding}}",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "v2.1",
        "diagnostics",
        "request_logs"
      ],
      "query": [
        {
          "key": "encoding",
          "value": "{{encoding}}"
        }
      ]
    },
    "description": "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. "
  },
  "response": [
  ]
}