Chilkat Online Tools

Objective-C / Atlassian Confluence Cloud / Create audit record

Back to Collection Items

#import <CkoHttp.h>
#import <CkoJsonObject.h>
#import <CkoHttpResponse.h>
#import <CkoStringBuilder.h>
#import <NSString.h>

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

CkoHttp *http = [[CkoHttp alloc] init];
BOOL success;

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

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

[http SetRequestHeader: @"Content-Type" value: @"application/json"];

CkoHttpResponse *resp = [http PostJson3: @"https://your-domain.atlassian.net/wiki/rest/api/audit" contentType: @"application/json" json: json];
if (http.LastMethodSuccess == NO) {
    NSLog(@"%@",http.LastErrorText);
    return;
}

CkoStringBuilder *sbResponseBody = [[CkoStringBuilder alloc] init];
[resp GetBodySb: sbResponseBody];

CkoJsonObject *jResp = [[CkoJsonObject alloc] init];
[jResp LoadSb: sbResponseBody];
jResp.EmitCompact = NO;

NSLog(@"%@",@"Response Body:");
NSLog(@"%@",[jResp Emit]);

int respStatusCode = [resp.StatusCode intValue];
NSLog(@"%@%d",@"Response Status Code = ",respStatusCode);
if (respStatusCode >= 400) {
    NSLog(@"%@",@"Response Header:");
    NSLog(@"%@",resp.Header);
    NSLog(@"%@",@"Failed.");

    return;
}

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

NSString *name = 0;
NSString *oldValue = 0;
NSString *newValue = 0;
NSString *objectType = 0;

NSString *v_Type = [jResp StringOf: @"author.type"];
NSString *DisplayName = [jResp StringOf: @"author.displayName"];
NSString *Operations = [jResp StringOf: @"author.operations"];
NSString *Username = [jResp StringOf: @"author.username"];
NSString *UserKey = [jResp StringOf: @"author.userKey"];
NSString *remoteAddress = [jResp StringOf: @"remoteAddress"];
int creationDate = [[jResp IntOf: @"creationDate"] intValue];
NSString *summary = [jResp StringOf: @"summary"];
NSString *description = [jResp StringOf: @"description"];
NSString *category = [jResp StringOf: @"category"];
BOOL sysAdmin = [jResp BoolOf: @"sysAdmin"];
NSString *Name = [jResp StringOf: @"affectedObject.name"];
NSString *ObjectType = [jResp StringOf: @"affectedObject.objectType"];
int i = 0;
int count_i = [[jResp SizeOfArray: @"changedValues"] intValue];
while (i < count_i) {
    jResp.I = [NSNumber numberWithInt: i];
    name = [jResp StringOf: @"changedValues[i].name"];
    oldValue = [jResp StringOf: @"changedValues[i].oldValue"];
    newValue = [jResp StringOf: @"changedValues[i].newValue"];
    i = i + 1;
}

i = 0;
count_i = [[jResp SizeOfArray: @"associatedObjects"] intValue];
while (i < count_i) {
    jResp.I = [NSNumber numberWithInt: i];
    name = [jResp StringOf: @"associatedObjects[i].name"];
    objectType = [jResp StringOf: @"associatedObjects[i].objectType"];
    i = i + 1;
}

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