Back to Collection Items
#include <C_CkHttpW.h>
#include <C_CkJsonObjectW.h>
#include <C_CkStringBuilderW.h>
#include <C_CkHttpResponseW.h>
void ChilkatSample(void)
{
HCkHttpW http;
BOOL success;
HCkJsonObjectW json;
HCkStringBuilderW sbRequestBody;
HCkHttpResponseW resp;
HCkStringBuilderW sbResponseBody;
HCkJsonObjectW jResp;
int respStatusCode;
const wchar_t *prefix;
const wchar_t *id;
const wchar_t *label;
const wchar_t *entityIdValue;
const wchar_t *entityValue;
const wchar_t *value;
const wchar_t *templateId;
const wchar_t *name;
const wchar_t *description;
const wchar_t *templateType;
const wchar_t *Body;
const wchar_t *Value;
const wchar_t *Representation;
const wchar_t *Content;
const wchar_t *AllValue;
const wchar_t *CssValue;
const wchar_t *JsValue;
const wchar_t *DataValue;
const wchar_t *SuperbatchValue;
int i;
int count_i;
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http = CkHttpW_Create();
// Use this online tool to generate code from sample JSON: Generate Code to Create JSON
// The following JSON is sent in the request body.
// {
// "templateId": "<string>",
// "name": "<string>",
// "templateType": "<string>",
// "body": {
// "value": "<string>",
// "representation": "<string>"
// },
// "description": "<string>",
// "labels": [
// {
// "prefix": "ipsum dolor Excepteur Duis",
// "name": "nulla et ipsum voluptate consectetur",
// "id": "nostrud enim proident cupidatat eu",
// "label": "enim Lorem veniam amet"
// },
// {
// "prefix": "amet",
// "name": "officia adipisicing ut labo",
// "id": "ipsum in tempor",
// "label": "est occaecat magna"
// }
// ],
// "space": {
// "key": "<string>"
// }
// }
json = CkJsonObjectW_Create();
CkJsonObjectW_UpdateString(json,L"templateId",L"<string>");
CkJsonObjectW_UpdateString(json,L"name",L"<string>");
CkJsonObjectW_UpdateString(json,L"templateType",L"<string>");
CkJsonObjectW_UpdateString(json,L"body.value",L"<string>");
CkJsonObjectW_UpdateString(json,L"body.representation",L"<string>");
CkJsonObjectW_UpdateString(json,L"description",L"<string>");
CkJsonObjectW_UpdateString(json,L"labels[0].prefix",L"ipsum dolor Excepteur Duis");
CkJsonObjectW_UpdateString(json,L"labels[0].name",L"nulla et ipsum voluptate consectetur");
CkJsonObjectW_UpdateString(json,L"labels[0].id",L"nostrud enim proident cupidatat eu");
CkJsonObjectW_UpdateString(json,L"labels[0].label",L"enim Lorem veniam amet");
CkJsonObjectW_UpdateString(json,L"labels[1].prefix",L"amet");
CkJsonObjectW_UpdateString(json,L"labels[1].name",L"officia adipisicing ut labo");
CkJsonObjectW_UpdateString(json,L"labels[1].id",L"ipsum in tempor");
CkJsonObjectW_UpdateString(json,L"labels[1].label",L"est occaecat magna");
CkJsonObjectW_UpdateString(json,L"space.key",L"<string>");
// Adds the "Authorization: Bearer <access_token>" header.
CkHttpW_putAuthToken(http,L"<access_token>");
CkHttpW_SetRequestHeader(http,L"Content-Type",L"application/json");
sbRequestBody = CkStringBuilderW_Create();
CkJsonObjectW_EmitSb(json,sbRequestBody);
resp = CkHttpW_PTextSb(http,L"PUT",L"https://your-domain.atlassian.net/wiki/rest/api/template",sbRequestBody,L"utf-8",L"application/json",FALSE,FALSE);
if (CkHttpW_getLastMethodSuccess(http) == FALSE) {
wprintf(L"%s\n",CkHttpW_lastErrorText(http));
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(json);
CkStringBuilderW_Dispose(sbRequestBody);
return;
}
sbResponseBody = CkStringBuilderW_Create();
CkHttpResponseW_GetBodySb(resp,sbResponseBody);
jResp = CkJsonObjectW_Create();
CkJsonObjectW_LoadSb(jResp,sbResponseBody);
CkJsonObjectW_putEmitCompact(jResp,FALSE);
wprintf(L"Response Body:\n");
wprintf(L"%s\n",CkJsonObjectW_emit(jResp));
respStatusCode = CkHttpResponseW_getStatusCode(resp);
wprintf(L"Response Status Code = %d\n",respStatusCode);
if (respStatusCode >= 400) {
wprintf(L"Response Header:\n");
wprintf(L"%s\n",CkHttpResponseW_header(resp));
wprintf(L"Failed.\n");
CkHttpResponseW_Dispose(resp);
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(json);
CkStringBuilderW_Dispose(sbRequestBody);
CkStringBuilderW_Dispose(sbResponseBody);
CkJsonObjectW_Dispose(jResp);
return;
}
CkHttpResponseW_Dispose(resp);
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "templateId": "id ipsum ut",
// "name": "sit dolor sint dolore",
// "description": "magna",
// "labels": [
// {
// "prefix": "fugiat sit Ut in ea",
// "name": "dolor in",
// "id": "aliqua culpa veniam ea",
// "label": "officia tempor ea"
// },
// {
// "prefix": "exercitation culpa proident",
// "name": "nulla mollit adipis",
// "id": "laborum sint",
// "label": "fugiat"
// }
// ],
// "templateType": "in cillum",
// "_expandable": {
// "body": "anim aute officia in culpa"
// },
// "_links": {},
// "body": {
// "value": "aute sit pariatur consequat deserunt",
// "representation": "anonymous_export_view",
// "_expandable": {
// "content": "nulla cillum reprehenderit"
// },
// "embeddedContent": [
// {
// "entityId": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "entity": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// }
// },
// {
// "entityId": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "entity": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// }
// }
// ],
// "webresource": {
// "keys": [
// {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// }
// ],
// "contexts": [
// {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// }
// ],
// "uris": {
// "all": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "css": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "js": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// }
// },
// "tags": {
// "all": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "css": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "data": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "js": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// }
// },
// "superbatch": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// }
// }
// }
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
// Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.
templateId = CkJsonObjectW_stringOf(jResp,L"templateId");
name = CkJsonObjectW_stringOf(jResp,L"name");
description = CkJsonObjectW_stringOf(jResp,L"description");
templateType = CkJsonObjectW_stringOf(jResp,L"templateType");
Body = CkJsonObjectW_stringOf(jResp,L"_expandable.body");
Value = CkJsonObjectW_stringOf(jResp,L"body.value");
Representation = CkJsonObjectW_stringOf(jResp,L"body.representation");
Content = CkJsonObjectW_stringOf(jResp,L"body._expandable.content");
AllValue = CkJsonObjectW_stringOf(jResp,L"body.webresource.uris.all.value");
CssValue = CkJsonObjectW_stringOf(jResp,L"body.webresource.uris.css.value");
JsValue = CkJsonObjectW_stringOf(jResp,L"body.webresource.uris.js.value");
AllValue = CkJsonObjectW_stringOf(jResp,L"body.webresource.tags.all.value");
CssValue = CkJsonObjectW_stringOf(jResp,L"body.webresource.tags.css.value");
DataValue = CkJsonObjectW_stringOf(jResp,L"body.webresource.tags.data.value");
JsValue = CkJsonObjectW_stringOf(jResp,L"body.webresource.tags.js.value");
SuperbatchValue = CkJsonObjectW_stringOf(jResp,L"body.webresource.superbatch.value");
i = 0;
count_i = CkJsonObjectW_SizeOfArray(jResp,L"labels");
while (i < count_i) {
CkJsonObjectW_putI(jResp,i);
prefix = CkJsonObjectW_stringOf(jResp,L"labels[i].prefix");
name = CkJsonObjectW_stringOf(jResp,L"labels[i].name");
id = CkJsonObjectW_stringOf(jResp,L"labels[i].id");
label = CkJsonObjectW_stringOf(jResp,L"labels[i].label");
i = i + 1;
}
i = 0;
count_i = CkJsonObjectW_SizeOfArray(jResp,L"body.embeddedContent");
while (i < count_i) {
CkJsonObjectW_putI(jResp,i);
entityIdValue = CkJsonObjectW_stringOf(jResp,L"body.embeddedContent[i].entityId.value");
entityValue = CkJsonObjectW_stringOf(jResp,L"body.embeddedContent[i].entity.value");
i = i + 1;
}
i = 0;
count_i = CkJsonObjectW_SizeOfArray(jResp,L"body.webresource.keys");
while (i < count_i) {
CkJsonObjectW_putI(jResp,i);
value = CkJsonObjectW_stringOf(jResp,L"body.webresource.keys[i].value");
i = i + 1;
}
i = 0;
count_i = CkJsonObjectW_SizeOfArray(jResp,L"body.webresource.contexts");
while (i < count_i) {
CkJsonObjectW_putI(jResp,i);
value = CkJsonObjectW_stringOf(jResp,L"body.webresource.contexts[i].value");
i = i + 1;
}
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(json);
CkStringBuilderW_Dispose(sbRequestBody);
CkStringBuilderW_Dispose(sbResponseBody);
CkJsonObjectW_Dispose(jResp);
}
Curl Command
curl -X PUT
-H "Authorization: Bearer <access_token>"
-H "Content-Type: application/json"
-d '{
"templateId": "<string>",
"name": "<string>",
"templateType": "<string>",
"body": {
"value": "<string>",
"representation": "<string>"
},
"description": "<string>",
"labels": [
{
"prefix": "ipsum dolor Excepteur Duis",
"name": "nulla et ipsum voluptate consectetur",
"id": "nostrud enim proident cupidatat eu",
"label": "enim Lorem veniam amet"
},
{
"prefix": "amet",
"name": "officia adipisicing ut labo",
"id": "ipsum in tempor",
"label": "est occaecat magna"
}
],
"space": {
"key": "<string>"
}
}'
https://your-domain.atlassian.net/wiki/rest/api/template
Postman Collection Item JSON
{
"name": "Update content template",
"request": {
"auth": {
"type": "oauth2"
},
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"templateId\": \"<string>\",\n \"name\": \"<string>\",\n \"templateType\": \"<string>\",\n \"body\": {\n \"value\": \"<string>\",\n \"representation\": \"<string>\"\n },\n \"description\": \"<string>\",\n \"labels\": [\n {\n \"prefix\": \"ipsum dolor Excepteur Duis\",\n \"name\": \"nulla et ipsum voluptate consectetur\",\n \"id\": \"nostrud enim proident cupidatat eu\",\n \"label\": \"enim Lorem veniam amet\"\n },\n {\n \"prefix\": \"amet\",\n \"name\": \"officia adipisicing ut labo\",\n \"id\": \"ipsum in tempor\",\n \"label\": \"est occaecat magna\"\n }\n ],\n \"space\": {\n \"key\": \"<string>\"\n }\n}"
},
"url": {
"raw": "{{baseUrl}}/api/template",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"template"
]
},
"description": "Updates a content template. Note, blueprint templates cannot be updated\nvia the REST API.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\n'Admin' permission for the space to create a space template or 'Confluence Administrator'\nglobal permission to create a global template."
},
"response": [
{
"name": "Returned if the template is updated.",
"originalRequest": {
"method": "PUT",
"header": [
{
"description": {
"content": "Added as a part of security scheme: oauth2",
"type": "text/plain"
},
"key": "Authorization",
"value": "<token>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"templateId\": \"<string>\",\n \"name\": \"<string>\",\n \"templateType\": \"<string>\",\n \"body\": {\n \"value\": \"<string>\",\n \"representation\": \"<string>\"\n },\n \"description\": \"<string>\",\n \"labels\": [\n {\n \"prefix\": \"officia ea in eu\",\n \"name\": \"commodo mollit\",\n \"id\": \"veniam minim nisi quis officia\",\n \"label\": \"commodo\"\n },\n {\n \"prefix\": \"cupidatat dolor aliqua laboris\",\n \"name\": \"officia amet\",\n \"id\": \"voluptate ad quis p\",\n \"label\": \"eu sit adipisicing ea Ut\"\n }\n ],\n \"space\": {\n \"key\": \"<string>\"\n }\n}"
},
"url": {
"raw": "{{baseUrl}}/api/template",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"template"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"templateId\": \"id ipsum ut\",\n \"name\": \"sit dolor sint dolore\",\n \"description\": \"magna\",\n \"labels\": [\n {\n \"prefix\": \"fugiat sit Ut in ea\",\n \"name\": \"dolor in\",\n \"id\": \"aliqua culpa veniam ea\",\n \"label\": \"officia tempor ea\"\n },\n {\n \"prefix\": \"exercitation culpa proident\",\n \"name\": \"nulla mollit adipis\",\n \"id\": \"laborum sint\",\n \"label\": \"fugiat\"\n }\n ],\n \"templateType\": \"in cillum\",\n \"_expandable\": {\n \"body\": \"anim aute officia in culpa\"\n },\n \"_links\": {},\n \"body\": {\n \"value\": \"aute sit pariatur consequat deserunt\",\n \"representation\": \"anonymous_export_view\",\n \"_expandable\": {\n \"content\": \"nulla cillum reprehenderit\"\n },\n \"embeddedContent\": [\n {\n \"entityId\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"entity\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n {\n \"entityId\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"entity\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n }\n ],\n \"webresource\": {\n \"keys\": [\n {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n ],\n \"contexts\": [\n {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n ],\n \"uris\": {\n \"all\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"css\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"js\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n \"tags\": {\n \"all\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"css\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"data\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"js\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n \"superbatch\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n }\n }\n}"
},
{
"name": "Returned if the calling user does not have permission to update the\ntemplate.",
"originalRequest": {
"method": "PUT",
"header": [
{
"description": {
"content": "Added as a part of security scheme: oauth2",
"type": "text/plain"
},
"key": "Authorization",
"value": "<token>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"templateId\": \"<string>\",\n \"name\": \"<string>\",\n \"templateType\": \"<string>\",\n \"body\": {\n \"value\": \"<string>\",\n \"representation\": \"<string>\"\n },\n \"description\": \"<string>\",\n \"labels\": [\n {\n \"prefix\": \"officia ea in eu\",\n \"name\": \"commodo mollit\",\n \"id\": \"veniam minim nisi quis officia\",\n \"label\": \"commodo\"\n },\n {\n \"prefix\": \"cupidatat dolor aliqua laboris\",\n \"name\": \"officia amet\",\n \"id\": \"voluptate ad quis p\",\n \"label\": \"eu sit adipisicing ea Ut\"\n }\n ],\n \"space\": {\n \"key\": \"<string>\"\n }\n}"
},
"url": {
"raw": "{{baseUrl}}/api/template",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"template"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}
