Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
; Use this online tool to generate code from sample JSON: Generate Code to Create JSON
; The following JSON is sent in the request body.
; {
; "name": "<string>",
; "templateType": "<string>",
; "body": {
; "storage": {
; "value": "<string>",
; "representation": "<string>"
; }
; },
; "description": "<string>",
; "labels": [
; {
; "prefix": "dolore deserunt ut est anim",
; "name": "occaecat quis culpa ad non",
; "id": "laborum nisi ipsum",
; "label": "labore laborum sint"
; },
; {
; "prefix": "proident tempor",
; "name": "incididunt cupidatat ea",
; "id": "non dolore quis proident",
; "label": "labore sint"
; }
; ],
; "space": {
; "key": "<string>"
; }
; }
json.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(json,"name","<string>")
CkJsonObject::ckUpdateString(json,"templateType","<string>")
CkJsonObject::ckUpdateString(json,"body.storage.value","<string>")
CkJsonObject::ckUpdateString(json,"body.storage.representation","<string>")
CkJsonObject::ckUpdateString(json,"description","<string>")
CkJsonObject::ckUpdateString(json,"labels[0].prefix","dolore deserunt ut est anim")
CkJsonObject::ckUpdateString(json,"labels[0].name","occaecat quis culpa ad non")
CkJsonObject::ckUpdateString(json,"labels[0].id","laborum nisi ipsum")
CkJsonObject::ckUpdateString(json,"labels[0].label","labore laborum sint")
CkJsonObject::ckUpdateString(json,"labels[1].prefix","proident tempor")
CkJsonObject::ckUpdateString(json,"labels[1].name","incididunt cupidatat ea")
CkJsonObject::ckUpdateString(json,"labels[1].id","non dolore quis proident")
CkJsonObject::ckUpdateString(json,"labels[1].label","labore sint")
CkJsonObject::ckUpdateString(json,"space.key","<string>")
; Adds the "Authorization: Bearer <access_token>" header.
CkHttp::setCkAuthToken(http, "<access_token>")
CkHttp::ckSetRequestHeader(http,"Content-Type","application/json")
resp.i = CkHttp::ckPostJson3(http,"https://your-domain.atlassian.net/wiki/rest/api/template","application/json",json)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
ProcedureReturn
EndIf
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHttpResponse::ckGetBodySb(resp,sbResponseBody)
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttpResponse::ckHeader(resp)
Debug "Failed."
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
CkHttpResponse::ckDispose(resp)
; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)
; {
; "templateId": "aliqua",
; "name": "officia cupidatat voluptate velit",
; "description": "labore",
; "labels": [
; {
; "prefix": "anim",
; "name": "in cupidatat cillum veniam Duis",
; "id": "cillum aliqua sed eiusmod enim",
; "label": "cupidatat"
; },
; {
; "prefix": "elit minim",
; "name": "vol",
; "id": "sit voluptate ",
; "label": "eu sit qui"
; }
; ],
; "templateType": "amet",
; "_expandable": {
; "body": "exercitation sunt"
; },
; "_links": {},
; "body": {
; "value": "reprehend",
; "representation": "export_view",
; "_expandable": {
; "content": "ex esse enim irure amet"
; },
; "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
prefix.s
id.s
label.s
entityIdValue.s
entityValue.s
value.s
templateId.s = CkJsonObject::ckStringOf(jResp,"templateId")
name.s = CkJsonObject::ckStringOf(jResp,"name")
description.s = CkJsonObject::ckStringOf(jResp,"description")
templateType.s = CkJsonObject::ckStringOf(jResp,"templateType")
Body.s = CkJsonObject::ckStringOf(jResp,"_expandable.body")
Value.s = CkJsonObject::ckStringOf(jResp,"body.value")
Representation.s = CkJsonObject::ckStringOf(jResp,"body.representation")
Content.s = CkJsonObject::ckStringOf(jResp,"body._expandable.content")
AllValue.s = CkJsonObject::ckStringOf(jResp,"body.webresource.uris.all.value")
CssValue.s = CkJsonObject::ckStringOf(jResp,"body.webresource.uris.css.value")
JsValue.s = CkJsonObject::ckStringOf(jResp,"body.webresource.uris.js.value")
AllValue = CkJsonObject::ckStringOf(jResp,"body.webresource.tags.all.value")
CssValue = CkJsonObject::ckStringOf(jResp,"body.webresource.tags.css.value")
DataValue.s = CkJsonObject::ckStringOf(jResp,"body.webresource.tags.data.value")
JsValue = CkJsonObject::ckStringOf(jResp,"body.webresource.tags.js.value")
SuperbatchValue.s = CkJsonObject::ckStringOf(jResp,"body.webresource.superbatch.value")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"labels")
While i < count_i
CkJsonObject::setCkI(jResp, i)
prefix = CkJsonObject::ckStringOf(jResp,"labels[i].prefix")
name = CkJsonObject::ckStringOf(jResp,"labels[i].name")
id = CkJsonObject::ckStringOf(jResp,"labels[i].id")
label = CkJsonObject::ckStringOf(jResp,"labels[i].label")
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"body.embeddedContent")
While i < count_i
CkJsonObject::setCkI(jResp, i)
entityIdValue = CkJsonObject::ckStringOf(jResp,"body.embeddedContent[i].entityId.value")
entityValue = CkJsonObject::ckStringOf(jResp,"body.embeddedContent[i].entity.value")
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"body.webresource.keys")
While i < count_i
CkJsonObject::setCkI(jResp, i)
value = CkJsonObject::ckStringOf(jResp,"body.webresource.keys[i].value")
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"body.webresource.contexts")
While i < count_i
CkJsonObject::setCkI(jResp, i)
value = CkJsonObject::ckStringOf(jResp,"body.webresource.contexts[i].value")
i = i + 1
Wend
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
Curl Command
curl -X POST
-H "Authorization: Bearer <access_token>"
-H "Content-Type: application/json"
-d '{
"name": "<string>",
"templateType": "<string>",
"body": {
"storage": {
"value": "<string>",
"representation": "<string>"
}
},
"description": "<string>",
"labels": [
{
"prefix": "dolore deserunt ut est anim",
"name": "occaecat quis culpa ad non",
"id": "laborum nisi ipsum",
"label": "labore laborum sint"
},
{
"prefix": "proident tempor",
"name": "incididunt cupidatat ea",
"id": "non dolore quis proident",
"label": "labore sint"
}
],
"space": {
"key": "<string>"
}
}'
https://your-domain.atlassian.net/wiki/rest/api/template
Postman Collection Item JSON
{
"name": "Create content template",
"request": {
"auth": {
"type": "oauth2"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"<string>\",\n \"templateType\": \"<string>\",\n \"body\": {\n \"storage\": {\n \"value\": \"<string>\",\n \"representation\": \"<string>\"\n }\n },\n \"description\": \"<string>\",\n \"labels\": [\n {\n \"prefix\": \"dolore deserunt ut est anim\",\n \"name\": \"occaecat quis culpa ad non\",\n \"id\": \"laborum nisi ipsum\",\n \"label\": \"labore laborum sint\"\n },\n {\n \"prefix\": \"proident tempor\",\n \"name\": \"incididunt cupidatat ea\",\n \"id\": \"non dolore quis proident\",\n \"label\": \"labore sint\"\n }\n ],\n \"space\": {\n \"key\": \"<string>\"\n }\n}"
},
"url": {
"raw": "{{baseUrl}}/api/template",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"template"
]
},
"description": "Creates a new content template. Note, blueprint templates cannot be created via 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 created.",
"originalRequest": {
"method": "POST",
"header": [
{
"description": {
"content": "Added as a part of security scheme: oauth2",
"type": "text/plain"
},
"key": "Authorization",
"value": "<token>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"<string>\",\n \"templateType\": \"<string>\",\n \"body\": {\n \"storage\": {\n \"value\": \"<string>\",\n \"representation\": \"<string>\"\n }\n },\n \"description\": \"<string>\",\n \"labels\": [\n {\n \"prefix\": \"occaecat commodo\",\n \"name\": \"exercitation veniam\",\n \"id\": \"deserunt ea Duis dolor\",\n \"label\": \"aliquip sunt proi\"\n },\n {\n \"prefix\": \"ex adipisicing elit sit\",\n \"name\": \"reprehenderit consequat s\",\n \"id\": \"irure consectetur\",\n \"label\": \"amet occaecat exercitation\"\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\": \"aliqua\",\n \"name\": \"officia cupidatat voluptate velit\",\n \"description\": \"labore\",\n \"labels\": [\n {\n \"prefix\": \"anim\",\n \"name\": \"in cupidatat cillum veniam Duis\",\n \"id\": \"cillum aliqua sed eiusmod enim\",\n \"label\": \"cupidatat\"\n },\n {\n \"prefix\": \"elit minim\",\n \"name\": \"vol\",\n \"id\": \"sit voluptate \",\n \"label\": \"eu sit qui\"\n }\n ],\n \"templateType\": \"amet\",\n \"_expandable\": {\n \"body\": \"exercitation sunt\"\n },\n \"_links\": {},\n \"body\": {\n \"value\": \"reprehend\",\n \"representation\": \"export_view\",\n \"_expandable\": {\n \"content\": \"ex esse enim irure amet\"\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 create the\ntemplate.",
"originalRequest": {
"method": "POST",
"header": [
{
"description": {
"content": "Added as a part of security scheme: oauth2",
"type": "text/plain"
},
"key": "Authorization",
"value": "<token>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"<string>\",\n \"templateType\": \"<string>\",\n \"body\": {\n \"storage\": {\n \"value\": \"<string>\",\n \"representation\": \"<string>\"\n }\n },\n \"description\": \"<string>\",\n \"labels\": [\n {\n \"prefix\": \"occaecat commodo\",\n \"name\": \"exercitation veniam\",\n \"id\": \"deserunt ea Duis dolor\",\n \"label\": \"aliquip sunt proi\"\n },\n {\n \"prefix\": \"ex adipisicing elit sit\",\n \"name\": \"reprehenderit consequat s\",\n \"id\": \"irure consectetur\",\n \"label\": \"amet occaecat exercitation\"\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": ""
}
]
}
