DataFlex / Support API / List Items
Back to Collection Items
Use ChilkatAx-win32.pkg
Procedure Test
Handle hoHttp
Boolean iSuccess
Variant vSbResponseBody
Handle hoSbResponseBody
Handle hoJResp
Integer iRespStatusCode
String sName
String sDefault_locale_id
String sCreated_at
String sId
String sOutdated
String sPlaceholder
String sUpdated_at
String sUrl
Integer j
Integer iCount_j
String sContent
String sLocale_id
String sActive
String sDefault
Integer i
Integer iCount_i
String sTemp1
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Get Create (RefClass(cComChilkatHttp)) To hoHttp
If (Not(IsComObjectCreated(hoHttp))) Begin
Send CreateComObject of hoHttp
End
Set ComBasicAuth Of hoHttp To True
Set ComLogin Of hoHttp To "login"
Set ComPassword Of hoHttp To "password"
Send ComSetRequestHeader To hoHttp "Accept" "application/json"
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
Send CreateComObject of hoSbResponseBody
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComQuickGetSb Of hoHttp "https://example.zendesk.com/api/v2/dynamic_content/items" vSbResponseBody To iSuccess
If (iSuccess = False) Begin
Get ComLastErrorText Of hoHttp To sTemp1
Showln sTemp1
Procedure_Return
End
Get Create (RefClass(cComChilkatJsonObject)) To hoJResp
If (Not(IsComObjectCreated(hoJResp))) Begin
Send CreateComObject of hoJResp
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComLoadSb Of hoJResp vSbResponseBody To iSuccess
Set ComEmitCompact Of hoJResp To False
Showln "Response Body:"
Get ComEmit Of hoJResp To sTemp1
Showln sTemp1
Get ComLastStatus Of hoHttp To iRespStatusCode
Showln "Response Status Code = " iRespStatusCode
If (iRespStatusCode >= 400) Begin
Showln "Response Header:"
Get ComLastHeader Of hoHttp To sTemp1
Showln sTemp1
Showln "Failed."
Procedure_Return
End
// 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
Move 0 To i
Get ComSizeOfArray Of hoJResp "items" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Get ComStringOf Of hoJResp "items[i].name" To sName
Get ComStringOf Of hoJResp "items[i].default_locale_id" To sDefault_locale_id
Get ComStringOf Of hoJResp "items[i].created_at" To sCreated_at
Get ComStringOf Of hoJResp "items[i].id" To sId
Get ComStringOf Of hoJResp "items[i].outdated" To sOutdated
Get ComStringOf Of hoJResp "items[i].placeholder" To sPlaceholder
Get ComStringOf Of hoJResp "items[i].updated_at" To sUpdated_at
Get ComStringOf Of hoJResp "items[i].url" To sUrl
Move 0 To j
Get ComSizeOfArray Of hoJResp "items[i].variants" To iCount_j
While (j < iCount_j)
Set ComJ Of hoJResp To j
Get ComStringOf Of hoJResp "items[i].variants[j].content" To sContent
Get ComStringOf Of hoJResp "items[i].variants[j].locale_id" To sLocale_id
Get ComStringOf Of hoJResp "items[i].variants[j].active" To sActive
Get ComStringOf Of hoJResp "items[i].variants[j].created_at" To sCreated_at
Get ComStringOf Of hoJResp "items[i].variants[j].default" To sDefault
Get ComStringOf Of hoJResp "items[i].variants[j].id" To sId
Get ComStringOf Of hoJResp "items[i].variants[j].outdated" To sOutdated
Get ComStringOf Of hoJResp "items[i].variants[j].updated_at" To sUpdated_at
Get ComStringOf Of hoJResp "items[i].variants[j].url" To sUrl
Move (j + 1) To j
Loop
Move (i + 1) To i
Loop
End_Procedure
Curl Command
curl -u login:password -X GET
-H "Accept: application/json"
https://example.zendesk.com/api/v2/dynamic_content/items
Postman Collection Item JSON
{
"name": "List Items",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/dynamic_content/items",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"dynamic_content",
"items"
]
},
"description": "Returns a list of all dynamic content items for your account if accessed as an admin or agents who have permission to manage dynamic content.\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",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"dynamic_content",
"items"
]
}
},
"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}"
}
]
}
