Objective-C / Support API / Create Batch Job for Trigger Categories
Back to Collection Items
#import <CkoHttp.h>
#import <CkoJsonObject.h>
#import <CkoHttpResponse.h>
#import <CkoStringBuilder.h>
#import <NSString.h>
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
CkoHttp *http = [[CkoHttp alloc] init];
BOOL success;
http.BasicAuth = YES;
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>"
// }
// ]
// }
// }
// }
CkoJsonObject *json = [[CkoJsonObject alloc] init];
[json UpdateString: @"job.action" value: @"patch"];
[json UpdateString: @"job.items.trigger_categories[0].id" value: @"<string>"];
[json UpdateString: @"job.items.trigger_categories[0].position" value: @"<long>"];
[json UpdateString: @"job.items.trigger_categories[1].id" value: @"<string>"];
[json UpdateString: @"job.items.trigger_categories[1].position" value: @"<long>"];
[json UpdateString: @"job.items.triggers[0].id" value: @"<string>"];
[json UpdateString: @"job.items.triggers[0].active" value: @"<boolean>"];
[json UpdateString: @"job.items.triggers[0].category_id" value: @"<string>"];
[json UpdateString: @"job.items.triggers[0].position" value: @"<long>"];
[json UpdateString: @"job.items.triggers[1].id" value: @"<string>"];
[json UpdateString: @"job.items.triggers[1].active" value: @"<boolean>"];
[json UpdateString: @"job.items.triggers[1].category_id" value: @"<string>"];
[json UpdateString: @"job.items.triggers[1].position" value: @"<long>"];
[http SetRequestHeader: @"Content-Type" value: @"application/json"];
[http SetRequestHeader: @"Accept" value: @"application/json"];
CkoHttpResponse *resp = [http PostJson3: @"https://example.zendesk.com/api/v2/trigger_categories/jobs" contentType: @"application/json" json: json];
if (http.LastMethodSuccess == NO) {
NSLog(@"%@",http.LastErrorText);
return;
}
CkoStringBuilder *sbResponseBody = [[CkoStringBuilder alloc] init];
[resp GetBodySb: sbResponseBody];
CkoJsonObject *jResp = [[CkoJsonObject alloc] init];
[jResp LoadSb: sbResponseBody];
jResp.EmitCompact = NO;
NSLog(@"%@",@"Response Body:");
NSLog(@"%@",[jResp Emit]);
int respStatusCode = [resp.StatusCode intValue];
NSLog(@"%@%d",@"Response Status Code = ",respStatusCode);
if (respStatusCode >= 400) {
NSLog(@"%@",@"Response Header:");
NSLog(@"%@",resp.Header);
NSLog(@"%@",@"Failed.");
return;
}
// 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
NSString *code = 0;
NSString *title = 0;
NSString *detail = 0;
NSString *id = 0;
NSString *trigger_id = 0;
NSString *created_at = 0;
NSString *name = 0;
NSString *position = 0;
NSString *updated_at = 0;
NSString *active = 0;
NSString *category_id = 0;
NSString *default = 0;
NSString *description = 0;
NSString *raw_title = 0;
NSString *url = 0;
int j;
int count_j;
NSString *field = 0;
NSString *operator = 0;
NSString *value = 0;
NSString *status = [jResp StringOf: @"status"];
int i = 0;
int count_i = [[jResp SizeOfArray: @"errors"] intValue];
while (i < count_i) {
jResp.I = [NSNumber numberWithInt: 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;
}
i = 0;
count_i = [[jResp SizeOfArray: @"results.trigger_categories"] intValue];
while (i < count_i) {
jResp.I = [NSNumber numberWithInt: 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;
}
i = 0;
count_i = [[jResp SizeOfArray: @"results.triggers"] intValue];
while (i < count_i) {
jResp.I = [NSNumber numberWithInt: 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"] intValue];
while (j < count_j) {
jResp.J = [NSNumber numberWithInt: 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;
}
j = 0;
count_j = [[jResp SizeOfArray: @"results.triggers[i].conditions.any"] intValue];
while (j < count_j) {
jResp.J = [NSNumber numberWithInt: 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;
}
j = 0;
count_j = [[jResp SizeOfArray: @"results.triggers[i].actions"] intValue];
while (j < count_j) {
jResp.J = [NSNumber numberWithInt: j];
field = [jResp StringOf: @"results.triggers[i].actions[j].field"];
value = [jResp StringOf: @"results.triggers[i].actions[j].value"];
j = j + 1;
}
i = i + 1;
}
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}"
}
]
}
