autoit / Support API / List Custom Object Fields
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_9_5_0.Http")
Local $bSuccess
$oHttp.BasicAuth = True
$oHttp.Login = "login"
$oHttp.Password = "password"
$oHttp.SetRequestHeader "Accept","application/json"
$oSbResponseBody = ObjCreate("Chilkat_9_5_0.StringBuilder")
$bSuccess = $oHttp.QuickGetSb("https://example.zendesk.com/api/v2/custom_objects/:custom_object_key/fields",$oSbResponseBody)
If ($bSuccess = False) Then
ConsoleWrite($oHttp.LastErrorText & @CRLF)
Exit
EndIf
$oJResp = ObjCreate("Chilkat_9_5_0.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_object_fields": [
; {
; "key": "<string>",
; "type": "<string>",
; "title": "<string>",
; "active": "<boolean>",
; "created_at": "<dateTime>",
; "custom_field_options": [
; {
; "name": "<string>",
; "value": "<string>",
; "id": "<integer>",
; "position": "<integer>",
; "raw_name": "<string>",
; "url": "<string>"
; },
; {
; "name": "<string>",
; "value": "<string>",
; "id": "<integer>",
; "position": "<integer>",
; "raw_name": "<string>",
; "url": "<string>"
; }
; ],
; "description": "<string>",
; "id": "<integer>",
; "position": "<integer>",
; "raw_description": "<string>",
; "raw_title": "<string>",
; "regexp_for_validation": "<string>",
; "relationship_filter": {},
; "relationship_target_type": "<string>",
; "system": "<boolean>",
; "tag": "<string>",
; "updated_at": "<dateTime>",
; "url": "<string>"
; },
; {
; "key": "<string>",
; "type": "<string>",
; "title": "<string>",
; "active": "<boolean>",
; "created_at": "<dateTime>",
; "custom_field_options": [
; {
; "name": "<string>",
; "value": "<string>",
; "id": "<integer>",
; "position": "<integer>",
; "raw_name": "<string>",
; "url": "<string>"
; },
; {
; "name": "<string>",
; "value": "<string>",
; "id": "<integer>",
; "position": "<integer>",
; "raw_name": "<string>",
; "url": "<string>"
; }
; ],
; "description": "<string>",
; "id": "<integer>",
; "position": "<integer>",
; "raw_description": "<string>",
; "raw_title": "<string>",
; "regexp_for_validation": "<string>",
; "relationship_filter": {},
; "relationship_target_type": "<string>",
; "system": "<boolean>",
; "tag": "<string>",
; "updated_at": "<dateTime>",
; "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 $sV_type
Local $sTitle
Local $sActive
Local $sCreated_at
Local $sDescription
Local $sId
Local $sPosition
Local $sRaw_description
Local $sRaw_title
Local $sRegexp_for_validation
Local $sRelationship_target_type
Local $system
Local $sTag
Local $sUpdated_at
Local $sUrl
Local $iJ
Local $iCount_j
Local $sName
Local $sValue
Local $sRaw_name
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("custom_object_fields")
While $i < $iCount_i
$oJResp.I = $i
$sKey = $oJResp.StringOf("custom_object_fields[i].key")
$sV_type = $oJResp.StringOf("custom_object_fields[i].type")
$sTitle = $oJResp.StringOf("custom_object_fields[i].title")
$sActive = $oJResp.StringOf("custom_object_fields[i].active")
$sCreated_at = $oJResp.StringOf("custom_object_fields[i].created_at")
$sDescription = $oJResp.StringOf("custom_object_fields[i].description")
$sId = $oJResp.StringOf("custom_object_fields[i].id")
$sPosition = $oJResp.StringOf("custom_object_fields[i].position")
$sRaw_description = $oJResp.StringOf("custom_object_fields[i].raw_description")
$sRaw_title = $oJResp.StringOf("custom_object_fields[i].raw_title")
$sRegexp_for_validation = $oJResp.StringOf("custom_object_fields[i].regexp_for_validation")
$sRelationship_target_type = $oJResp.StringOf("custom_object_fields[i].relationship_target_type")
$system = $oJResp.StringOf("custom_object_fields[i].system")
$sTag = $oJResp.StringOf("custom_object_fields[i].tag")
$sUpdated_at = $oJResp.StringOf("custom_object_fields[i].updated_at")
$sUrl = $oJResp.StringOf("custom_object_fields[i].url")
$iJ = 0
$iCount_j = $oJResp.SizeOfArray("custom_object_fields[i].custom_field_options")
While $iJ < $iCount_j
$oJResp.J = $iJ
$sName = $oJResp.StringOf("custom_object_fields[i].custom_field_options[j].name")
$sValue = $oJResp.StringOf("custom_object_fields[i].custom_field_options[j].value")
$sId = $oJResp.StringOf("custom_object_fields[i].custom_field_options[j].id")
$sPosition = $oJResp.StringOf("custom_object_fields[i].custom_field_options[j].position")
$sRaw_name = $oJResp.StringOf("custom_object_fields[i].custom_field_options[j].raw_name")
$sUrl = $oJResp.StringOf("custom_object_fields[i].custom_field_options[j].url")
$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/custom_objects/:custom_object_key/fields
Postman Collection Item JSON
{
"name": "List Custom Object Fields",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/custom_objects/:custom_object_key/fields",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"custom_objects",
":custom_object_key",
"fields"
],
"variable": [
{
"key": "custom_object_key",
"value": "<string>"
}
]
},
"description": "Lists all undeleted custom fields for the specified object.\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/:custom_object_key/fields",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"custom_objects",
":custom_object_key",
"fields"
],
"variable": [
{
"key": "custom_object_key"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"custom_object_fields\": [\n {\n \"key\": \"<string>\",\n \"type\": \"<string>\",\n \"title\": \"<string>\",\n \"active\": \"<boolean>\",\n \"created_at\": \"<dateTime>\",\n \"custom_field_options\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"id\": \"<integer>\",\n \"position\": \"<integer>\",\n \"raw_name\": \"<string>\",\n \"url\": \"<string>\"\n },\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"id\": \"<integer>\",\n \"position\": \"<integer>\",\n \"raw_name\": \"<string>\",\n \"url\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"id\": \"<integer>\",\n \"position\": \"<integer>\",\n \"raw_description\": \"<string>\",\n \"raw_title\": \"<string>\",\n \"regexp_for_validation\": \"<string>\",\n \"relationship_filter\": {},\n \"relationship_target_type\": \"<string>\",\n \"system\": \"<boolean>\",\n \"tag\": \"<string>\",\n \"updated_at\": \"<dateTime>\",\n \"url\": \"<string>\"\n },\n {\n \"key\": \"<string>\",\n \"type\": \"<string>\",\n \"title\": \"<string>\",\n \"active\": \"<boolean>\",\n \"created_at\": \"<dateTime>\",\n \"custom_field_options\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"id\": \"<integer>\",\n \"position\": \"<integer>\",\n \"raw_name\": \"<string>\",\n \"url\": \"<string>\"\n },\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"id\": \"<integer>\",\n \"position\": \"<integer>\",\n \"raw_name\": \"<string>\",\n \"url\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"id\": \"<integer>\",\n \"position\": \"<integer>\",\n \"raw_description\": \"<string>\",\n \"raw_title\": \"<string>\",\n \"regexp_for_validation\": \"<string>\",\n \"relationship_filter\": {},\n \"relationship_target_type\": \"<string>\",\n \"system\": \"<boolean>\",\n \"tag\": \"<string>\",\n \"updated_at\": \"<dateTime>\",\n \"url\": \"<string>\"\n }\n ]\n}"
}
]
}
