Objective-C / Support API / Show Custom Object Field
Back to Collection Items
#import <CkoHttp.h>
#import <CkoStringBuilder.h>
#import <CkoJsonObject.h>
#import <NSString.h>
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
CkoHttp *http = [[CkoHttp alloc] init];
BOOL success;
http.BasicAuth = YES;
http.Login = @"login";
http.Password = @"password";
[http SetRequestHeader: @"Accept" value: @"application/json"];
CkoStringBuilder *sbResponseBody = [[CkoStringBuilder alloc] init];
success = [http QuickGetSb: @"https://example.zendesk.com/api/v2/custom_objects/:custom_object_key/fields/:custom_object_field_key_or_id" sbContent: sbResponseBody];
if (success == NO) {
NSLog(@"%@",http.LastErrorText);
return;
}
CkoJsonObject *jResp = [[CkoJsonObject alloc] init];
[jResp LoadSb: sbResponseBody];
jResp.EmitCompact = NO;
NSLog(@"%@",@"Response Body:");
NSLog(@"%@",[jResp Emit]);
int respStatusCode = [http.LastStatus intValue];
NSLog(@"%@%d",@"Response Status Code = ",respStatusCode);
if (respStatusCode >= 400) {
NSLog(@"%@",@"Response Header:");
NSLog(@"%@",http.LastHeader);
NSLog(@"%@",@"Failed.");
return;
}
// 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
NSString *name = 0;
NSString *value = 0;
NSString *id = 0;
NSString *position = 0;
NSString *raw_name = 0;
NSString *url = 0;
NSString *Key = [jResp StringOf: @"custom_object_field.key"];
NSString *v_Type = [jResp StringOf: @"custom_object_field.type"];
NSString *Title = [jResp StringOf: @"custom_object_field.title"];
NSString *Active = [jResp StringOf: @"custom_object_field.active"];
NSString *Created_at = [jResp StringOf: @"custom_object_field.created_at"];
NSString *Description = [jResp StringOf: @"custom_object_field.description"];
NSString *Id = [jResp StringOf: @"custom_object_field.id"];
NSString *Position = [jResp StringOf: @"custom_object_field.position"];
NSString *Raw_description = [jResp StringOf: @"custom_object_field.raw_description"];
NSString *Raw_title = [jResp StringOf: @"custom_object_field.raw_title"];
NSString *Regexp_for_validation = [jResp StringOf: @"custom_object_field.regexp_for_validation"];
NSString *Relationship_target_type = [jResp StringOf: @"custom_object_field.relationship_target_type"];
NSString *System = [jResp StringOf: @"custom_object_field.system"];
NSString *Tag = [jResp StringOf: @"custom_object_field.tag"];
NSString *Updated_at = [jResp StringOf: @"custom_object_field.updated_at"];
NSString *v_Url = [jResp StringOf: @"custom_object_field.url"];
int i = 0;
int count_i = [[jResp SizeOfArray: @"custom_object_field.custom_field_options"] intValue];
while (i < count_i) {
jResp.I = [NSNumber numberWithInt: 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;
}
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}"
}
]
}
