Ruby / Support API / Create Organization Field
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")
# resp is a CkHttpResponse
resp = http.QuickRequest("POST","https://example.zendesk.com/api/v2/organization_fields")
if (http.get_LastMethodSuccess() == false)
print http.lastErrorText() + "\n";
exit
end
sbResponseBody = Chilkat::CkStringBuilder.new()
resp.GetBodySb(sbResponseBody)
jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)
print "Response Body:" + "\n";
print jResp.emit() + "\n";
respStatusCode = resp.get_StatusCode()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
print "Response Header:" + "\n";
print resp.header() + "\n";
print "Failed." + "\n";
exit
end
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# {
# "organization_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
Key = jResp.stringOf("organization_field.key")
v_Type = jResp.stringOf("organization_field.type")
Title = jResp.stringOf("organization_field.title")
Active = jResp.stringOf("organization_field.active")
Created_at = jResp.stringOf("organization_field.created_at")
Description = jResp.stringOf("organization_field.description")
Id = jResp.stringOf("organization_field.id")
Position = jResp.stringOf("organization_field.position")
Raw_description = jResp.stringOf("organization_field.raw_description")
Raw_title = jResp.stringOf("organization_field.raw_title")
Regexp_for_validation = jResp.stringOf("organization_field.regexp_for_validation")
Relationship_target_type = jResp.stringOf("organization_field.relationship_target_type")
System = jResp.stringOf("organization_field.system")
Tag = jResp.stringOf("organization_field.tag")
Updated_at = jResp.stringOf("organization_field.updated_at")
v_Url = jResp.stringOf("organization_field.url")
i = 0
count_i = jResp.SizeOfArray("organization_field.custom_field_options")
while i < count_i
jResp.put_I(i)
name = jResp.stringOf("organization_field.custom_field_options[i].name")
value = jResp.stringOf("organization_field.custom_field_options[i].value")
id = jResp.stringOf("organization_field.custom_field_options[i].id")
position = jResp.stringOf("organization_field.custom_field_options[i].position")
raw_name = jResp.stringOf("organization_field.custom_field_options[i].raw_name")
url = jResp.stringOf("organization_field.custom_field_options[i].url")
i = i + 1
end
Curl Command
curl -u login:password -X POST
-H "Accept: application/json"
https://example.zendesk.com/api/v2/organization_fields
Postman Collection Item JSON
{
"name": "Create Organization Field",
"request": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/organization_fields",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"organization_fields"
]
},
"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 response",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/organization_fields",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"organization_fields"
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"organization_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}"
}
]
}
