Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loQueryParams
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcV_type
LOCAL lcV_Type
LOCAL lcPath
LOCAL lnWidth
LOCAL lnHeight
LOCAL lnIsDefault
LOCAL lcDisplayName
LOCAL lcAccountId
LOCAL lcValue
LOCAL lcPersonalValue
LOCAL lcUsername
LOCAL lcUserKey
LOCAL lcContentId
LOCAL j
LOCAL lnCount_j
LOCAL lcOperation
LOCAL lcTargetType
LOCAL lnStart
LOCAL lnLimit
LOCAL lnSize
LOCAL i
LOCAL lnCount_i
* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loQueryParams = CreateObject('Chilkat.JsonObject')
loQueryParams.UpdateInt("start",0)
loQueryParams.UpdateInt("limit",200)
* Adds the "Authorization: Bearer <access_token>" header.
loHttp.AuthToken = "<access_token>"
loResp = loHttp.QuickRequestParams("GET","https://your-domain.atlassian.net/wiki/rest/api/content/:id/notification/child-created",loQueryParams)
IF (loHttp.LastMethodSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
RELEASE loQueryParams
CANCEL
ENDIF
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
loResp.GetBodySb(loSbResponseBody)
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
? "Response Header:"
? loResp.Header
? "Failed."
RELEASE loResp
RELEASE loHttp
RELEASE loQueryParams
RELEASE loSbResponseBody
RELEASE loJResp
CANCEL
ENDIF
RELEASE loResp
* 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
lnStart = loJResp.IntOf("start")
lnLimit = loJResp.IntOf("limit")
lnSize = loJResp.IntOf("size")
i = 0
lnCount_i = loJResp.SizeOfArray("results")
DO WHILE i < lnCount_i
loJResp.I = i
lcV_type = loJResp.StringOf("results[i].type")
lcV_Type = loJResp.StringOf("results[i].watcher.type")
lcPath = loJResp.StringOf("results[i].watcher.profilePicture.path")
lnWidth = loJResp.IntOf("results[i].watcher.profilePicture.width")
lnHeight = loJResp.IntOf("results[i].watcher.profilePicture.height")
lnIsDefault = loJResp.BoolOf("results[i].watcher.profilePicture.isDefault")
lcDisplayName = loJResp.StringOf("results[i].watcher.displayName")
lcAccountId = loJResp.StringOf("results[i].watcher.accountId")
lcValue = loJResp.StringOf("results[i].watcher.details.business.value")
lcPersonalValue = loJResp.StringOf("results[i].watcher.details.personal.value")
lcUsername = loJResp.StringOf("results[i].watcher.username")
lcUserKey = loJResp.StringOf("results[i].watcher.userKey")
lcContentId = loJResp.StringOf("results[i].contentId")
j = 0
lnCount_j = loJResp.SizeOfArray("results[i].watcher.operations")
DO WHILE j < lnCount_j
loJResp.J = j
lcOperation = loJResp.StringOf("results[i].watcher.operations[j].operation")
lcTargetType = loJResp.StringOf("results[i].watcher.operations[j].targetType")
j = j + 1
ENDDO
i = i + 1
ENDDO
RELEASE loHttp
RELEASE loQueryParams
RELEASE loSbResponseBody
RELEASE loJResp
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": ""
}
]
}
