TCL / Support API / Show Many Items
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"
set queryParams [new_CkJsonObject]
CkJsonObject_UpdateString $queryParams "identifiers" "<string>"
CkHttp_SetRequestHeader $http "Accept" "application/json"
# resp is a CkHttpResponse
set resp [CkHttp_QuickRequestParams $http "GET" "https://example.zendesk.com/api/v2/dynamic_content/items/show_many" $queryParams]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkJsonObject $queryParams
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_CkJsonObject $queryParams
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
exit
}
delete_CkHttpResponse $resp
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# {
# "items": [
# {
# "name": "<string>",
# "default_locale_id": "<integer>",
# "variants": [
# {
# "content": "<string>",
# "locale_id": "<integer>",
# "active": "<boolean>",
# "created_at": "<dateTime>",
# "default": "<boolean>",
# "id": "<integer>",
# "outdated": "<boolean>",
# "updated_at": "<dateTime>",
# "url": "<string>"
# },
# {
# "content": "<string>",
# "locale_id": "<integer>",
# "active": "<boolean>",
# "created_at": "<dateTime>",
# "default": "<boolean>",
# "id": "<integer>",
# "outdated": "<boolean>",
# "updated_at": "<dateTime>",
# "url": "<string>"
# }
# ],
# "created_at": "<dateTime>",
# "id": "<integer>",
# "outdated": "<boolean>",
# "placeholder": "<string>",
# "updated_at": "<dateTime>",
# "url": "<string>"
# },
# {
# "name": "<string>",
# "default_locale_id": "<integer>",
# "variants": [
# {
# "content": "<string>",
# "locale_id": "<integer>",
# "active": "<boolean>",
# "created_at": "<dateTime>",
# "default": "<boolean>",
# "id": "<integer>",
# "outdated": "<boolean>",
# "updated_at": "<dateTime>",
# "url": "<string>"
# },
# {
# "content": "<string>",
# "locale_id": "<integer>",
# "active": "<boolean>",
# "created_at": "<dateTime>",
# "default": "<boolean>",
# "id": "<integer>",
# "outdated": "<boolean>",
# "updated_at": "<dateTime>",
# "url": "<string>"
# }
# ],
# "created_at": "<dateTime>",
# "id": "<integer>",
# "outdated": "<boolean>",
# "placeholder": "<string>",
# "updated_at": "<dateTime>",
# "url": "<string>"
# }
# ]
# }
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "items"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set name [CkJsonObject_stringOf $jResp "items[i].name"]
set default_locale_id [CkJsonObject_stringOf $jResp "items[i].default_locale_id"]
set created_at [CkJsonObject_stringOf $jResp "items[i].created_at"]
set id [CkJsonObject_stringOf $jResp "items[i].id"]
set outdated [CkJsonObject_stringOf $jResp "items[i].outdated"]
set placeholder [CkJsonObject_stringOf $jResp "items[i].placeholder"]
set updated_at [CkJsonObject_stringOf $jResp "items[i].updated_at"]
set url [CkJsonObject_stringOf $jResp "items[i].url"]
set j 0
set count_j [CkJsonObject_SizeOfArray $jResp "items[i].variants"]
while {$j < $count_j} {
CkJsonObject_put_J $jResp $j
set content [CkJsonObject_stringOf $jResp "items[i].variants[j].content"]
set locale_id [CkJsonObject_stringOf $jResp "items[i].variants[j].locale_id"]
set active [CkJsonObject_stringOf $jResp "items[i].variants[j].active"]
set created_at [CkJsonObject_stringOf $jResp "items[i].variants[j].created_at"]
set default [CkJsonObject_stringOf $jResp "items[i].variants[j].default"]
set id [CkJsonObject_stringOf $jResp "items[i].variants[j].id"]
set outdated [CkJsonObject_stringOf $jResp "items[i].variants[j].outdated"]
set updated_at [CkJsonObject_stringOf $jResp "items[i].variants[j].updated_at"]
set url [CkJsonObject_stringOf $jResp "items[i].variants[j].url"]
set j [expr $j + 1]
}
set i [expr $i + 1]
}
delete_CkHttp $http
delete_CkJsonObject $queryParams
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
Curl Command
curl -u login:password -G -d "identifiers=%3Cstring%3E"
-H "Accept: application/json"
https://example.zendesk.com/api/v2/dynamic_content/items/show_many
Postman Collection Item JSON
{
"name": "Show Many Items",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/dynamic_content/items/show_many?identifiers=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"dynamic_content",
"items",
"show_many"
],
"query": [
{
"key": "identifiers",
"value": "<string>",
"description": "Identifiers for the dynamic contents"
}
]
},
"description": "#### Stability\n\n* Development\n\n#### 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/dynamic_content/items/show_many?identifiers=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"dynamic_content",
"items",
"show_many"
],
"query": [
{
"key": "identifiers",
"value": "<string>",
"description": "Identifiers for the dynamic contents"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"items\": [\n {\n \"name\": \"<string>\",\n \"default_locale_id\": \"<integer>\",\n \"variants\": [\n {\n \"content\": \"<string>\",\n \"locale_id\": \"<integer>\",\n \"active\": \"<boolean>\",\n \"created_at\": \"<dateTime>\",\n \"default\": \"<boolean>\",\n \"id\": \"<integer>\",\n \"outdated\": \"<boolean>\",\n \"updated_at\": \"<dateTime>\",\n \"url\": \"<string>\"\n },\n {\n \"content\": \"<string>\",\n \"locale_id\": \"<integer>\",\n \"active\": \"<boolean>\",\n \"created_at\": \"<dateTime>\",\n \"default\": \"<boolean>\",\n \"id\": \"<integer>\",\n \"outdated\": \"<boolean>\",\n \"updated_at\": \"<dateTime>\",\n \"url\": \"<string>\"\n }\n ],\n \"created_at\": \"<dateTime>\",\n \"id\": \"<integer>\",\n \"outdated\": \"<boolean>\",\n \"placeholder\": \"<string>\",\n \"updated_at\": \"<dateTime>\",\n \"url\": \"<string>\"\n },\n {\n \"name\": \"<string>\",\n \"default_locale_id\": \"<integer>\",\n \"variants\": [\n {\n \"content\": \"<string>\",\n \"locale_id\": \"<integer>\",\n \"active\": \"<boolean>\",\n \"created_at\": \"<dateTime>\",\n \"default\": \"<boolean>\",\n \"id\": \"<integer>\",\n \"outdated\": \"<boolean>\",\n \"updated_at\": \"<dateTime>\",\n \"url\": \"<string>\"\n },\n {\n \"content\": \"<string>\",\n \"locale_id\": \"<integer>\",\n \"active\": \"<boolean>\",\n \"created_at\": \"<dateTime>\",\n \"default\": \"<boolean>\",\n \"id\": \"<integer>\",\n \"outdated\": \"<boolean>\",\n \"updated_at\": \"<dateTime>\",\n \"url\": \"<string>\"\n }\n ],\n \"created_at\": \"<dateTime>\",\n \"id\": \"<integer>\",\n \"outdated\": \"<boolean>\",\n \"placeholder\": \"<string>\",\n \"updated_at\": \"<dateTime>\",\n \"url\": \"<string>\"\n }\n ]\n}"
}
]
}
