Back to Collection Items
require 'chilkat'
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
http = Chilkat::CkHttp.new()
queryParams = Chilkat::CkJsonObject.new()
queryParams.UpdateString("start","<string>")
queryParams.UpdateString("limit","<string>")
# resp is a CkHttpResponse
resp = http.QuickRequestParams("GET","https://your-domain.atlassian.net/wiki/rest/api/space/:spaceKey/watch",queryParams)
if (http.get_LastMethodSuccess() == false)
print http.lastErrorText() + "\n";
exit
end
sbResponseBody = Chilkat::CkStringBuilder.new()
resp.GetBodySb(sbResponseBody)
jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)
print "Response Body:" + "\n";
print jResp.emit() + "\n";
respStatusCode = resp.get_StatusCode()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
print "Response Header:" + "\n";
print resp.header() + "\n";
print "Failed." + "\n";
exit
end
# 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
start = jResp.IntOf("start")
limit = jResp.IntOf("limit")
size = jResp.IntOf("size")
i = 0
count_i = jResp.SizeOfArray("results")
while i < count_i
jResp.put_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")
while j < count_j
jResp.put_J(j)
operation = jResp.stringOf("results[i].watcher.operations[j].operation")
targetType = jResp.stringOf("results[i].watcher.operations[j].targetType")
j = j + 1
end
i = i + 1
end
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": ""
}
]
}
