Chilkat Online Tools

Ruby / Support API / List Active Views

Back to Collection Items

require 'chilkat'

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

http = Chilkat::CkHttp.new()

http.put_BasicAuth(true)
http.put_Login("login")
http.put_Password("password")

queryParams = Chilkat::CkJsonObject.new()
queryParams.UpdateString("access","<string>")
queryParams.UpdateString("group_id","<integer>")
queryParams.UpdateString("sort_by","<string>")
queryParams.UpdateString("sort_order","<string>")

http.SetRequestHeader("Accept","application/json")

# resp is a CkHttpResponse
resp = http.QuickRequestParams("GET","https://example.zendesk.com/api/v2/views/active",queryParams)
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

sbResponseBody = Chilkat::CkStringBuilder.new()
resp.GetBodySb(sbResponseBody)

jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)

print "Response Body:" + "\n";
print jResp.emit() + "\n";

respStatusCode = resp.get_StatusCode()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
    print "Response Header:" + "\n";
    print resp.header() + "\n";
    print "Failed." + "\n";

    exit
end

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

# {
#   "count": "<integer>",
#   "next_page": "<string>",
#   "previous_page": "<string>",
#   "views": [
#     {
#       "active": "<boolean>",
#       "conditions": {
#         "amet_b2": "minim et Ut aliquip",
#         "pariatur_d74": true,
#         "eiusmodd7e": 16274866
#       },
#       "created_at": "<dateTime>",
#       "default": "<boolean>",
#       "description": "<string>",
#       "execution": {
#         "sit_bd1": -70845421.92699432,
#         "voluptated": -13477997
#       },
#       "id": "<integer>",
#       "position": "<integer>",
#       "restriction": {
#         "officia_1c": -36345253.13616539
#       },
#       "title": "<string>",
#       "updated_at": "<dateTime>"
#     },
#     {
#       "active": "<boolean>",
#       "conditions": {
#         "do_99": 75108528,
#         "aliqua_ad": true,
#         "dolore277": 23927228,
#         "labore0": "incididunt ut dolor"
#       },
#       "created_at": "<dateTime>",
#       "default": "<boolean>",
#       "description": "<string>",
#       "execution": {
#         "deserunt00": 61902530,
#         "velit_90": "consectetur in Excepteur"
#       },
#       "id": "<integer>",
#       "position": "<integer>",
#       "restriction": {
#         "dolor_58": -88642742.97884612,
#         "sed_41": "commodo ut"
#       },
#       "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

count = jResp.stringOf("count")
next_page = jResp.stringOf("next_page")
previous_page = jResp.stringOf("previous_page")
i = 0
count_i = jResp.SizeOfArray("views")
while i < count_i
    jResp.put_I(i)
    active = jResp.stringOf("views[i].active")
    Amet_b2 = jResp.stringOf("views[i].conditions.amet_b2")
    Pariatur_d74 = jResp.BoolOf("views[i].conditions.pariatur_d74")
    Eiusmodd7e = jResp.IntOf("views[i].conditions.eiusmodd7e")
    created_at = jResp.stringOf("views[i].created_at")
    default = jResp.stringOf("views[i].default")
    description = jResp.stringOf("views[i].description")
    Sit_bd1 = jResp.stringOf("views[i].execution.sit_bd1")
    Voluptated = jResp.IntOf("views[i].execution.voluptated")
    id = jResp.stringOf("views[i].id")
    position = jResp.stringOf("views[i].position")
    Officia_1c = jResp.stringOf("views[i].restriction.officia_1c")
    title = jResp.stringOf("views[i].title")
    updated_at = jResp.stringOf("views[i].updated_at")
    Do_99 = jResp.IntOf("views[i].conditions.do_99")
    Aliqua_ad = jResp.BoolOf("views[i].conditions.aliqua_ad")
    Dolore277 = jResp.IntOf("views[i].conditions.dolore277")
    Labore0 = jResp.stringOf("views[i].conditions.labore0")
    Deserunt00 = jResp.IntOf("views[i].execution.deserunt00")
    Velit_90 = jResp.stringOf("views[i].execution.velit_90")
    Dolor_58 = jResp.stringOf("views[i].restriction.dolor_58")
    Sed_41 = jResp.stringOf("views[i].restriction.sed_41")
    i = i + 1
end

Curl Command

