Back to Collection Items
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Dim http As New Chilkat.Http
Dim success As Boolean
Dim queryParams As New Chilkat.JsonObject
success = queryParams.UpdateInt("start",0)
success = queryParams.UpdateInt("limit",200)
// Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = "<access_token>"
Dim resp As Chilkat.HttpResponse
resp = http.QuickRequestParams("GET","https://your-domain.atlassian.net/wiki/rest/api/content/:id/notification/child-created",queryParams)
If (http.LastMethodSuccess = False) Then
System.DebugLog(http.LastErrorText)
Return
End If
Dim sbResponseBody As New Chilkat.StringBuilder
success = resp.GetBodySb(sbResponseBody)
Dim jResp As New Chilkat.JsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False
System.DebugLog("Response Body:")
System.DebugLog(jResp.Emit())
Dim respStatusCode As Int32
respStatusCode = resp.StatusCode
System.DebugLog("Response Status Code = " + Str(respStatusCode))
If (respStatusCode >= 400) Then
System.DebugLog("Response Header:")
System.DebugLog(resp.Header)
System.DebugLog("Failed.")
Return
End If
// 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
Dim v_type As String
Dim v_Type As String
Dim Path As String
Dim Width As Int32
Dim Height As Int32
Dim IsDefault As Boolean
Dim DisplayName As String
Dim AccountId As String
Dim Value As String
Dim PersonalValue As String
Dim Username As String
Dim UserKey As String
Dim contentId As String
Dim j As Int32
Dim count_j As Int32
Dim operation As String
Dim targetType As String
Dim start As Int32
start = jResp.IntOf("start")
Dim limit As Int32
limit = jResp.IntOf("limit")
Dim size As Int32
size = jResp.IntOf("size")
Dim i As Int32
i = 0
Dim count_i As Int32
count_i = jResp.SizeOfArray("results")
While i < count_i
jResp.I = i
v_type = jResp.StringOf("results[i].type")
v_Type = jResp.StringOf("results[i].watcher.type")
Path = jResp.StringOf("results[i].watcher.profilePicture.path")
Width = jResp.IntOf("results[i].watcher.profilePicture.width")
Height = jResp.IntOf("results[i].watcher.profilePicture.height")
IsDefault = jResp.BoolOf("results[i].watcher.profilePicture.isDefault")
DisplayName = jResp.StringOf("results[i].watcher.displayName")
AccountId = jResp.StringOf("results[i].watcher.accountId")
Value = jResp.StringOf("results[i].watcher.details.business.value")
PersonalValue = jResp.StringOf("results[i].watcher.details.personal.value")
Username = jResp.StringOf("results[i].watcher.username")
UserKey = jResp.StringOf("results[i].watcher.userKey")
contentId = jResp.StringOf("results[i].contentId")
j = 0
count_j = jResp.SizeOfArray("results[i].watcher.operations")
While j < count_j
jResp.J = j
operation = jResp.StringOf("results[i].watcher.operations[j].operation")
targetType = jResp.StringOf("results[i].watcher.operations[j].targetType")
j = j + 1
Wend
i = i + 1
Wend
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": ""
}
]
}
