Objective-C / Support API / Create Workspace
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.
// {
// "workspace": {
// "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>"
// }
// ]
// },
// "description": "<string>",
// "macros": [
// "<number>",
// "<number>"
// ],
// "ticket_form_id": "<number>",
// "title": "<string>"
// }
// }
CkoJsonObject *json = [[CkoJsonObject alloc] init];
[json UpdateString: @"workspace.conditions.all[0].field" value: @"<string>"];
[json UpdateString: @"workspace.conditions.all[0].operator" value: @"<string>"];
[json UpdateString: @"workspace.conditions.all[0].value" value: @"<string>"];
[json UpdateString: @"workspace.conditions.all[1].field" value: @"<string>"];
[json UpdateString: @"workspace.conditions.all[1].operator" value: @"<string>"];
[json UpdateString: @"workspace.conditions.all[1].value" value: @"<string>"];
[json UpdateString: @"workspace.conditions.any[0].field" value: @"<string>"];
[json UpdateString: @"workspace.conditions.any[0].operator" value: @"<string>"];
[json UpdateString: @"workspace.conditions.any[0].value" value: @"<string>"];
[json UpdateString: @"workspace.conditions.any[1].field" value: @"<string>"];
[json UpdateString: @"workspace.conditions.any[1].operator" value: @"<string>"];
[json UpdateString: @"workspace.conditions.any[1].value" value: @"<string>"];
[json UpdateString: @"workspace.description" value: @"<string>"];
[json UpdateString: @"workspace.macros[0]" value: @"<number>"];
[json UpdateString: @"workspace.macros[1]" value: @"<number>"];
[json UpdateString: @"workspace.ticket_form_id" value: @"<number>"];
[json UpdateString: @"workspace.title" value: @"<string>"];
[http SetRequestHeader: @"Content-Type" value: @"application/json"];
[http SetRequestHeader: @"Accept" value: @"application/json"];
CkoHttpResponse *resp = [http PostJson3: @"https://example.zendesk.com/api/v2/workspaces" 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)
// {
// "workspace": {
// "activated": "<boolean>",
// "apps": [
// {
// "ad_be": true,
// "ead07": 69455617,
// "adipisicinga": true
// },
// {
// "fugiat_e": false,
// "dolorf7": -57129708.70016649
// }
// ],
// "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>"
// }
// ]
// },
// "created_at": "<dateTime>",
// "description": "<string>",
// "id": "<integer>",
// "macro_ids": [
// "<integer>",
// "<integer>"
// ],
// "macros": [
// "<integer>",
// "<integer>"
// ],
// "position": "<integer>",
// "prefer_workspace_app_order": "<boolean>",
// "selected_macros": [
// {
// "actions": [
// {
// "field": "<string>",
// "value": "<string>"
// },
// {
// "field": "<string>",
// "value": "<string>"
// }
// ],
// "title": "<string>",
// "active": "<boolean>",
// "created_at": "<dateTime>",
// "default": "<boolean>",
// "description": "<string>",
// "id": "<integer>",
// "position": "<integer>",
// "restriction": {
// "in_f25": true,
// "nisid81": "reprehenderit anim nostrud id",
// "minim_886": false
// },
// "updated_at": "<dateTime>",
// "url": "<string>",
// "app_installation": "<string>",
// "categories": "<string>",
// "permissions": "<string>",
// "usage_1h": "<integer>",
// "usage_7d": "<integer>",
// "usage_24h": "<integer>",
// "usage_30d": "<integer>"
// },
// {
// "actions": [
// {
// "field": "<string>",
// "value": "<string>"
// },
// {
// "field": "<string>",
// "value": "<string>"
// }
// ],
// "title": "<string>",
// "active": "<boolean>",
// "created_at": "<dateTime>",
// "default": "<boolean>",
// "description": "<string>",
// "id": "<integer>",
// "position": "<integer>",
// "restriction": {
// "culpa__d7": false,
// "ad7": true,
// "esse0": -82046233.9137964,
// "veniam_f": -91185504
// },
// "updated_at": "<dateTime>",
// "url": "<string>",
// "app_installation": "<string>",
// "categories": "<string>",
// "permissions": "<string>",
// "usage_1h": "<integer>",
// "usage_7d": "<integer>",
// "usage_24h": "<integer>",
// "usage_30d": "<integer>"
// }
// ],
// "ticket_form_id": "<integer>",
// "title": "<string>",
// "updated_at": "<dateTime>",
// "url": "<string>"
// }
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
BOOL ad_be;
int ead07;
BOOL adipisicinga;
BOOL fugiat_e;
NSString *dolorf7 = 0;
NSString *field = 0;
NSString *operator = 0;
NSString *value = 0;
NSString *strVal = 0;
NSString *title = 0;
NSString *active = 0;
NSString *created_at = 0;
NSString *default = 0;
NSString *description = 0;
NSString *id = 0;
NSString *position = 0;
BOOL In_f25;
NSString *Nisid81 = 0;
BOOL Minim_886;
NSString *updated_at = 0;
NSString *url = 0;
NSString *app_installation = 0;
NSString *categories = 0;
NSString *permissions = 0;
NSString *usage_1h = 0;
NSString *usage_7d = 0;
NSString *usage_24h = 0;
NSString *usage_30d = 0;
BOOL Culpa__d7;
BOOL Ad7;
NSString *Esse0 = 0;
int Veniam_f;
int j;
int count_j;
NSString *Activated = [jResp StringOf: @"workspace.activated"];
NSString *Created_at = [jResp StringOf: @"workspace.created_at"];
NSString *Description = [jResp StringOf: @"workspace.description"];
NSString *Id = [jResp StringOf: @"workspace.id"];
NSString *Position = [jResp StringOf: @"workspace.position"];
NSString *Prefer_workspace_app_order = [jResp StringOf: @"workspace.prefer_workspace_app_order"];
NSString *Ticket_form_id = [jResp StringOf: @"workspace.ticket_form_id"];
NSString *Title = [jResp StringOf: @"workspace.title"];
NSString *Updated_at = [jResp StringOf: @"workspace.updated_at"];
NSString *v_Url = [jResp StringOf: @"workspace.url"];
int i = 0;
int count_i = [[jResp SizeOfArray: @"workspace.apps"] intValue];
while (i < count_i) {
jResp.I = [NSNumber numberWithInt: i];
ad_be = [jResp BoolOf: @"workspace.apps[i].ad_be"];
ead07 = [[jResp IntOf: @"workspace.apps[i].ead07"] intValue];
adipisicinga = [jResp BoolOf: @"workspace.apps[i].adipisicinga"];
fugiat_e = [jResp BoolOf: @"workspace.apps[i].fugiat_e"];
dolorf7 = [jResp StringOf: @"workspace.apps[i].dolorf7"];
i = i + 1;
}
i = 0;
count_i = [[jResp SizeOfArray: @"workspace.conditions.all"] intValue];
while (i < count_i) {
jResp.I = [NSNumber numberWithInt: i];
field = [jResp StringOf: @"workspace.conditions.all[i].field"];
operator = [jResp StringOf: @"workspace.conditions.all[i].operator"];
value = [jResp StringOf: @"workspace.conditions.all[i].value"];
i = i + 1;
}
i = 0;
count_i = [[jResp SizeOfArray: @"workspace.conditions.any"] intValue];
while (i < count_i) {
jResp.I = [NSNumber numberWithInt: i];
field = [jResp StringOf: @"workspace.conditions.any[i].field"];
operator = [jResp StringOf: @"workspace.conditions.any[i].operator"];
value = [jResp StringOf: @"workspace.conditions.any[i].value"];
i = i + 1;
}
i = 0;
count_i = [[jResp SizeOfArray: @"workspace.macro_ids"] intValue];
while (i < count_i) {
jResp.I = [NSNumber numberWithInt: i];
strVal = [jResp StringOf: @"workspace.macro_ids[i]"];
i = i + 1;
}
i = 0;
count_i = [[jResp SizeOfArray: @"workspace.macros"] intValue];
while (i < count_i) {
jResp.I = [NSNumber numberWithInt: i];
strVal = [jResp StringOf: @"workspace.macros[i]"];
i = i + 1;
}
i = 0;
count_i = [[jResp SizeOfArray: @"workspace.selected_macros"] intValue];
while (i < count_i) {
jResp.I = [NSNumber numberWithInt: i];
title = [jResp StringOf: @"workspace.selected_macros[i].title"];
active = [jResp StringOf: @"workspace.selected_macros[i].active"];
created_at = [jResp StringOf: @"workspace.selected_macros[i].created_at"];
default = [jResp StringOf: @"workspace.selected_macros[i].default"];
description = [jResp StringOf: @"workspace.selected_macros[i].description"];
id = [jResp StringOf: @"workspace.selected_macros[i].id"];
position = [jResp StringOf: @"workspace.selected_macros[i].position"];
In_f25 = [jResp BoolOf: @"workspace.selected_macros[i].restriction.in_f25"];
Nisid81 = [jResp StringOf: @"workspace.selected_macros[i].restriction.nisid81"];
Minim_886 = [jResp BoolOf: @"workspace.selected_macros[i].restriction.minim_886"];
updated_at = [jResp StringOf: @"workspace.selected_macros[i].updated_at"];
url = [jResp StringOf: @"workspace.selected_macros[i].url"];
app_installation = [jResp StringOf: @"workspace.selected_macros[i].app_installation"];
categories = [jResp StringOf: @"workspace.selected_macros[i].categories"];
permissions = [jResp StringOf: @"workspace.selected_macros[i].permissions"];
usage_1h = [jResp StringOf: @"workspace.selected_macros[i].usage_1h"];
usage_7d = [jResp StringOf: @"workspace.selected_macros[i].usage_7d"];
usage_24h = [jResp StringOf: @"workspace.selected_macros[i].usage_24h"];
usage_30d = [jResp StringOf: @"workspace.selected_macros[i].usage_30d"];
Culpa__d7 = [jResp BoolOf: @"workspace.selected_macros[i].restriction.culpa__d7"];
Ad7 = [jResp BoolOf: @"workspace.selected_macros[i].restriction.ad7"];
Esse0 = [jResp StringOf: @"workspace.selected_macros[i].restriction.esse0"];
Veniam_f = [[jResp IntOf: @"workspace.selected_macros[i].restriction.veniam_f"] intValue];
j = 0;
count_j = [[jResp SizeOfArray: @"workspace.selected_macros[i].actions"] intValue];
while (j < count_j) {
jResp.J = [NSNumber numberWithInt: j];
field = [jResp StringOf: @"workspace.selected_macros[i].actions[j].field"];
value = [jResp StringOf: @"workspace.selected_macros[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 '{
"workspace": {
"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>"
}
]
},
"description": "<string>",
"macros": [
"<number>",
"<number>"
],
"ticket_form_id": "<number>",
"title": "<string>"
}
}'
https://example.zendesk.com/api/v2/workspaces
Postman Collection Item JSON
{
"name": "Create Workspace",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"workspace\": {\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 \"description\": \"<string>\",\n \"macros\": [\n \"<number>\",\n \"<number>\"\n ],\n \"ticket_form_id\": \"<number>\",\n \"title\": \"<string>\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/workspaces",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"workspaces"
]
},
"description": "#### Allowed For\n\n* Admins\n"
},
"response": [
{
"name": "Created workspace",
"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 \"workspace\": {\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 \"description\": \"<string>\",\n \"macros\": [\n \"<number>\",\n \"<number>\"\n ],\n \"ticket_form_id\": \"<number>\",\n \"title\": \"<string>\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/workspaces",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"workspaces"
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"workspace\": {\n \"activated\": \"<boolean>\",\n \"apps\": [\n {\n \"ad_be\": true,\n \"ead07\": 69455617,\n \"adipisicinga\": true\n },\n {\n \"fugiat_e\": false,\n \"dolorf7\": -57129708.70016649\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 \"created_at\": \"<dateTime>\",\n \"description\": \"<string>\",\n \"id\": \"<integer>\",\n \"macro_ids\": [\n \"<integer>\",\n \"<integer>\"\n ],\n \"macros\": [\n \"<integer>\",\n \"<integer>\"\n ],\n \"position\": \"<integer>\",\n \"prefer_workspace_app_order\": \"<boolean>\",\n \"selected_macros\": [\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 \"created_at\": \"<dateTime>\",\n \"default\": \"<boolean>\",\n \"description\": \"<string>\",\n \"id\": \"<integer>\",\n \"position\": \"<integer>\",\n \"restriction\": {\n \"in_f25\": true,\n \"nisid81\": \"reprehenderit anim nostrud id\",\n \"minim_886\": false\n },\n \"updated_at\": \"<dateTime>\",\n \"url\": \"<string>\",\n \"app_installation\": \"<string>\",\n \"categories\": \"<string>\",\n \"permissions\": \"<string>\",\n \"usage_1h\": \"<integer>\",\n \"usage_7d\": \"<integer>\",\n \"usage_24h\": \"<integer>\",\n \"usage_30d\": \"<integer>\"\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 \"created_at\": \"<dateTime>\",\n \"default\": \"<boolean>\",\n \"description\": \"<string>\",\n \"id\": \"<integer>\",\n \"position\": \"<integer>\",\n \"restriction\": {\n \"culpa__d7\": false,\n \"ad7\": true,\n \"esse0\": -82046233.9137964,\n \"veniam_f\": -91185504\n },\n \"updated_at\": \"<dateTime>\",\n \"url\": \"<string>\",\n \"app_installation\": \"<string>\",\n \"categories\": \"<string>\",\n \"permissions\": \"<string>\",\n \"usage_1h\": \"<integer>\",\n \"usage_7d\": \"<integer>\",\n \"usage_24h\": \"<integer>\",\n \"usage_30d\": \"<integer>\"\n }\n ],\n \"ticket_form_id\": \"<integer>\",\n \"title\": \"<string>\",\n \"updated_at\": \"<dateTime>\",\n \"url\": \"<string>\"\n }\n}"
}
]
}
