Chilkat Online Tools

ERROR!

------------------- GenerateCode ----------------------
---- begin chilkat script ----
// This example assumes the Chilkat API to have been previously unlocked.
// See {{-global_unlock:::Global Unlock Sample-}} for sample code.

new Http http;
ckbool success;

http.BasicAuth = cktrue;
http.Login = "login";
http.Password = "password";

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

new StringBuilder sbResponseBody;
success = http.QuickGetSb("https://example.zendesk.com/api/v2/custom_objects/:custom_object_key/fields",sbResponseBody);
if (success == ckfalse) {
println http.LastErrorText;
return;
}

new JsonObject jResp;
call jResp.LoadSb(sbResponseBody);
jResp.EmitCompact = ckfalse;

println "Response Body:";
println jResp.Emit();

int respStatusCode = http.LastStatus;
println "Response Status Code = ",respStatusCode;
if (respStatusCode >= 400) {
    println "Response Header:";
    println http.LastHeader;
    println "Failed.";
    return;
}

// 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: {{.https://tools.chilkat.io/jsonParse|||Generate JSON Parsing Code.}}

#ifdef IS_C_CPP
// Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.
#undef IS_C_CPP

string description;
string id;
string position;
string raw_description;
string raw_title;
string regexp_for_validation;
string relationship_target_type;
string system;
string tag;
string updated_at;
string url;
int j;
int count_j;
string name;
string value;
string raw_name;

int i = 0;
int count_i = 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;
    }
    i = i + 1;
}



---- end chilkat script ----

Python / Support API / List Custom Object Fields

Back to Collection Items

import sys
import chilkat

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

http = chilkat.CkHttp()

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

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

sbResponseBody = chilkat.CkStringBuilder()
success = http.QuickGetSb("https://example.zendesk.com/api/v2/custom_objects/:custom_object_key/fields",sbResponseBody)
if (success == False):
    print(http.lastErrorText())
    sys.exit()

jResp = chilkat.CkJsonObject()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(False)

print("Response Body:")
print(jResp.emit())

respStatusCode = http.get_LastStatus()
print("Response Status Code = " + str(respStatusCode))
if (respStatusCode >= 400):
    print("Response Header:")
    print(http.lastHeader())
    print("Failed.")
    sys.exit()

# 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)
ERROR: Undefined variable(key)

ERROR: Undefined variable(v_type)

ERROR: Undefined variable(title)

ERROR: Undefined variable(active)

ERROR: Undefined variable(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

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