Foxpro / Support API / Create Custom Object Field
Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loJson
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcName
LOCAL lcValue
LOCAL lcId
LOCAL lcPosition
LOCAL lcRaw_name
LOCAL lcUrl
LOCAL lcKey
LOCAL lcV_Type
LOCAL lcTitle
LOCAL lcActive
LOCAL lcCreated_at
LOCAL lcDescription
LOCAL lcId
LOCAL lcPosition
LOCAL lcRaw_description
LOCAL lcRaw_title
LOCAL lcRegexp_for_validation
LOCAL lcRelationship_target_type
LOCAL lcSystem
LOCAL lcTag
LOCAL lcUpdated_at
LOCAL lcV_Url
LOCAL i
LOCAL lnCount_i
* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.
loHttp = CreateObject('Chilkat_9_5_0.Http')
loHttp.BasicAuth = 1
loHttp.Login = "login"
loHttp.Password = "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>"
* }
* }
loJson = CreateObject('Chilkat_9_5_0.JsonObject')
loJson.UpdateString("custom_object_field.key","<string>")
loJson.UpdateString("custom_object_field.type","<string>")
loJson.UpdateString("custom_object_field.title","<string>")
loJson.UpdateString("custom_object_field.active","<boolean>")
loJson.UpdateString("custom_object_field.created_at","<dateTime>")
loJson.UpdateString("custom_object_field.custom_field_options[0].name","<string>")
loJson.UpdateString("custom_object_field.custom_field_options[0].value","<string>")
loJson.UpdateString("custom_object_field.custom_field_options[0].id","<integer>")
loJson.UpdateString("custom_object_field.custom_field_options[0].position","<integer>")
loJson.UpdateString("custom_object_field.custom_field_options[0].raw_name","<string>")
loJson.UpdateString("custom_object_field.custom_field_options[0].url","<string>")
loJson.UpdateString("custom_object_field.custom_field_options[1].name","<string>")
loJson.UpdateString("custom_object_field.custom_field_options[1].value","<string>")
loJson.UpdateString("custom_object_field.custom_field_options[1].id","<integer>")
loJson.UpdateString("custom_object_field.custom_field_options[1].position","<integer>")
loJson.UpdateString("custom_object_field.custom_field_options[1].raw_name","<string>")
loJson.UpdateString("custom_object_field.custom_field_options[1].url","<string>")
loJson.UpdateString("custom_object_field.description","<string>")
loJson.UpdateString("custom_object_field.id","<integer>")
loJson.UpdateString("custom_object_field.position","<integer>")
loJson.UpdateString("custom_object_field.raw_description","<string>")
loJson.UpdateString("custom_object_field.raw_title","<string>")
loJson.UpdateString("custom_object_field.regexp_for_validation","<string>")
loJson.UpdateNewObject("custom_object_field.relationship_filter")
loJson.UpdateString("custom_object_field.relationship_target_type","<string>")
loJson.UpdateString("custom_object_field.system","<boolean>")
loJson.UpdateString("custom_object_field.tag","<string>")
loJson.UpdateString("custom_object_field.updated_at","<dateTime>")
loJson.UpdateString("custom_object_field.url","<string>")
loHttp.SetRequestHeader("Content-Type","application/json")
loHttp.SetRequestHeader("Accept","application/json")
loResp = loHttp.PostJson3("https://example.zendesk.com/api/v2/custom_objects/:custom_object_key/fields","application/json",loJson)
IF (loHttp.LastMethodSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
RELEASE loJson
CANCEL
ENDIF
loSbResponseBody = CreateObject('Chilkat_9_5_0.StringBuilder')
loResp.GetBodySb(loSbResponseBody)
loJResp = CreateObject('Chilkat_9_5_0.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
? "Response Header:"
? loResp.Header
? "Failed."
RELEASE loResp
RELEASE loHttp
RELEASE loJson
RELEASE loSbResponseBody
RELEASE loJResp
CANCEL
ENDIF
RELEASE loResp
* 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
lcKey = loJResp.StringOf("custom_object_field.key")
lcV_Type = loJResp.StringOf("custom_object_field.type")
lcTitle = loJResp.StringOf("custom_object_field.title")
lcActive = loJResp.StringOf("custom_object_field.active")
lcCreated_at = loJResp.StringOf("custom_object_field.created_at")
lcDescription = loJResp.StringOf("custom_object_field.description")
lcId = loJResp.StringOf("custom_object_field.id")
lcPosition = loJResp.StringOf("custom_object_field.position")
lcRaw_description = loJResp.StringOf("custom_object_field.raw_description")
lcRaw_title = loJResp.StringOf("custom_object_field.raw_title")
lcRegexp_for_validation = loJResp.StringOf("custom_object_field.regexp_for_validation")
lcRelationship_target_type = loJResp.StringOf("custom_object_field.relationship_target_type")
lcSystem = loJResp.StringOf("custom_object_field.system")
lcTag = loJResp.StringOf("custom_object_field.tag")
lcUpdated_at = loJResp.StringOf("custom_object_field.updated_at")
lcV_Url = loJResp.StringOf("custom_object_field.url")
i = 0
lnCount_i = loJResp.SizeOfArray("custom_object_field.custom_field_options")
DO WHILE i < lnCount_i
loJResp.I = i
lcName = loJResp.StringOf("custom_object_field.custom_field_options[i].name")
lcValue = loJResp.StringOf("custom_object_field.custom_field_options[i].value")
lcId = loJResp.StringOf("custom_object_field.custom_field_options[i].id")
lcPosition = loJResp.StringOf("custom_object_field.custom_field_options[i].position")
lcRaw_name = loJResp.StringOf("custom_object_field.custom_field_options[i].raw_name")
lcUrl = loJResp.StringOf("custom_object_field.custom_field_options[i].url")
i = i + 1
ENDDO
RELEASE loHttp
RELEASE loJson
RELEASE loSbResponseBody
RELEASE loJResp
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}"
}
]
}
