Chilkat Online Tools

unicodeC / Support API / Update View

Back to Collection Items

#include <C_CkHttpW.h>
#include <C_CkHttpResponseW.h>
#include <C_CkStringBuilderW.h>
#include <C_CkJsonObjectW.h>

void ChilkatSample(void)
    {
    HCkHttpW http;
    BOOL success;
    HCkHttpResponseW resp;
    HCkStringBuilderW sbResponseBody;
    HCkJsonObjectW jResp;
    int respStatusCode;
    int Duis8;
    const wchar_t *ullamco_0;
    int officia_13e;
    const wchar_t *ipsum_7;
    BOOL in_a8;
    BOOL laborum_a27;
    const wchar_t *ea85c;
    int occaecat_04;
    const wchar_t *qui82a;
    int velit21;
    const wchar_t *ex_f;
    const wchar_t *Excepteur_92;
    int cillum4;
    const wchar_t *Active;
    const wchar_t *Laborum_8;
    int Consequata;
    const wchar_t *Created_at;
    const wchar_t *Default;
    const wchar_t *Description;
    BOOL Deserunt6;
    const wchar_t *Eu7df;
    const wchar_t *Utd70;
    BOOL Aute_03;
    int Culpa_5b2;
    const wchar_t *Id;
    const wchar_t *Position;
    const wchar_t *Exercitatione1;
    const wchar_t *Magna_b_3;
    const wchar_t *Title;
    const wchar_t *Updated_at;
    int i;
    int count_i;

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

    http = CkHttpW_Create();

    CkHttpW_putBasicAuth(http,TRUE);
    CkHttpW_putLogin(http,L"login");
    CkHttpW_putPassword(http,L"password");

    CkHttpW_SetRequestHeader(http,L"Accept",L"application/json");

    resp = CkHttpW_QuickRequest(http,L"PUT",L"https://example.zendesk.com/api/v2/views/:view_id");
    if (CkHttpW_getLastMethodSuccess(http) == FALSE) {
        wprintf(L"%s\n",CkHttpW_lastErrorText(http));
        CkHttpW_Dispose(http);
        return;
    }

    sbResponseBody = CkStringBuilderW_Create();
    CkHttpResponseW_GetBodySb(resp,sbResponseBody);

    jResp = CkJsonObjectW_Create();
    CkJsonObjectW_LoadSb(jResp,sbResponseBody);
    CkJsonObjectW_putEmitCompact(jResp,FALSE);

    wprintf(L"Response Body:\n");
    wprintf(L"%s\n",CkJsonObjectW_emit(jResp));

    respStatusCode = CkHttpResponseW_getStatusCode(resp);
    wprintf(L"Response Status Code = %d\n",respStatusCode);
    if (respStatusCode >= 400) {
        wprintf(L"Response Header:\n");
        wprintf(L"%s\n",CkHttpResponseW_header(resp));
        wprintf(L"Failed.\n");
        CkHttpResponseW_Dispose(resp);
        CkHttpW_Dispose(http);
        CkStringBuilderW_Dispose(sbResponseBody);
        CkJsonObjectW_Dispose(jResp);
        return;
    }

    CkHttpResponseW_Dispose(resp);

    // Sample JSON response:
    // (Sample code for parsing the JSON response is shown below)

    // {
    //   "columns": [
    //     {
    //       "Duis8": -59589120,
    //       "ullamco_0": "Ut nostrud qui elit dolor"
    //     },
    //     {
    //       "officia_13e": -39842370,
    //       "ipsum_7": "sunt",
    //       "in_a8": true
    //     }
    //   ],
    //   "groups": [
    //     {
    //       "laborum_a27": false
    //     },
    //     {
    //       "ea85c": 69952708.53230786,
    //       "occaecat_04": 58869893,
    //       "qui82a": "L"
    //     }
    //   ],
    //   "rows": [
    //     {
    //       "velit21": -89119970
    //     },
    //     {
    //       "ex_f": 92255473.59295204,
    //       "Excepteur_92": "sunt",
    //       "cillum4": 24641748
    //     }
    //   ],
    //   "view": {
    //     "active": "<boolean>",
    //     "conditions": {
    //       "laborum_8": 404871.0763479173,
    //       "consequata": -40432952
    //     },
    //     "created_at": "<dateTime>",
    //     "default": "<boolean>",
    //     "description": "<string>",
    //     "execution": {
    //       "deserunt6": false,
    //       "eu7df": "veniam",
    //       "utd70": -40480339.58192083,
    //       "aute_03": true,
    //       "culpa_5b2": -78225658
    //     },
    //     "id": "<integer>",
    //     "position": "<integer>",
    //     "restriction": {
    //       "exercitatione1": "in",
    //       "magna_b_3": -90768253.5149942
    //     },
    //     "title": "<string>",
    //     "updated_at": "<dateTime>"
    //   }
    // }

    // Sample code for parsing the JSON response...
    // Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

    // Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.

    Active = CkJsonObjectW_stringOf(jResp,L"view.active");
    Laborum_8 = CkJsonObjectW_stringOf(jResp,L"view.conditions.laborum_8");
    Consequata = CkJsonObjectW_IntOf(jResp,L"view.conditions.consequata");
    Created_at = CkJsonObjectW_stringOf(jResp,L"view.created_at");
    Default = CkJsonObjectW_stringOf(jResp,L"view.default");
    Description = CkJsonObjectW_stringOf(jResp,L"view.description");
    Deserunt6 = CkJsonObjectW_BoolOf(jResp,L"view.execution.deserunt6");
    Eu7df = CkJsonObjectW_stringOf(jResp,L"view.execution.eu7df");
    Utd70 = CkJsonObjectW_stringOf(jResp,L"view.execution.utd70");
    Aute_03 = CkJsonObjectW_BoolOf(jResp,L"view.execution.aute_03");
    Culpa_5b2 = CkJsonObjectW_IntOf(jResp,L"view.execution.culpa_5b2");
    Id = CkJsonObjectW_stringOf(jResp,L"view.id");
    Position = CkJsonObjectW_stringOf(jResp,L"view.position");
    Exercitatione1 = CkJsonObjectW_stringOf(jResp,L"view.restriction.exercitatione1");
    Magna_b_3 = CkJsonObjectW_stringOf(jResp,L"view.restriction.magna_b_3");
    Title = CkJsonObjectW_stringOf(jResp,L"view.title");
    Updated_at = CkJsonObjectW_stringOf(jResp,L"view.updated_at");
    i = 0;
    count_i = CkJsonObjectW_SizeOfArray(jResp,L"columns");
    while (i < count_i) {
        CkJsonObjectW_putI(jResp,i);
        Duis8 = CkJsonObjectW_IntOf(jResp,L"columns[i].Duis8");
        ullamco_0 = CkJsonObjectW_stringOf(jResp,L"columns[i].ullamco_0");
        officia_13e = CkJsonObjectW_IntOf(jResp,L"columns[i].officia_13e");
        ipsum_7 = CkJsonObjectW_stringOf(jResp,L"columns[i].ipsum_7");
        in_a8 = CkJsonObjectW_BoolOf(jResp,L"columns[i].in_a8");
        i = i + 1;
    }

    i = 0;
    count_i = CkJsonObjectW_SizeOfArray(jResp,L"groups");
    while (i < count_i) {
        CkJsonObjectW_putI(jResp,i);
        laborum_a27 = CkJsonObjectW_BoolOf(jResp,L"groups[i].laborum_a27");
        ea85c = CkJsonObjectW_stringOf(jResp,L"groups[i].ea85c");
        occaecat_04 = CkJsonObjectW_IntOf(jResp,L"groups[i].occaecat_04");
        qui82a = CkJsonObjectW_stringOf(jResp,L"groups[i].qui82a");
        i = i + 1;
    }

    i = 0;
    count_i = CkJsonObjectW_SizeOfArray(jResp,L"rows");
    while (i < count_i) {
        CkJsonObjectW_putI(jResp,i);
        velit21 = CkJsonObjectW_IntOf(jResp,L"rows[i].velit21");
        ex_f = CkJsonObjectW_stringOf(jResp,L"rows[i].ex_f");
        Excepteur_92 = CkJsonObjectW_stringOf(jResp,L"rows[i].Excepteur_92");
        cillum4 = CkJsonObjectW_IntOf(jResp,L"rows[i].cillum4");
        i = i + 1;
    }



    CkHttpW_Dispose(http);
    CkStringBuilderW_Dispose(sbResponseBody);
    CkJsonObjectW_Dispose(jResp);

    }

