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::ckUpdateInt(queryParams,"start",0)
CkJsonObject::ckUpdateInt(queryParams,"limit",100)
resp.i = CkHttp::ckQuickRequestParams(http,"GET","https://your-domain.atlassian.net/wiki/rest/api/longtask",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": [
; {
; "id": "irure laborum reprehenderit",
; "name": {
; "key": "ea fugiat"
; },
; "elapsedTime": -80970955,
; "percentageComplete": -50700695,
; "successful": false,
; "messages": [
; {
; "translation": "laboris dolore est pariatur"
; },
; {
; "translation": "ut consectetur"
; }
; ]
; },
; {
; "id": "exercitation quis occaecat pariatur",
; "name": {
; "key": "ipsum enim consectetur laborum ea"
; },
; "elapsedTime": 68022774,
; "percentageComplete": -46095628,
; "successful": true,
; "messages": [
; {
; "translation": "ullamco officia Lorem occaecat"
; },
; {
; "translation": "aliquip de"
; }
; ]
; }
; ],
; "start": 73270285,
; "limit": -69580683,
; "size": 69587096,
; "_links": {}
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
id.s
Key.s
elapsedTime.i
percentageComplete.i
successful.i
j.i
count_j.i
translation.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)
id = CkJsonObject::ckStringOf(jResp,"results[i].id")
Key = CkJsonObject::ckStringOf(jResp,"results[i].name.key")
elapsedTime = CkJsonObject::ckIntOf(jResp,"results[i].elapsedTime")
percentageComplete = CkJsonObject::ckIntOf(jResp,"results[i].percentageComplete")
successful = CkJsonObject::ckBoolOf(jResp,"results[i].successful")
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"results[i].messages")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
translation = CkJsonObject::ckStringOf(jResp,"results[i].messages[j].translation")
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=0"
-d "limit=100"
https://your-domain.atlassian.net/wiki/rest/api/longtask
Postman Collection Item JSON
{
"name": "Get long-running tasks",
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/api/longtask?start=0&limit=100",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"longtask"
],
"query": [
{
"key": "start",
"value": "0",
"description": "The starting index of the returned tasks."
},
{
"key": "limit",
"value": "100",
"description": "The maximum number of tasks to return per page. Note, this may be\nrestricted by fixed system limits."
}
]
},
"description": "Returns information about all active long-running tasks (e.g. space export),\nsuch as how long each task has been running and the percentage of each task\nthat has completed.\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 tasks are returned.",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/api/longtask?start=0&limit=100",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"longtask"
],
"query": [
{
"key": "start",
"value": "0"
},
{
"key": "limit",
"value": "100"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"results\": [\n {\n \"id\": \"irure laborum reprehenderit\",\n \"name\": {\n \"key\": \"ea fugiat\"\n },\n \"elapsedTime\": -80970955,\n \"percentageComplete\": -50700695,\n \"successful\": false,\n \"messages\": [\n {\n \"translation\": \"laboris dolore est pariatur\"\n },\n {\n \"translation\": \"ut consectetur\"\n }\n ]\n },\n {\n \"id\": \"exercitation quis occaecat pariatur\",\n \"name\": {\n \"key\": \"ipsum enim consectetur laborum ea\"\n },\n \"elapsedTime\": 68022774,\n \"percentageComplete\": -46095628,\n \"successful\": true,\n \"messages\": [\n {\n \"translation\": \"ullamco officia Lorem occaecat\"\n },\n {\n \"translation\": \"aliquip de\"\n }\n ]\n }\n ],\n \"start\": 73270285,\n \"limit\": -69580683,\n \"size\": 69587096,\n \"_links\": {}\n}"
},
{
"name": "Returned if the calling user is not logged in to Confluence.",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/api/longtask?start=0&limit=100",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"longtask"
],
"query": [
{
"key": "start",
"value": "0"
},
{
"key": "limit",
"value": "100"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}