Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
queryParams.i = CkJsonObject::ckCreate()
If queryParams.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(queryParams,"start","<string>")
CkJsonObject::ckUpdateString(queryParams,"limit","<string>")
resp.i = CkHttp::ckQuickRequestParams(http,"GET","https://your-domain.atlassian.net/wiki/rest/api/space/:spaceKey/watch",queryParams)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
ProcedureReturn
EndIf
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHttpResponse::ckGetBodySb(resp,sbResponseBody)
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttpResponse::ckHeader(resp)
Debug "Failed."
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
CkHttpResponse::ckDispose(resp)
; 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
v_type.s
v_Type.s
Path.s
Width.i
Height.i
IsDefault.i
DisplayName.s
AccountId.s
AccountType.s
v_Email.s
PublicName.s
Username.s
UserKey.s
Value.s
PersonalValue.s
spaceKey.s
contentId.s
j.i
count_j.i
operation.s
targetType.s
start.i = CkJsonObject::ckIntOf(jResp,"start")
limit.i = CkJsonObject::ckIntOf(jResp,"limit")
size.i = CkJsonObject::ckIntOf(jResp,"size")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"results")
While i < count_i
CkJsonObject::setCkI(jResp, i)
v_type = CkJsonObject::ckStringOf(jResp,"results[i].type")
v_Type = CkJsonObject::ckStringOf(jResp,"results[i].watcher.type")
Path = CkJsonObject::ckStringOf(jResp,"results[i].watcher.profilePicture.path")
Width = CkJsonObject::ckIntOf(jResp,"results[i].watcher.profilePicture.width")
Height = CkJsonObject::ckIntOf(jResp,"results[i].watcher.profilePicture.height")
IsDefault = CkJsonObject::ckBoolOf(jResp,"results[i].watcher.profilePicture.isDefault")
DisplayName = CkJsonObject::ckStringOf(jResp,"results[i].watcher.displayName")
AccountId = CkJsonObject::ckStringOf(jResp,"results[i].watcher.accountId")
AccountType = CkJsonObject::ckStringOf(jResp,"results[i].watcher.accountType")
v_Email = CkJsonObject::ckStringOf(jResp,"results[i].watcher.email")
PublicName = CkJsonObject::ckStringOf(jResp,"results[i].watcher.publicName")
Username = CkJsonObject::ckStringOf(jResp,"results[i].watcher.username")
UserKey = CkJsonObject::ckStringOf(jResp,"results[i].watcher.userKey")
Value = CkJsonObject::ckStringOf(jResp,"results[i].watcher.details.business.value")
PersonalValue = CkJsonObject::ckStringOf(jResp,"results[i].watcher.details.personal.value")
spaceKey = CkJsonObject::ckStringOf(jResp,"results[i].spaceKey")
contentId = CkJsonObject::ckStringOf(jResp,"results[i].contentId")
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"results[i].watcher.operations")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
operation = CkJsonObject::ckStringOf(jResp,"results[i].watcher.operations[j].operation")
targetType = CkJsonObject::ckStringOf(jResp,"results[i].watcher.operations[j].targetType")
j = j + 1
Wend
i = i + 1
Wend
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
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": ""
}
]
}
