Chilkat Online Tools

Perl / Support API / Create Batch Job for Trigger Categories

Back to Collection Items

use chilkat();

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

$http = chilkat::CkHttp->new();

$http->put_BasicAuth(1);
$http->put_Login("login");
$http->put_Password("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>"
#         }
#       ]
#     }
#   }
# }

$json = chilkat::CkJsonObject->new();
$json->UpdateString("job.action","patch");
$json->UpdateString("job.items.trigger_categories[0].id","<string>");
$json->UpdateString("job.items.trigger_categories[0].position","<long>");
$json->UpdateString("job.items.trigger_categories[1].id","<string>");
$json->UpdateString("job.items.trigger_categories[1].position","<long>");
$json->UpdateString("job.items.triggers[0].id","<string>");
$json->UpdateString("job.items.triggers[0].active","<boolean>");
$json->UpdateString("job.items.triggers[0].category_id","<string>");
$json->UpdateString("job.items.triggers[0].position","<long>");
$json->UpdateString("job.items.triggers[1].id","<string>");
$json->UpdateString("job.items.triggers[1].active","<boolean>");
$json->UpdateString("job.items.triggers[1].category_id","<string>");
$json->UpdateString("job.items.triggers[1].position","<long>");

$http->SetRequestHeader("Content-Type","application/json");
$http->SetRequestHeader("Accept","application/json");

# resp is a HttpResponse
$resp = $http->PostJson3("https://example.zendesk.com/api/v2/trigger_categories/jobs","application/json",$json);
if ($http->get_LastMethodSuccess() == 0) {
    print $http->lastErrorText() . "\r\n";
    exit;
}

$sbResponseBody = chilkat::CkStringBuilder->new();
$resp->GetBodySb($sbResponseBody);

$jResp = chilkat::CkJsonObject->new();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(0);

print "Response Body:" . "\r\n";
print $jResp->emit() . "\r\n";

$respStatusCode = $resp->get_StatusCode();
print "Response Status Code = " . $respStatusCode . "\r\n";
if ($respStatusCode >= 400) {
    print "Response Header:" . "\r\n";
    print $resp->header() . "\r\n";
    print "Failed." . "\r\n";

    exit;
}

# 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

$status = $jResp->stringOf("status");
$i = 0;
$count_i = $jResp->SizeOfArray("errors");
while ($i < $count_i) {
    $jResp->put_I($i);
    $code = $jResp->stringOf("errors[i].code");
    $title = $jResp->stringOf("errors[i].title");
    $detail = $jResp->stringOf("errors[i].detail");
    $id = $jResp->stringOf("errors[i].id");
    $status = $jResp->stringOf("errors[i].status");
    $trigger_id = $jResp->stringOf("errors[i].trigger_id");
    $i = $i + 1;
}

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

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

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

    $j = 0;
    $count_j = $jResp->SizeOfArray("results.triggers[i].actions");
    while ($j < $count_j) {
        $jResp->put_J($j);
        $field = $jResp->stringOf("results.triggers[i].actions[j].field");
        $value = $jResp->stringOf("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}"
    }
  ]
}