PureBasic / Support API / Create Custom Object Field
Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.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")
; Use this online tool to generate code from sample JSON: Generate Code to Create JSON
; The following JSON is sent in the request body.
; {
; "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>"
; }
; }
json.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(json,"custom_object_field.key","<string>")
CkJsonObject::ckUpdateString(json,"custom_object_field.type","<string>")
CkJsonObject::ckUpdateString(json,"custom_object_field.title","<string>")
CkJsonObject::ckUpdateString(json,"custom_object_field.active","<boolean>")
CkJsonObject::ckUpdateString(json,"custom_object_field.created_at","<dateTime>")
CkJsonObject::ckUpdateString(json,"custom_object_field.custom_field_options[0].name","<string>")
CkJsonObject::ckUpdateString(json,"custom_object_field.custom_field_options[0].value","<string>")
CkJsonObject::ckUpdateString(json,"custom_object_field.custom_field_options[0].id","<integer>")
CkJsonObject::ckUpdateString(json,"custom_object_field.custom_field_options[0].position","<integer>")
CkJsonObject::ckUpdateString(json,"custom_object_field.custom_field_options[0].raw_name","<string>")
CkJsonObject::ckUpdateString(json,"custom_object_field.custom_field_options[0].url","<string>")
CkJsonObject::ckUpdateString(json,"custom_object_field.custom_field_options[1].name","<string>")
CkJsonObject::ckUpdateString(json,"custom_object_field.custom_field_options[1].value","<string>")
CkJsonObject::ckUpdateString(json,"custom_object_field.custom_field_options[1].id","<integer>")
CkJsonObject::ckUpdateString(json,"custom_object_field.custom_field_options[1].position","<integer>")
CkJsonObject::ckUpdateString(json,"custom_object_field.custom_field_options[1].raw_name","<string>")
CkJsonObject::ckUpdateString(json,"custom_object_field.custom_field_options[1].url","<string>")
CkJsonObject::ckUpdateString(json,"custom_object_field.description","<string>")
CkJsonObject::ckUpdateString(json,"custom_object_field.id","<integer>")
CkJsonObject::ckUpdateString(json,"custom_object_field.position","<integer>")
CkJsonObject::ckUpdateString(json,"custom_object_field.raw_description","<string>")
CkJsonObject::ckUpdateString(json,"custom_object_field.raw_title","<string>")
CkJsonObject::ckUpdateString(json,"custom_object_field.regexp_for_validation","<string>")
CkJsonObject::ckUpdateNewObject(json,"custom_object_field.relationship_filter")
CkJsonObject::ckUpdateString(json,"custom_object_field.relationship_target_type","<string>")
CkJsonObject::ckUpdateString(json,"custom_object_field.system","<boolean>")
CkJsonObject::ckUpdateString(json,"custom_object_field.tag","<string>")
CkJsonObject::ckUpdateString(json,"custom_object_field.updated_at","<dateTime>")
CkJsonObject::ckUpdateString(json,"custom_object_field.url","<string>")
CkHttp::ckSetRequestHeader(http,"Content-Type","application/json")
CkHttp::ckSetRequestHeader(http,"Accept","application/json")
resp.i = CkHttp::ckPostJson3(http,"https://example.zendesk.com/api/v2/custom_objects/:custom_object_key/fields","application/json",json)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
ProcedureReturn
EndIf
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHttpResponse::ckGetBodySb(resp,sbResponseBody)
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 = CkHttpResponse::ckStatusCode(resp)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttpResponse::ckHeader(resp)
Debug "Failed."
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
CkHttpResponse::ckDispose(resp)
; 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
name.s
value.s
id.s
position.s
raw_name.s
url.s
Key.s = CkJsonObject::ckStringOf(jResp,"custom_object_field.key")
v_Type.s = CkJsonObject::ckStringOf(jResp,"custom_object_field.type")
Title.s = CkJsonObject::ckStringOf(jResp,"custom_object_field.title")
Active.s = CkJsonObject::ckStringOf(jResp,"custom_object_field.active")
Created_at.s = CkJsonObject::ckStringOf(jResp,"custom_object_field.created_at")
Description.s = CkJsonObject::ckStringOf(jResp,"custom_object_field.description")
Id.s = CkJsonObject::ckStringOf(jResp,"custom_object_field.id")
Position.s = CkJsonObject::ckStringOf(jResp,"custom_object_field.position")
Raw_description.s = CkJsonObject::ckStringOf(jResp,"custom_object_field.raw_description")
Raw_title.s = CkJsonObject::ckStringOf(jResp,"custom_object_field.raw_title")
Regexp_for_validation.s = CkJsonObject::ckStringOf(jResp,"custom_object_field.regexp_for_validation")
Relationship_target_type.s = CkJsonObject::ckStringOf(jResp,"custom_object_field.relationship_target_type")
System.s = CkJsonObject::ckStringOf(jResp,"custom_object_field.system")
Tag.s = CkJsonObject::ckStringOf(jResp,"custom_object_field.tag")
Updated_at.s = CkJsonObject::ckStringOf(jResp,"custom_object_field.updated_at")
v_Url.s = CkJsonObject::ckStringOf(jResp,"custom_object_field.url")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"custom_object_field.custom_field_options")
While i < count_i
CkJsonObject::setCkI(jResp, i)
name = CkJsonObject::ckStringOf(jResp,"custom_object_field.custom_field_options[i].name")
value = CkJsonObject::ckStringOf(jResp,"custom_object_field.custom_field_options[i].value")
id = CkJsonObject::ckStringOf(jResp,"custom_object_field.custom_field_options[i].id")
position = CkJsonObject::ckStringOf(jResp,"custom_object_field.custom_field_options[i].position")
raw_name = CkJsonObject::ckStringOf(jResp,"custom_object_field.custom_field_options[i].raw_name")
url = CkJsonObject::ckStringOf(jResp,"custom_object_field.custom_field_options[i].url")
i = i + 1
Wend
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
Curl Command
curl -u login:password -X POST
-H "Content-Type: application/json"
-H "Accept: application/json"
-d '{
"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>"
}
}'
https://example.zendesk.com/api/v2/custom_objects/:custom_object_key/fields
Postman Collection Item JSON
{
"name": "Create Custom Object Field",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\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}",
"options": {
"raw": {
"headerFamily": "json",
"language": "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": "Creates any of the following custom field types:\n\n* text (default when no \"type\" is specified)\n* textarea\n* checkbox\n* date\n* integer\n* decimal\n* regexp\n* dropdown\n* lookup\n\nSee [About custom field types](https://support.zendesk.com/hc/en-us/articles/203661866) in Zendesk help.\n\n#### Allowed For\n\n* Admins\n"
},
"response": [
{
"name": "Created",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"body": {
"mode": "raw",
"raw": "{\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}",
"options": {
"raw": {
"headerFamily": "json",
"language": "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"
}
]
}
},
"status": "Created",
"code": 201,
"_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}"
}
]
}
