DataFlex / Support API / List Trigger Categories
Back to Collection Items
Use ChilkatAx-win32.pkg
Procedure Test
Handle hoHttp
Boolean iSuccess
Variant vQueryParams
Handle hoQueryParams
Variant vResp
Handle hoResp
Variant vSbResponseBody
Handle hoSbResponseBody
Handle hoJResp
Integer iRespStatusCode
String sActive_count
String sInactive_count
String sV_Next
String sPrev
String sAfter_cursor
String sBefore_cursor
String sHas_more
Integer i
Integer iCount_i
String sTemp1
Boolean bTemp1
// 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"
Get Create (RefClass(cComChilkatJsonObject)) To hoQueryParams
If (Not(IsComObjectCreated(hoQueryParams))) Begin
Send CreateComObject of hoQueryParams
End
Get ComUpdateString Of hoQueryParams "page[after]" "<string>" To iSuccess
Get ComUpdateString Of hoQueryParams "page[before]" "<string>" To iSuccess
Get ComUpdateString Of hoQueryParams "page[size]" "<integer>" To iSuccess
Get ComUpdateString Of hoQueryParams "sort" "-updated_at" To iSuccess
Get ComUpdateString Of hoQueryParams "include" "rule_counts" To iSuccess
Send ComSetRequestHeader To hoHttp "Accept" "application/json"
Get pvComObject of hoQueryParams to vQueryParams
Get ComQuickRequestParams Of hoHttp "GET" "https://example.zendesk.com/api/v2/trigger_categories" vQueryParams To vResp
If (IsComObject(vResp)) Begin
Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
Set pvComObject Of hoResp To vResp
End
Get ComLastMethodSuccess Of hoHttp To bTemp1
If (bTemp1 = False) Begin
Get ComLastErrorText Of hoHttp To sTemp1
Showln sTemp1
Procedure_Return
End
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
Send CreateComObject of hoSbResponseBody
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComGetBodySb Of hoResp vSbResponseBody To iSuccess
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 ComStatusCode Of hoResp To iRespStatusCode
Showln "Response Status Code = " iRespStatusCode
If (iRespStatusCode >= 400) Begin
Showln "Response Header:"
Get ComHeader Of hoResp To sTemp1
Showln sTemp1
Showln "Failed."
Send Destroy of hoResp
Procedure_Return
End
Send Destroy of hoResp
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "trigger_categories": [
// {
// "active_count": "<long>",
// "inactive_count": "<long>"
// },
// {
// "active_count": "<long>",
// "inactive_count": "<long>"
// }
// ],
// "links": {
// "next": "<string>",
// "prev": "<string>"
// },
// "meta": {
// "after_cursor": "<string>",
// "before_cursor": "<string>",
// "has_more": "<boolean>"
// }
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Get ComStringOf Of hoJResp "links.next" To sV_Next
Get ComStringOf Of hoJResp "links.prev" To sPrev
Get ComStringOf Of hoJResp "meta.after_cursor" To sAfter_cursor
Get ComStringOf Of hoJResp "meta.before_cursor" To sBefore_cursor
Get ComStringOf Of hoJResp "meta.has_more" To sHas_more
Move 0 To i
Get ComSizeOfArray Of hoJResp "trigger_categories" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Get ComStringOf Of hoJResp "trigger_categories[i].active_count" To sActive_count
Get ComStringOf Of hoJResp "trigger_categories[i].inactive_count" To sInactive_count
Move (i + 1) To i
Loop
End_Procedure
Curl Command
curl -u login:password -G -d "page[after]=%3Cstring%3E"
-d "page[before]=%3Cstring%3E"
-d "page[size]=%3Cinteger%3E"
-d "sort=-updated_at"
-d "include=rule_counts"
-H "Accept: application/json"
https://example.zendesk.com/api/v2/trigger_categories
Postman Collection Item JSON
{
"name": "List Trigger Categories",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/trigger_categories?page[after]=<string>&page[before]=<string>&page[size]=<integer>&sort=-updated_at&include=rule_counts",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"trigger_categories"
],
"query": [
{
"key": "page[after]",
"value": "<string>",
"description": "Pagination parameters"
},
{
"key": "page[before]",
"value": "<string>",
"description": "Pagination parameters"
},
{
"key": "page[size]",
"value": "<integer>",
"description": "Pagination parameters"
},
{
"key": "sort",
"value": "-updated_at",
"description": "Sort parameters"
},
{
"key": "include",
"value": "rule_counts",
"description": "Allowed sideloads"
}
]
},
"description": "Returns all the trigger categories in the account."
},
"response": [
{
"name": "A paged array of trigger categories",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/trigger_categories?page[after]=<string>&page[before]=<string>&page[size]=<integer>&sort=-updated_at&include=rule_counts",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"trigger_categories"
],
"query": [
{
"key": "page[after]",
"value": "<string>",
"description": "Pagination parameters"
},
{
"key": "page[before]",
"value": "<string>",
"description": "Pagination parameters"
},
{
"key": "page[size]",
"value": "<integer>",
"description": "Pagination parameters"
},
{
"key": "sort",
"value": "-updated_at",
"description": "Sort parameters"
},
{
"key": "include",
"value": "rule_counts",
"description": "Allowed sideloads"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"trigger_categories\": [\n {\n \"active_count\": \"<long>\",\n \"inactive_count\": \"<long>\"\n },\n {\n \"active_count\": \"<long>\",\n \"inactive_count\": \"<long>\"\n }\n ],\n \"links\": {\n \"next\": \"<string>\",\n \"prev\": \"<string>\"\n },\n \"meta\": {\n \"after_cursor\": \"<string>\",\n \"before_cursor\": \"<string>\",\n \"has_more\": \"<boolean>\"\n }\n}"
},
{
"name": "Error",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/trigger_categories?page[after]=<string>&page[before]=<string>&page[size]=<integer>&sort=-updated_at&include=rule_counts",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"trigger_categories"
],
"query": [
{
"key": "page[after]",
"value": "<string>",
"description": "Pagination parameters"
},
{
"key": "page[before]",
"value": "<string>",
"description": "Pagination parameters"
},
{
"key": "page[size]",
"value": "<integer>",
"description": "Pagination parameters"
},
{
"key": "sort",
"value": "-updated_at",
"description": "Sort parameters"
},
{
"key": "include",
"value": "rule_counts",
"description": "Allowed sideloads"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n {\n \"code\": \"<string>\",\n \"title\": \"<string>\",\n \"detail\": \"<string>\",\n \"id\": \"<string>\",\n \"links\": {},\n \"source\": {},\n \"status\": \"<string>\"\n },\n {\n \"code\": \"<string>\",\n \"title\": \"<string>\",\n \"detail\": \"<string>\",\n \"id\": \"<string>\",\n \"links\": {},\n \"source\": {},\n \"status\": \"<string>\"\n }\n ]\n}"
},
{
"name": "Error",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/trigger_categories?page[after]=<string>&page[before]=<string>&page[size]=<integer>&sort=-updated_at&include=rule_counts",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"trigger_categories"
],
"query": [
{
"key": "page[after]",
"value": "<string>",
"description": "Pagination parameters"
},
{
"key": "page[before]",
"value": "<string>",
"description": "Pagination parameters"
},
{
"key": "page[size]",
"value": "<integer>",
"description": "Pagination parameters"
},
{
"key": "sort",
"value": "-updated_at",
"description": "Sort parameters"
},
{
"key": "include",
"value": "rule_counts",
"description": "Allowed sideloads"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n {\n \"code\": \"<string>\",\n \"title\": \"<string>\",\n \"detail\": \"<string>\",\n \"id\": \"<string>\",\n \"links\": {},\n \"source\": {},\n \"status\": \"<string>\"\n },\n {\n \"code\": \"<string>\",\n \"title\": \"<string>\",\n \"detail\": \"<string>\",\n \"id\": \"<string>\",\n \"links\": {},\n \"source\": {},\n \"status\": \"<string>\"\n }\n ]\n}"
}
]
}
