Chilkat Online Tools

PureBasic / Support API / Create View

Back to Collection Items

IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"

Procedure ChilkatExample()

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

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i

    CkHttp::setCkBasicAuth(http, 1)
    CkHttp::setCkLogin(http, "login")
    CkHttp::setCkPassword(http, "password")

    CkHttp::ckSetRequestHeader(http,"Accept","application/json")

    resp.i = CkHttp::ckQuickRequest(http,"POST","https://example.zendesk.com/api/v2/views")
    If CkHttp::ckLastMethodSuccess(http) = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        ProcedureReturn
    EndIf

    sbResponseBody.i = CkStringBuilder::ckCreate()
    If sbResponseBody.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkHttpResponse::ckGetBodySb(resp,sbResponseBody)

    jResp.i = CkJsonObject::ckCreate()
    If jResp.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckLoadSb(jResp,sbResponseBody)
    CkJsonObject::setCkEmitCompact(jResp, 0)

    Debug "Response Body:"
    Debug CkJsonObject::ckEmit(jResp)

    respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
    Debug "Response Status Code = " + Str(respStatusCode)
    If respStatusCode >= 400
        Debug "Response Header:"
        Debug CkHttpResponse::ckHeader(resp)
        Debug "Failed."
        CkHttpResponse::ckDispose(resp)

        CkHttp::ckDispose(http)
        CkStringBuilder::ckDispose(sbResponseBody)
        CkJsonObject::ckDispose(jResp)
        ProcedureReturn
    EndIf

    CkHttpResponse::ckDispose(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

    Duis8.i
    ullamco_0.s
    officia_13e.i
    ipsum_7.s
    in_a8.i
    laborum_a27.i
    ea85c.s
    occaecat_04.i
    qui82a.s
    velit21.i
    ex_f.s
    Excepteur_92.s
    cillum4.i

    Active.s = CkJsonObject::ckStringOf(jResp,"view.active")
    Laborum_8.s = CkJsonObject::ckStringOf(jResp,"view.conditions.laborum_8")
    Consequata.i = CkJsonObject::ckIntOf(jResp,"view.conditions.consequata")
    Created_at.s = CkJsonObject::ckStringOf(jResp,"view.created_at")
    Default.s = CkJsonObject::ckStringOf(jResp,"view.default")
    Description.s = CkJsonObject::ckStringOf(jResp,"view.description")
    Deserunt6.i = CkJsonObject::ckBoolOf(jResp,"view.execution.deserunt6")
    Eu7df.s = CkJsonObject::ckStringOf(jResp,"view.execution.eu7df")
    Utd70.s = CkJsonObject::ckStringOf(jResp,"view.execution.utd70")
    Aute_03.i = CkJsonObject::ckBoolOf(jResp,"view.execution.aute_03")
    Culpa_5b2.i = CkJsonObject::ckIntOf(jResp,"view.execution.culpa_5b2")
    Id.s = CkJsonObject::ckStringOf(jResp,"view.id")
    Position.s = CkJsonObject::ckStringOf(jResp,"view.position")
    Exercitatione1.s = CkJsonObject::ckStringOf(jResp,"view.restriction.exercitatione1")
    Magna_b_3.s = CkJsonObject::ckStringOf(jResp,"view.restriction.magna_b_3")
    Title.s = CkJsonObject::ckStringOf(jResp,"view.title")
    Updated_at.s = CkJsonObject::ckStringOf(jResp,"view.updated_at")
    i.i = 0
    count_i.i = CkJsonObject::ckSizeOfArray(jResp,"columns")
    While i < count_i
        CkJsonObject::setCkI(jResp, i)
        Duis8 = CkJsonObject::ckIntOf(jResp,"columns[i].Duis8")
        ullamco_0 = CkJsonObject::ckStringOf(jResp,"columns[i].ullamco_0")
        officia_13e = CkJsonObject::ckIntOf(jResp,"columns[i].officia_13e")
        ipsum_7 = CkJsonObject::ckStringOf(jResp,"columns[i].ipsum_7")
        in_a8 = CkJsonObject::ckBoolOf(jResp,"columns[i].in_a8")
        i = i + 1
    Wend
    i = 0
    count_i = CkJsonObject::ckSizeOfArray(jResp,"groups")
    While i < count_i
        CkJsonObject::setCkI(jResp, i)
        laborum_a27 = CkJsonObject::ckBoolOf(jResp,"groups[i].laborum_a27")
        ea85c = CkJsonObject::ckStringOf(jResp,"groups[i].ea85c")
        occaecat_04 = CkJsonObject::ckIntOf(jResp,"groups[i].occaecat_04")
        qui82a = CkJsonObject::ckStringOf(jResp,"groups[i].qui82a")
        i = i + 1
    Wend
    i = 0
    count_i = CkJsonObject::ckSizeOfArray(jResp,"rows")
    While i < count_i
        CkJsonObject::setCkI(jResp, i)
        velit21 = CkJsonObject::ckIntOf(jResp,"rows[i].velit21")
        ex_f = CkJsonObject::ckStringOf(jResp,"rows[i].ex_f")
        Excepteur_92 = CkJsonObject::ckStringOf(jResp,"rows[i].Excepteur_92")
        cillum4 = CkJsonObject::ckIntOf(jResp,"rows[i].cillum4")
        i = i + 1
    Wend


    CkHttp::ckDispose(http)
    CkStringBuilder::ckDispose(sbResponseBody)
    CkJsonObject::ckDispose(jResp)


    ProcedureReturn
EndProcedure

Curl Command

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

Postman Collection Item JSON

{
  "name": "Create View",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/views",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "views"
      ]
    },
    "description": "#### Allowed For\n\n* Agents\n\n#### JSON Format\n\nThe JSON format consists of one property, a `view` object that lists the values to set when the view is created.\n\n**Note**: The request must include at least one condition in the `all` array that checks one of the following fields: `status`, `type`, `group_id`, `assignee_id`, or `requester_id`.\n\n| Name        | Description\n| ----------- | -----------\n| title       | Required. The title of the view\n| all         | Required. An array of one or more conditions. A ticket must meet all of them to be included in the view. 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. See [Conditions reference](/documentation/ticketing/reference-guides/conditions-reference)\n| description | The description of the view\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\n#### Example Request Body\n\n```js\n{\n  \"view\": {\n    \"title\": \"Kelly's tickets\",\n    \"raw_title\": \"{{dc.tickets_assigned_to_kelly}}\",\n    \"description\": \"Tickets that are assigned to Kelly\",\n    \"active\": true,\n    \"position\": 3,\n    \"restriction\": {\n      \"type\": \"User\",\n      \"id\": \"213977756\"\n    },\n    \"all\": [\n      {\n        \"field\": \"status\",\n        \"operator\": \"less_than\",\n        \"value\": \"solved\"\n      },\n      {\n        \"field\": \"group_id\",\n        \"operator\": \"is\",\n        \"value\": \"24000932\"\n      },\n      {\n        \"field\": \"custom_fields_360011872073\",\n        \"operator\": \"is\",\n        \"value\": \"Canada\"\n      },\n      ...\n    ],\n    \"output\": {\n      \"columns\": [\"status\", \"requester\", \"assignee\"],\n      \"group_by\": \"assignee\",\n      \"group_order\": \"desc\",\n      \"sort_by\": \"status\",\n      \"sort_order\": \"desc\"\n    }\n  }\n}\n```\n\n#### View columns\n\nThe `output` request parameter lets you specify what columns to include in the view in the agent interface. Example: `\"output\": {\"columns\": [\"status\", \"description\", \"priority\"]}`. The following table lists possible columns for views in the agent UI and the corresponding values in the `columns` array.\n\nFor custom fields, specify the id of the custom field in the `columns` array.\n\nYou can specify a total of 10 columns to a view.\n\n| View column title in UI     | Value                |\n|---------------------------- | -------------------- |\n| Assigned                    | `assigned`           |\n| Assignee                    | `assignee`           |\n| Due Date                    | `due_date`           |\n| Group                       | `group`              |\n| ID                          | `nice_id`            |\n| Updated                     | `updated`            |\n| Assignee updated            | `updated_assignee`   |\n| Requester updated           | `updated_requester`  |\n| Updater                     | `updated_by_type`    |\n| Organization                | `organization`       |\n| Priority                    | `priority`           |\n| Requested                   | `created`            |\n| Requester                   | `requester`          |\n| Requester language          | `locale_id`          |\n| Satisfaction                | `satisfaction_score` |\n| Solved                      | `solved`             |\n| Status category             | `status`             |\n| Subject                     | `description`        |\n| Submitter                   | `submitter`          |\n| Ticket form                 | `ticket_form`        |\n| Type                        | `type`               |\n| Brand                       | `brand`              |\n| Ticket status               | `custom_status_id`   |\n\n#### View sorting\n\nYou can group and sort items in the view by adding items to the `output` parameter:\n\n| Attribute                   | Description\n|-----------------------------| -----------\n| `group_by`, `sort_by`       | Sort or group the tickets by a column in the [View columns](#view-columns) table. The `subject` and `submitter` columns are not supported\n| `group_order`, `sort_order` | Either \"asc\" or \"desc\"\n"
  },
  "response": [
    {
      "name": "Success response",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v2/views",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "views"
          ]
        }
      },
      "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}"
    }
  ]
}