curl  -u login:password -G -d "access=%3Cstring%3E"
	-d "group_id=%3Cinteger%3E"
	-d "sort_by=%3Cstring%3E"
	-d "sort_order=%3Cstring%3E"
	-H "Accept: application/json"
https://example.zendesk.com/api/v2/views/active

Postman Collection Item JSON

{
  "name": "List Active Views",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/views/active?access=<string>&group_id=<integer>&sort_by=<string>&sort_order=<string>",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "views",
        "active"
      ],
      "query": [
        {
          "key": "access",
          "value": "<string>",
          "description": "Only views with given access. May be \"personal\", \"shared\", or \"account\""
        },
        {
          "key": "group_id",
          "value": "<integer>",
          "description": "Only views belonging to given group"
        },
        {
          "key": "sort_by",
          "value": "<string>",
          "description": "Possible values are \"alphabetical\", \"created_at\", or \"updated_at\". Defaults to \"position\""
        },
        {
          "key": "sort_order",
          "value": "<string>",
          "description": "One of \"asc\" or \"desc\". Defaults to \"asc\" for alphabetical and position sort, \"desc\" for all others"
        }
      ]
    },
    "description": "Lists active shared and personal views available to the current user.\n\n#### Sideloads\n\nThe following sideloads are supported:\n\n| Name             | Will sideload\n| ---------------- | -------------\n| app_installation | The app installation that requires each view, if present\n| permissions      | The permissions for each view\n\n#### Pagination\n\n- Offset pagination\n\nSee [Pagination](/api-reference/introduction/pagination/).\n\nReturns a maximum of 100 records per page.\n\n#### Allowed For\n\n* Agents\n"
  },
  "response": [
    {
      "name": "Success response",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v2/views/active?access=<string>&group_id=<integer>&sort_by=<string>&sort_order=<string>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "views",
            "active"
          ],
          "query": [
            {
              "key": "access",
              "value": "<string>",
              "description": "Only views with given access. May be \"personal\", \"shared\", or \"account\""
            },
            {
              "key": "group_id",
              "value": "<integer>",
              "description": "Only views belonging to given group"
            },
            {
              "key": "sort_by",
              "value": "<string>",
              "description": "Possible values are \"alphabetical\", \"created_at\", or \"updated_at\". Defaults to \"position\""
            },
            {
              "key": "sort_order",
              "value": "<string>",
              "description": "One of \"asc\" or \"desc\". Defaults to \"asc\" for alphabetical and position sort, \"desc\" for all others"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"count\": \"<integer>\",\n  \"next_page\": \"<string>\",\n  \"previous_page\": \"<string>\",\n  \"views\": [\n    {\n      \"active\": \"<boolean>\",\n      \"conditions\": {\n        \"amet_b2\": \"minim et Ut aliquip\",\n        \"pariatur_d74\": true,\n        \"eiusmodd7e\": 16274866\n      },\n      \"created_at\": \"<dateTime>\",\n      \"default\": \"<boolean>\",\n      \"description\": \"<string>\",\n      \"execution\": {\n        \"sit_bd1\": -70845421.92699432,\n        \"voluptated\": -13477997\n      },\n      \"id\": \"<integer>\",\n      \"position\": \"<integer>\",\n      \"restriction\": {\n        \"officia_1c\": -36345253.13616539\n      },\n      \"title\": \"<string>\",\n      \"updated_at\": \"<dateTime>\"\n    },\n    {\n      \"active\": \"<boolean>\",\n      \"conditions\": {\n        \"do_99\": 75108528,\n        \"aliqua_ad\": true,\n        \"dolore277\": 23927228,\n        \"labore0\": \"incididunt ut dolor\"\n      },\n      \"created_at\": \"<dateTime>\",\n      \"default\": \"<boolean>\",\n      \"description\": \"<string>\",\n      \"execution\": {\n        \"deserunt00\": 61902530,\n        \"velit_90\": \"consectetur in Excepteur\"\n      },\n      \"id\": \"<integer>\",\n      \"position\": \"<integer>\",\n      \"restriction\": {\n        \"dolor_58\": -88642742.97884612,\n        \"sed_41\": \"commodo ut\"\n      },\n      \"title\": \"<string>\",\n      \"updated_at\": \"<dateTime>\"\n    }\n  ]\n}"
    }
  ]
}