delphiAx / Support API / Show Custom Object Field
Back to Collection Items
var
http: TChilkatHttp;
success: Integer;
sbResponseBody: TChilkatStringBuilder;
jResp: TChilkatJsonObject;
respStatusCode: Integer;
name: WideString;
value: WideString;
id: WideString;
position: WideString;
raw_name: WideString;
url: WideString;
Key: WideString;
v_Type: WideString;
Title: WideString;
Active: WideString;
Created_at: WideString;
Description: WideString;
Id: WideString;
Position: WideString;
Raw_description: WideString;
Raw_title: WideString;
Regexp_for_validation: WideString;
Relationship_target_type: WideString;
System: WideString;
Tag: WideString;
Updated_at: WideString;
v_Url: WideString;
i: Integer;
count_i: Integer;
begin
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http := TChilkatHttp.Create(Self);
http.BasicAuth := 1;
http.Login := 'login';
http.Password := 'password';
http.SetRequestHeader('Accept','application/json');
sbResponseBody := TChilkatStringBuilder.Create(Self);
success := http.QuickGetSb('https://example.zendesk.com/api/v2/custom_objects/:custom_object_key/fields/:custom_object_field_key_or_id',sbResponseBody.ControlInterface);
if (success = 0) then
begin
Memo1.Lines.Add(http.LastErrorText);
Exit;
end;
jResp := TChilkatJsonObject.Create(Self);
jResp.LoadSb(sbResponseBody.ControlInterface);
jResp.EmitCompact := 0;
Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(jResp.Emit());
respStatusCode := http.LastStatus;
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
begin
Memo1.Lines.Add('Response Header:');
Memo1.Lines.Add(http.LastHeader);
Memo1.Lines.Add('Failed.');
Exit;
end;
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "custom_object_field": {
// "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
Key := jResp.StringOf('custom_object_field.key');
v_Type := jResp.StringOf('custom_object_field.type');
Title := jResp.StringOf('custom_object_field.title');
Active := jResp.StringOf('custom_object_field.active');
Created_at := jResp.StringOf('custom_object_field.created_at');
Description := jResp.StringOf('custom_object_field.description');
Id := jResp.StringOf('custom_object_field.id');
Position := jResp.StringOf('custom_object_field.position');
Raw_description := jResp.StringOf('custom_object_field.raw_description');
Raw_title := jResp.StringOf('custom_object_field.raw_title');
Regexp_for_validation := jResp.StringOf('custom_object_field.regexp_for_validation');
Relationship_target_type := jResp.StringOf('custom_object_field.relationship_target_type');
System := jResp.StringOf('custom_object_field.system');
Tag := jResp.StringOf('custom_object_field.tag');
Updated_at := jResp.StringOf('custom_object_field.updated_at');
v_Url := jResp.StringOf('custom_object_field.url');
i := 0;
count_i := jResp.SizeOfArray('custom_object_field.custom_field_options');
while i < count_i do
begin
jResp.I := i;
name := jResp.StringOf('custom_object_field.custom_field_options[i].name');
value := jResp.StringOf('custom_object_field.custom_field_options[i].value');
id := jResp.StringOf('custom_object_field.custom_field_options[i].id');
position := jResp.StringOf('custom_object_field.custom_field_options[i].position');
raw_name := jResp.StringOf('custom_object_field.custom_field_options[i].raw_name');
url := jResp.StringOf('custom_object_field.custom_field_options[i].url');
i := i + 1;
end;
Curl Command
curl -u login:password -X GET
-H "Accept: application/json"
https://example.zendesk.com/api/v2/custom_objects/:custom_object_key/fields/:custom_object_field_key_or_id
Postman Collection Item JSON
{
"name": "Show Custom Object Field",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/custom_objects/:custom_object_key/fields/:custom_object_field_key_or_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"custom_objects",
":custom_object_key",
"fields",
":custom_object_field_key_or_id"
],
"variable": [
{
"key": "custom_object_key",
"value": "<string>"
},
{
"key": "custom_object_field_key_or_id",
"value": "<string>"
}
]
},
"description": "Returns a custom field for a specific object using a provided key or id of the field.\n#### Allowed For\n* Agents\n"
},
"response": [
{
"name": "Custom Object Field",
"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/:custom_object_field_key_or_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"custom_objects",
":custom_object_key",
"fields",
":custom_object_field_key_or_id"
],
"variable": [
{
"key": "custom_object_key"
},
{
"key": "custom_object_field_key_or_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"custom_object_field\": {\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}"
}
]
}
