Chilkat Online Tools

PureBasic / Support API / Show Automation

Back to Collection Items

IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"

Procedure ChilkatExample()

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

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i

    CkHttp::setCkBasicAuth(http, 1)
    CkHttp::setCkLogin(http, "login")
    CkHttp::setCkPassword(http, "password")

    CkHttp::ckSetRequestHeader(http,"Accept","application/json")

    sbResponseBody.i = CkStringBuilder::ckCreate()
    If sbResponseBody.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success = CkHttp::ckQuickGetSb(http,"https://example.zendesk.com/api/v2/automations/:automation_id",sbResponseBody)
    If success = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkStringBuilder::ckDispose(sbResponseBody)
        ProcedureReturn
    EndIf

    jResp.i = CkJsonObject::ckCreate()
    If jResp.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckLoadSb(jResp,sbResponseBody)
    CkJsonObject::setCkEmitCompact(jResp, 0)

    Debug "Response Body:"
    Debug CkJsonObject::ckEmit(jResp)

    respStatusCode.i = CkHttp::ckLastStatus(http)
    Debug "Response Status Code = " + Str(respStatusCode)
    If respStatusCode >= 400
        Debug "Response Header:"
        Debug CkHttp::ckLastHeader(http)
        Debug "Failed."
        CkHttp::ckDispose(http)
        CkStringBuilder::ckDispose(sbResponseBody)
        CkJsonObject::ckDispose(jResp)
        ProcedureReturn
    EndIf

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

    ; {
    ;   "automation": {
    ;     "actions": [
    ;       {
    ;         "field": "<string>",
    ;         "value": "<string>"
    ;       },
    ;       {
    ;         "field": "<string>",
    ;         "value": "<string>"
    ;       }
    ;     ],
    ;     "active": "<boolean>",
    ;     "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>"
    ;         }
    ;       ]
    ;     },
    ;     "created_at": "<dateTime>",
    ;     "default": "<boolean>",
    ;     "id": "<integer>",
    ;     "position": "<integer>",
    ;     "raw_title": "<string>",
    ;     "title": "<string>",
    ;     "updated_at": "<dateTime>"
    ;   }
    ; }

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

    field.s
    value.s
    operator.s

    Active.s = CkJsonObject::ckStringOf(jResp,"automation.active")
    Created_at.s = CkJsonObject::ckStringOf(jResp,"automation.created_at")
    Default.s = CkJsonObject::ckStringOf(jResp,"automation.default")
    Id.s = CkJsonObject::ckStringOf(jResp,"automation.id")
    Position.s = CkJsonObject::ckStringOf(jResp,"automation.position")
    Raw_title.s = CkJsonObject::ckStringOf(jResp,"automation.raw_title")
    Title.s = CkJsonObject::ckStringOf(jResp,"automation.title")
    Updated_at.s = CkJsonObject::ckStringOf(jResp,"automation.updated_at")
    i.i = 0
    count_i.i = CkJsonObject::ckSizeOfArray(jResp,"automation.actions")
    While i < count_i
        CkJsonObject::setCkI(jResp, i)
        field = CkJsonObject::ckStringOf(jResp,"automation.actions[i].field")
        value = CkJsonObject::ckStringOf(jResp,"automation.actions[i].value")
        i = i + 1
    Wend
    i = 0
    count_i = CkJsonObject::ckSizeOfArray(jResp,"automation.conditions.all")
    While i < count_i
        CkJsonObject::setCkI(jResp, i)
        field = CkJsonObject::ckStringOf(jResp,"automation.conditions.all[i].field")
        operator = CkJsonObject::ckStringOf(jResp,"automation.conditions.all[i].operator")
        value = CkJsonObject::ckStringOf(jResp,"automation.conditions.all[i].value")
        i = i + 1
    Wend
    i = 0
    count_i = CkJsonObject::ckSizeOfArray(jResp,"automation.conditions.any")
    While i < count_i
        CkJsonObject::setCkI(jResp, i)
        field = CkJsonObject::ckStringOf(jResp,"automation.conditions.any[i].field")
        operator = CkJsonObject::ckStringOf(jResp,"automation.conditions.any[i].operator")
        value = CkJsonObject::ckStringOf(jResp,"automation.conditions.any[i].value")
        i = i + 1
    Wend


    CkHttp::ckDispose(http)
    CkStringBuilder::ckDispose(sbResponseBody)
    CkJsonObject::ckDispose(jResp)


    ProcedureReturn
EndProcedure

Curl Command

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

Postman Collection Item JSON

{
  "name": "Show Automation",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/automations/:automation_id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "automations",
        ":automation_id"
      ],
      "variable": [
        {
          "key": "automation_id",
          "value": "<integer>"
        }
      ]
    },
    "description": "#### Allowed For\n\n* 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/automations/:automation_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "automations",
            ":automation_id"
          ],
          "variable": [
            {
              "key": "automation_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"automation\": {\n    \"actions\": [\n      {\n        \"field\": \"<string>\",\n        \"value\": \"<string>\"\n      },\n      {\n        \"field\": \"<string>\",\n        \"value\": \"<string>\"\n      }\n    ],\n    \"active\": \"<boolean>\",\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    \"created_at\": \"<dateTime>\",\n    \"default\": \"<boolean>\",\n    \"id\": \"<integer>\",\n    \"position\": \"<integer>\",\n    \"raw_title\": \"<string>\",\n    \"title\": \"<string>\",\n    \"updated_at\": \"<dateTime>\"\n  }\n}"
    }
  ]
}