Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
; 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.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(json,"remoteAddress","<string>")
CkJsonObject::ckUpdateString(json,"author.type","user")
CkJsonObject::ckUpdateString(json,"author.displayName","<string>")
CkJsonObject::ckUpdateString(json,"author.operations","<object>")
CkJsonObject::ckUpdateString(json,"author.username","<string>")
CkJsonObject::ckUpdateString(json,"author.userKey","<string>")
CkJsonObject::ckUpdateString(json,"creationDate","<long>")
CkJsonObject::ckUpdateString(json,"summary","<string>")
CkJsonObject::ckUpdateString(json,"description","<string>")
CkJsonObject::ckUpdateString(json,"category","<string>")
CkJsonObject::ckUpdateBool(json,"sysAdmin",0)
CkJsonObject::ckUpdateString(json,"affectedObject.name","amet dolore")
CkJsonObject::ckUpdateString(json,"affectedObject.objectType","labore tempor veniam officia")
CkJsonObject::ckUpdateString(json,"changedValues[0].name","voluptate sit sed sint ")
CkJsonObject::ckUpdateString(json,"changedValues[0].oldValue","proident nisi")
CkJsonObject::ckUpdateString(json,"changedValues[0].newValue","dolore aute cupidatat enim")
CkJsonObject::ckUpdateString(json,"changedValues[1].name","in eu")
CkJsonObject::ckUpdateString(json,"changedValues[1].oldValue","enim laborum tempor Lorem")
CkJsonObject::ckUpdateString(json,"changedValues[1].newValue","ipsum ex velit")
CkJsonObject::ckUpdateString(json,"associatedObjects[0].name","qui")
CkJsonObject::ckUpdateString(json,"associatedObjects[0].objectType","ipsum")
CkJsonObject::ckUpdateString(json,"associatedObjects[1].name","nostrud consectetur")
CkJsonObject::ckUpdateString(json,"associatedObjects[1].objectType","sit dolore enim Ut")
CkHttp::ckSetRequestHeader(http,"Content-Type","application/json")
resp.i = CkHttp::ckPostJson3(http,"https://your-domain.atlassian.net/wiki/rest/api/audit","application/json",json)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
ProcedureReturn
EndIf
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHttpResponse::ckGetBodySb(resp,sbResponseBody)
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttpResponse::ckHeader(resp)
Debug "Failed."
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
CkHttpResponse::ckDispose(resp)
; 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
name.s
oldValue.s
newValue.s
objectType.s
v_Type.s = CkJsonObject::ckStringOf(jResp,"author.type")
DisplayName.s = CkJsonObject::ckStringOf(jResp,"author.displayName")
Operations.s = CkJsonObject::ckStringOf(jResp,"author.operations")
Username.s = CkJsonObject::ckStringOf(jResp,"author.username")
UserKey.s = CkJsonObject::ckStringOf(jResp,"author.userKey")
remoteAddress.s = CkJsonObject::ckStringOf(jResp,"remoteAddress")
creationDate.i = CkJsonObject::ckIntOf(jResp,"creationDate")
summary.s = CkJsonObject::ckStringOf(jResp,"summary")
description.s = CkJsonObject::ckStringOf(jResp,"description")
category.s = CkJsonObject::ckStringOf(jResp,"category")
sysAdmin.i = CkJsonObject::ckBoolOf(jResp,"sysAdmin")
Name.s = CkJsonObject::ckStringOf(jResp,"affectedObject.name")
ObjectType.s = CkJsonObject::ckStringOf(jResp,"affectedObject.objectType")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"changedValues")
While i < count_i
CkJsonObject::setCkI(jResp, i)
name = CkJsonObject::ckStringOf(jResp,"changedValues[i].name")
oldValue = CkJsonObject::ckStringOf(jResp,"changedValues[i].oldValue")
newValue = CkJsonObject::ckStringOf(jResp,"changedValues[i].newValue")
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"associatedObjects")
While i < count_i
CkJsonObject::setCkI(jResp, i)
name = CkJsonObject::ckStringOf(jResp,"associatedObjects[i].name")
objectType = CkJsonObject::ckStringOf(jResp,"associatedObjects[i].objectType")
i = i + 1
Wend
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
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": ""
}
]
}
