Chilkat Online Tools

lianja / Support API / Show Trigger

Back to Collection Items

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

loHttp = createobject("CkHttp")

loHttp.BasicAuth = .T.
loHttp.Login = "login"
loHttp.Password = "password"

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

loSbResponseBody = createobject("CkStringBuilder")
llSuccess = loHttp.QuickGetSb("https://example.zendesk.com/api/v2/triggers/:trigger_id",loSbResponseBody)
if (llSuccess = .F.) then
    ? loHttp.LastErrorText
    release loHttp
    release loSbResponseBody
    return
endif

loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.

? "Response Body:"
? loJResp.Emit()

lnRespStatusCode = loHttp.LastStatus
? "Response Status Code = " + str(lnRespStatusCode)
if (lnRespStatusCode >= 400) then
    ? "Response Header:"
    ? loHttp.LastHeader
    ? "Failed."
    release loHttp
    release loSbResponseBody
    release loJResp
    return
endif

// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)

// {
//   "trigger": {
//     "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>"
//         }
//       ]
//     },
//     "actions": [
//       {
//         "field": "<string>",
//         "value": "<string>"
//       },
//       {
//         "field": "<string>",
//         "value": "<string>"
//       }
//     ],
//     "title": "<string>",
//     "active": "<boolean>",
//     "category_id": "<string>",
//     "created_at": "<string>",
//     "default": "<boolean>",
//     "description": "<string>",
//     "id": "<integer>",
//     "position": "<integer>",
//     "raw_title": "<string>",
//     "updated_at": "<string>",
//     "url": "<string>"
//   }
// }

// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

lcTitle = loJResp.StringOf("trigger.title")
lcActive = loJResp.StringOf("trigger.active")
lcCategory_id = loJResp.StringOf("trigger.category_id")
lcCreated_at = loJResp.StringOf("trigger.created_at")
lcDefault = loJResp.StringOf("trigger.default")
lcDescription = loJResp.StringOf("trigger.description")
lcId = loJResp.StringOf("trigger.id")
lcPosition = loJResp.StringOf("trigger.position")
lcRaw_title = loJResp.StringOf("trigger.raw_title")
lcUpdated_at = loJResp.StringOf("trigger.updated_at")
lcV_Url = loJResp.StringOf("trigger.url")
i = 0
lnCount_i = loJResp.SizeOfArray("trigger.conditions.all")
do while i < lnCount_i
    loJResp.I = i
    lcField = loJResp.StringOf("trigger.conditions.all[i].field")
    lcOperator = loJResp.StringOf("trigger.conditions.all[i].operator")
    lcValue = loJResp.StringOf("trigger.conditions.all[i].value")
    i = i + 1
enddo
i = 0
lnCount_i = loJResp.SizeOfArray("trigger.conditions.any")
do while i < lnCount_i
    loJResp.I = i
    lcField = loJResp.StringOf("trigger.conditions.any[i].field")
    lcOperator = loJResp.StringOf("trigger.conditions.any[i].operator")
    lcValue = loJResp.StringOf("trigger.conditions.any[i].value")
    i = i + 1
enddo
i = 0
lnCount_i = loJResp.SizeOfArray("trigger.actions")
do while i < lnCount_i
    loJResp.I = i
    lcField = loJResp.StringOf("trigger.actions[i].field")
    lcValue = loJResp.StringOf("trigger.actions[i].value")
    i = i + 1
enddo


release loHttp
release loSbResponseBody
release loJResp

Curl Command

curl  -u login:password -X GET
	-H "Accept: application/json"
https://example.zendesk.com/api/v2/triggers/:trigger_id

Postman Collection Item JSON

{
  "name": "Show Trigger",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/triggers/:trigger_id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "triggers",
        ":trigger_id"
      ],
      "variable": [
        {
          "key": "trigger_id",
          "value": "<integer>"
        }
      ]
    },
    "description": "#### Allowed For\n\n* Agents\n\nThe Via Type value is a number instead of a text string. See [Via types reference](/documentation/ticketing/reference-guides/via-types/) for the keys.\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/triggers/:trigger_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "triggers",
            ":trigger_id"
          ],
          "variable": [
            {
              "key": "trigger_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"trigger\": {\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    \"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    \"category_id\": \"<string>\",\n    \"created_at\": \"<string>\",\n    \"default\": \"<boolean>\",\n    \"description\": \"<string>\",\n    \"id\": \"<integer>\",\n    \"position\": \"<integer>\",\n    \"raw_title\": \"<string>\",\n    \"updated_at\": \"<string>\",\n    \"url\": \"<string>\"\n  }\n}"
    }
  ]
}