Chilkat Online Tools

delphiDll / Support API / Update Attribute Value

Back to Collection Items

var
http: HCkHttp;
success: Boolean;
resp: HCkHttpResponse;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
Attribute_id: PWideChar;
Created_at: PWideChar;
Id: PWideChar;
Name: PWideChar;
Updated_at: 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');

CkHttp_SetRequestHeader(http,'Accept','application/json');

resp := CkHttp_QuickRequest(http,'PATCH','https://example.zendesk.com/api/v2/routing/attributes/:attribute_id/values/:attribute_value_id');
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)

// {
//   "attribute_value": {
//     "attribute_id": "<string>",
//     "created_at": "<dateTime>",
//     "id": "<string>",
//     "name": "<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

Attribute_id := CkJsonObject__stringOf(jResp,'attribute_value.attribute_id');
Created_at := CkJsonObject__stringOf(jResp,'attribute_value.created_at');
Id := CkJsonObject__stringOf(jResp,'attribute_value.id');
Name := CkJsonObject__stringOf(jResp,'attribute_value.name');
Updated_at := CkJsonObject__stringOf(jResp,'attribute_value.updated_at');
v_Url := CkJsonObject__stringOf(jResp,'attribute_value.url');

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

Curl Command

curl  -u login:password -X PATCH
	-H "Accept: application/json"
https://example.zendesk.com/api/v2/routing/attributes/:attribute_id/values/:attribute_value_id

Postman Collection Item JSON

{
  "name": "Update Attribute Value",
  "request": {
    "method": "PATCH",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/routing/attributes/:attribute_id/values/:attribute_value_id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "routing",
        "attributes",
        ":attribute_id",
        "values",
        ":attribute_value_id"
      ],
      "variable": [
        {
          "key": "attribute_id",
          "value": "<string>"
        },
        {
          "key": "attribute_value_id",
          "value": "<string>"
        }
      ]
    },
    "description": "Updates an attribute value.\n\n#### Allowed For\n\n* Admins\n"
  },
  "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/routing/attributes/:attribute_id/values/:attribute_value_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "routing",
            "attributes",
            ":attribute_id",
            "values",
            ":attribute_value_id"
          ],
          "variable": [
            {
              "key": "attribute_id"
            },
            {
              "key": "attribute_value_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"attribute_value\": {\n    \"attribute_id\": \"<string>\",\n    \"created_at\": \"<dateTime>\",\n    \"id\": \"<string>\",\n    \"name\": \"<string>\",\n    \"updated_at\": \"<dateTime>\",\n    \"url\": \"<string>\"\n  }\n}"
    }
  ]
}