Chilkat Online Tools

Powershell / Support API / List Job Statuses

Back to Collection Items

Add-Type -Path "C:\chilkat\ChilkatDotNet47-x64\ChilkatDotNet47.dll"

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

$http = New-Object Chilkat.Http

$http.BasicAuth = $true
$http.Login = "login"
$http.Password = "password"

$http.SetRequestHeader("Accept","application/json")

$sbResponseBody = New-Object Chilkat.StringBuilder
$success = $http.QuickGetSb("https://example.zendesk.com/api/v2/job_statuses",$sbResponseBody)
if ($success -eq $false) {
    $($http.LastErrorText)
    exit
}

$jResp = New-Object Chilkat.JsonObject
$jResp.LoadSb($sbResponseBody)
$jResp.EmitCompact = $false

$("Response Body:")
$($jResp.Emit())

$respStatusCode = $http.LastStatus
$("Response Status Code = " + $respStatusCode)
if ($respStatusCode -ge 400) {
    $("Response Header:")
    $($http.LastHeader)
    $("Failed.")
    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

$i = 0
$count_i = $jResp.SizeOfArray("job_statuses")
while ($i -lt $count_i) {
    $jResp.I = $i
    $id = $jResp.StringOf("job_statuses[i].id")
    $message = $jResp.StringOf("job_statuses[i].message")
    $progress = $jResp.StringOf("job_statuses[i].progress")
    $status = $jResp.StringOf("job_statuses[i].status")
    $total = $jResp.StringOf("job_statuses[i].total")
    $url = $jResp.StringOf("job_statuses[i].url")
    $j = 0
    $count_j = $jResp.SizeOfArray("job_statuses[i].results")
    while ($j -lt $count_j) {
        $jResp.J = $j
        $id = $jResp.StringOf("job_statuses[i].results[j].id")
        $index = $jResp.StringOf("job_statuses[i].results[j].index")
        $j = $j + 1
    }

    $i = $i + 1
}

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