VB.NET / 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.
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/custom_objects/:custom_object_key/fields",sbResponseBody)
If (success = False) Then
Debug.WriteLine(http.LastErrorText)
Exit Sub
End If
Dim jResp As New Chilkat.JsonObject
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False
Debug.WriteLine("Response Body:")
Debug.WriteLine(jResp.Emit())
Dim respStatusCode As Integer = http.LastStatus
Debug.WriteLine("Response Status Code = " & respStatusCode)
If (respStatusCode >= 400) Then
Debug.WriteLine("Response Header:")
Debug.WriteLine(http.LastHeader)
Debug.WriteLine("Failed.")
Exit Sub
End If
' 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
Dim key As String
Dim v_type As String
Dim title As String
Dim active As String
Dim created_at As String
Dim description As String
Dim id As String
Dim position As String
Dim raw_description As String
Dim raw_title As String
Dim regexp_for_validation As String
Dim relationship_target_type As String
Dim system As String
Dim tag As String
Dim updated_at As String
Dim url As String
Dim j As Integer
Dim count_j As Integer
Dim name As String
Dim value As String
Dim raw_name As String
Dim i As Integer = 0
Dim count_i As Integer = jResp.SizeOfArray("custom_object_fields")
While i < count_i
jResp.I = i
key = jResp.StringOf("custom_object_fields[i].key")
v_type = jResp.StringOf("custom_object_fields[i].type")
title = jResp.StringOf("custom_object_fields[i].title")
active = jResp.StringOf("custom_object_fields[i].active")
created_at = jResp.StringOf("custom_object_fields[i].created_at")
description = jResp.StringOf("custom_object_fields[i].description")
id = jResp.StringOf("custom_object_fields[i].id")
position = jResp.StringOf("custom_object_fields[i].position")
raw_description = jResp.StringOf("custom_object_fields[i].raw_description")
raw_title = jResp.StringOf("custom_object_fields[i].raw_title")
regexp_for_validation = jResp.StringOf("custom_object_fields[i].regexp_for_validation")
relationship_target_type = jResp.StringOf("custom_object_fields[i].relationship_target_type")
system = jResp.StringOf("custom_object_fields[i].system")
tag = jResp.StringOf("custom_object_fields[i].tag")
updated_at = jResp.StringOf("custom_object_fields[i].updated_at")
url = jResp.StringOf("custom_object_fields[i].url")
j = 0
count_j = jResp.SizeOfArray("custom_object_fields[i].custom_field_options")
While j < count_j
jResp.J = j
name = jResp.StringOf("custom_object_fields[i].custom_field_options[j].name")
value = jResp.StringOf("custom_object_fields[i].custom_field_options[j].value")
id = jResp.StringOf("custom_object_fields[i].custom_field_options[j].id")
position = jResp.StringOf("custom_object_fields[i].custom_field_options[j].position")
raw_name = jResp.StringOf("custom_object_fields[i].custom_field_options[j].raw_name")
url = jResp.StringOf("custom_object_fields[i].custom_field_options[j].url")
j = j + 1
End While
i = i + 1
End While
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}"
}
]
}
