Back to Collection Items
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess
; 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>"
; }
; }
$oJson = ObjCreate("Chilkat.JsonObject")
$oJson.UpdateString("templateId","<string>")
$oJson.UpdateString("name","<string>")
$oJson.UpdateString("templateType","<string>")
$oJson.UpdateString("body.value","<string>")
$oJson.UpdateString("body.representation","<string>")
$oJson.UpdateString("description","<string>")
$oJson.UpdateString("labels[0].prefix","ipsum dolor Excepteur Duis")
$oJson.UpdateString("labels[0].name","nulla et ipsum voluptate consectetur")
$oJson.UpdateString("labels[0].id","nostrud enim proident cupidatat eu")
$oJson.UpdateString("labels[0].label","enim Lorem veniam amet")
$oJson.UpdateString("labels[1].prefix","amet")
$oJson.UpdateString("labels[1].name","officia adipisicing ut labo")
$oJson.UpdateString("labels[1].id","ipsum in tempor")
$oJson.UpdateString("labels[1].label","est occaecat magna")
$oJson.UpdateString("space.key","<string>")
; Adds the "Authorization: Bearer <access_token>" header.
$oHttp.AuthToken = "<access_token>"
$oHttp.SetRequestHeader "Content-Type","application/json"
$oSbRequestBody = ObjCreate("Chilkat.StringBuilder")
$oJson.EmitSb($oSbRequestBody)
Local $oResp = $oHttp.PTextSb("PUT","https://your-domain.atlassian.net/wiki/rest/api/template",$oSbRequestBody,"utf-8","application/json",False,False)
If ($oHttp.LastMethodSuccess = False) Then
ConsoleWrite($oHttp.LastErrorText & @CRLF)
Exit
EndIf
$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$oResp.GetBodySb($oSbResponseBody)
$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False
ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)
Local $iRespStatusCode = $oResp.StatusCode
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
ConsoleWrite("Response Header:" & @CRLF)
ConsoleWrite($oResp.Header & @CRLF)
ConsoleWrite("Failed." & @CRLF)
Exit
EndIf
; 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
Local $sPrefix
Local $sId
Local $sLabel
Local $sEntityIdValue
Local $sEntityValue
Local $sValue
Local $sTemplateId = $oJResp.StringOf("templateId")
Local $sName = $oJResp.StringOf("name")
Local $sDescription = $oJResp.StringOf("description")
Local $sTemplateType = $oJResp.StringOf("templateType")
Local $sBody = $oJResp.StringOf("_expandable.body")
Local $sValue = $oJResp.StringOf("body.value")
Local $sRepresentation = $oJResp.StringOf("body.representation")
Local $sContent = $oJResp.StringOf("body._expandable.content")
Local $sAllValue = $oJResp.StringOf("body.webresource.uris.all.value")
Local $sCssValue = $oJResp.StringOf("body.webresource.uris.css.value")
Local $sJsValue = $oJResp.StringOf("body.webresource.uris.js.value")
$sAllValue = $oJResp.StringOf("body.webresource.tags.all.value")
$sCssValue = $oJResp.StringOf("body.webresource.tags.css.value")
Local $sDataValue = $oJResp.StringOf("body.webresource.tags.data.value")
$sJsValue = $oJResp.StringOf("body.webresource.tags.js.value")
Local $sSuperbatchValue = $oJResp.StringOf("body.webresource.superbatch.value")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("labels")
While $i < $iCount_i
$oJResp.I = $i
$sPrefix = $oJResp.StringOf("labels[i].prefix")
$sName = $oJResp.StringOf("labels[i].name")
$sId = $oJResp.StringOf("labels[i].id")
$sLabel = $oJResp.StringOf("labels[i].label")
$i = $i + 1
Wend
$i = 0
$iCount_i = $oJResp.SizeOfArray("body.embeddedContent")
While $i < $iCount_i
$oJResp.I = $i
$sEntityIdValue = $oJResp.StringOf("body.embeddedContent[i].entityId.value")
$sEntityValue = $oJResp.StringOf("body.embeddedContent[i].entity.value")
$i = $i + 1
Wend
$i = 0
$iCount_i = $oJResp.SizeOfArray("body.webresource.keys")
While $i < $iCount_i
$oJResp.I = $i
$sValue = $oJResp.StringOf("body.webresource.keys[i].value")
$i = $i + 1
Wend
$i = 0
$iCount_i = $oJResp.SizeOfArray("body.webresource.contexts")
While $i < $iCount_i
$oJResp.I = $i
$sValue = $oJResp.StringOf("body.webresource.contexts[i].value")
$i = $i + 1
Wend
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": ""
}
]
}
