Chilkat Online Tools

delphiDll / Support API / Create Custom Object Record

Back to Collection Items

var
http: HCkHttp;
success: Boolean;
json: HCkJsonObject;
resp: HCkHttpResponse;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
Name: PWideChar;
Created_at: PWideChar;
Created_by_user_id: PWideChar;
Do8: PWideChar;
Adipisicing_e: PWideChar;
Commodo0: PWideChar;
Sunta4: PWideChar;
Custom_object_key: PWideChar;
External_id: PWideChar;
Id: PWideChar;
Updated_at: PWideChar;
Updated_by_user_id: PWideChar;
v_Url: PWideChar;

begin
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

http := CkHttp_Create();

CkHttp_putBasicAuth(http,True);
CkHttp_putLogin(http,'login');
CkHttp_putPassword(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 := CkJsonObject_Create();
CkJsonObject_UpdateString(json,'custom_object_record.name','<string>');
CkJsonObject_UpdateString(json,'custom_object_record.created_at','<dateTime>');
CkJsonObject_UpdateString(json,'custom_object_record.created_by_user_id','<string>');
CkJsonObject_UpdateString(json,'custom_object_record.custom_object_fields.do8','<string>');
CkJsonObject_UpdateString(json,'custom_object_record.custom_object_fields.adipisicing_e','<string>');
CkJsonObject_UpdateString(json,'custom_object_record.custom_object_fields.commodo0','<string>');
CkJsonObject_UpdateString(json,'custom_object_record.custom_object_fields.sunta4','<string>');
CkJsonObject_UpdateString(json,'custom_object_record.custom_object_key','<string>');
CkJsonObject_UpdateString(json,'custom_object_record.external_id','<string>');
CkJsonObject_UpdateString(json,'custom_object_record.id','<string>');
CkJsonObject_UpdateString(json,'custom_object_record.updated_at','<dateTime>');
CkJsonObject_UpdateString(json,'custom_object_record.updated_by_user_id','<string>');
CkJsonObject_UpdateString(json,'custom_object_record.url','<string>');

CkHttp_SetRequestHeader(http,'Content-Type','application/json');
CkHttp_SetRequestHeader(http,'Accept','application/json');

resp := CkHttp_PostJson3(http,'https://example.zendesk.com/api/v2/custom_objects/:custom_object_key/records','application/json',json);
if (CkHttp_getLastMethodSuccess(http) = False) then
  begin
    Memo1.Lines.Add(CkHttp__lastErrorText(http));
    Exit;
  end;

sbResponseBody := CkStringBuilder_Create();
CkHttpResponse_GetBodySb(resp,sbResponseBody);

jResp := CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,False);

Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(CkJsonObject__emit(jResp));

respStatusCode := CkHttpResponse_getStatusCode(resp);
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
  begin
    Memo1.Lines.Add('Response Header:');
    Memo1.Lines.Add(CkHttpResponse__header(resp));
    Memo1.Lines.Add('Failed.');
    CkHttpResponse_Dispose(resp);
    Exit;
  end;
CkHttpResponse_Dispose(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 := CkJsonObject__stringOf(jResp,'custom_object_record.name');
Created_at := CkJsonObject__stringOf(jResp,'custom_object_record.created_at');
Created_by_user_id := CkJsonObject__stringOf(jResp,'custom_object_record.created_by_user_id');
Do8 := CkJsonObject__stringOf(jResp,'custom_object_record.custom_object_fields.do8');
Adipisicing_e := CkJsonObject__stringOf(jResp,'custom_object_record.custom_object_fields.adipisicing_e');
Commodo0 := CkJsonObject__stringOf(jResp,'custom_object_record.custom_object_fields.commodo0');
Sunta4 := CkJsonObject__stringOf(jResp,'custom_object_record.custom_object_fields.sunta4');
Custom_object_key := CkJsonObject__stringOf(jResp,'custom_object_record.custom_object_key');
External_id := CkJsonObject__stringOf(jResp,'custom_object_record.external_id');
Id := CkJsonObject__stringOf(jResp,'custom_object_record.id');
Updated_at := CkJsonObject__stringOf(jResp,'custom_object_record.updated_at');
Updated_by_user_id := CkJsonObject__stringOf(jResp,'custom_object_record.updated_by_user_id');
v_Url := CkJsonObject__stringOf(jResp,'custom_object_record.url');

CkHttp_Dispose(http);
CkJsonObject_Dispose(json);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);

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}"
    }
  ]
}