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
queryParams.UpdateInt("start",0)
queryParams.UpdateInt("limit",200)
' Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = "<access_token>"
Dim resp As Chilkat.HttpResponse = http.QuickRequestParams("GET","https://your-domain.atlassian.net/wiki/rest/api/content/:id/notification/created",queryParams)
If (http.LastMethodSuccess = False) Then
Debug.WriteLine(http.LastErrorText)
Exit Sub
End If
Dim sbResponseBody As New Chilkat.StringBuilder
resp.GetBodySb(sbResponseBody)
Dim jResp As New Chilkat.JsonObject
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False
Debug.WriteLine("Response Body:")
Debug.WriteLine(jResp.Emit())
Dim respStatusCode As Integer = resp.StatusCode
Debug.WriteLine("Response Status Code = " & respStatusCode)
If (respStatusCode >= 400) Then
Debug.WriteLine("Response Header:")
Debug.WriteLine(resp.Header)
Debug.WriteLine("Failed.")
Exit Sub
End If
' Sample JSON response:
' (Sample code for parsing the JSON response is shown below)
' {
' "results": [
' {
' "type": "incididunt ea",
' "watcher": {
' "type": "elit in minim aliquip",
' "profilePicture": {
' "path": "tempor commodo amet voluptate",
' "width": -39236226,
' "height": 75695638,
' "isDefault": true
' },
' "displayName": "qui",
' "operations": [
' {
' "operation": "copy",
' "targetType": "space"
' },
' {
' "operation": "purge",
' "targetType": "space"
' }
' ],
' "accountId": "nulla dolor",
' "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": "veniam exercitation deserunt",
' "userKey": "adipisicing culpa eu"
' },
' "contentId": "do nostrud consectetur"
' },
' {
' "type": "qui in aliquip",
' "watcher": {
' "type": "culpa velit Excepteur in",
' "profilePicture": {
' "path": "est iru",
' "width": -23304200,
' "height": -94415594,
' "isDefault": false
' },
' "displayName": "eiusmod Ut",
' "operations": [
' {
' "operation": "purge",
' "targetType": "page"
' },
' {
' "operation": "move",
' "targetType": "space"
' }
' ],
' "accountId": "laborum",
' "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": "conse",
' "userKey": "id ad velit incididunt Ut"
' },
' "contentId": "Duis labore voluptate consectetur"
' }
' ],
' "start": 86483335,
' "limit": 45770246,
' "size": 20684808,
' "_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 Integer
Dim Height As Integer
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 Integer
Dim count_j As Integer
Dim operation As String
Dim targetType As String
Dim start As Integer = jResp.IntOf("start")
Dim limit As Integer = jResp.IntOf("limit")
Dim size As Integer = jResp.IntOf("size")
Dim i As Integer = 0
Dim count_i As Integer = 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
End While
i = i + 1
End While
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/created
Postman Collection Item JSON
{
"name": "Get watches for space",
"request": {
"auth": {
"type": "oauth2"
},
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/api/content/:id/notification/created?start=0&limit=200",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"content",
":id",
"notification",
"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 all space watches for the space that the content is in. A user that\nwatches a space will receive receive notifications when any content in the\nspace is updated.\n\nIf you want to manage watches for a space, use the following `user` methods:\n\n- [Get space watch status for user](#api-user-watch-space-spaceKey-get)\n- [Add space watch](#api-user-watch-space-spaceKey-post)\n- [Remove space watch](#api-user-watch-space-spaceKey-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/created?start=0&limit=200",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"content",
":id",
"notification",
"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\": \"incididunt ea\",\n \"watcher\": {\n \"type\": \"elit in minim aliquip\",\n \"profilePicture\": {\n \"path\": \"tempor commodo amet voluptate\",\n \"width\": -39236226,\n \"height\": 75695638,\n \"isDefault\": true\n },\n \"displayName\": \"qui\",\n \"operations\": [\n {\n \"operation\": \"copy\",\n \"targetType\": \"space\"\n },\n {\n \"operation\": \"purge\",\n \"targetType\": \"space\"\n }\n ],\n \"accountId\": \"nulla dolor\",\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\": \"veniam exercitation deserunt\",\n \"userKey\": \"adipisicing culpa eu\"\n },\n \"contentId\": \"do nostrud consectetur\"\n },\n {\n \"type\": \"qui in aliquip\",\n \"watcher\": {\n \"type\": \"culpa velit Excepteur in\",\n \"profilePicture\": {\n \"path\": \"est iru\",\n \"width\": -23304200,\n \"height\": -94415594,\n \"isDefault\": false\n },\n \"displayName\": \"eiusmod Ut\",\n \"operations\": [\n {\n \"operation\": \"purge\",\n \"targetType\": \"page\"\n },\n {\n \"operation\": \"move\",\n \"targetType\": \"space\"\n }\n ],\n \"accountId\": \"laborum\",\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\": \"conse\",\n \"userKey\": \"id ad velit incididunt Ut\"\n },\n \"contentId\": \"Duis labore voluptate consectetur\"\n }\n ],\n \"start\": 86483335,\n \"limit\": 45770246,\n \"size\": 20684808,\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/created?start=0&limit=200",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"content",
":id",
"notification",
"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": ""
}
]
}
