Chilkat Online Tools

unicodeCpp / Support API / Create Batch Job for Trigger Categories

Back to Collection Items

#include <CkHttpW.h>
#include <CkJsonObjectW.h>
#include <CkHttpResponseW.h>
#include <CkStringBuilderW.h>

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

    CkHttpW http;
    bool success;

    http.put_BasicAuth(true);
    http.put_Login(L"login");
    http.put_Password(L"password");

    // Use this online tool to generate code from sample JSON: Generate Code to Create JSON

    // The following JSON is sent in the request body.

    // {
    //   "job": {
    //     "action": "patch",
    //     "items": {
    //       "trigger_categories": [
    //         {
    //           "id": "<string>",
    //           "position": "<long>"
    //         },
    //         {
    //           "id": "<string>",
    //           "position": "<long>"
    //         }
    //       ],
    //       "triggers": [
    //         {
    //           "id": "<string>",
    //           "active": "<boolean>",
    //           "category_id": "<string>",
    //           "position": "<long>"
    //         },
    //         {
    //           "id": "<string>",
    //           "active": "<boolean>",
    //           "category_id": "<string>",
    //           "position": "<long>"
    //         }
    //       ]
    //     }
    //   }
    // }

    CkJsonObjectW json;
    json.UpdateString(L"job.action",L"patch");
    json.UpdateString(L"job.items.trigger_categories[0].id",L"<string>");
    json.UpdateString(L"job.items.trigger_categories[0].position",L"<long>");
    json.UpdateString(L"job.items.trigger_categories[1].id",L"<string>");
    json.UpdateString(L"job.items.trigger_categories[1].position",L"<long>");
    json.UpdateString(L"job.items.triggers[0].id",L"<string>");
    json.UpdateString(L"job.items.triggers[0].active",L"<boolean>");
    json.UpdateString(L"job.items.triggers[0].category_id",L"<string>");
    json.UpdateString(L"job.items.triggers[0].position",L"<long>");
    json.UpdateString(L"job.items.triggers[1].id",L"<string>");
    json.UpdateString(L"job.items.triggers[1].active",L"<boolean>");
    json.UpdateString(L"job.items.triggers[1].category_id",L"<string>");
    json.UpdateString(L"job.items.triggers[1].position",L"<long>");

    http.SetRequestHeader(L"Content-Type",L"application/json");
    http.SetRequestHeader(L"Accept",L"application/json");

    CkHttpResponseW *resp = http.PostJson3(L"https://example.zendesk.com/api/v2/trigger_categories/jobs",L"application/json",json);
    if (http.get_LastMethodSuccess() == false) {
        wprintf(L"%s\n",http.lastErrorText());
        return;
    }

    CkStringBuilderW sbResponseBody;
    resp->GetBodySb(sbResponseBody);

    CkJsonObjectW jResp;
    jResp.LoadSb(sbResponseBody);
    jResp.put_EmitCompact(false);

    wprintf(L"Response Body:\n");
    wprintf(L"%s\n",jResp.emit());

    int respStatusCode = resp->get_StatusCode();
    wprintf(L"Response Status Code = %d\n",respStatusCode);
    if (respStatusCode >= 400) {
        wprintf(L"Response Header:\n");
        wprintf(L"%s\n",resp->header());
        wprintf(L"Failed.\n");
        delete resp;
        return;
    }

    delete resp;

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

    // {
    //   "errors": [
    //     {
    //       "code": "<string>",
    //       "title": "<string>",
    //       "detail": "<string>",
    //       "id": "<string>",
    //       "links": {},
    //       "source": {},
    //       "status": "<string>",
    //       "trigger_id": "<string>"
    //     },
    //     {
    //       "code": "<string>",
    //       "title": "<string>",
    //       "detail": "<string>",
    //       "id": "<string>",
    //       "links": {},
    //       "source": {},
    //       "status": "<string>",
    //       "trigger_id": "<string>"
    //     }
    //   ],
    //   "results": {
    //     "trigger_categories": [
    //       {
    //         "created_at": "<string>",
    //         "id": "<string>",
    //         "name": "<string>",
    //         "position": "<long>",
    //         "updated_at": "<string>"
    //       },
    //       {
    //         "created_at": "<string>",
    //         "id": "<string>",
    //         "name": "<string>",
    //         "position": "<long>",
    //         "updated_at": "<string>"
    //       }
    //     ],
    //     "triggers": [
    //       {
    //         "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>"
    //       },
    //       {
    //         "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>"
    //       }
    //     ]
    //   },
    //   "status": "failed"
    // }

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

    const wchar_t *code = 0;
    const wchar_t *title = 0;
    const wchar_t *detail = 0;
    const wchar_t *id = 0;
    const wchar_t *trigger_id = 0;
    const wchar_t *created_at = 0;
    const wchar_t *name = 0;
    const wchar_t *position = 0;
    const wchar_t *updated_at = 0;
    const wchar_t *active = 0;
    const wchar_t *category_id = 0;
    const wchar_t *default = 0;
    const wchar_t *description = 0;
    const wchar_t *raw_title = 0;
    const wchar_t *url = 0;
    int j;
    int count_j;
    const wchar_t *field = 0;
    const wchar_t *operator = 0;
    const wchar_t *value = 0;

    const wchar_t *status = jResp.stringOf(L"status");
    int i = 0;
    int count_i = jResp.SizeOfArray(L"errors");
    while (i < count_i) {
        jResp.put_I(i);
        code = jResp.stringOf(L"errors[i].code");
        title = jResp.stringOf(L"errors[i].title");
        detail = jResp.stringOf(L"errors[i].detail");
        id = jResp.stringOf(L"errors[i].id");
        status = jResp.stringOf(L"errors[i].status");
        trigger_id = jResp.stringOf(L"errors[i].trigger_id");
        i = i + 1;
    }

    i = 0;
    count_i = jResp.SizeOfArray(L"results.trigger_categories");
    while (i < count_i) {
        jResp.put_I(i);
        created_at = jResp.stringOf(L"results.trigger_categories[i].created_at");
        id = jResp.stringOf(L"results.trigger_categories[i].id");
        name = jResp.stringOf(L"results.trigger_categories[i].name");
        position = jResp.stringOf(L"results.trigger_categories[i].position");
        updated_at = jResp.stringOf(L"results.trigger_categories[i].updated_at");
        i = i + 1;
    }

    i = 0;
    count_i = jResp.SizeOfArray(L"results.triggers");
    while (i < count_i) {
        jResp.put_I(i);
        title = jResp.stringOf(L"results.triggers[i].title");
        active = jResp.stringOf(L"results.triggers[i].active");
        category_id = jResp.stringOf(L"results.triggers[i].category_id");
        created_at = jResp.stringOf(L"results.triggers[i].created_at");
        default = jResp.stringOf(L"results.triggers[i].default");
        description = jResp.stringOf(L"results.triggers[i].description");
        id = jResp.stringOf(L"results.triggers[i].id");
        position = jResp.stringOf(L"results.triggers[i].position");
        raw_title = jResp.stringOf(L"results.triggers[i].raw_title");
        updated_at = jResp.stringOf(L"results.triggers[i].updated_at");
        url = jResp.stringOf(L"results.triggers[i].url");
        j = 0;
        count_j = jResp.SizeOfArray(L"results.triggers[i].conditions.all");
        while (j < count_j) {
            jResp.put_J(j);
            field = jResp.stringOf(L"results.triggers[i].conditions.all[j].field");
            operator = jResp.stringOf(L"results.triggers[i].conditions.all[j].operator");
            value = jResp.stringOf(L"results.triggers[i].conditions.all[j].value");
            j = j + 1;
        }

        j = 0;
        count_j = jResp.SizeOfArray(L"results.triggers[i].conditions.any");
        while (j < count_j) {
            jResp.put_J(j);
            field = jResp.stringOf(L"results.triggers[i].conditions.any[j].field");
            operator = jResp.stringOf(L"results.triggers[i].conditions.any[j].operator");
            value = jResp.stringOf(L"results.triggers[i].conditions.any[j].value");
            j = j + 1;
        }

        j = 0;
        count_j = jResp.SizeOfArray(L"results.triggers[i].actions");
        while (j < count_j) {
            jResp.put_J(j);
            field = jResp.stringOf(L"results.triggers[i].actions[j].field");
            value = jResp.stringOf(L"results.triggers[i].actions[j].value");
            j = j + 1;
        }

        i = i + 1;
    }
    }

