PureBasic / Support API / Create Custom Object Record
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_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>"
; }
; }
json.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(json,"custom_object_record.name","<string>")
CkJsonObject::ckUpdateString(json,"custom_object_record.created_at","<dateTime>")
CkJsonObject::ckUpdateString(json,"custom_object_record.created_by_user_id","<string>")
CkJsonObject::ckUpdateString(json,"custom_object_record.custom_object_fields.do8","<string>")
CkJsonObject::ckUpdateString(json,"custom_object_record.custom_object_fields.adipisicing_e","<string>")
CkJsonObject::ckUpdateString(json,"custom_object_record.custom_object_fields.commodo0","<string>")
CkJsonObject::ckUpdateString(json,"custom_object_record.custom_object_fields.sunta4","<string>")
CkJsonObject::ckUpdateString(json,"custom_object_record.custom_object_key","<string>")
CkJsonObject::ckUpdateString(json,"custom_object_record.external_id","<string>")
CkJsonObject::ckUpdateString(json,"custom_object_record.id","<string>")
CkJsonObject::ckUpdateString(json,"custom_object_record.updated_at","<dateTime>")
CkJsonObject::ckUpdateString(json,"custom_object_record.updated_by_user_id","<string>")
CkJsonObject::ckUpdateString(json,"custom_object_record.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/records","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_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
Name.s = CkJsonObject::ckStringOf(jResp,"custom_object_record.name")
Created_at.s = CkJsonObject::ckStringOf(jResp,"custom_object_record.created_at")
Created_by_user_id.s = CkJsonObject::ckStringOf(jResp,"custom_object_record.created_by_user_id")
Do8.s = CkJsonObject::ckStringOf(jResp,"custom_object_record.custom_object_fields.do8")
Adipisicing_e.s = CkJsonObject::ckStringOf(jResp,"custom_object_record.custom_object_fields.adipisicing_e")
Commodo0.s = CkJsonObject::ckStringOf(jResp,"custom_object_record.custom_object_fields.commodo0")
Sunta4.s = CkJsonObject::ckStringOf(jResp,"custom_object_record.custom_object_fields.sunta4")
Custom_object_key.s = CkJsonObject::ckStringOf(jResp,"custom_object_record.custom_object_key")
External_id.s = CkJsonObject::ckStringOf(jResp,"custom_object_record.external_id")
Id.s = CkJsonObject::ckStringOf(jResp,"custom_object_record.id")
Updated_at.s = CkJsonObject::ckStringOf(jResp,"custom_object_record.updated_at")
Updated_by_user_id.s = CkJsonObject::ckStringOf(jResp,"custom_object_record.updated_by_user_id")
v_Url.s = CkJsonObject::ckStringOf(jResp,"custom_object_record.url")
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_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}"
}
]
}
