Delphi (DLL) / Support API / List Custom Object Fields
Back to Collection Items
var
begin
CkHttp_putBasicAuth(http,True);CkHttp_putLogin(http,'login');CkHttp_putPassword(http,'password');success := CkHttp_QuickGetSb(http,'https://example.zendesk.com/api/v2/custom_objects/:custom_object_key/fields',sbResponseBody);CkJsonObject_LoadSb(jResp,sbResponseBody);CkJsonObject_putEmitCompact(jResp,False);CkJsonObject_putI(jResp,i);key := CkJsonObject__stringOf(jResp,'custom_object_fields[i].key');v_type := CkJsonObject__stringOf(jResp,'custom_object_fields[i].type');title := CkJsonObject__stringOf(jResp,'custom_object_fields[i].title');active := CkJsonObject__stringOf(jResp,'custom_object_fields[i].active');created_at := CkJsonObject__stringOf(jResp,'custom_object_fields[i].created_at');description := CkJsonObject__stringOf(jResp,'custom_object_fields[i].description');id := CkJsonObject__stringOf(jResp,'custom_object_fields[i].id');position := CkJsonObject__stringOf(jResp,'custom_object_fields[i].position');raw_description := CkJsonObject__stringOf(jResp,'custom_object_fields[i].raw_description');raw_title := CkJsonObject__stringOf(jResp,'custom_object_fields[i].raw_title');regexp_for_validation := CkJsonObject__stringOf(jResp,'custom_object_fields[i].regexp_for_validation');relationship_target_type := CkJsonObject__stringOf(jResp,'custom_object_fields[i].relationship_target_type');system := CkJsonObject__stringOf(jResp,'custom_object_fields[i].system');tag := CkJsonObject__stringOf(jResp,'custom_object_fields[i].tag');updated_at := CkJsonObject__stringOf(jResp,'custom_object_fields[i].updated_at');url := CkJsonObject__stringOf(jResp,'custom_object_fields[i].url');j := 0;count_j := CkJsonObject_SizeOfArray(jResp,'custom_object_fields[i].custom_field_options');CkJsonObject_putJ(jResp,j);name := CkJsonObject__stringOf(jResp,'custom_object_fields[i].custom_field_options[j].name');value := CkJsonObject__stringOf(jResp,'custom_object_fields[i].custom_field_options[j].value');id := CkJsonObject__stringOf(jResp,'custom_object_fields[i].custom_field_options[j].id');position := CkJsonObject__stringOf(jResp,'custom_object_fields[i].custom_field_options[j].position');raw_name := CkJsonObject__stringOf(jResp,'custom_object_fields[i].custom_field_options[j].raw_name');url := CkJsonObject__stringOf(jResp,'custom_object_fields[i].custom_field_options[j].url');j := j + 1;i := i + 1;
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}"
}
]
}
