Chilkat Online Tools

delphiAx / Atlassian Confluence Cloud / Create audit record

Back to Collection Items

var
http: TChilkatHttp;
success: Integer;
json: TChilkatJsonObject;
resp: IChilkatHttpResponse;
sbResponseBody: TChilkatStringBuilder;
jResp: TChilkatJsonObject;
respStatusCode: Integer;
name: WideString;
oldValue: WideString;
newValue: WideString;
objectType: WideString;
v_Type: WideString;
DisplayName: WideString;
Operations: WideString;
Username: WideString;
UserKey: WideString;
remoteAddress: WideString;
creationDate: Integer;
summary: WideString;
description: WideString;
category: WideString;
sysAdmin: Integer;
Name: WideString;
ObjectType: WideString;
i: Integer;
count_i: Integer;

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

http := TChilkatHttp.Create(Self);

// Use this online tool to generate code from sample JSON: Generate Code to Create JSON

// The following JSON is sent in the request body.

// {
//   "remoteAddress": "<string>",
//   "author": {
//     "type": "user",
//     "displayName": "<string>",
//     "operations": "<object>",
//     "username": "<string>",
//     "userKey": "<string>"
//   },
//   "creationDate": "<long>",
//   "summary": "<string>",
//   "description": "<string>",
//   "category": "<string>",
//   "sysAdmin": false,
//   "affectedObject": {
//     "name": "amet dolore",
//     "objectType": "labore tempor veniam officia"
//   },
//   "changedValues": [
//     {
//       "name": "voluptate sit sed sint ",
//       "oldValue": "proident nisi",
//       "newValue": "dolore aute cupidatat enim"
//     },
//     {
//       "name": "in eu",
//       "oldValue": "enim laborum tempor Lorem",
//       "newValue": "ipsum ex velit"
//     }
//   ],
//   "associatedObjects": [
//     {
//       "name": "qui",
//       "objectType": "ipsum"
//     },
//     {
//       "name": "nostrud consectetur",
//       "objectType": "sit dolore enim Ut"
//     }
//   ]
// }

json := TChilkatJsonObject.Create(Self);
json.UpdateString('remoteAddress','<string>');
json.UpdateString('author.type','user');
json.UpdateString('author.displayName','<string>');
json.UpdateString('author.operations','<object>');
json.UpdateString('author.username','<string>');
json.UpdateString('author.userKey','<string>');
json.UpdateString('creationDate','<long>');
json.UpdateString('summary','<string>');
json.UpdateString('description','<string>');
json.UpdateString('category','<string>');
json.UpdateBool('sysAdmin',0);
json.UpdateString('affectedObject.name','amet dolore');
json.UpdateString('affectedObject.objectType','labore tempor veniam officia');
json.UpdateString('changedValues[0].name','voluptate sit sed sint ');
json.UpdateString('changedValues[0].oldValue','proident nisi');
json.UpdateString('changedValues[0].newValue','dolore aute cupidatat enim');
json.UpdateString('changedValues[1].name','in eu');
json.UpdateString('changedValues[1].oldValue','enim laborum tempor Lorem');
json.UpdateString('changedValues[1].newValue','ipsum ex velit');
json.UpdateString('associatedObjects[0].name','qui');
json.UpdateString('associatedObjects[0].objectType','ipsum');
json.UpdateString('associatedObjects[1].name','nostrud consectetur');
json.UpdateString('associatedObjects[1].objectType','sit dolore enim Ut');

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

resp := http.PostJson3('https://your-domain.atlassian.net/wiki/rest/api/audit','application/json',json.ControlInterface);
if (http.LastMethodSuccess = 0) then
  begin
    Memo1.Lines.Add(http.LastErrorText);
    Exit;
  end;

sbResponseBody := TChilkatStringBuilder.Create(Self);
resp.GetBodySb(sbResponseBody.ControlInterface);

jResp := TChilkatJsonObject.Create(Self);
jResp.LoadSb(sbResponseBody.ControlInterface);
jResp.EmitCompact := 0;

Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(jResp.Emit());

respStatusCode := resp.StatusCode;
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
  begin
    Memo1.Lines.Add('Response Header:');
    Memo1.Lines.Add(resp.Header);
    Memo1.Lines.Add('Failed.');

    Exit;
  end;

// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)

