TCL / Support API / List Job Statuses
Back to Collection Items
load ./chilkat.dll
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
set http [new_CkHttp]
CkHttp_put_BasicAuth $http 1
CkHttp_put_Login $http "login"
CkHttp_put_Password $http "password"
CkHttp_SetRequestHeader $http "Accept" "application/json"
set sbResponseBody [new_CkStringBuilder]
set success [CkHttp_QuickGetSb $http "https://example.zendesk.com/api/v2/job_statuses" $sbResponseBody]
if {$success == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
exit
}
set jResp [new_CkJsonObject]
CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0
puts "Response Body:"
puts [CkJsonObject_emit $jResp]
set respStatusCode [CkHttp_get_LastStatus $http]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
puts "Response Header:"
puts [CkHttp_lastHeader $http]
puts "Failed."
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
exit
}
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# {
# "job_statuses": [
# {
# "id": "<string>",
# "message": "<string>",
# "progress": "<integer>",
# "results": [
# {
# "id": "<integer>",
# "index": "<integer>"
# },
# {
# "id": "<integer>",
# "index": "<integer>"
# }
# ],
# "status": "<string>",
# "total": "<integer>",
# "url": "<string>"
# },
# {
# "id": "<string>",
# "message": "<string>",
# "progress": "<integer>",
# "results": [
# {
# "id": "<integer>",
# "index": "<integer>"
# },
# {
# "id": "<integer>",
# "index": "<integer>"
# }
# ],
# "status": "<string>",
# "total": "<integer>",
# "url": "<string>"
# }
# ]
# }
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "job_statuses"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set id [CkJsonObject_stringOf $jResp "job_statuses[i].id"]
set message [CkJsonObject_stringOf $jResp "job_statuses[i].message"]
set progress [CkJsonObject_stringOf $jResp "job_statuses[i].progress"]
set status [CkJsonObject_stringOf $jResp "job_statuses[i].status"]
set total [CkJsonObject_stringOf $jResp "job_statuses[i].total"]
set url [CkJsonObject_stringOf $jResp "job_statuses[i].url"]
set j 0
set count_j [CkJsonObject_SizeOfArray $jResp "job_statuses[i].results"]
while {$j < $count_j} {
CkJsonObject_put_J $jResp $j
set id [CkJsonObject_stringOf $jResp "job_statuses[i].results[j].id"]
set index [CkJsonObject_stringOf $jResp "job_statuses[i].results[j].index"]
set j [expr $j + 1]
}
set i [expr $i + 1]
}
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
Curl Command
curl -u login:password -X GET
-H "Accept: application/json"
https://example.zendesk.com/api/v2/job_statuses
Postman Collection Item JSON
{
"name": "List Job Statuses",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/job_statuses",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"job_statuses"
]
},
"description": "Shows the statuses for background jobs. Statuses are sorted first by completion date and then by creation date in descending order.\n\n#### Allowed For:\n\n* Agents\n\n#### Pagination\n\n* Cursor pagination\n\nSee [Pagination](/api-reference/introduction/pagination/#using-cursor-pagination).\n\nReturns a maximum of 100 records per page sorted by `completed_at desc, created_at desc`. Does not allow any other sort order.\n"
},
"response": [
{
"name": "Success Response",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/job_statuses",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"job_statuses"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"job_statuses\": [\n {\n \"id\": \"<string>\",\n \"message\": \"<string>\",\n \"progress\": \"<integer>\",\n \"results\": [\n {\n \"id\": \"<integer>\",\n \"index\": \"<integer>\"\n },\n {\n \"id\": \"<integer>\",\n \"index\": \"<integer>\"\n }\n ],\n \"status\": \"<string>\",\n \"total\": \"<integer>\",\n \"url\": \"<string>\"\n },\n {\n \"id\": \"<string>\",\n \"message\": \"<string>\",\n \"progress\": \"<integer>\",\n \"results\": [\n {\n \"id\": \"<integer>\",\n \"index\": \"<integer>\"\n },\n {\n \"id\": \"<integer>\",\n \"index\": \"<integer>\"\n }\n ],\n \"status\": \"<string>\",\n \"total\": \"<integer>\",\n \"url\": \"<string>\"\n }\n ]\n}"
}
]
}