Foxpro / Support API / Create Custom Object Record
Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loJson
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcName
LOCAL lcCreated_at
LOCAL lcCreated_by_user_id
LOCAL lcDo8
LOCAL lcAdipisicing_e
LOCAL lcCommodo0
LOCAL lcSunta4
LOCAL lcCustom_object_key
LOCAL lcExternal_id
LOCAL lcId
LOCAL lcUpdated_at
LOCAL lcUpdated_by_user_id
LOCAL lcV_Url
* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.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_record": {
* "name": "<string>",
* "created_at": "<dateTime>",
* "created_by_user_id": "<string>",
* "custom_object_fields": {
* "do8": "<string>",
* "adipisicing_e": "<string>",
* "commodo0": "<string>",
* "sunta4": "<string>"
* },
* "custom_object_key": "<string>",
* "external_id": "<string>",
* "id": "<string>",
* "updated_at": "<dateTime>",
* "updated_by_user_id": "<string>",
* "url": "<string>"
* }
* }
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJson = CreateObject('Chilkat.JsonObject')
loJson.UpdateString("custom_object_record.name","<string>")
loJson.UpdateString("custom_object_record.created_at","<dateTime>")
loJson.UpdateString("custom_object_record.created_by_user_id","<string>")
loJson.UpdateString("custom_object_record.custom_object_fields.do8","<string>")
loJson.UpdateString("custom_object_record.custom_object_fields.adipisicing_e","<string>")
loJson.UpdateString("custom_object_record.custom_object_fields.commodo0","<string>")
loJson.UpdateString("custom_object_record.custom_object_fields.sunta4","<string>")
loJson.UpdateString("custom_object_record.custom_object_key","<string>")
loJson.UpdateString("custom_object_record.external_id","<string>")
loJson.UpdateString("custom_object_record.id","<string>")
loJson.UpdateString("custom_object_record.updated_at","<dateTime>")
loJson.UpdateString("custom_object_record.updated_by_user_id","<string>")
loJson.UpdateString("custom_object_record.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/records","application/json",loJson)
IF (loHttp.LastMethodSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
RELEASE loJson
CANCEL
ENDIF
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
loResp.GetBodySb(loSbResponseBody)
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.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_record": {
* "name": "<string>",
* "created_at": "<dateTime>",
* "created_by_user_id": "<string>",
* "custom_object_fields": {
* "do8": "<string>",
* "adipisicing_e": "<string>",
* "commodo0": "<string>",
* "sunta4": "<string>"
* },
* "custom_object_key": "<string>",
* "external_id": "<string>",
* "id": "<string>",
* "updated_at": "<dateTime>",
* "updated_by_user_id": "<string>",
* "url": "<string>"
* }
* }
* Sample code for parsing the JSON response...
* Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
lcName = loJResp.StringOf("custom_object_record.name")
lcCreated_at = loJResp.StringOf("custom_object_record.created_at")
lcCreated_by_user_id = loJResp.StringOf("custom_object_record.created_by_user_id")
lcDo8 = loJResp.StringOf("custom_object_record.custom_object_fields.do8")
lcAdipisicing_e = loJResp.StringOf("custom_object_record.custom_object_fields.adipisicing_e")
lcCommodo0 = loJResp.StringOf("custom_object_record.custom_object_fields.commodo0")
lcSunta4 = loJResp.StringOf("custom_object_record.custom_object_fields.sunta4")
lcCustom_object_key = loJResp.StringOf("custom_object_record.custom_object_key")
lcExternal_id = loJResp.StringOf("custom_object_record.external_id")
lcId = loJResp.StringOf("custom_object_record.id")
lcUpdated_at = loJResp.StringOf("custom_object_record.updated_at")
lcUpdated_by_user_id = loJResp.StringOf("custom_object_record.updated_by_user_id")
lcV_Url = loJResp.StringOf("custom_object_record.url")
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_record": {
"name": "<string>",
"created_at": "<dateTime>",
"created_by_user_id": "<string>",
"custom_object_fields": {
"do8": "<string>",
"adipisicing_e": "<string>",
"commodo0": "<string>",
"sunta4": "<string>"
},
"custom_object_key": "<string>",
"external_id": "<string>",
"id": "<string>",
"updated_at": "<dateTime>",
"updated_by_user_id": "<string>",
"url": "<string>"
}
}'
https://example.zendesk.com/api/v2/custom_objects/:custom_object_key/records
Postman Collection Item JSON
{
"name": "Create Custom Object Record",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"custom_object_record\": {\n \"name\": \"<string>\",\n \"created_at\": \"<dateTime>\",\n \"created_by_user_id\": \"<string>\",\n \"custom_object_fields\": {\n \"do8\": \"<string>\",\n \"adipisicing_e\": \"<string>\",\n \"commodo0\": \"<string>\",\n \"sunta4\": \"<string>\"\n },\n \"custom_object_key\": \"<string>\",\n \"external_id\": \"<string>\",\n \"id\": \"<string>\",\n \"updated_at\": \"<dateTime>\",\n \"updated_by_user_id\": \"<string>\",\n \"url\": \"<string>\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/custom_objects/:custom_object_key/records",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"custom_objects",
":custom_object_key",
"records"
],
"variable": [
{
"key": "custom_object_key",
"value": "<string>"
}
]
},
"description": "Creates a custom object record according to all the properties described by a custom object definition\n\n#### Allowed For\n\n* Agents\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_record\": {\n \"name\": \"<string>\",\n \"created_at\": \"<dateTime>\",\n \"created_by_user_id\": \"<string>\",\n \"custom_object_fields\": {\n \"do8\": \"<string>\",\n \"adipisicing_e\": \"<string>\",\n \"commodo0\": \"<string>\",\n \"sunta4\": \"<string>\"\n },\n \"custom_object_key\": \"<string>\",\n \"external_id\": \"<string>\",\n \"id\": \"<string>\",\n \"updated_at\": \"<dateTime>\",\n \"updated_by_user_id\": \"<string>\",\n \"url\": \"<string>\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/custom_objects/:custom_object_key/records",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"custom_objects",
":custom_object_key",
"records"
],
"variable": [
{
"key": "custom_object_key"
}
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"custom_object_record\": {\n \"name\": \"<string>\",\n \"created_at\": \"<dateTime>\",\n \"created_by_user_id\": \"<string>\",\n \"custom_object_fields\": {\n \"do8\": \"<string>\",\n \"adipisicing_e\": \"<string>\",\n \"commodo0\": \"<string>\",\n \"sunta4\": \"<string>\"\n },\n \"custom_object_key\": \"<string>\",\n \"external_id\": \"<string>\",\n \"id\": \"<string>\",\n \"updated_at\": \"<dateTime>\",\n \"updated_by_user_id\": \"<string>\",\n \"url\": \"<string>\"\n }\n}"
}
]
}
