Chilkat Online Tools

C / Support API / Show Automation

Back to Collection Items

#include <C_CkHttp.h>
#include <C_CkStringBuilder.h>
#include <C_CkJsonObject.h>

void ChilkatSample(void)
    {
    HCkHttp http;
    BOOL success;
    HCkStringBuilder sbResponseBody;
    HCkJsonObject jResp;
    int respStatusCode;
    const char *field;
    const char *value;
    const char *operator;
    const char *Active;
    const char *Created_at;
    const char *Default;
    const char *Id;
    const char *Position;
    const char *Raw_title;
    const char *Title;
    const char *Updated_at;
    int i;
    int count_i;

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

    http = CkHttp_Create();

    CkHttp_putBasicAuth(http,TRUE);
    CkHttp_putLogin(http,"login");
    CkHttp_putPassword(http,"password");

    CkHttp_SetRequestHeader(http,"Accept","application/json");

    sbResponseBody = CkStringBuilder_Create();
    success = CkHttp_QuickGetSb(http,"https://example.zendesk.com/api/v2/automations/:automation_id",sbResponseBody);
    if (success == FALSE) {
        printf("%s\n",CkHttp_lastErrorText(http));
        CkHttp_Dispose(http);
        CkStringBuilder_Dispose(sbResponseBody);
        return;
    }

    jResp = CkJsonObject_Create();
    CkJsonObject_LoadSb(jResp,sbResponseBody);
    CkJsonObject_putEmitCompact(jResp,FALSE);

    printf("Response Body:\n");
    printf("%s\n",CkJsonObject_emit(jResp));

    respStatusCode = CkHttp_getLastStatus(http);
    printf("Response Status Code = %d\n",respStatusCode);
    if (respStatusCode >= 400) {
        printf("Response Header:\n");
        printf("%s\n",CkHttp_lastHeader(http));
        printf("Failed.\n");
        CkHttp_Dispose(http);
        CkStringBuilder_Dispose(sbResponseBody);
        CkJsonObject_Dispose(jResp);
        return;
    }

    // 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

    // Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.

    Active = CkJsonObject_stringOf(jResp,"automation.active");
    Created_at = CkJsonObject_stringOf(jResp,"automation.created_at");
    Default = CkJsonObject_stringOf(jResp,"automation.default");
    Id = CkJsonObject_stringOf(jResp,"automation.id");
    Position = CkJsonObject_stringOf(jResp,"automation.position");
    Raw_title = CkJsonObject_stringOf(jResp,"automation.raw_title");
    Title = CkJsonObject_stringOf(jResp,"automation.title");
    Updated_at = CkJsonObject_stringOf(jResp,"automation.updated_at");
    i = 0;
    count_i = CkJsonObject_SizeOfArray(jResp,"automation.actions");
    while (i < count_i) {
        CkJsonObject_putI(jResp,i);
        field = CkJsonObject_stringOf(jResp,"automation.actions[i].field");
        value = CkJsonObject_stringOf(jResp,"automation.actions[i].value");
        i = i + 1;
    }

    i = 0;
    count_i = CkJsonObject_SizeOfArray(jResp,"automation.conditions.all");
    while (i < count_i) {
        CkJsonObject_putI(jResp,i);
        field = CkJsonObject_stringOf(jResp,"automation.conditions.all[i].field");
        operator = CkJsonObject_stringOf(jResp,"automation.conditions.all[i].operator");
        value = CkJsonObject_stringOf(jResp,"automation.conditions.all[i].value");
        i = i + 1;
    }

    i = 0;
    count_i = CkJsonObject_SizeOfArray(jResp,"automation.conditions.any");
    while (i < count_i) {
        CkJsonObject_putI(jResp,i);
        field = CkJsonObject_stringOf(jResp,"automation.conditions.any[i].field");
        operator = CkJsonObject_stringOf(jResp,"automation.conditions.any[i].operator");
        value = CkJsonObject_stringOf(jResp,"automation.conditions.any[i].value");
        i = i + 1;
    }



    CkHttp_Dispose(http);
    CkStringBuilder_Dispose(sbResponseBody);
    CkJsonObject_Dispose(jResp);

    }

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}"
    }
  ]
}