Chilkat Online Tools

Ruby / Support API / List Custom Object Fields

Back to Collection Items

require 'chilkat'

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

http = Chilkat::CkHttp.new()

http.put_BasicAuth(true)
http.put_Login("login")
http.put_Password("password")

http.SetRequestHeader("Accept","application/json")

sbResponseBody = Chilkat::CkStringBuilder.new()
success = http.QuickGetSb("https://example.zendesk.com/api/v2/custom_objects/:custom_object_key/fields",sbResponseBody)
if (success == false)
    print http.lastErrorText() + "\n";
    exit
end

jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)

print "Response Body:" + "\n";
print jResp.emit() + "\n";

respStatusCode = http.get_LastStatus()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
    print "Response Header:" + "\n";
    print http.lastHeader() + "\n";
    print "Failed." + "\n";
    exit
end

# 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

i = 0
count_i = jResp.SizeOfArray("custom_object_fields")
while i < count_i
    jResp.put_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.put_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
    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

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}"
    }
  ]
}