Chilkat Online Tools

TCL / Support API / Update View

Back to Collection Items

load ./chilkat.dll

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

set http [new_CkHttp]

CkHttp_put_BasicAuth $http 1
CkHttp_put_Login $http "login"
CkHttp_put_Password $http "password"

CkHttp_SetRequestHeader $http "Accept" "application/json"

# resp is a CkHttpResponse
set resp [CkHttp_QuickRequest $http "PUT" "https://example.zendesk.com/api/v2/views/:view_id"]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    exit
}

set sbResponseBody [new_CkStringBuilder]

CkHttpResponse_GetBodySb $resp $sbResponseBody

set jResp [new_CkJsonObject]

CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0

puts "Response Body:"
puts [CkJsonObject_emit $jResp]

set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
    puts "Response Header:"
    puts [CkHttpResponse_header $resp]
    puts "Failed."
    delete_CkHttpResponse $resp

    delete_CkHttp $http
    delete_CkStringBuilder $sbResponseBody
    delete_CkJsonObject $jResp
    exit
}

delete_CkHttpResponse $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

set Active [CkJsonObject_stringOf $jResp "view.active"]
set Laborum_8 [CkJsonObject_stringOf $jResp "view.conditions.laborum_8"]
set Consequata [CkJsonObject_IntOf $jResp "view.conditions.consequata"]
set Created_at [CkJsonObject_stringOf $jResp "view.created_at"]
set Default [CkJsonObject_stringOf $jResp "view.default"]
set Description [CkJsonObject_stringOf $jResp "view.description"]
set Deserunt6 [CkJsonObject_BoolOf $jResp "view.execution.deserunt6"]
set Eu7df [CkJsonObject_stringOf $jResp "view.execution.eu7df"]
set Utd70 [CkJsonObject_stringOf $jResp "view.execution.utd70"]
set Aute_03 [CkJsonObject_BoolOf $jResp "view.execution.aute_03"]
set Culpa_5b2 [CkJsonObject_IntOf $jResp "view.execution.culpa_5b2"]
set Id [CkJsonObject_stringOf $jResp "view.id"]
set Position [CkJsonObject_stringOf $jResp "view.position"]
set Exercitatione1 [CkJsonObject_stringOf $jResp "view.restriction.exercitatione1"]
set Magna_b_3 [CkJsonObject_stringOf $jResp "view.restriction.magna_b_3"]
set Title [CkJsonObject_stringOf $jResp "view.title"]
set Updated_at [CkJsonObject_stringOf $jResp "view.updated_at"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "columns"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set Duis8 [CkJsonObject_IntOf $jResp "columns[i].Duis8"]
    set ullamco_0 [CkJsonObject_stringOf $jResp "columns[i].ullamco_0"]
    set officia_13e [CkJsonObject_IntOf $jResp "columns[i].officia_13e"]
    set ipsum_7 [CkJsonObject_stringOf $jResp "columns[i].ipsum_7"]
    set in_a8 [CkJsonObject_BoolOf $jResp "columns[i].in_a8"]
    set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "groups"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set laborum_a27 [CkJsonObject_BoolOf $jResp "groups[i].laborum_a27"]
    set ea85c [CkJsonObject_stringOf $jResp "groups[i].ea85c"]
    set occaecat_04 [CkJsonObject_IntOf $jResp "groups[i].occaecat_04"]
    set qui82a [CkJsonObject_stringOf $jResp "groups[i].qui82a"]
    set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "rows"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set velit21 [CkJsonObject_IntOf $jResp "rows[i].velit21"]
    set ex_f [CkJsonObject_stringOf $jResp "rows[i].ex_f"]
    set Excepteur_92 [CkJsonObject_stringOf $jResp "rows[i].Excepteur_92"]
    set cillum4 [CkJsonObject_IntOf $jResp "rows[i].cillum4"]
    set i [expr $i + 1]
}

delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $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}"
    }
  ]
}