TCL / DocuSign REST API / Enables or disables API request logging for troubleshooting.
Back to Collection Items
load ./chilkat.dll
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
set http [new_CkHttp]
# Use this online tool to generate code from sample JSON: Generate Code to Create JSON
# The following JSON is sent in the request body.
# {
# "apiRequestLogging": "sample string 1",
# "apiRequestLogMaxEntries": "sample string 2",
# "apiRequestLogRemainingEntries": "sample string 3"
# }
set json [new_CkJsonObject]
CkJsonObject_UpdateString $json "apiRequestLogging" "sample string 1"
CkJsonObject_UpdateString $json "apiRequestLogMaxEntries" "sample string 2"
CkJsonObject_UpdateString $json "apiRequestLogRemainingEntries" "sample string 3"
# Adds the "Authorization: Bearer {{accessToken}}" header.
CkHttp_put_AuthToken $http "{{accessToken}}"
CkHttp_SetRequestHeader $http "Accept" "application/json"
set sbRequestBody [new_CkStringBuilder]
CkJsonObject_EmitSb $json $sbRequestBody
# resp is a CkHttpResponse
set resp [CkHttp_PTextSb $http "PUT" "https://domain.com/v2.1/diagnostics/settings" $sbRequestBody "utf-8" "application/json" 0 0]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbRequestBody
exit
}
puts [CkHttpResponse_get_StatusCode $resp]
puts [CkHttpResponse_bodyStr $resp]
delete_CkHttpResponse $resp
delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbRequestBody
Curl Command
curl -X PUT
-H "Accept: application/json"
-H "Authorization: Bearer {{accessToken}}"
-d '{
"apiRequestLogging": "sample string 1",
"apiRequestLogMaxEntries": "sample string 2",
"apiRequestLogRemainingEntries": "sample string 3"
}'
https://domain.com/v2.1/diagnostics/settings
Postman Collection Item JSON
{
"name": "Enables or disables API request logging for troubleshooting.",
"request": {
"method": "PUT",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{accessToken}}"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"apiRequestLogging\": \"sample string 1\",\n \"apiRequestLogMaxEntries\": \"sample string 2\",\n \"apiRequestLogRemainingEntries\": \"sample string 3\"\n}"
},
"url": {
"raw": "{{baseUrl}}/v2.1/diagnostics/settings",
"host": [
"{{baseUrl}}"
],
"path": [
"v2.1",
"diagnostics",
"settings"
]
},
"description": "Enables or disables API request logging for troubleshooting.\n\nWhen 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.\n\nYou 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.\n\nPrivate information, such as passwords and integrator key information, which is normally located in the call header is omitted from the request/response log.\n\n###### 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.\n"
},
"response": [
]
}