delphiDll / Support API / Create Batch Job for Trigger Categories
Back to Collection Items
var
http: HCkHttp;
success: Boolean;
json: HCkJsonObject;
resp: HCkHttpResponse;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
code: PWideChar;
title: PWideChar;
detail: PWideChar;
id: PWideChar;
trigger_id: PWideChar;
created_at: PWideChar;
name: PWideChar;
position: PWideChar;
updated_at: PWideChar;
active: PWideChar;
category_id: PWideChar;
default: PWideChar;
description: PWideChar;
raw_title: PWideChar;
url: PWideChar;
j: Integer;
count_j: Integer;
field: PWideChar;
operator: PWideChar;
value: PWideChar;
status: PWideChar;
i: Integer;
count_i: Integer;
begin
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http := CkHttp_Create();
CkHttp_putBasicAuth(http,True);
CkHttp_putLogin(http,'login');
CkHttp_putPassword(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>"
// }
// ]
// }
// }
// }
json := CkJsonObject_Create();
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 := CkHttp_PostJson3(http,'https://example.zendesk.com/api/v2/trigger_categories/jobs','application/json',json);
if (CkHttp_getLastMethodSuccess(http) = False) then
begin
Memo1.Lines.Add(CkHttp__lastErrorText(http));
Exit;
end;
sbResponseBody := CkStringBuilder_Create();
CkHttpResponse_GetBodySb(resp,sbResponseBody);
jResp := CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,False);
Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(CkJsonObject__emit(jResp));
respStatusCode := CkHttpResponse_getStatusCode(resp);
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
begin
Memo1.Lines.Add('Response Header:');
Memo1.Lines.Add(CkHttpResponse__header(resp));
Memo1.Lines.Add('Failed.');
CkHttpResponse_Dispose(resp);
Exit;
end;
CkHttpResponse_Dispose(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
status := CkJsonObject__stringOf(jResp,'status');
i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'errors');
while i < count_i do
begin
CkJsonObject_putI(jResp,i);
code := CkJsonObject__stringOf(jResp,'errors[i].code');
title := CkJsonObject__stringOf(jResp,'errors[i].title');
detail := CkJsonObject__stringOf(jResp,'errors[i].detail');
id := CkJsonObject__stringOf(jResp,'errors[i].id');
status := CkJsonObject__stringOf(jResp,'errors[i].status');
trigger_id := CkJsonObject__stringOf(jResp,'errors[i].trigger_id');
i := i + 1;
end;
i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'results.trigger_categories');
while i < count_i do
begin
CkJsonObject_putI(jResp,i);
created_at := CkJsonObject__stringOf(jResp,'results.trigger_categories[i].created_at');
id := CkJsonObject__stringOf(jResp,'results.trigger_categories[i].id');
name := CkJsonObject__stringOf(jResp,'results.trigger_categories[i].name');
position := CkJsonObject__stringOf(jResp,'results.trigger_categories[i].position');
updated_at := CkJsonObject__stringOf(jResp,'results.trigger_categories[i].updated_at');
i := i + 1;
end;
i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'results.triggers');
while i < count_i do
begin
CkJsonObject_putI(jResp,i);
title := CkJsonObject__stringOf(jResp,'results.triggers[i].title');
active := CkJsonObject__stringOf(jResp,'results.triggers[i].active');
category_id := CkJsonObject__stringOf(jResp,'results.triggers[i].category_id');
created_at := CkJsonObject__stringOf(jResp,'results.triggers[i].created_at');
default := CkJsonObject__stringOf(jResp,'results.triggers[i].default');
description := CkJsonObject__stringOf(jResp,'results.triggers[i].description');
id := CkJsonObject__stringOf(jResp,'results.triggers[i].id');
position := CkJsonObject__stringOf(jResp,'results.triggers[i].position');
raw_title := CkJsonObject__stringOf(jResp,'results.triggers[i].raw_title');
updated_at := CkJsonObject__stringOf(jResp,'results.triggers[i].updated_at');
url := CkJsonObject__stringOf(jResp,'results.triggers[i].url');
j := 0;
count_j := CkJsonObject_SizeOfArray(jResp,'results.triggers[i].conditions.all');
while j < count_j do
begin
CkJsonObject_putJ(jResp,j);
field := CkJsonObject__stringOf(jResp,'results.triggers[i].conditions.all[j].field');
operator := CkJsonObject__stringOf(jResp,'results.triggers[i].conditions.all[j].operator');
value := CkJsonObject__stringOf(jResp,'results.triggers[i].conditions.all[j].value');
j := j + 1;
end;
j := 0;
count_j := CkJsonObject_SizeOfArray(jResp,'results.triggers[i].conditions.any');
while j < count_j do
begin
CkJsonObject_putJ(jResp,j);
field := CkJsonObject__stringOf(jResp,'results.triggers[i].conditions.any[j].field');
operator := CkJsonObject__stringOf(jResp,'results.triggers[i].conditions.any[j].operator');
value := CkJsonObject__stringOf(jResp,'results.triggers[i].conditions.any[j].value');
j := j + 1;
end;
j := 0;
count_j := CkJsonObject_SizeOfArray(jResp,'results.triggers[i].actions');
while j < count_j do
begin
CkJsonObject_putJ(jResp,j);
field := CkJsonObject__stringOf(jResp,'results.triggers[i].actions[j].field');
value := CkJsonObject__stringOf(jResp,'results.triggers[i].actions[j].value');
j := j + 1;
end;
i := i + 1;
end;
CkHttp_Dispose(http);
CkJsonObject_Dispose(json);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(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}"
}
]
}
