PowerBuilder / Support API / Update Custom Object Record
Back to Collection Items
integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_Resp
oleobject loo_SbResponseBody
oleobject loo_JResp
integer li_RespStatusCode
string ls_Name
string ls_Created_at
string ls_Created_by_user_id
string ls_Do8
string ls_Adipisicing_e
string ls_Commodo0
string ls_Sunta4
string ls_Custom_object_key
string ls_External_id
string ls_Id
string ls_Updated_at
string ls_Updated_by_user_id
string ls_V_Url
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loo_Http = create oleobject
// Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
li_rc = loo_Http.ConnectToNewObject("Chilkat.Http")
if li_rc < 0 then
destroy loo_Http
MessageBox("Error","Connecting to COM object failed")
return
end if
loo_Http.BasicAuth = 1
loo_Http.Login = "login"
loo_Http.Password = "password"
loo_Http.SetRequestHeader("Accept","application/json")
loo_Resp = loo_Http.QuickRequest("PATCH","https://example.zendesk.com/api/v2/custom_objects/:custom_object_key/records/:custom_object_record_id")
if loo_Http.LastMethodSuccess = 0 then
Write-Debug loo_Http.LastErrorText
destroy loo_Http
return
end if
loo_SbResponseBody = create oleobject
// Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat.StringBuilder")
loo_Resp.GetBodySb(loo_SbResponseBody)
loo_JResp = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_JResp.ConnectToNewObject("Chilkat.JsonObject")
loo_JResp.LoadSb(loo_SbResponseBody)
loo_JResp.EmitCompact = 0
Write-Debug "Response Body:"
Write-Debug loo_JResp.Emit()
li_RespStatusCode = loo_Resp.StatusCode
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_RespStatusCode >= 400 then
Write-Debug "Response Header:"
Write-Debug loo_Resp.Header
Write-Debug "Failed."
destroy loo_Resp
destroy loo_Http
destroy loo_SbResponseBody
destroy loo_JResp
return
end if
destroy loo_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
ls_Name = loo_JResp.StringOf("custom_object_record.name")
ls_Created_at = loo_JResp.StringOf("custom_object_record.created_at")
ls_Created_by_user_id = loo_JResp.StringOf("custom_object_record.created_by_user_id")
ls_Do8 = loo_JResp.StringOf("custom_object_record.custom_object_fields.do8")
ls_Adipisicing_e = loo_JResp.StringOf("custom_object_record.custom_object_fields.adipisicing_e")
ls_Commodo0 = loo_JResp.StringOf("custom_object_record.custom_object_fields.commodo0")
ls_Sunta4 = loo_JResp.StringOf("custom_object_record.custom_object_fields.sunta4")
ls_Custom_object_key = loo_JResp.StringOf("custom_object_record.custom_object_key")
ls_External_id = loo_JResp.StringOf("custom_object_record.external_id")
ls_Id = loo_JResp.StringOf("custom_object_record.id")
ls_Updated_at = loo_JResp.StringOf("custom_object_record.updated_at")
ls_Updated_by_user_id = loo_JResp.StringOf("custom_object_record.updated_by_user_id")
ls_V_Url = loo_JResp.StringOf("custom_object_record.url")
destroy loo_Http
destroy loo_SbResponseBody
destroy loo_JResp
Curl Command
curl -u login:password -X PATCH
-H "Accept: application/json"
https://example.zendesk.com/api/v2/custom_objects/:custom_object_key/records/:custom_object_record_id
Postman Collection Item JSON
{
"name": "Update Custom Object Record",
"request": {
"method": "PATCH",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/custom_objects/:custom_object_key/records/:custom_object_record_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"custom_objects",
":custom_object_key",
"records",
":custom_object_record_id"
],
"variable": [
{
"key": "custom_object_key",
"value": "<string>"
},
{
"key": "custom_object_record_id",
"value": "<string>"
}
]
},
"description": "Updates an individual custom object record. The updating rules are as follows:\n* Takes a `custom_object_record` object that specifies the properties to update\n* The custom object fields should be nested inside a `custom_object_fields` object\n#### Allowed For\n* Agents"
},
"response": [
{
"name": "Success response",
"originalRequest": {
"method": "PATCH",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/custom_objects/:custom_object_key/records/:custom_object_record_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"custom_objects",
":custom_object_key",
"records",
":custom_object_record_id"
],
"variable": [
{
"key": "custom_object_key"
},
{
"key": "custom_object_record_id"
}
]
}
},
"status": "OK",
"code": 200,
"_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}"
}
]
}
