VB6 / 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.
Dim http As New ChilkatHttp
Dim success As Long
http.BasicAuth = 1
http.Login = "login"
http.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>"
' }
' ]
' }
' }
' }
Dim json As New ChilkatJsonObject
success = json.UpdateString("job.action","patch")
success = json.UpdateString("job.items.trigger_categories[0].id","<string>")
success = json.UpdateString("job.items.trigger_categories[0].position","<long>")
success = json.UpdateString("job.items.trigger_categories[1].id","<string>")
success = json.UpdateString("job.items.trigger_categories[1].position","<long>")
success = json.UpdateString("job.items.triggers[0].id","<string>")
success = json.UpdateString("job.items.triggers[0].active","<boolean>")
success = json.UpdateString("job.items.triggers[0].category_id","<string>")
success = json.UpdateString("job.items.triggers[0].position","<long>")
success = json.UpdateString("job.items.triggers[1].id","<string>")
success = json.UpdateString("job.items.triggers[1].active","<boolean>")
success = json.UpdateString("job.items.triggers[1].category_id","<string>")
success = json.UpdateString("job.items.triggers[1].position","<long>")
http.SetRequestHeader "Content-Type","application/json"
http.SetRequestHeader "Accept","application/json"
Dim resp As ChilkatHttpResponse
Set resp = http.PostJson3("https://example.zendesk.com/api/v2/trigger_categories/jobs","application/json",json)
If (http.LastMethodSuccess = 0) Then
Debug.Print http.LastErrorText
Exit Sub
End If
Dim sbResponseBody As New ChilkatStringBuilder
success = resp.GetBodySb(sbResponseBody)
Dim jResp As New ChilkatJsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = 0
Debug.Print "Response Body:"
Debug.Print jResp.Emit()
Dim respStatusCode As Long
respStatusCode = resp.StatusCode
Debug.Print "Response Status Code = " & respStatusCode
If (respStatusCode >= 400) Then
Debug.Print "Response Header:"
Debug.Print resp.Header
Debug.Print "Failed."
Exit Sub
End If
' 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
Dim code As String
Dim title As String
Dim detail As String
Dim id As String
Dim trigger_id As String
Dim created_at As String
Dim name As String
Dim position As String
Dim updated_at As String
Dim active As String
Dim category_id As String
Dim default As String
Dim description As String
Dim raw_title As String
Dim url As String
Dim j As Long
Dim count_j As Long
Dim field As String
Dim operator As String
Dim value As String
Dim status As String
status = jResp.StringOf("status")
Dim i As Long
i = 0
Dim count_i As Long
count_i = jResp.SizeOfArray("errors")
Do While i < count_i
jResp.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
Loop
i = 0
count_i = jResp.SizeOfArray("results.trigger_categories")
Do While i < count_i
jResp.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
Loop
i = 0
count_i = jResp.SizeOfArray("results.triggers")
Do While i < count_i
jResp.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")
Do While j < count_j
jResp.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
Loop
j = 0
count_j = jResp.SizeOfArray("results.triggers[i].conditions.any")
Do While j < count_j
jResp.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
Loop
j = 0
count_j = jResp.SizeOfArray("results.triggers[i].actions")
Do While j < count_j
jResp.J = j
field = jResp.StringOf("results.triggers[i].actions[j].field")
value = jResp.StringOf("results.triggers[i].actions[j].value")
j = j + 1
Loop
i = i + 1
Loop
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}"
}
]
}
