Chilkat Online Tools

Go / Atlassian Confluence Cloud / Set retention period

Back to Collection Items

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

    http := chilkat.NewHttp()
    var success bool

    // 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>"
    // }

    json := chilkat.NewJsonObject()
    json.UpdateString("number","<integer>")
    json.UpdateString("units","<string>")

    http.SetRequestHeader("Content-Type","application/json")

    sbRequestBody := chilkat.NewStringBuilder()
    json.EmitSb(sbRequestBody)

    resp := http.PTextSb("PUT","https://your-domain.atlassian.net/wiki/rest/api/audit/retention",sbRequestBody,"utf-8","application/json",false,false)
    if http.LastMethodSuccess() == false {
        fmt.Println(http.LastErrorText())
        http.DisposeHttp()
        json.DisposeJsonObject()
        sbRequestBody.DisposeStringBuilder()
        return
    }

    sbResponseBody := chilkat.NewStringBuilder()
    resp.GetBodySb(sbResponseBody)

    jResp := chilkat.NewJsonObject()
    jResp.LoadSb(sbResponseBody)
    jResp.SetEmitCompact(false)

    fmt.Println("Response Body:")
    fmt.Println(*jResp.Emit())

    respStatusCode := resp.StatusCode()
    fmt.Println("Response Status Code = ", respStatusCode)
    if respStatusCode >= 400 {
        fmt.Println("Response Header:")
        fmt.Println(resp.Header())
        fmt.Println("Failed.")
        resp.DisposeHttpResponse()
        http.DisposeHttp()
        json.DisposeJsonObject()
        sbRequestBody.DisposeStringBuilder()
        sbResponseBody.DisposeStringBuilder()
        jResp.DisposeJsonObject()
        return
    }

    resp.DisposeHttpResponse()

    // 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

    v_number := jResp.StringOf("number")
    units := jResp.StringOf("units")

    http.DisposeHttp()
    json.DisposeJsonObject()
    sbRequestBody.DisposeStringBuilder()
    sbResponseBody.DisposeStringBuilder()
    jResp.DisposeJsonObject()

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": ""
    }
  ]
}