Curl Command

curl  -u login:password -X POST
	-H "Content-Type: application/json"
	-H "Accept: application/json"
	-d '{
  "job": {
    "action": "patch",
    "items": {
      "trigger_categories": [
        {
          "id": "<string>",
          "position": "<long>"
        },
        {
          "id": "<string>",
          "position": "<long>"
        }
      ],
      "triggers": [
        {
          "id": "<string>",
          "active": "<boolean>",
          "category_id": "<string>",
          "position": "<long>"
        },
        {
          "id": "<string>",
          "active": "<boolean>",
          "category_id": "<string>",
          "position": "<long>"
        }
      ]
    }
  }
}'
https://example.zendesk.com/api/v2/trigger_categories/jobs

Postman Collection Item JSON

{
  "name": "Create Batch Job for Trigger Categories",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      },
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"job\": {\n    \"action\": \"patch\",\n    \"items\": {\n      \"trigger_categories\": [\n        {\n          \"id\": \"<string>\",\n          \"position\": \"<long>\"\n        },\n        {\n          \"id\": \"<string>\",\n          \"position\": \"<long>\"\n        }\n      ],\n      \"triggers\": [\n        {\n          \"id\": \"<string>\",\n          \"active\": \"<boolean>\",\n          \"category_id\": \"<string>\",\n          \"position\": \"<long>\"\n        },\n        {\n          \"id\": \"<string>\",\n          \"active\": \"<boolean>\",\n          \"category_id\": \"<string>\",\n          \"position\": \"<long>\"\n        }\n      ]\n    }\n  }\n}",
      "options": {
        "raw": {
          "headerFamily": "json",
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{baseUrl}}/api/v2/trigger_categories/jobs",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "trigger_categories",
        "jobs"
      ]
    },
    "description": "Creates a job that performs a batch operation for the given trigger categories."
  },
  "response": [
    {
      "name": "The response to the batch job",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"job\": {\n    \"action\": \"patch\",\n    \"items\": {\n      \"trigger_categories\": [\n        {\n          \"id\": \"<string>\",\n          \"position\": \"<long>\"\n        },\n        {\n          \"id\": \"<string>\",\n          \"position\": \"<long>\"\n        }\n      ],\n      \"triggers\": [\n        {\n          \"id\": \"<string>\",\n          \"active\": \"<boolean>\",\n          \"category_id\": \"<string>\",\n          \"position\": \"<long>\"\n        },\n        {\n          \"id\": \"<string>\",\n          \"active\": \"<boolean>\",\n          \"category_id\": \"<string>\",\n          \"position\": \"<long>\"\n        }\n      ]\n    }\n  }\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v2/trigger_categories/jobs",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "trigger_categories",
            "jobs"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_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      \"trigger_id\": \"<string>\"\n    },\n    {\n      \"code\": \"<string>\",\n      \"title\": \"<string>\",\n      \"detail\": \"<string>\",\n      \"id\": \"<string>\",\n      \"links\": {},\n      \"source\": {},\n      \"status\": \"<string>\",\n      \"trigger_id\": \"<string>\"\n    }\n  ],\n  \"results\": {\n    \"trigger_categories\": [\n      {\n        \"created_at\": \"<string>\",\n        \"id\": \"<string>\",\n        \"name\": \"<string>\",\n        \"position\": \"<long>\",\n        \"updated_at\": \"<string>\"\n      },\n      {\n        \"created_at\": \"<string>\",\n        \"id\": \"<string>\",\n        \"name\": \"<string>\",\n        \"position\": \"<long>\",\n        \"updated_at\": \"<string>\"\n      }\n    ],\n    \"triggers\": [\n      {\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      {\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    ]\n  },\n  \"status\": \"failed\"\n}"
    },
    {
      "name": "Error",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"job\": {\n    \"action\": \"patch\",\n    \"items\": {\n      \"trigger_categories\": [\n        {\n          \"id\": \"<string>\",\n          \"position\": \"<long>\"\n        },\n        {\n          \"id\": \"<string>\",\n          \"position\": \"<long>\"\n        }\n      ],\n      \"triggers\": [\n        {\n          \"id\": \"<string>\",\n          \"active\": \"<boolean>\",\n          \"category_id\": \"<string>\",\n          \"position\": \"<long>\"\n        },\n        {\n          \"id\": \"<string>\",\n          \"active\": \"<boolean>\",\n          \"category_id\": \"<string>\",\n          \"position\": \"<long>\"\n        }\n      ]\n    }\n  }\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v2/trigger_categories/jobs",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "trigger_categories",
            "jobs"
          ]
        }
      },
      "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      \"trigger_id\": \"<string>\"\n    },\n    {\n      \"code\": \"<string>\",\n      \"title\": \"<string>\",\n      \"detail\": \"<string>\",\n      \"id\": \"<string>\",\n      \"links\": {},\n      \"source\": {},\n      \"status\": \"<string>\",\n      \"trigger_id\": \"<string>\"\n    }\n  ],\n  \"results\": {\n    \"trigger_categories\": [\n      {\n        \"created_at\": \"<string>\",\n        \"id\": \"<string>\",\n        \"name\": \"<string>\",\n        \"position\": \"<long>\",\n        \"updated_at\": \"<string>\"\n      },\n      {\n        \"created_at\": \"<string>\",\n        \"id\": \"<string>\",\n        \"name\": \"<string>\",\n        \"position\": \"<long>\",\n        \"updated_at\": \"<string>\"\n      }\n    ],\n    \"triggers\": [\n      {\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      {\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    ]\n  },\n  \"status\": \"failed\"\n}"
    }
  ]
}