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 lcAccountType
LOCAL lcV_Email
LOCAL lcPublicName
LOCAL lcUsername
LOCAL lcUserKey
LOCAL lcValue
LOCAL lcPersonalValue
LOCAL lcSpaceKey
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.UpdateString("start","<string>")
loQueryParams.UpdateString("limit","<string>")
loResp = loHttp.QuickRequestParams("GET","https://your-domain.atlassian.net/wiki/rest/api/space/:spaceKey/watch",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": "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
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")
lcAccountType = loJResp.StringOf("results[i].watcher.accountType")
lcV_Email = loJResp.StringOf("results[i].watcher.email")
lcPublicName = loJResp.StringOf("results[i].watcher.publicName")
lcUsername = loJResp.StringOf("results[i].watcher.username")
lcUserKey = loJResp.StringOf("results[i].watcher.userKey")
lcValue = loJResp.StringOf("results[i].watcher.details.business.value")
lcPersonalValue = loJResp.StringOf("results[i].watcher.details.personal.value")
lcSpaceKey = loJResp.StringOf("results[i].spaceKey")
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=%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": ""
}
]
}
