Chilkat Online Tools

lianja / Support API / Create Batch Job for Trigger Categories

Back to Collection Items

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

loHttp = createobject("CkHttp")

loHttp.BasicAuth = .T.
loHttp.Login = "login"
loHttp.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>"
//         }
//       ]
//     }
//   }
// }

loJson = createobject("CkJsonObject")
loJson.UpdateString("job.action","patch")
loJson.UpdateString("job.items.trigger_categories[0].id","<string>")
loJson.UpdateString("job.items.trigger_categories[0].position","<long>")
loJson.UpdateString("job.items.trigger_categories[1].id","<string>")
loJson.UpdateString("job.items.trigger_categories[1].position","<long>")
loJson.UpdateString("job.items.triggers[0].id","<string>")
loJson.UpdateString("job.items.triggers[0].active","<boolean>")
loJson.UpdateString("job.items.triggers[0].category_id","<string>")
loJson.UpdateString("job.items.triggers[0].position","<long>")
loJson.UpdateString("job.items.triggers[1].id","<string>")
loJson.UpdateString("job.items.triggers[1].active","<boolean>")
loJson.UpdateString("job.items.triggers[1].category_id","<string>")
loJson.UpdateString("job.items.triggers[1].position","<long>")

loHttp.SetRequestHeader("Content-Type","application/json")
loHttp.SetRequestHeader("Accept","application/json")

loResp = loHttp.PostJson3("https://example.zendesk.com/api/v2/trigger_categories/jobs","application/json",loJson)
if (loHttp.LastMethodSuccess = .F.) then
    ? loHttp.LastErrorText
    release loHttp
    release loJson
    return
endif

loSbResponseBody = createobject("CkStringBuilder")
loResp.GetBodySb(loSbResponseBody)

loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.

? "Response Body:"
? loJResp.Emit()

lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + str(lnRespStatusCode)
if (lnRespStatusCode >= 400) then
    ? "Response Header:"
    ? loResp.Header
    ? "Failed."
    release loResp
    release loHttp
    release loJson
    release loSbResponseBody
    release loJResp
    return
endif

release loResp

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

lcStatus = loJResp.StringOf("status")
i = 0
lnCount_i = loJResp.SizeOfArray("errors")
do while i < lnCount_i
    loJResp.I = i
    lcCode = loJResp.StringOf("errors[i].code")
    lcTitle = loJResp.StringOf("errors[i].title")
    lcDetail = loJResp.StringOf("errors[i].detail")
    lcId = loJResp.StringOf("errors[i].id")
    lcStatus = loJResp.StringOf("errors[i].status")
    lcTrigger_id = loJResp.StringOf("errors[i].trigger_id")
    i = i + 1
enddo
i = 0
lnCount_i = loJResp.SizeOfArray("results.trigger_categories")
do while i < lnCount_i
    loJResp.I = i
    lcCreated_at = loJResp.StringOf("results.trigger_categories[i].created_at")
    lcId = loJResp.StringOf("results.trigger_categories[i].id")
    lcName = loJResp.StringOf("results.trigger_categories[i].name")
    lcPosition = loJResp.StringOf("results.trigger_categories[i].position")
    lcUpdated_at = loJResp.StringOf("results.trigger_categories[i].updated_at")
    i = i + 1
enddo
i = 0
lnCount_i = loJResp.SizeOfArray("results.triggers")
do while i < lnCount_i
    loJResp.I = i
    lcTitle = loJResp.StringOf("results.triggers[i].title")
    lcActive = loJResp.StringOf("results.triggers[i].active")
    lcCategory_id = loJResp.StringOf("results.triggers[i].category_id")
    lcCreated_at = loJResp.StringOf("results.triggers[i].created_at")
    lcDefault = loJResp.StringOf("results.triggers[i].default")
    lcDescription = loJResp.StringOf("results.triggers[i].description")
    lcId = loJResp.StringOf("results.triggers[i].id")
    lcPosition = loJResp.StringOf("results.triggers[i].position")
    lcRaw_title = loJResp.StringOf("results.triggers[i].raw_title")
    lcUpdated_at = loJResp.StringOf("results.triggers[i].updated_at")
    lcUrl = loJResp.StringOf("results.triggers[i].url")
    j = 0
    lnCount_j = loJResp.SizeOfArray("results.triggers[i].conditions.all")
    do while j < lnCount_j
        loJResp.J = j
        lcField = loJResp.StringOf("results.triggers[i].conditions.all[j].field")
        lcOperator = loJResp.StringOf("results.triggers[i].conditions.all[j].operator")
        lcValue = loJResp.StringOf("results.triggers[i].conditions.all[j].value")
        j = j + 1
    enddo
    j = 0
    lnCount_j = loJResp.SizeOfArray("results.triggers[i].conditions.any")
    do while j < lnCount_j
        loJResp.J = j
        lcField = loJResp.StringOf("results.triggers[i].conditions.any[j].field")
        lcOperator = loJResp.StringOf("results.triggers[i].conditions.any[j].operator")
        lcValue = loJResp.StringOf("results.triggers[i].conditions.any[j].value")
        j = j + 1
    enddo
    j = 0
    lnCount_j = loJResp.SizeOfArray("results.triggers[i].actions")
    do while j < lnCount_j
        loJResp.J = j
        lcField = loJResp.StringOf("results.triggers[i].actions[j].field")
        lcValue = loJResp.StringOf("results.triggers[i].actions[j].value")
        j = j + 1
    enddo
    i = i + 1
enddo


release loHttp
release loJson
release loSbResponseBody
release loJResp

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