Chilkat Online Tools

Xojo / Support API / Show Job Status

Back to Collection Items

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

Dim http As New Chilkat.Http
Dim success As Boolean

http.BasicAuth = True
http.Login = "login"
http.Password = "password"

http.SetRequestHeader "Accept","application/json"

Dim sbResponseBody As New Chilkat.StringBuilder
success = http.QuickGetSb("https://example.zendesk.com/api/v2/job_statuses/:job_status_id",sbResponseBody)
If (success = False) Then
    System.DebugLog(http.LastErrorText)
    Return
End If

Dim jResp As New Chilkat.JsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False

System.DebugLog("Response Body:")
System.DebugLog(jResp.Emit())

Dim respStatusCode As Int32
respStatusCode = http.LastStatus
System.DebugLog("Response Status Code = " + Str(respStatusCode))
If (respStatusCode >= 400) Then
    System.DebugLog("Response Header:")
    System.DebugLog(http.LastHeader)
    System.DebugLog("Failed.")
    Return
End If

// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)

// {
//   "job_status": {
//     "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

Dim id As String
Dim index As String

Dim Id As String
Id = jResp.StringOf("job_status.id")
Dim Message As String
Message = jResp.StringOf("job_status.message")
Dim Progress As String
Progress = jResp.StringOf("job_status.progress")
Dim Status As String
Status = jResp.StringOf("job_status.status")
Dim Total As String
Total = jResp.StringOf("job_status.total")
Dim v_Url As String
v_Url = jResp.StringOf("job_status.url")
Dim i As Int32
i = 0
Dim count_i As Int32
count_i = jResp.SizeOfArray("job_status.results")
While i < count_i
    jResp.I = i
    id = jResp.StringOf("job_status.results[i].id")
    index = jResp.StringOf("job_status.results[i].index")
    i = i + 1
Wend

Curl Command

curl  -u login:password -X GET
	-H "Accept: application/json"
https://example.zendesk.com/api/v2/job_statuses/:job_status_id

Postman Collection Item JSON

{
  "name": "Show Job Status",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/job_statuses/:job_status_id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "job_statuses",
        ":job_status_id"
      ],
      "variable": [
        {
          "key": "job_status_id",
          "value": "<string>"
        }
      ]
    },
    "description": "Shows the status of a background job.\n\n#### Allowed For:\n\n* Agents\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/:job_status_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "job_statuses",
            ":job_status_id"
          ],
          "variable": [
            {
              "key": "job_status_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"job_status\": {\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}"
    }
  ]
}