Chilkat Online Tools

autoit / Support API / List Custom Objects

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/custom_objects",$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)

; {
;   "custom_objects": [
;     {
;       "key": "<string>",
;       "title": "<string>",
;       "title_pluralized": "<string>",
;       "created_at": "<dateTime>",
;       "created_by_user_id": "<string>",
;       "description": "<string>",
;       "raw_description": "<string>",
;       "raw_title": "<string>",
;       "raw_title_pluralized": "<string>",
;       "updated_at": "<dateTime>",
;       "updated_by_user_id": "<string>",
;       "url": "<string>"
;     },
;     {
;       "key": "<string>",
;       "title": "<string>",
;       "title_pluralized": "<string>",
;       "created_at": "<dateTime>",
;       "created_by_user_id": "<string>",
;       "description": "<string>",
;       "raw_description": "<string>",
;       "raw_title": "<string>",
;       "raw_title_pluralized": "<string>",
;       "updated_at": "<dateTime>",
;       "updated_by_user_id": "<string>",
;       "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 $sKey
Local $sTitle
Local $sTitle_pluralized
Local $sCreated_at
Local $sCreated_by_user_id
Local $sDescription
Local $sRaw_description
Local $sRaw_title
Local $sRaw_title_pluralized
Local $sUpdated_at
Local $sUpdated_by_user_id
Local $sUrl

Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("custom_objects")
While $i < $iCount_i
    $oJResp.I = $i
    $sKey = $oJResp.StringOf("custom_objects[i].key")
    $sTitle = $oJResp.StringOf("custom_objects[i].title")
    $sTitle_pluralized = $oJResp.StringOf("custom_objects[i].title_pluralized")
    $sCreated_at = $oJResp.StringOf("custom_objects[i].created_at")
    $sCreated_by_user_id = $oJResp.StringOf("custom_objects[i].created_by_user_id")
    $sDescription = $oJResp.StringOf("custom_objects[i].description")
    $sRaw_description = $oJResp.StringOf("custom_objects[i].raw_description")
    $sRaw_title = $oJResp.StringOf("custom_objects[i].raw_title")
    $sRaw_title_pluralized = $oJResp.StringOf("custom_objects[i].raw_title_pluralized")
    $sUpdated_at = $oJResp.StringOf("custom_objects[i].updated_at")
    $sUpdated_by_user_id = $oJResp.StringOf("custom_objects[i].updated_by_user_id")
    $sUrl = $oJResp.StringOf("custom_objects[i].url")
    $i = $i + 1
Wend

Curl Command

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

Postman Collection Item JSON

{
  "name": "List Custom Objects",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/custom_objects",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "custom_objects"
      ]
    },
    "description": "Lists all undeleted custom objects for the account\n#### Allowed For\n* Everyone"
  },
  "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/custom_objects",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "custom_objects"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"custom_objects\": [\n    {\n      \"key\": \"<string>\",\n      \"title\": \"<string>\",\n      \"title_pluralized\": \"<string>\",\n      \"created_at\": \"<dateTime>\",\n      \"created_by_user_id\": \"<string>\",\n      \"description\": \"<string>\",\n      \"raw_description\": \"<string>\",\n      \"raw_title\": \"<string>\",\n      \"raw_title_pluralized\": \"<string>\",\n      \"updated_at\": \"<dateTime>\",\n      \"updated_by_user_id\": \"<string>\",\n      \"url\": \"<string>\"\n    },\n    {\n      \"key\": \"<string>\",\n      \"title\": \"<string>\",\n      \"title_pluralized\": \"<string>\",\n      \"created_at\": \"<dateTime>\",\n      \"created_by_user_id\": \"<string>\",\n      \"description\": \"<string>\",\n      \"raw_description\": \"<string>\",\n      \"raw_title\": \"<string>\",\n      \"raw_title_pluralized\": \"<string>\",\n      \"updated_at\": \"<dateTime>\",\n      \"updated_by_user_id\": \"<string>\",\n      \"url\": \"<string>\"\n    }\n  ]\n}"
    }
  ]
}