Chilkat Tools

PowerBuilder / Support API / Show Many Items

integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_QueryParams
oleobject loo_Resp
oleobject loo_SbResponseBody
oleobject loo_JResp
integer li_RespStatusCode
string ls_Name
string ls_Default_locale_id
string ls_Created_at
string ls_Id
string ls_Outdated
string ls_Placeholder
string ls_Updated_at
string ls_Url
integer j
integer li_Count_j
string ls_Content
string ls_Locale_id
string ls_Active
string ls_Default
integer i
integer li_Count_i

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

loo_Http = create oleobject
li_rc = loo_Http.ConnectToNewObject("Chilkat_9_5_0.Http")
if li_rc < 0 then
    destroy loo_Http
    MessageBox("Error","Connecting to COM object failed")
    return
end if

loo_Http.BasicAuth = 1
loo_Http.Login = "login"
loo_Http.Password = "password"

loo_QueryParams = create oleobject
li_rc = loo_QueryParams.ConnectToNewObject("Chilkat_9_5_0.JsonObject")

loo_QueryParams.UpdateString("identifiers","<string>")

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

loo_Resp = loo_Http.QuickRequestParams("GET","https://example.zendesk.com/api/v2/dynamic_content/items/show_many",loo_QueryParams)
if loo_Http.LastMethodSuccess = 0 then
    Write-Debug loo_Http.LastErrorText
    destroy loo_Http
    destroy loo_QueryParams
    return
end if

loo_SbResponseBody = create oleobject
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat_9_5_0.StringBuilder")

loo_Resp.GetBodySb(loo_SbResponseBody)

loo_JResp = create oleobject
li_rc = loo_JResp.ConnectToNewObject("Chilkat_9_5_0.JsonObject")

loo_JResp.LoadSb(loo_SbResponseBody)
loo_JResp.EmitCompact = 0

Write-Debug "Response Body:"
Write-Debug loo_JResp.Emit()

li_RespStatusCode = loo_Resp.StatusCode
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_RespStatusCode >= 400 then
    Write-Debug "Response Header:"
    Write-Debug loo_Resp.Header
    Write-Debug "Failed."
    destroy loo_Resp
    destroy loo_Http
    destroy loo_QueryParams
    destroy loo_SbResponseBody
    destroy loo_JResp
    return
end if

destroy loo_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

i = 0
li_Count_i = loo_JResp.SizeOfArray("items")
do while i < li_Count_i
    loo_JResp.I = i
    ls_Name = loo_JResp.StringOf("items[i].name")
    ls_Default_locale_id = loo_JResp.StringOf("items[i].default_locale_id")
    ls_Created_at = loo_JResp.StringOf("items[i].created_at")
    ls_Id = loo_JResp.StringOf("items[i].id")
    ls_Outdated = loo_JResp.StringOf("items[i].outdated")
    ls_Placeholder = loo_JResp.StringOf("items[i].placeholder")
    ls_Updated_at = loo_JResp.StringOf("items[i].updated_at")
    ls_Url = loo_JResp.StringOf("items[i].url")
    j = 0
    li_Count_j = loo_JResp.SizeOfArray("items[i].variants")
    do while j < li_Count_j
        loo_JResp.J = j
        ls_Content = loo_JResp.StringOf("items[i].variants[j].content")
        ls_Locale_id = loo_JResp.StringOf("items[i].variants[j].locale_id")
        ls_Active = loo_JResp.StringOf("items[i].variants[j].active")
        ls_Created_at = loo_JResp.StringOf("items[i].variants[j].created_at")
        ls_Default = loo_JResp.StringOf("items[i].variants[j].default")
        ls_Id = loo_JResp.StringOf("items[i].variants[j].id")
        ls_Outdated = loo_JResp.StringOf("items[i].variants[j].outdated")
        ls_Updated_at = loo_JResp.StringOf("items[i].variants[j].updated_at")
        ls_Url = loo_JResp.StringOf("items[i].variants[j].url")
        j = j + 1
    loop
    i = i + 1
loop


destroy loo_Http
destroy loo_QueryParams
destroy loo_SbResponseBody
destroy loo_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}"
    }
  ]
}

Chilkat Online Tools

PowerBuilder / Support API / Show Many Items

Curl Command

Postman Collection Item JSON