// {
//   "author": {
//     "type": "user",
//     "displayName": "dolore do consectetur veniam",
//     "operations": null,
//     "username": "adipisicing nostrud ullamco",
//     "userKey": "eu in"
//   },
//   "remoteAddress": "ea Duis minim p",
//   "creationDate": -62196571,
//   "summary": "laboris",
//   "description": "dolor est sed non officia",
//   "category": "eiusmod ut nulla",
//   "sysAdmin": false,
//   "affectedObject": {
//     "name": "sint eu labore magna fugiat",
//     "objectType": "ut exercitation"
//   },
//   "changedValues": [
//     {
//       "name": "ut ea occaecat ex cupidatat",
//       "oldValue": "ipsum minim Duis",
//       "newValue": "esse cupidatat ad"
//     },
//     {
//       "name": "fugiat est enim deserunt commodo",
//       "oldValue": "quis ipsum",
//       "newValue": "occaecat Lorem"
//     }
//   ],
//   "associatedObjects": [
//     {
//       "name": "in es",
//       "objectType": "ut reprehenderit mollit exercitation"
//     },
//     {
//       "name": "velit culpa eiusmod",
//       "objectType": "tempor"
//     }
//   ]
// }

// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

v_Type := jResp.StringOf('author.type');
DisplayName := jResp.StringOf('author.displayName');
Operations := jResp.StringOf('author.operations');
Username := jResp.StringOf('author.username');
UserKey := jResp.StringOf('author.userKey');
remoteAddress := jResp.StringOf('remoteAddress');
creationDate := jResp.IntOf('creationDate');
summary := jResp.StringOf('summary');
description := jResp.StringOf('description');
category := jResp.StringOf('category');
sysAdmin := jResp.BoolOf('sysAdmin');
Name := jResp.StringOf('affectedObject.name');
ObjectType := jResp.StringOf('affectedObject.objectType');
i := 0;
count_i := jResp.SizeOfArray('changedValues');
while i < count_i do
  begin
    jResp.I := i;
    name := jResp.StringOf('changedValues[i].name');
    oldValue := jResp.StringOf('changedValues[i].oldValue');
    newValue := jResp.StringOf('changedValues[i].newValue');
    i := i + 1;
  end;

i := 0;
count_i := jResp.SizeOfArray('associatedObjects');
while i < count_i do
  begin
    jResp.I := i;
    name := jResp.StringOf('associatedObjects[i].name');
    objectType := jResp.StringOf('associatedObjects[i].objectType');
    i := i + 1;
  end;

Curl Command

curl -X POST
	-H "Content-Type: application/json"
	-d '{
    "remoteAddress": "<string>",
    "author": {
        "type": "user",
        "displayName": "<string>",
        "operations": "<object>",
        "username": "<string>",
        "userKey": "<string>"
    },
    "creationDate": "<long>",
    "summary": "<string>",
    "description": "<string>",
    "category": "<string>",
    "sysAdmin": false,
    "affectedObject": {
        "name": "amet dolore",
        "objectType": "labore tempor veniam officia"
    },
    "changedValues": [
        {
            "name": "voluptate sit sed sint ",
            "oldValue": "proident nisi",
            "newValue": "dolore aute cupidatat enim"
        },
        {
            "name": "in eu",
            "oldValue": "enim laborum tempor Lorem",
            "newValue": "ipsum ex velit"
        }
    ],
    "associatedObjects": [
        {
            "name": "qui",
            "objectType": "ipsum"
        },
        {
            "name": "nostrud consectetur",
            "objectType": "sit dolore enim Ut"
        }
    ]
}'
https://your-domain.atlassian.net/wiki/rest/api/audit

Postman Collection Item JSON

