PowerBuilder / Support API / Create Batch Job for Trigger Categories
Back to Collection Items
integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_Json
oleobject loo_Resp
oleobject loo_SbResponseBody
oleobject loo_JResp
integer li_RespStatusCode
string ls_Code
string ls_Title
string ls_Detail
string ls_Id
string ls_Trigger_id
string ls_Created_at
string ls_Name
string ls_Position
string ls_Updated_at
string ls_Active
string ls_Category_id
string ls_Default
string ls_Description
string ls_Raw_title
string ls_Url
integer j
integer li_Count_j
string ls_Field
string ls_Operator
string ls_Value
string ls_Status
integer i
integer li_Count_i
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loo_Http = create oleobject
li_rc = loo_Http.ConnectToNewObject("Chilkat_9_5_0.Http")
if li_rc < 0 then
destroy loo_Http
MessageBox("Error","Connecting to COM object failed")
return
end if
loo_Http.BasicAuth = 1
loo_Http.Login = "login"
loo_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>"
// }
// ]
// }
// }
// }
loo_Json = create oleobject
li_rc = loo_Json.ConnectToNewObject("Chilkat_9_5_0.JsonObject")
loo_Json.UpdateString("job.action","patch")
loo_Json.UpdateString("job.items.trigger_categories[0].id","<string>")
loo_Json.UpdateString("job.items.trigger_categories[0].position","<long>")
loo_Json.UpdateString("job.items.trigger_categories[1].id","<string>")
loo_Json.UpdateString("job.items.trigger_categories[1].position","<long>")
loo_Json.UpdateString("job.items.triggers[0].id","<string>")
loo_Json.UpdateString("job.items.triggers[0].active","<boolean>")
loo_Json.UpdateString("job.items.triggers[0].category_id","<string>")
loo_Json.UpdateString("job.items.triggers[0].position","<long>")
loo_Json.UpdateString("job.items.triggers[1].id","<string>")
loo_Json.UpdateString("job.items.triggers[1].active","<boolean>")
loo_Json.UpdateString("job.items.triggers[1].category_id","<string>")
loo_Json.UpdateString("job.items.triggers[1].position","<long>")
loo_Http.SetRequestHeader("Content-Type","application/json")
loo_Http.SetRequestHeader("Accept","application/json")
loo_Resp = loo_Http.PostJson3("https://example.zendesk.com/api/v2/trigger_categories/jobs","application/json",loo_Json)
if loo_Http.LastMethodSuccess = 0 then
Write-Debug loo_Http.LastErrorText
destroy loo_Http
destroy loo_Json
return
end if
loo_SbResponseBody = create oleobject
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat_9_5_0.StringBuilder")
loo_Resp.GetBodySb(loo_SbResponseBody)
loo_JResp = create oleobject
li_rc = loo_JResp.ConnectToNewObject("Chilkat_9_5_0.JsonObject")
loo_JResp.LoadSb(loo_SbResponseBody)
loo_JResp.EmitCompact = 0
Write-Debug "Response Body:"
Write-Debug loo_JResp.Emit()
li_RespStatusCode = loo_Resp.StatusCode
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_RespStatusCode >= 400 then
Write-Debug "Response Header:"
Write-Debug loo_Resp.Header
Write-Debug "Failed."
destroy loo_Resp
destroy loo_Http
destroy loo_Json
destroy loo_SbResponseBody
destroy loo_JResp
return
end if
destroy loo_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
ls_Status = loo_JResp.StringOf("status")
i = 0
li_Count_i = loo_JResp.SizeOfArray("errors")
do while i < li_Count_i
loo_JResp.I = i
ls_Code = loo_JResp.StringOf("errors[i].code")
ls_Title = loo_JResp.StringOf("errors[i].title")
ls_Detail = loo_JResp.StringOf("errors[i].detail")
ls_Id = loo_JResp.StringOf("errors[i].id")
ls_Status = loo_JResp.StringOf("errors[i].status")
ls_Trigger_id = loo_JResp.StringOf("errors[i].trigger_id")
i = i + 1
loop
i = 0
li_Count_i = loo_JResp.SizeOfArray("results.trigger_categories")
do while i < li_Count_i
loo_JResp.I = i
ls_Created_at = loo_JResp.StringOf("results.trigger_categories[i].created_at")
ls_Id = loo_JResp.StringOf("results.trigger_categories[i].id")
ls_Name = loo_JResp.StringOf("results.trigger_categories[i].name")
ls_Position = loo_JResp.StringOf("results.trigger_categories[i].position")
ls_Updated_at = loo_JResp.StringOf("results.trigger_categories[i].updated_at")
i = i + 1
loop
i = 0
li_Count_i = loo_JResp.SizeOfArray("results.triggers")
do while i < li_Count_i
loo_JResp.I = i
ls_Title = loo_JResp.StringOf("results.triggers[i].title")
ls_Active = loo_JResp.StringOf("results.triggers[i].active")
ls_Category_id = loo_JResp.StringOf("results.triggers[i].category_id")
ls_Created_at = loo_JResp.StringOf("results.triggers[i].created_at")
ls_Default = loo_JResp.StringOf("results.triggers[i].default")
ls_Description = loo_JResp.StringOf("results.triggers[i].description")
ls_Id = loo_JResp.StringOf("results.triggers[i].id")
ls_Position = loo_JResp.StringOf("results.triggers[i].position")
ls_Raw_title = loo_JResp.StringOf("results.triggers[i].raw_title")
ls_Updated_at = loo_JResp.StringOf("results.triggers[i].updated_at")
ls_Url = loo_JResp.StringOf("results.triggers[i].url")
j = 0
li_Count_j = loo_JResp.SizeOfArray("results.triggers[i].conditions.all")
do while j < li_Count_j
loo_JResp.J = j
ls_Field = loo_JResp.StringOf("results.triggers[i].conditions.all[j].field")
ls_Operator = loo_JResp.StringOf("results.triggers[i].conditions.all[j].operator")
ls_Value = loo_JResp.StringOf("results.triggers[i].conditions.all[j].value")
j = j + 1
loop
j = 0
li_Count_j = loo_JResp.SizeOfArray("results.triggers[i].conditions.any")
do while j < li_Count_j
loo_JResp.J = j
ls_Field = loo_JResp.StringOf("results.triggers[i].conditions.any[j].field")
ls_Operator = loo_JResp.StringOf("results.triggers[i].conditions.any[j].operator")
ls_Value = loo_JResp.StringOf("results.triggers[i].conditions.any[j].value")
j = j + 1
loop
j = 0
li_Count_j = loo_JResp.SizeOfArray("results.triggers[i].actions")
do while j < li_Count_j
loo_JResp.J = j
ls_Field = loo_JResp.StringOf("results.triggers[i].actions[j].field")
ls_Value = loo_JResp.StringOf("results.triggers[i].actions[j].value")
j = j + 1
loop
i = i + 1
loop
destroy loo_Http
destroy loo_Json
destroy loo_SbResponseBody
destroy loo_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}"
}
]
}
