Chilkat Online Tools

PureBasic / Support API / List Active Automations

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/active",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)

    ; {
    ;   "automations": [
    ;     {
    ;       "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>"
    ;     },
    ;     {
    ;       "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>"
    ;     }
    ;   ],
    ;   "count": "<integer>",
    ;   "next_page": "<string>",
    ;   "previous_page": "<string>"
    ; }

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

    active.s
    created_at.s
    default.s
    id.s
    position.s
    raw_title.s
    title.s
    updated_at.s
    j.i
    count_j.i
    field.s
    value.s
    operator.s

    count.s = CkJsonObject::ckStringOf(jResp,"count")
    next_page.s = CkJsonObject::ckStringOf(jResp,"next_page")
    previous_page.s = CkJsonObject::ckStringOf(jResp,"previous_page")
    i.i = 0
    count_i.i = CkJsonObject::ckSizeOfArray(jResp,"automations")
    While i < count_i
        CkJsonObject::setCkI(jResp, i)
        active = CkJsonObject::ckStringOf(jResp,"automations[i].active")
        created_at = CkJsonObject::ckStringOf(jResp,"automations[i].created_at")
        default = CkJsonObject::ckStringOf(jResp,"automations[i].default")
        id = CkJsonObject::ckStringOf(jResp,"automations[i].id")
        position = CkJsonObject::ckStringOf(jResp,"automations[i].position")
        raw_title = CkJsonObject::ckStringOf(jResp,"automations[i].raw_title")
        title = CkJsonObject::ckStringOf(jResp,"automations[i].title")
        updated_at = CkJsonObject::ckStringOf(jResp,"automations[i].updated_at")
        j = 0
        count_j = CkJsonObject::ckSizeOfArray(jResp,"automations[i].actions")
        While j < count_j
            CkJsonObject::setCkJ(jResp, j)
            field = CkJsonObject::ckStringOf(jResp,"automations[i].actions[j].field")
            value = CkJsonObject::ckStringOf(jResp,"automations[i].actions[j].value")
            j = j + 1
        Wend
        j = 0
        count_j = CkJsonObject::ckSizeOfArray(jResp,"automations[i].conditions.all")
        While j < count_j
            CkJsonObject::setCkJ(jResp, j)
            field = CkJsonObject::ckStringOf(jResp,"automations[i].conditions.all[j].field")
            operator = CkJsonObject::ckStringOf(jResp,"automations[i].conditions.all[j].operator")
            value = CkJsonObject::ckStringOf(jResp,"automations[i].conditions.all[j].value")
            j = j + 1
        Wend
        j = 0
        count_j = CkJsonObject::ckSizeOfArray(jResp,"automations[i].conditions.any")
        While j < count_j
            CkJsonObject::setCkJ(jResp, j)
            field = CkJsonObject::ckStringOf(jResp,"automations[i].conditions.any[j].field")
            operator = CkJsonObject::ckStringOf(jResp,"automations[i].conditions.any[j].operator")
            value = CkJsonObject::ckStringOf(jResp,"automations[i].conditions.any[j].value")
            j = j + 1
        Wend
        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/active

Postman Collection Item JSON

{
  "name": "List Active Automations",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/automations/active",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "automations",
        "active"
      ]
    },
    "description": "Lists all active automations.\n\n#### Allowed For\n\n* Agents\n\n#### Available Parameters\n\nYou can pass in any combination of the following optional filters:\n\n| Name       | Type   | Comment\n| ---------- | ------ | -------\n| sort_by    | string | Possible values are \"alphabetical\", \"created_at\", \"updated_at\", \"usage_1h\", \"usage_24h\", or \"usage_7d\". Defaults to \"position\"\n| sort_order | string | One of \"asc\" or \"desc\". Defaults to \"asc\" for alphabetical and position sort, \"desc\" for all others\n\n#### Sideloads\n\nThe following sideloads are supported:\n\n| Name             | Will sideload\n| ---------------- | -------------\n| app_installation | The app installation that requires each automation, if present\n| permissions      | The permissions for each automation\n| usage_1h         | The number of times each automation has been used in the past hour\n| usage_24h        | The number of times each automation has been used in the past day\n| usage_7d         | The number of times each automation has been used in the past week\n| usage_30d        | The number of times each automation has been used in the past thirty days\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/active",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "automations",
            "active"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"automations\": [\n    {\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    {\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  ],\n  \"count\": \"<integer>\",\n  \"next_page\": \"<string>\",\n  \"previous_page\": \"<string>\"\n}"
    }
  ]
}