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.
# {
# "number": "<integer>",
# "units": "<string>"
# }
set json [new_CkJsonObject]
CkJsonObject_UpdateString $json "number" "<integer>"
CkJsonObject_UpdateString $json "units" "<string>"
CkHttp_SetRequestHeader $http "Content-Type" "application/json"
set sbRequestBody [new_CkStringBuilder]
CkJsonObject_EmitSb $json $sbRequestBody
# resp is a CkHttpResponse
set resp [CkHttp_PTextSb $http "PUT" "https://your-domain.atlassian.net/wiki/rest/api/audit/retention" $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
}
set sbResponseBody [new_CkStringBuilder]
CkHttpResponse_GetBodySb $resp $sbResponseBody
set jResp [new_CkJsonObject]
CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0
puts "Response Body:"
puts [CkJsonObject_emit $jResp]
set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
puts "Response Header:"
puts [CkHttpResponse_header $resp]
puts "Failed."
delete_CkHttpResponse $resp
delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbRequestBody
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
exit
}
delete_CkHttpResponse $resp
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# {
# "number": "<integer>",
# "units": "<string>"
# }
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
set v_number [CkJsonObject_stringOf $jResp "number"]
set units [CkJsonObject_stringOf $jResp "units"]
delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbRequestBody
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
Curl Command
curl -X PUT
-H "Content-Type: application/json"
-d '{
"number": "<integer>",
"units": "<string>"
}'
https://your-domain.atlassian.net/wiki/rest/api/audit/retention
Postman Collection Item JSON
{
"name": "Set retention period",
"request": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"number\": \"<integer>\",\n \"units\": \"<string>\"\n}"
},
"url": {
"raw": "{{baseUrl}}/api/audit/retention",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"audit",
"retention"
]
},
"description": "Sets the retention period for records in the audit log. The retention period\ncan be set to a maximum of 20 years.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\n'Confluence Administrator' global permission."
},
"response": [
{
"name": "Returned if the retention period is updated.",
"originalRequest": {
"method": "PUT",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"number\": \"<integer>\",\n \"units\": \"<string>\"\n}"
},
"url": {
"raw": "{{baseUrl}}/api/audit/retention",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"audit",
"retention"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"number\": \"<integer>\",\n \"units\": \"<string>\"\n}"
},
{
"name": "Returned if the calling user does not have permission to view the audit\nlog.",
"originalRequest": {
"method": "PUT",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"number\": \"<integer>\",\n \"units\": \"<string>\"\n}"
},
"url": {
"raw": "{{baseUrl}}/api/audit/retention",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"audit",
"retention"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}