TCL / Support API / Create Batch Job for Trigger Categories
Back to Collection Items
load ./chilkat.dll
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
set http [new_CkHttp]
CkHttp_put_BasicAuth $http 1
CkHttp_put_Login $http "login"
CkHttp_put_Password $http "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>"
# }
# ]
# }
# }
# }
set json [new_CkJsonObject]
CkJsonObject_UpdateString $json "job.action" "patch"
CkJsonObject_UpdateString $json "job.items.trigger_categories[0].id" "<string>"
CkJsonObject_UpdateString $json "job.items.trigger_categories[0].position" "<long>"
CkJsonObject_UpdateString $json "job.items.trigger_categories[1].id" "<string>"
CkJsonObject_UpdateString $json "job.items.trigger_categories[1].position" "<long>"
CkJsonObject_UpdateString $json "job.items.triggers[0].id" "<string>"
CkJsonObject_UpdateString $json "job.items.triggers[0].active" "<boolean>"
CkJsonObject_UpdateString $json "job.items.triggers[0].category_id" "<string>"
CkJsonObject_UpdateString $json "job.items.triggers[0].position" "<long>"
CkJsonObject_UpdateString $json "job.items.triggers[1].id" "<string>"
CkJsonObject_UpdateString $json "job.items.triggers[1].active" "<boolean>"
CkJsonObject_UpdateString $json "job.items.triggers[1].category_id" "<string>"
CkJsonObject_UpdateString $json "job.items.triggers[1].position" "<long>"
CkHttp_SetRequestHeader $http "Content-Type" "application/json"
CkHttp_SetRequestHeader $http "Accept" "application/json"
# resp is a CkHttpResponse
set resp [CkHttp_PostJson3 $http "https://example.zendesk.com/api/v2/trigger_categories/jobs" "application/json" $json]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkJsonObject $json
exit
}
set sbResponseBody [new_CkStringBuilder]
CkHttpResponse_GetBodySb $resp $sbResponseBody
set jResp [new_CkJsonObject]
CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0
puts "Response Body:"
puts [CkJsonObject_emit $jResp]
set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
puts "Response Header:"
puts [CkHttpResponse_header $resp]
puts "Failed."
delete_CkHttpResponse $resp
delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
exit
}
delete_CkHttpResponse $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
set status [CkJsonObject_stringOf $jResp "status"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "errors"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set code [CkJsonObject_stringOf $jResp "errors[i].code"]
set title [CkJsonObject_stringOf $jResp "errors[i].title"]
set detail [CkJsonObject_stringOf $jResp "errors[i].detail"]
set id [CkJsonObject_stringOf $jResp "errors[i].id"]
set status [CkJsonObject_stringOf $jResp "errors[i].status"]
set trigger_id [CkJsonObject_stringOf $jResp "errors[i].trigger_id"]
set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "results.trigger_categories"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set created_at [CkJsonObject_stringOf $jResp "results.trigger_categories[i].created_at"]
set id [CkJsonObject_stringOf $jResp "results.trigger_categories[i].id"]
set name [CkJsonObject_stringOf $jResp "results.trigger_categories[i].name"]
set position [CkJsonObject_stringOf $jResp "results.trigger_categories[i].position"]
set updated_at [CkJsonObject_stringOf $jResp "results.trigger_categories[i].updated_at"]
set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "results.triggers"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set title [CkJsonObject_stringOf $jResp "results.triggers[i].title"]
set active [CkJsonObject_stringOf $jResp "results.triggers[i].active"]
set category_id [CkJsonObject_stringOf $jResp "results.triggers[i].category_id"]
set created_at [CkJsonObject_stringOf $jResp "results.triggers[i].created_at"]
set default [CkJsonObject_stringOf $jResp "results.triggers[i].default"]
set description [CkJsonObject_stringOf $jResp "results.triggers[i].description"]
set id [CkJsonObject_stringOf $jResp "results.triggers[i].id"]
set position [CkJsonObject_stringOf $jResp "results.triggers[i].position"]
set raw_title [CkJsonObject_stringOf $jResp "results.triggers[i].raw_title"]
set updated_at [CkJsonObject_stringOf $jResp "results.triggers[i].updated_at"]
set url [CkJsonObject_stringOf $jResp "results.triggers[i].url"]
set j 0
set count_j [CkJsonObject_SizeOfArray $jResp "results.triggers[i].conditions.all"]
while {$j < $count_j} {
CkJsonObject_put_J $jResp $j
set field [CkJsonObject_stringOf $jResp "results.triggers[i].conditions.all[j].field"]
set operator [CkJsonObject_stringOf $jResp "results.triggers[i].conditions.all[j].operator"]
set value [CkJsonObject_stringOf $jResp "results.triggers[i].conditions.all[j].value"]
set j [expr $j + 1]
}
set j 0
set count_j [CkJsonObject_SizeOfArray $jResp "results.triggers[i].conditions.any"]
while {$j < $count_j} {
CkJsonObject_put_J $jResp $j
set field [CkJsonObject_stringOf $jResp "results.triggers[i].conditions.any[j].field"]
set operator [CkJsonObject_stringOf $jResp "results.triggers[i].conditions.any[j].operator"]
set value [CkJsonObject_stringOf $jResp "results.triggers[i].conditions.any[j].value"]
set j [expr $j + 1]
}
set j 0
set count_j [CkJsonObject_SizeOfArray $jResp "results.triggers[i].actions"]
while {$j < $count_j} {
CkJsonObject_put_J $jResp $j
set field [CkJsonObject_stringOf $jResp "results.triggers[i].actions[j].field"]
set value [CkJsonObject_stringOf $jResp "results.triggers[i].actions[j].value"]
set j [expr $j + 1]
}
set i [expr $i + 1]
}
delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
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}"
}
]
}