PureBasic / Support API / List Custom Object Fields
Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
CkHttp::setCkBasicAuth(http, 1)
CkHttp::setCkLogin(http, "login")
CkHttp::setCkPassword(http, "password")
CkHttp::ckSetRequestHeader(http,"Accept","application/json")
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkHttp::ckQuickGetSb(http,"https://example.zendesk.com/api/v2/custom_objects/:custom_object_key/fields",sbResponseBody)
If success = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
ProcedureReturn
EndIf
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttp::ckLastStatus(http)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttp::ckLastHeader(http)
Debug "Failed."
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
; 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
key.s
v_type.s
title.s
active.s
created_at.s
description.s
id.s
position.s
raw_description.s
raw_title.s
regexp_for_validation.s
relationship_target_type.s
system.s
tag.s
updated_at.s
url.s
j.i
count_j.i
name.s
value.s
raw_name.s
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"custom_object_fields")
While i < count_i
CkJsonObject::setCkI(jResp, i)
key = CkJsonObject::ckStringOf(jResp,"custom_object_fields[i].key")
v_type = CkJsonObject::ckStringOf(jResp,"custom_object_fields[i].type")
title = CkJsonObject::ckStringOf(jResp,"custom_object_fields[i].title")
active = CkJsonObject::ckStringOf(jResp,"custom_object_fields[i].active")
created_at = CkJsonObject::ckStringOf(jResp,"custom_object_fields[i].created_at")
description = CkJsonObject::ckStringOf(jResp,"custom_object_fields[i].description")
id = CkJsonObject::ckStringOf(jResp,"custom_object_fields[i].id")
position = CkJsonObject::ckStringOf(jResp,"custom_object_fields[i].position")
raw_description = CkJsonObject::ckStringOf(jResp,"custom_object_fields[i].raw_description")
raw_title = CkJsonObject::ckStringOf(jResp,"custom_object_fields[i].raw_title")
regexp_for_validation = CkJsonObject::ckStringOf(jResp,"custom_object_fields[i].regexp_for_validation")
relationship_target_type = CkJsonObject::ckStringOf(jResp,"custom_object_fields[i].relationship_target_type")
system = CkJsonObject::ckStringOf(jResp,"custom_object_fields[i].system")
tag = CkJsonObject::ckStringOf(jResp,"custom_object_fields[i].tag")
updated_at = CkJsonObject::ckStringOf(jResp,"custom_object_fields[i].updated_at")
url = CkJsonObject::ckStringOf(jResp,"custom_object_fields[i].url")
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"custom_object_fields[i].custom_field_options")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
name = CkJsonObject::ckStringOf(jResp,"custom_object_fields[i].custom_field_options[j].name")
value = CkJsonObject::ckStringOf(jResp,"custom_object_fields[i].custom_field_options[j].value")
id = CkJsonObject::ckStringOf(jResp,"custom_object_fields[i].custom_field_options[j].id")
position = CkJsonObject::ckStringOf(jResp,"custom_object_fields[i].custom_field_options[j].position")
raw_name = CkJsonObject::ckStringOf(jResp,"custom_object_fields[i].custom_field_options[j].raw_name")
url = CkJsonObject::ckStringOf(jResp,"custom_object_fields[i].custom_field_options[j].url")
j = j + 1
Wend
i = i + 1
Wend
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
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}"
}
]
}
