PureBasic / Support API / List Workspaces
Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.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")
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkHttp::ckQuickGetSb(http,"https://example.zendesk.com/api/v2/workspaces",sbResponseBody)
If success = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
ProcedureReturn
EndIf
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 = CkHttp::ckLastStatus(http)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttp::ckLastHeader(http)
Debug "Failed."
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)
; {
; "workspaces": [
; {
; "activated": "<boolean>",
; "apps": [
; {
; "ut_1": true
; },
; {
; "Lorem_ec": "ut ipsum nulla voluptate",
; "sed_a": 38535010.16636646
; }
; ],
; "conditions": {
; "all": [
; {
; "field": "<string>",
; "operator": "<string>",
; "value": "<string>"
; },
; {
; "field": "<string>",
; "operator": "<string>",
; "value": "<string>"
; }
; ],
; "any": [
; {
; "field": "<string>",
; "operator": "<string>",
; "value": "<string>"
; },
; {
; "field": "<string>",
; "operator": "<string>",
; "value": "<string>"
; }
; ]
; },
; "created_at": "<dateTime>",
; "description": "<string>",
; "id": "<integer>",
; "macro_ids": [
; "<integer>",
; "<integer>"
; ],
; "macros": [
; "<integer>",
; "<integer>"
; ],
; "position": "<integer>",
; "prefer_workspace_app_order": "<boolean>",
; "selected_macros": [
; {
; "actions": [
; {
; "field": "<string>",
; "value": "<string>"
; },
; {
; "field": "<string>",
; "value": "<string>"
; }
; ],
; "title": "<string>",
; "active": "<boolean>",
; "created_at": "<dateTime>",
; "default": "<boolean>",
; "description": "<string>",
; "id": "<integer>",
; "position": "<integer>",
; "restriction": {
; "elit_0": 95926683,
; "Loreme7": 1915356
; },
; "updated_at": "<dateTime>",
; "url": "<string>",
; "app_installation": "<string>",
; "categories": "<string>",
; "permissions": "<string>",
; "usage_1h": "<integer>",
; "usage_7d": "<integer>",
; "usage_24h": "<integer>",
; "usage_30d": "<integer>"
; },
; {
; "actions": [
; {
; "field": "<string>",
; "value": "<string>"
; },
; {
; "field": "<string>",
; "value": "<string>"
; }
; ],
; "title": "<string>",
; "active": "<boolean>",
; "created_at": "<dateTime>",
; "default": "<boolean>",
; "description": "<string>",
; "id": "<integer>",
; "position": "<integer>",
; "restriction": {
; "ut_2": true,
; "exf9": false,
; "magna_5": false
; },
; "updated_at": "<dateTime>",
; "url": "<string>",
; "app_installation": "<string>",
; "categories": "<string>",
; "permissions": "<string>",
; "usage_1h": "<integer>",
; "usage_7d": "<integer>",
; "usage_24h": "<integer>",
; "usage_30d": "<integer>"
; }
; ],
; "ticket_form_id": "<integer>",
; "title": "<string>",
; "updated_at": "<dateTime>",
; "url": "<string>"
; },
; {
; "activated": "<boolean>",
; "apps": [
; {
; "laborum_": "esse elit mollit nulla",
; "dolore_72": 44930495
; },
; {
; "Duis_e27": false,
; "do_7b": true,
; "eu_6": true
; }
; ],
; "conditions": {
; "all": [
; {
; "field": "<string>",
; "operator": "<string>",
; "value": "<string>"
; },
; {
; "field": "<string>",
; "operator": "<string>",
; "value": "<string>"
; }
; ],
; "any": [
; {
; "field": "<string>",
; "operator": "<string>",
; "value": "<string>"
; },
; {
; "field": "<string>",
; "operator": "<string>",
; "value": "<string>"
; }
; ]
; },
; "created_at": "<dateTime>",
; "description": "<string>",
; "id": "<integer>",
; "macro_ids": [
; "<integer>",
; "<integer>"
; ],
; "macros": [
; "<integer>",
; "<integer>"
; ],
; "position": "<integer>",
; "prefer_workspace_app_order": "<boolean>",
; "selected_macros": [
; {
; "actions": [
; {
; "field": "<string>",
; "value": "<string>"
; },
; {
; "field": "<string>",
; "value": "<string>"
; }
; ],
; "title": "<string>",
; "active": "<boolean>",
; "created_at": "<dateTime>",
; "default": "<boolean>",
; "description": "<string>",
; "id": "<integer>",
; "position": "<integer>",
; "restriction": {
; "nostrud_7": false,
; "ex69c": -43731952,
; "ut_a": "anim nostrud pariatur",
; "mollit__": -87941840
; },
; "updated_at": "<dateTime>",
; "url": "<string>",
; "app_installation": "<string>",
; "categories": "<string>",
; "permissions": "<string>",
; "usage_1h": "<integer>",
; "usage_7d": "<integer>",
; "usage_24h": "<integer>",
; "usage_30d": "<integer>"
; },
; {
; "actions": [
; {
; "field": "<string>",
; "value": "<string>"
; },
; {
; "field": "<string>",
; "value": "<string>"
; }
; ],
; "title": "<string>",
; "active": "<boolean>",
; "created_at": "<dateTime>",
; "default": "<boolean>",
; "description": "<string>",
; "id": "<integer>",
; "position": "<integer>",
; "restriction": {
; "deseruntc_": false,
; "consequatd0": 17786909,
; "id_4a": false
; },
; "updated_at": "<dateTime>",
; "url": "<string>",
; "app_installation": "<string>",
; "categories": "<string>",
; "permissions": "<string>",
; "usage_1h": "<integer>",
; "usage_7d": "<integer>",
; "usage_24h": "<integer>",
; "usage_30d": "<integer>"
; }
; ],
; "ticket_form_id": "<integer>",
; "title": "<string>",
; "updated_at": "<dateTime>",
; "url": "<string>"
; }
; ],
; "count": "<integer>",
; "next_page": "<string>",
; "previous_page": "<string>"
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
activated.s
created_at.s
description.s
id.s
position.s
prefer_workspace_app_order.s
ticket_form_id.s
title.s
updated_at.s
url.s
j.i
count_j.i
ut_1.i
Lorem_ec.s
sed_a.s
laborum_.s
dolore_72.i
Duis_e27.i
do_7b.i
eu_6.i
field.s
operator.s
value.s
strVal.s
active.s
default.s
Elit_0.i
Loreme7.i
app_installation.s
categories.s
permissions.s
usage_1h.s
usage_7d.s
usage_24h.s
usage_30d.s
Ut_2.i
Exf9.i
Magna_5.i
Nostrud_7.i
Ex69c.i
Ut_a.s
Mollit__.i
Deseruntc_.i
Consequatd0.i
Id_4a.i
k.i
count_k.i
count.s = CkJsonObject::ckStringOf(jResp,"count")
next_page.s = CkJsonObject::ckStringOf(jResp,"next_page")
previous_page.s = CkJsonObject::ckStringOf(jResp,"previous_page")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"workspaces")
While i < count_i
CkJsonObject::setCkI(jResp, i)
activated = CkJsonObject::ckStringOf(jResp,"workspaces[i].activated")
created_at = CkJsonObject::ckStringOf(jResp,"workspaces[i].created_at")
description = CkJsonObject::ckStringOf(jResp,"workspaces[i].description")
id = CkJsonObject::ckStringOf(jResp,"workspaces[i].id")
position = CkJsonObject::ckStringOf(jResp,"workspaces[i].position")
prefer_workspace_app_order = CkJsonObject::ckStringOf(jResp,"workspaces[i].prefer_workspace_app_order")
ticket_form_id = CkJsonObject::ckStringOf(jResp,"workspaces[i].ticket_form_id")
title = CkJsonObject::ckStringOf(jResp,"workspaces[i].title")
updated_at = CkJsonObject::ckStringOf(jResp,"workspaces[i].updated_at")
url = CkJsonObject::ckStringOf(jResp,"workspaces[i].url")
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"workspaces[i].apps")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
ut_1 = CkJsonObject::ckBoolOf(jResp,"workspaces[i].apps[j].ut_1")
Lorem_ec = CkJsonObject::ckStringOf(jResp,"workspaces[i].apps[j].Lorem_ec")
sed_a = CkJsonObject::ckStringOf(jResp,"workspaces[i].apps[j].sed_a")
laborum_ = CkJsonObject::ckStringOf(jResp,"workspaces[i].apps[j].laborum_")
dolore_72 = CkJsonObject::ckIntOf(jResp,"workspaces[i].apps[j].dolore_72")
Duis_e27 = CkJsonObject::ckBoolOf(jResp,"workspaces[i].apps[j].Duis_e27")
do_7b = CkJsonObject::ckBoolOf(jResp,"workspaces[i].apps[j].do_7b")
eu_6 = CkJsonObject::ckBoolOf(jResp,"workspaces[i].apps[j].eu_6")
j = j + 1
Wend
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"workspaces[i].conditions.all")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
field = CkJsonObject::ckStringOf(jResp,"workspaces[i].conditions.all[j].field")
operator = CkJsonObject::ckStringOf(jResp,"workspaces[i].conditions.all[j].operator")
value = CkJsonObject::ckStringOf(jResp,"workspaces[i].conditions.all[j].value")
j = j + 1
Wend
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"workspaces[i].conditions.any")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
field = CkJsonObject::ckStringOf(jResp,"workspaces[i].conditions.any[j].field")
operator = CkJsonObject::ckStringOf(jResp,"workspaces[i].conditions.any[j].operator")
value = CkJsonObject::ckStringOf(jResp,"workspaces[i].conditions.any[j].value")
j = j + 1
Wend
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"workspaces[i].macro_ids")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
strVal = CkJsonObject::ckStringOf(jResp,"workspaces[i].macro_ids[j]")
j = j + 1
Wend
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"workspaces[i].macros")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
strVal = CkJsonObject::ckStringOf(jResp,"workspaces[i].macros[j]")
j = j + 1
Wend
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"workspaces[i].selected_macros")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
title = CkJsonObject::ckStringOf(jResp,"workspaces[i].selected_macros[j].title")
active = CkJsonObject::ckStringOf(jResp,"workspaces[i].selected_macros[j].active")
created_at = CkJsonObject::ckStringOf(jResp,"workspaces[i].selected_macros[j].created_at")
default = CkJsonObject::ckStringOf(jResp,"workspaces[i].selected_macros[j].default")
description = CkJsonObject::ckStringOf(jResp,"workspaces[i].selected_macros[j].description")
id = CkJsonObject::ckStringOf(jResp,"workspaces[i].selected_macros[j].id")
position = CkJsonObject::ckStringOf(jResp,"workspaces[i].selected_macros[j].position")
Elit_0 = CkJsonObject::ckIntOf(jResp,"workspaces[i].selected_macros[j].restriction.elit_0")
Loreme7 = CkJsonObject::ckIntOf(jResp,"workspaces[i].selected_macros[j].restriction.Loreme7")
updated_at = CkJsonObject::ckStringOf(jResp,"workspaces[i].selected_macros[j].updated_at")
url = CkJsonObject::ckStringOf(jResp,"workspaces[i].selected_macros[j].url")
app_installation = CkJsonObject::ckStringOf(jResp,"workspaces[i].selected_macros[j].app_installation")
categories = CkJsonObject::ckStringOf(jResp,"workspaces[i].selected_macros[j].categories")
permissions = CkJsonObject::ckStringOf(jResp,"workspaces[i].selected_macros[j].permissions")
usage_1h = CkJsonObject::ckStringOf(jResp,"workspaces[i].selected_macros[j].usage_1h")
usage_7d = CkJsonObject::ckStringOf(jResp,"workspaces[i].selected_macros[j].usage_7d")
usage_24h = CkJsonObject::ckStringOf(jResp,"workspaces[i].selected_macros[j].usage_24h")
usage_30d = CkJsonObject::ckStringOf(jResp,"workspaces[i].selected_macros[j].usage_30d")
Ut_2 = CkJsonObject::ckBoolOf(jResp,"workspaces[i].selected_macros[j].restriction.ut_2")
Exf9 = CkJsonObject::ckBoolOf(jResp,"workspaces[i].selected_macros[j].restriction.exf9")
Magna_5 = CkJsonObject::ckBoolOf(jResp,"workspaces[i].selected_macros[j].restriction.magna_5")
Nostrud_7 = CkJsonObject::ckBoolOf(jResp,"workspaces[i].selected_macros[j].restriction.nostrud_7")
Ex69c = CkJsonObject::ckIntOf(jResp,"workspaces[i].selected_macros[j].restriction.ex69c")
Ut_a = CkJsonObject::ckStringOf(jResp,"workspaces[i].selected_macros[j].restriction.ut_a")
Mollit__ = CkJsonObject::ckIntOf(jResp,"workspaces[i].selected_macros[j].restriction.mollit__")
Deseruntc_ = CkJsonObject::ckBoolOf(jResp,"workspaces[i].selected_macros[j].restriction.deseruntc_")
Consequatd0 = CkJsonObject::ckIntOf(jResp,"workspaces[i].selected_macros[j].restriction.consequatd0")
Id_4a = CkJsonObject::ckBoolOf(jResp,"workspaces[i].selected_macros[j].restriction.id_4a")
k = 0
count_k = CkJsonObject::ckSizeOfArray(jResp,"workspaces[i].selected_macros[j].actions")
While k < count_k
CkJsonObject::setCkK(jResp, k)
field = CkJsonObject::ckStringOf(jResp,"workspaces[i].selected_macros[j].actions[k].field")
value = CkJsonObject::ckStringOf(jResp,"workspaces[i].selected_macros[j].actions[k].value")
k = k + 1
Wend
j = j + 1
Wend
i = i + 1
Wend
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
Curl Command
curl -u login:password -X GET
-H "Accept: application/json"
https://example.zendesk.com/api/v2/workspaces
Postman Collection Item JSON
{
"name": "List Workspaces",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/workspaces",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"workspaces"
]
},
"description": "#### Allowed For\n\n* Admins, 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/workspaces",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"workspaces"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"workspaces\": [\n {\n \"activated\": \"<boolean>\",\n \"apps\": [\n {\n \"ut_1\": true\n },\n {\n \"Lorem_ec\": \"ut ipsum nulla voluptate\",\n \"sed_a\": 38535010.16636646\n }\n ],\n \"conditions\": {\n \"all\": [\n {\n \"field\": \"<string>\",\n \"operator\": \"<string>\",\n \"value\": \"<string>\"\n },\n {\n \"field\": \"<string>\",\n \"operator\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"any\": [\n {\n \"field\": \"<string>\",\n \"operator\": \"<string>\",\n \"value\": \"<string>\"\n },\n {\n \"field\": \"<string>\",\n \"operator\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n },\n \"created_at\": \"<dateTime>\",\n \"description\": \"<string>\",\n \"id\": \"<integer>\",\n \"macro_ids\": [\n \"<integer>\",\n \"<integer>\"\n ],\n \"macros\": [\n \"<integer>\",\n \"<integer>\"\n ],\n \"position\": \"<integer>\",\n \"prefer_workspace_app_order\": \"<boolean>\",\n \"selected_macros\": [\n {\n \"actions\": [\n {\n \"field\": \"<string>\",\n \"value\": \"<string>\"\n },\n {\n \"field\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"title\": \"<string>\",\n \"active\": \"<boolean>\",\n \"created_at\": \"<dateTime>\",\n \"default\": \"<boolean>\",\n \"description\": \"<string>\",\n \"id\": \"<integer>\",\n \"position\": \"<integer>\",\n \"restriction\": {\n \"elit_0\": 95926683,\n \"Loreme7\": 1915356\n },\n \"updated_at\": \"<dateTime>\",\n \"url\": \"<string>\",\n \"app_installation\": \"<string>\",\n \"categories\": \"<string>\",\n \"permissions\": \"<string>\",\n \"usage_1h\": \"<integer>\",\n \"usage_7d\": \"<integer>\",\n \"usage_24h\": \"<integer>\",\n \"usage_30d\": \"<integer>\"\n },\n {\n \"actions\": [\n {\n \"field\": \"<string>\",\n \"value\": \"<string>\"\n },\n {\n \"field\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"title\": \"<string>\",\n \"active\": \"<boolean>\",\n \"created_at\": \"<dateTime>\",\n \"default\": \"<boolean>\",\n \"description\": \"<string>\",\n \"id\": \"<integer>\",\n \"position\": \"<integer>\",\n \"restriction\": {\n \"ut_2\": true,\n \"exf9\": false,\n \"magna_5\": false\n },\n \"updated_at\": \"<dateTime>\",\n \"url\": \"<string>\",\n \"app_installation\": \"<string>\",\n \"categories\": \"<string>\",\n \"permissions\": \"<string>\",\n \"usage_1h\": \"<integer>\",\n \"usage_7d\": \"<integer>\",\n \"usage_24h\": \"<integer>\",\n \"usage_30d\": \"<integer>\"\n }\n ],\n \"ticket_form_id\": \"<integer>\",\n \"title\": \"<string>\",\n \"updated_at\": \"<dateTime>\",\n \"url\": \"<string>\"\n },\n {\n \"activated\": \"<boolean>\",\n \"apps\": [\n {\n \"laborum_\": \"esse elit mollit nulla\",\n \"dolore_72\": 44930495\n },\n {\n \"Duis_e27\": false,\n \"do_7b\": true,\n \"eu_6\": true\n }\n ],\n \"conditions\": {\n \"all\": [\n {\n \"field\": \"<string>\",\n \"operator\": \"<string>\",\n \"value\": \"<string>\"\n },\n {\n \"field\": \"<string>\",\n \"operator\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"any\": [\n {\n \"field\": \"<string>\",\n \"operator\": \"<string>\",\n \"value\": \"<string>\"\n },\n {\n \"field\": \"<string>\",\n \"operator\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n },\n \"created_at\": \"<dateTime>\",\n \"description\": \"<string>\",\n \"id\": \"<integer>\",\n \"macro_ids\": [\n \"<integer>\",\n \"<integer>\"\n ],\n \"macros\": [\n \"<integer>\",\n \"<integer>\"\n ],\n \"position\": \"<integer>\",\n \"prefer_workspace_app_order\": \"<boolean>\",\n \"selected_macros\": [\n {\n \"actions\": [\n {\n \"field\": \"<string>\",\n \"value\": \"<string>\"\n },\n {\n \"field\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"title\": \"<string>\",\n \"active\": \"<boolean>\",\n \"created_at\": \"<dateTime>\",\n \"default\": \"<boolean>\",\n \"description\": \"<string>\",\n \"id\": \"<integer>\",\n \"position\": \"<integer>\",\n \"restriction\": {\n \"nostrud_7\": false,\n \"ex69c\": -43731952,\n \"ut_a\": \"anim nostrud pariatur\",\n \"mollit__\": -87941840\n },\n \"updated_at\": \"<dateTime>\",\n \"url\": \"<string>\",\n \"app_installation\": \"<string>\",\n \"categories\": \"<string>\",\n \"permissions\": \"<string>\",\n \"usage_1h\": \"<integer>\",\n \"usage_7d\": \"<integer>\",\n \"usage_24h\": \"<integer>\",\n \"usage_30d\": \"<integer>\"\n },\n {\n \"actions\": [\n {\n \"field\": \"<string>\",\n \"value\": \"<string>\"\n },\n {\n \"field\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"title\": \"<string>\",\n \"active\": \"<boolean>\",\n \"created_at\": \"<dateTime>\",\n \"default\": \"<boolean>\",\n \"description\": \"<string>\",\n \"id\": \"<integer>\",\n \"position\": \"<integer>\",\n \"restriction\": {\n \"deseruntc_\": false,\n \"consequatd0\": 17786909,\n \"id_4a\": false\n },\n \"updated_at\": \"<dateTime>\",\n \"url\": \"<string>\",\n \"app_installation\": \"<string>\",\n \"categories\": \"<string>\",\n \"permissions\": \"<string>\",\n \"usage_1h\": \"<integer>\",\n \"usage_7d\": \"<integer>\",\n \"usage_24h\": \"<integer>\",\n \"usage_30d\": \"<integer>\"\n }\n ],\n \"ticket_form_id\": \"<integer>\",\n \"title\": \"<string>\",\n \"updated_at\": \"<dateTime>\",\n \"url\": \"<string>\"\n }\n ],\n \"count\": \"<integer>\",\n \"next_page\": \"<string>\",\n \"previous_page\": \"<string>\"\n}"
}
]
}
