Chilkat Online Tools

autoit / Support API / Update View

Back to Collection Items

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

$oHttp = ObjCreate("Chilkat_9_5_0.Http")
Local $bSuccess

$oHttp.BasicAuth = True
$oHttp.Login = "login"
$oHttp.Password = "password"

$oHttp.SetRequestHeader "Accept","application/json"

Local $oResp = $oHttp.QuickRequest("PUT","https://example.zendesk.com/api/v2/views/:view_id")
If ($oHttp.LastMethodSuccess = False) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

$oSbResponseBody = ObjCreate("Chilkat_9_5_0.StringBuilder")
$oResp.GetBodySb($oSbResponseBody)

$oJResp = ObjCreate("Chilkat_9_5_0.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False

ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)

Local $iRespStatusCode = $oResp.StatusCode
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
    ConsoleWrite("Response Header:" & @CRLF)
    ConsoleWrite($oResp.Header & @CRLF)
    ConsoleWrite("Failed." & @CRLF)

    Exit
EndIf

; 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

Local $iDuis8
Local $sUllamco_0
Local $iOfficia_13e
Local $sIpsum_7
Local $bIn_a8
Local $bLaborum_a27
Local $sEa85c
Local $iOccaecat_04
Local $sQui82a
Local $iVelit21
Local $sEx_f
Local $sExcepteur_92
Local $iCillum4

Local $sActive = $oJResp.StringOf("view.active")
Local $sLaborum_8 = $oJResp.StringOf("view.conditions.laborum_8")
Local $iConsequata = $oJResp.IntOf("view.conditions.consequata")
Local $sCreated_at = $oJResp.StringOf("view.created_at")
Local $sDefault = $oJResp.StringOf("view.default")
Local $sDescription = $oJResp.StringOf("view.description")
Local $bDeserunt6 = $oJResp.BoolOf("view.execution.deserunt6")
Local $sEu7df = $oJResp.StringOf("view.execution.eu7df")
Local $sUtd70 = $oJResp.StringOf("view.execution.utd70")
Local $bAute_03 = $oJResp.BoolOf("view.execution.aute_03")
Local $iCulpa_5b2 = $oJResp.IntOf("view.execution.culpa_5b2")
Local $sId = $oJResp.StringOf("view.id")
Local $sPosition = $oJResp.StringOf("view.position")
Local $sExercitatione1 = $oJResp.StringOf("view.restriction.exercitatione1")
Local $sMagna_b_3 = $oJResp.StringOf("view.restriction.magna_b_3")
Local $sTitle = $oJResp.StringOf("view.title")
Local $sUpdated_at = $oJResp.StringOf("view.updated_at")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("columns")
While $i < $iCount_i
    $oJResp.I = $i
    $iDuis8 = $oJResp.IntOf("columns[i].Duis8")
    $sUllamco_0 = $oJResp.StringOf("columns[i].ullamco_0")
    $iOfficia_13e = $oJResp.IntOf("columns[i].officia_13e")
    $sIpsum_7 = $oJResp.StringOf("columns[i].ipsum_7")
    $bIn_a8 = $oJResp.BoolOf("columns[i].in_a8")
    $i = $i + 1
Wend
$i = 0
$iCount_i = $oJResp.SizeOfArray("groups")
While $i < $iCount_i
    $oJResp.I = $i
    $bLaborum_a27 = $oJResp.BoolOf("groups[i].laborum_a27")
    $sEa85c = $oJResp.StringOf("groups[i].ea85c")
    $iOccaecat_04 = $oJResp.IntOf("groups[i].occaecat_04")
    $sQui82a = $oJResp.StringOf("groups[i].qui82a")
    $i = $i + 1
Wend
$i = 0
$iCount_i = $oJResp.SizeOfArray("rows")
While $i < $iCount_i
    $oJResp.I = $i
    $iVelit21 = $oJResp.IntOf("rows[i].velit21")
    $sEx_f = $oJResp.StringOf("rows[i].ex_f")
    $sExcepteur_92 = $oJResp.StringOf("rows[i].Excepteur_92")
    $iCillum4 = $oJResp.IntOf("rows[i].cillum4")
    $i = $i + 1
Wend

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