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 ChilkatHttp
Dim success As Long
Dim queryParams As New ChilkatJsonObject
success = queryParams.UpdateString("start","<string>")
success = queryParams.UpdateString("limit","<string>")
Dim resp As ChilkatHttpResponse
Set resp = http.QuickRequestParams("GET","https://your-domain.atlassian.net/wiki/rest/api/space/:spaceKey/watch",queryParams)
If (http.LastMethodSuccess = 0) Then
Debug.Print http.LastErrorText
Exit Sub
End If
Dim sbResponseBody As New ChilkatStringBuilder
success = resp.GetBodySb(sbResponseBody)
Dim jResp As New ChilkatJsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = 0
Debug.Print "Response Body:"
Debug.Print jResp.Emit()
Dim respStatusCode As Long
respStatusCode = resp.StatusCode
Debug.Print "Response Status Code = " & respStatusCode
If (respStatusCode >= 400) Then
Debug.Print "Response Header:"
Debug.Print resp.Header
Debug.Print "Failed."
Exit Sub
End If
' Sample JSON response:
' (Sample code for parsing the JSON response is shown below)
' {
' "results": [
' {
' "type": "proident nisi dolo",
' "watcher": {
' "type": "veniam enim exercitation ",
' "profilePicture": {
' "path": "Duis velit",
' "width": -59620755,
' "height": 31433400,
' "isDefault": true
' },
' "displayName": "reprehenderit dolor ea magna",
' "accountId": "sint enim volupta",
' "accountType": "do ea ipsum ullamco",
' "email": "dolor",
' "publicName": "do aliqua",
' "username": "nisi officia",
' "userKey": "sint a",
' "operations": [
' {
' "operation": "move",
' "targetType": "attachment"
' },
' {
' "operation": "move",
' "targetType": "attachment"
' }
' ],
' "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>"
' }
' }
' },
' "spaceKey": "minim ex",
' "contentId": "do"
' },
' {
' "type": "ut in Duis ad",
' "watcher": {
' "type": "dolor id",
' "profilePicture": {
' "path": "dolore Ut",
' "width": -91859267,
' "height": 76867520,
' "isDefault": false
' },
' "displayName": "magna in veniam aliqua dolor",
' "accountId": "ut incididunt",
' "accountType": "sint Lorem",
' "email": "voluptate id",
' "publicName": "Duis mi",
' "username": "dolor consectetur venia",
' "userKey": "reprehenderit eius",
' "operations": [
' {
' "operation": "administer",
' "targetType": "page"
' },
' {
' "operation": "purge_version",
' "targetType": "comment"
' }
' ],
' "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>"
' }
' }
' },
' "spaceKey": "Duis minim",
' "contentId": "est irure dolore"
' }
' ],
' "start": 36796637,
' "limit": -14900038,
' "size": -90406538,
' "_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 Long
Dim Height As Long
Dim IsDefault As Long
Dim DisplayName As String
Dim AccountId As String
Dim AccountType As String
Dim v_Email As String
Dim PublicName As String
Dim Username As String
Dim UserKey As String
Dim Value As String
Dim PersonalValue As String
Dim spaceKey As String
Dim contentId As String
Dim j As Long
Dim count_j As Long
Dim operation As String
Dim targetType As String
Dim start As Long
start = jResp.IntOf("start")
Dim limit As Long
limit = jResp.IntOf("limit")
Dim size As Long
size = jResp.IntOf("size")
Dim i As Long
i = 0
Dim count_i As Long
count_i = jResp.SizeOfArray("results")
Do 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")
AccountType = jResp.StringOf("results[i].watcher.accountType")
v_Email = jResp.StringOf("results[i].watcher.email")
PublicName = jResp.StringOf("results[i].watcher.publicName")
Username = jResp.StringOf("results[i].watcher.username")
UserKey = jResp.StringOf("results[i].watcher.userKey")
Value = jResp.StringOf("results[i].watcher.details.business.value")
PersonalValue = jResp.StringOf("results[i].watcher.details.personal.value")
spaceKey = jResp.StringOf("results[i].spaceKey")
contentId = jResp.StringOf("results[i].contentId")
j = 0
count_j = jResp.SizeOfArray("results[i].watcher.operations")
Do 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
Loop
i = i + 1
Loop
Curl Command
curl -G -d "start=%3Cstring%3E"
-d "limit=%3Cstring%3E"
https://your-domain.atlassian.net/wiki/rest/api/space/:spaceKey/watch
Postman Collection Item JSON
{
"name": "Get space watchers",
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/api/space/:spaceKey/watch?start=<string>&limit=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"space",
":spaceKey",
"watch"
],
"query": [
{
"key": "start",
"value": "<string>",
"description": "The start point of the collection to return."
},
{
"key": "limit",
"value": "<string>",
"description": "The limit of the number of items to return, this may be restricted by fixed system limits."
}
],
"variable": [
{
"key": "spaceKey",
"value": "<string>",
"type": "string",
"description": "(Required) The key of the space to get watchers."
}
]
},
"description": "Returns a list of watchers of a space"
},
"response": [
{
"name": "Returned if watchers list is returned.",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/api/space/:spaceKey/watch?start=<string>&limit=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"space",
":spaceKey",
"watch"
],
"query": [
{
"key": "start",
"value": "<string>"
},
{
"key": "limit",
"value": "<string>"
}
],
"variable": [
{
"key": "spaceKey"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"results\": [\n {\n \"type\": \"proident nisi dolo\",\n \"watcher\": {\n \"type\": \"veniam enim exercitation \",\n \"profilePicture\": {\n \"path\": \"Duis velit\",\n \"width\": -59620755,\n \"height\": 31433400,\n \"isDefault\": true\n },\n \"displayName\": \"reprehenderit dolor ea magna\",\n \"accountId\": \"sint enim volupta\",\n \"accountType\": \"do ea ipsum ullamco\",\n \"email\": \"dolor\",\n \"publicName\": \"do aliqua\",\n \"username\": \"nisi officia\",\n \"userKey\": \"sint a\",\n \"operations\": [\n {\n \"operation\": \"move\",\n \"targetType\": \"attachment\"\n },\n {\n \"operation\": \"move\",\n \"targetType\": \"attachment\"\n }\n ],\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 },\n \"spaceKey\": \"minim ex\",\n \"contentId\": \"do\"\n },\n {\n \"type\": \"ut in Duis ad\",\n \"watcher\": {\n \"type\": \"dolor id\",\n \"profilePicture\": {\n \"path\": \"dolore Ut\",\n \"width\": -91859267,\n \"height\": 76867520,\n \"isDefault\": false\n },\n \"displayName\": \"magna in veniam aliqua dolor\",\n \"accountId\": \"ut incididunt\",\n \"accountType\": \"sint Lorem\",\n \"email\": \"voluptate id\",\n \"publicName\": \"Duis mi\",\n \"username\": \"dolor consectetur venia\",\n \"userKey\": \"reprehenderit eius\",\n \"operations\": [\n {\n \"operation\": \"administer\",\n \"targetType\": \"page\"\n },\n {\n \"operation\": \"purge_version\",\n \"targetType\": \"comment\"\n }\n ],\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 },\n \"spaceKey\": \"Duis minim\",\n \"contentId\": \"est irure dolore\"\n }\n ],\n \"start\": 36796637,\n \"limit\": -14900038,\n \"size\": -90406538,\n \"_links\": {}\n}"
},
{
"name": "Returned if there is no space with the given key",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/api/space/:spaceKey/watch?start=<string>&limit=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"space",
":spaceKey",
"watch"
],
"query": [
{
"key": "start",
"value": "<string>"
},
{
"key": "limit",
"value": "<string>"
}
],
"variable": [
{
"key": "spaceKey"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}