Curl Command

curl  -u login:password -X PUT
	-H "Accept: application/json"
https://example.zendesk.com/api/v2/views/:view_id

Postman Collection Item JSON

{
  "name": "Update View",
  "request": {
    "method": "PUT",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/views/:view_id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "views",
        ":view_id"
      ],
      "variable": [
        {
          "key": "view_id",
          "value": "<integer>"
        }
      ]
    },
    "description": "#### Allowed For\n\n* Agents\n\n#### JSON Format\n\n The PUT request takes one property, a `view` object that lists the values to update. All properties are optional.\n\n**Note**: Updating a condition updates the containing array, clearing the other conditions. Include all your conditions when updating any condition.\n\n| Name        | Description\n| ----------- | -----------\n| title       | The title of the view\n| all         | An array of one or more conditions. A ticket must meet all the conditions to be included in the view. The PUT request replaces all existing conditions. See [Conditions reference](/documentation/ticketing/reference-guides/conditions-reference)\n| any         | An array of one or more conditions. A ticket must meet any of them to be included in the view. At least one `all` condition must be defined with the `any` conditions. The PUT request replaces all existing `any` conditions. See [Conditions reference](/documentation/ticketing/reference-guides/conditions-reference)\n| active      | Allowed values are true or false. Determines if the view is displayed or not\n| output      | An object that specifies the columns to display. Example: `\"output\": {\"columns\": [\"status\", \"description,\" \"priority\"]}`. See [View columns](#view-columns)\n| restriction | An object that describes who can access the view. To give all agents access to the view, omit this property\n\nThe `restriction` object has the following properties.\n\n| Name | Comment\n| ---- | -------\n| type | Allowed values are \"Group\" or \"User\"\n| id   | The numeric ID of a single group or user\n| ids  | The numeric IDs of a single or more groups. Recommended for \"Group\" `type`\n\nIf `type` is \"Group\", the `ids` property is the preferred method of specifying the group id or ids.\n\nYou can also update how items are sorted and grouped. See [View sorting](#view-sorting) in Create View.\n\n#### Example Request Body\n\n```js\n{\n  \"view\": {\n    \"title\": \"Code red tickets\",\n    \"restriction\": {\n      \"type\": \"Group\",\n      \"ids\": [10052, 10057, 10062, 10002]\n    },\n    \"all\": [\n      {\n        \"field\": \"priority\",\n        \"operator\": \"is\",\n        \"value\": \"urgent\"\n      }\n    ],\n    \"output\": {\n      \"columns\": [\"status\", \"requester\", \"assignee\", \"updated\"]\n    }\n  }\n}\n```\n"
  },
  "response": [
    {
      "name": "Success response",
      "originalRequest": {
        "method": "PUT",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v2/views/:view_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "views",
            ":view_id"
          ],
          "variable": [
            {
              "key": "view_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"columns\": [\n    {\n      \"Duis8\": -59589120,\n      \"ullamco_0\": \"Ut nostrud qui elit dolor\"\n    },\n    {\n      \"officia_13e\": -39842370,\n      \"ipsum_7\": \"sunt\",\n      \"in_a8\": true\n    }\n  ],\n  \"groups\": [\n    {\n      \"laborum_a27\": false\n    },\n    {\n      \"ea85c\": 69952708.53230786,\n      \"occaecat_04\": 58869893,\n      \"qui82a\": \"L\"\n    }\n  ],\n  \"rows\": [\n    {\n      \"velit21\": -89119970\n    },\n    {\n      \"ex_f\": 92255473.59295204,\n      \"Excepteur_92\": \"sunt\",\n      \"cillum4\": 24641748\n    }\n  ],\n  \"view\": {\n    \"active\": \"<boolean>\",\n    \"conditions\": {\n      \"laborum_8\": 404871.0763479173,\n      \"consequata\": -40432952\n    },\n    \"created_at\": \"<dateTime>\",\n    \"default\": \"<boolean>\",\n    \"description\": \"<string>\",\n    \"execution\": {\n      \"deserunt6\": false,\n      \"eu7df\": \"veniam\",\n      \"utd70\": -40480339.58192083,\n      \"aute_03\": true,\n      \"culpa_5b2\": -78225658\n    },\n    \"id\": \"<integer>\",\n    \"position\": \"<integer>\",\n    \"restriction\": {\n      \"exercitatione1\": \"in\",\n      \"magna_b_3\": -90768253.5149942\n    },\n    \"title\": \"<string>\",\n    \"updated_at\": \"<dateTime>\"\n  }\n}"
    }
  ]
}