{
  "name": "Create audit record",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"remoteAddress\": \"<string>\",\n    \"author\": {\n        \"type\": \"user\",\n        \"displayName\": \"<string>\",\n        \"operations\": \"<object>\",\n        \"username\": \"<string>\",\n        \"userKey\": \"<string>\"\n    },\n    \"creationDate\": \"<long>\",\n    \"summary\": \"<string>\",\n    \"description\": \"<string>\",\n    \"category\": \"<string>\",\n    \"sysAdmin\": false,\n    \"affectedObject\": {\n        \"name\": \"amet dolore\",\n        \"objectType\": \"labore tempor veniam officia\"\n    },\n    \"changedValues\": [\n        {\n            \"name\": \"voluptate sit sed sint \",\n            \"oldValue\": \"proident nisi\",\n            \"newValue\": \"dolore aute cupidatat enim\"\n        },\n        {\n            \"name\": \"in eu\",\n            \"oldValue\": \"enim laborum tempor Lorem\",\n            \"newValue\": \"ipsum ex velit\"\n        }\n    ],\n    \"associatedObjects\": [\n        {\n            \"name\": \"qui\",\n            \"objectType\": \"ipsum\"\n        },\n        {\n            \"name\": \"nostrud consectetur\",\n            \"objectType\": \"sit dolore enim Ut\"\n        }\n    ]\n}"
    },
    "url": {
      "raw": "{{baseUrl}}/api/audit",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "audit"
      ]
    },
    "description": "Creates a record in the audit log.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\n'Confluence Administrator' global permission."
  },
  "response": [
    {
      "name": "Returned if the record is created in the audit log.",
      "originalRequest": {
        "method": "POST",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"remoteAddress\": \"<string>\",\n    \"author\": {\n        \"type\": \"user\",\n        \"displayName\": \"<string>\",\n        \"operations\": \"<object>\",\n        \"username\": \"<string>\",\n        \"userKey\": \"<string>\"\n    },\n    \"creationDate\": \"<long>\",\n    \"summary\": \"<string>\",\n    \"description\": \"<string>\",\n    \"category\": \"<string>\",\n    \"sysAdmin\": false,\n    \"affectedObject\": {\n        \"name\": \"ut Lorem reprehenderit dolore tempor\",\n        \"objectType\": \"magna consectetur\"\n    },\n    \"changedValues\": [\n        {\n            \"name\": \"in\",\n            \"oldValue\": \"nisi cillum eiusmod exercitation\",\n            \"newValue\": \"in nulla adipisicing ni\"\n        },\n        {\n            \"name\": \"esse ea\",\n            \"oldValue\": \"mollit elit laborum\",\n            \"newValue\": \"sint ut nisi elit\"\n        }\n    ],\n    \"associatedObjects\": [\n        {\n            \"name\": \"veniam qui\",\n            \"objectType\": \"magna laborum mollit\"\n        },\n        {\n            \"name\": \"sit tempor ad id adipisicing\",\n            \"objectType\": \"reprehenderit Duis est ex commodo\"\n        }\n    ]\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/api/audit",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "audit"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"author\": {\n  \"type\": \"user\",\n  \"displayName\": \"dolore do consectetur veniam\",\n  \"operations\": null,\n  \"username\": \"adipisicing nostrud ullamco\",\n  \"userKey\": \"eu in\"\n },\n \"remoteAddress\": \"ea Duis minim p\",\n \"creationDate\": -62196571,\n \"summary\": \"laboris\",\n \"description\": \"dolor est sed non officia\",\n \"category\": \"eiusmod ut nulla\",\n \"sysAdmin\": false,\n \"affectedObject\": {\n  \"name\": \"sint eu labore magna fugiat\",\n  \"objectType\": \"ut exercitation\"\n },\n \"changedValues\": [\n  {\n   \"name\": \"ut ea occaecat ex cupidatat\",\n   \"oldValue\": \"ipsum minim Duis\",\n   \"newValue\": \"esse cupidatat ad\"\n  },\n  {\n   \"name\": \"fugiat est enim deserunt commodo\",\n   \"oldValue\": \"quis ipsum\",\n   \"newValue\": \"occaecat Lorem\"\n  }\n ],\n \"associatedObjects\": [\n  {\n   \"name\": \"in es\",\n   \"objectType\": \"ut reprehenderit mollit exercitation\"\n  },\n  {\n   \"name\": \"velit culpa eiusmod\",\n   \"objectType\": \"tempor\"\n  }\n ]\n}"
    },
    {
      "name": "Returned if the `remoteAddress` property is not specified.",
      "originalRequest": {
        "method": "POST",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"remoteAddress\": \"<string>\",\n    \"author\": {\n        \"type\": \"user\",\n        \"displayName\": \"<string>\",\n        \"operations\": \"<object>\",\n        \"username\": \"<string>\",\n        \"userKey\": \"<string>\"\n    },\n    \"creationDate\": \"<long>\",\n    \"summary\": \"<string>\",\n    \"description\": \"<string>\",\n    \"category\": \"<string>\",\n    \"sysAdmin\": false,\n    \"affectedObject\": {\n        \"name\": \"ut Lorem reprehenderit dolore tempor\",\n        \"objectType\": \"magna consectetur\"\n    },\n    \"changedValues\": [\n        {\n            \"name\": \"in\",\n            \"oldValue\": \"nisi cillum eiusmod exercitation\",\n            \"newValue\": \"in nulla adipisicing ni\"\n        },\n        {\n            \"name\": \"esse ea\",\n            \"oldValue\": \"mollit elit laborum\",\n            \"newValue\": \"sint ut nisi elit\"\n        }\n    ],\n    \"associatedObjects\": [\n        {\n            \"name\": \"veniam qui\",\n            \"objectType\": \"magna laborum mollit\"\n        },\n        {\n            \"name\": \"sit tempor ad id adipisicing\",\n            \"objectType\": \"reprehenderit Duis est ex commodo\"\n        }\n    ]\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/api/audit",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "audit"
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}