Back to Collection Items
load ./chilkat.dll
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
set http [new_CkHttp]
# 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>"
# }
# }
set json [new_CkJsonObject]
CkJsonObject_UpdateString $json "templateId" "<string>"
CkJsonObject_UpdateString $json "name" "<string>"
CkJsonObject_UpdateString $json "templateType" "<string>"
CkJsonObject_UpdateString $json "body.value" "<string>"
CkJsonObject_UpdateString $json "body.representation" "<string>"
CkJsonObject_UpdateString $json "description" "<string>"
CkJsonObject_UpdateString $json "labels[0].prefix" "ipsum dolor Excepteur Duis"
CkJsonObject_UpdateString $json "labels[0].name" "nulla et ipsum voluptate consectetur"
CkJsonObject_UpdateString $json "labels[0].id" "nostrud enim proident cupidatat eu"
CkJsonObject_UpdateString $json "labels[0].label" "enim Lorem veniam amet"
CkJsonObject_UpdateString $json "labels[1].prefix" "amet"
CkJsonObject_UpdateString $json "labels[1].name" "officia adipisicing ut labo"
CkJsonObject_UpdateString $json "labels[1].id" "ipsum in tempor"
CkJsonObject_UpdateString $json "labels[1].label" "est occaecat magna"
CkJsonObject_UpdateString $json "space.key" "<string>"
# Adds the "Authorization: Bearer <access_token>" header.
CkHttp_put_AuthToken $http "<access_token>"
CkHttp_SetRequestHeader $http "Content-Type" "application/json"
set sbRequestBody [new_CkStringBuilder]
CkJsonObject_EmitSb $json $sbRequestBody
# resp is a CkHttpResponse
set resp [CkHttp_PTextSb $http "PUT" "https://your-domain.atlassian.net/wiki/rest/api/template" $sbRequestBody "utf-8" "application/json" 0 0]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbRequestBody
exit
}
set sbResponseBody [new_CkStringBuilder]
CkHttpResponse_GetBodySb $resp $sbResponseBody
set jResp [new_CkJsonObject]
CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0
puts "Response Body:"
puts [CkJsonObject_emit $jResp]
set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
puts "Response Header:"
puts [CkHttpResponse_header $resp]
puts "Failed."
delete_CkHttpResponse $resp
delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbRequestBody
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
exit
}
delete_CkHttpResponse $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
set templateId [CkJsonObject_stringOf $jResp "templateId"]
set name [CkJsonObject_stringOf $jResp "name"]
set description [CkJsonObject_stringOf $jResp "description"]
set templateType [CkJsonObject_stringOf $jResp "templateType"]
set Body [CkJsonObject_stringOf $jResp "_expandable.body"]
set Value [CkJsonObject_stringOf $jResp "body.value"]
set Representation [CkJsonObject_stringOf $jResp "body.representation"]
set Content [CkJsonObject_stringOf $jResp "body._expandable.content"]
set AllValue [CkJsonObject_stringOf $jResp "body.webresource.uris.all.value"]
set CssValue [CkJsonObject_stringOf $jResp "body.webresource.uris.css.value"]
set JsValue [CkJsonObject_stringOf $jResp "body.webresource.uris.js.value"]
set AllValue [CkJsonObject_stringOf $jResp "body.webresource.tags.all.value"]
set CssValue [CkJsonObject_stringOf $jResp "body.webresource.tags.css.value"]
set DataValue [CkJsonObject_stringOf $jResp "body.webresource.tags.data.value"]
set JsValue [CkJsonObject_stringOf $jResp "body.webresource.tags.js.value"]
set SuperbatchValue [CkJsonObject_stringOf $jResp "body.webresource.superbatch.value"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "labels"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set prefix [CkJsonObject_stringOf $jResp "labels[i].prefix"]
set name [CkJsonObject_stringOf $jResp "labels[i].name"]
set id [CkJsonObject_stringOf $jResp "labels[i].id"]
set label [CkJsonObject_stringOf $jResp "labels[i].label"]
set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "body.embeddedContent"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set entityIdValue [CkJsonObject_stringOf $jResp "body.embeddedContent[i].entityId.value"]
set entityValue [CkJsonObject_stringOf $jResp "body.embeddedContent[i].entity.value"]
set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "body.webresource.keys"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set value [CkJsonObject_stringOf $jResp "body.webresource.keys[i].value"]
set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "body.webresource.contexts"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set value [CkJsonObject_stringOf $jResp "body.webresource.contexts[i].value"]
set i [expr $i + 1]
}
delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbRequestBody
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $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": ""
}
]
}