Back to Collection Items
var
http: HCkHttp;
success: Boolean;
queryParams: HCkJsonObject;
resp: HCkHttpResponse;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
v_type: PWideChar;
v_Type: PWideChar;
Path: PWideChar;
Width: Integer;
Height: Integer;
IsDefault: Boolean;
DisplayName: PWideChar;
AccountId: PWideChar;
Value: PWideChar;
PersonalValue: PWideChar;
Username: PWideChar;
UserKey: PWideChar;
contentId: PWideChar;
j: Integer;
count_j: Integer;
operation: PWideChar;
targetType: PWideChar;
start: Integer;
limit: Integer;
size: Integer;
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 := CkHttp_Create();
queryParams := CkJsonObject_Create();
CkJsonObject_UpdateInt(queryParams,'start',0);
CkJsonObject_UpdateInt(queryParams,'limit',200);
// Adds the "Authorization: Bearer <access_token>" header.
CkHttp_putAuthToken(http,'<access_token>');
resp := CkHttp_QuickRequestParams(http,'GET','https://your-domain.atlassian.net/wiki/rest/api/content/:id/notification/child-created',queryParams);
if (CkHttp_getLastMethodSuccess(http) = False) then
begin
Memo1.Lines.Add(CkHttp__lastErrorText(http));
Exit;
end;
sbResponseBody := CkStringBuilder_Create();
CkHttpResponse_GetBodySb(resp,sbResponseBody);
jResp := CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,False);
Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(CkJsonObject__emit(jResp));
respStatusCode := CkHttpResponse_getStatusCode(resp);
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
begin
Memo1.Lines.Add('Response Header:');
Memo1.Lines.Add(CkHttpResponse__header(resp));
Memo1.Lines.Add('Failed.');
CkHttpResponse_Dispose(resp);
Exit;
end;
CkHttpResponse_Dispose(resp);
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "results": [
// {
// "type": "Dui",
// "watcher": {
// "type": "voluptate",
// "profilePicture": {
// "path": "cillum",
// "width": 28975792,
// "height": -2569548,
// "isDefault": true
// },
// "displayName": "aliqua",
// "operations": [
// {
// "operation": "export",
// "targetType": "space"
// },
// {
// "operation": "administer",
// "targetType": "blogpost"
// }
// ],
// "accountId": "ex reprehenderit in",
// "details": {
// "business": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "personal": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// }
// },
// "username": "ex nisi nulla nostrud adipisicing",
// "userKey": "esse sunt dolore"
// },
// "contentId": "ut aute voluptate"
// },
// {
// "type": "dolore dolor",
// "watcher": {
// "type": "qui ea cillum mollit",
// "profilePicture": {
// "path": "esse dolor veniam",
// "width": 73225956,
// "height": 11139116,
// "isDefault": false
// },
// "displayName": "aliquip ex",
// "operations": [
// {
// "operation": "read",
// "targetType": "attachment"
// },
// {
// "operation": "delete",
// "targetType": "attachment"
// }
// ],
// "accountId": "sed nu",
// "details": {
// "business": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "personal": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// }
// },
// "username": "cupidatat amet adipisicing Excepteur",
// "userKey": "dolore eiusmod id adipisicing"
// },
// "contentId": "incididunt non in irure proident"
// }
// ],
// "start": 28460425,
// "limit": -13406271,
// "size": 94884215,
// "_links": {}
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
start := CkJsonObject_IntOf(jResp,'start');
limit := CkJsonObject_IntOf(jResp,'limit');
size := CkJsonObject_IntOf(jResp,'size');
i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'results');
while i < count_i do
begin
CkJsonObject_putI(jResp,i);
v_type := CkJsonObject__stringOf(jResp,'results[i].type');
v_Type := CkJsonObject__stringOf(jResp,'results[i].watcher.type');
Path := CkJsonObject__stringOf(jResp,'results[i].watcher.profilePicture.path');
Width := CkJsonObject_IntOf(jResp,'results[i].watcher.profilePicture.width');
Height := CkJsonObject_IntOf(jResp,'results[i].watcher.profilePicture.height');
IsDefault := CkJsonObject_BoolOf(jResp,'results[i].watcher.profilePicture.isDefault');
DisplayName := CkJsonObject__stringOf(jResp,'results[i].watcher.displayName');
AccountId := CkJsonObject__stringOf(jResp,'results[i].watcher.accountId');
Value := CkJsonObject__stringOf(jResp,'results[i].watcher.details.business.value');
PersonalValue := CkJsonObject__stringOf(jResp,'results[i].watcher.details.personal.value');
Username := CkJsonObject__stringOf(jResp,'results[i].watcher.username');
UserKey := CkJsonObject__stringOf(jResp,'results[i].watcher.userKey');
contentId := CkJsonObject__stringOf(jResp,'results[i].contentId');
j := 0;
count_j := CkJsonObject_SizeOfArray(jResp,'results[i].watcher.operations');
while j < count_j do
begin
CkJsonObject_putJ(jResp,j);
operation := CkJsonObject__stringOf(jResp,'results[i].watcher.operations[j].operation');
targetType := CkJsonObject__stringOf(jResp,'results[i].watcher.operations[j].targetType');
j := j + 1;
end;
i := i + 1;
end;
CkHttp_Dispose(http);
CkJsonObject_Dispose(queryParams);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
Curl Command
curl -G -d "start=0"
-d "limit=200"
-H "Authorization: Bearer <access_token>"
https://your-domain.atlassian.net/wiki/rest/api/content/:id/notification/child-created
Postman Collection Item JSON
{
"name": "Get watches for page",
"request": {
"auth": {
"type": "oauth2"
},
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/api/content/:id/notification/child-created?start=0&limit=200",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"content",
":id",
"notification",
"child-created"
],
"query": [
{
"key": "start",
"value": "0",
"description": "The starting index of the returned watches."
},
{
"key": "limit",
"value": "200",
"description": "The maximum number of watches to return per page.\nNote, this may be restricted by fixed system limits."
}
],
"variable": [
{
"key": "id",
"value": "<string>",
"type": "string",
"description": "(Required) The ID of the content to be queried for its watches."
}
]
},
"description": "Returns the watches for a page. A user that watches a page will receive\nreceive notifications when the page is updated.\n\nIf you want to manage watches for a page, use the following `user` methods:\n\n- [Get content watch status for user](#api-user-watch-content-contentId-get)\n- [Add content watch](#api-user-watch-content-contentId-post)\n- [Remove content watch](#api-user-watch-content-contentId-delete)\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to access the Confluence site ('Can use' global permission)."
},
"response": [
{
"name": "Returned if the requested watches are returned.",
"originalRequest": {
"method": "GET",
"header": [
{
"description": {
"content": "Added as a part of security scheme: oauth2",
"type": "text/plain"
},
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/api/content/:id/notification/child-created?start=0&limit=200",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"content",
":id",
"notification",
"child-created"
],
"query": [
{
"key": "start",
"value": "0"
},
{
"key": "limit",
"value": "200"
}
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"results\": [\n {\n \"type\": \"Dui\",\n \"watcher\": {\n \"type\": \"voluptate\",\n \"profilePicture\": {\n \"path\": \"cillum\",\n \"width\": 28975792,\n \"height\": -2569548,\n \"isDefault\": true\n },\n \"displayName\": \"aliqua\",\n \"operations\": [\n {\n \"operation\": \"export\",\n \"targetType\": \"space\"\n },\n {\n \"operation\": \"administer\",\n \"targetType\": \"blogpost\"\n }\n ],\n \"accountId\": \"ex reprehenderit in\",\n \"details\": {\n \"business\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"personal\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n \"username\": \"ex nisi nulla nostrud adipisicing\",\n \"userKey\": \"esse sunt dolore\"\n },\n \"contentId\": \"ut aute voluptate\"\n },\n {\n \"type\": \"dolore dolor\",\n \"watcher\": {\n \"type\": \"qui ea cillum mollit\",\n \"profilePicture\": {\n \"path\": \"esse dolor veniam\",\n \"width\": 73225956,\n \"height\": 11139116,\n \"isDefault\": false\n },\n \"displayName\": \"aliquip ex\",\n \"operations\": [\n {\n \"operation\": \"read\",\n \"targetType\": \"attachment\"\n },\n {\n \"operation\": \"delete\",\n \"targetType\": \"attachment\"\n }\n ],\n \"accountId\": \"sed nu\",\n \"details\": {\n \"business\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"personal\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n \"username\": \"cupidatat amet adipisicing Excepteur\",\n \"userKey\": \"dolore eiusmod id adipisicing\"\n },\n \"contentId\": \"incididunt non in irure proident\"\n }\n ],\n \"start\": 28460425,\n \"limit\": -13406271,\n \"size\": 94884215,\n \"_links\": {}\n}"
},
{
"name": "Returned if the authentication credentials are incorrect or missing\nfrom the request.",
"originalRequest": {
"method": "GET",
"header": [
{
"description": {
"content": "Added as a part of security scheme: oauth2",
"type": "text/plain"
},
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/api/content/:id/notification/child-created?start=0&limit=200",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"content",
":id",
"notification",
"child-created"
],
"query": [
{
"key": "start",
"value": "0"
},
{
"key": "limit",
"value": "200"
}
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}
