Chilkat Online Tools

autoit / Support API / List Job Statuses

Back to Collection Items

; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.

$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess

$oHttp.BasicAuth = True
$oHttp.Login = "login"
$oHttp.Password = "password"

$oHttp.SetRequestHeader "Accept","application/json"

$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$bSuccess = $oHttp.QuickGetSb("https://example.zendesk.com/api/v2/job_statuses",$oSbResponseBody)
If ($bSuccess = False) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False

ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)

Local $iRespStatusCode = $oHttp.LastStatus
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
    ConsoleWrite("Response Header:" & @CRLF)
    ConsoleWrite($oHttp.LastHeader & @CRLF)
    ConsoleWrite("Failed." & @CRLF)
    Exit
EndIf

; 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

Local $sId
Local $sMessage
Local $sProgress
Local $status
Local $sTotal
Local $sUrl
Local $iJ
Local $iCount_j
Local $sIndex

Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("job_statuses")
While $i < $iCount_i
    $oJResp.I = $i
    $sId = $oJResp.StringOf("job_statuses[i].id")
    $sMessage = $oJResp.StringOf("job_statuses[i].message")
    $sProgress = $oJResp.StringOf("job_statuses[i].progress")
    $status = $oJResp.StringOf("job_statuses[i].status")
    $sTotal = $oJResp.StringOf("job_statuses[i].total")
    $sUrl = $oJResp.StringOf("job_statuses[i].url")
    $iJ = 0
    $iCount_j = $oJResp.SizeOfArray("job_statuses[i].results")
    While $iJ < $iCount_j
        $oJResp.J = $iJ
        $sId = $oJResp.StringOf("job_statuses[i].results[j].id")
        $sIndex = $oJResp.StringOf("job_statuses[i].results[j].index")
        $iJ = $iJ + 1
    Wend
    $i = $i + 1
Wend

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}"
    }
  ]
}