Back to Collection Items
' This example assumes the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.
Dim http As New Chilkat.Http
Dim success As Boolean
' 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>"
' }
' }
Dim json As New Chilkat.JsonObject
json.UpdateString("templateId","<string>")
json.UpdateString("name","<string>")
json.UpdateString("templateType","<string>")
json.UpdateString("body.value","<string>")
json.UpdateString("body.representation","<string>")
json.UpdateString("description","<string>")
json.UpdateString("labels[0].prefix","ipsum dolor Excepteur Duis")
json.UpdateString("labels[0].name","nulla et ipsum voluptate consectetur")
json.UpdateString("labels[0].id","nostrud enim proident cupidatat eu")
json.UpdateString("labels[0].label","enim Lorem veniam amet")
json.UpdateString("labels[1].prefix","amet")
json.UpdateString("labels[1].name","officia adipisicing ut labo")
json.UpdateString("labels[1].id","ipsum in tempor")
json.UpdateString("labels[1].label","est occaecat magna")
json.UpdateString("space.key","<string>")
' Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = "<access_token>"
http.SetRequestHeader("Content-Type","application/json")
Dim sbRequestBody As New Chilkat.StringBuilder
json.EmitSb(sbRequestBody)
Dim resp As Chilkat.HttpResponse = http.PTextSb("PUT","https://your-domain.atlassian.net/wiki/rest/api/template",sbRequestBody,"utf-8","application/json",False,False)
If (http.LastMethodSuccess = False) Then
Debug.WriteLine(http.LastErrorText)
Exit Sub
End If
Dim sbResponseBody As New Chilkat.StringBuilder
resp.GetBodySb(sbResponseBody)
Dim jResp As New Chilkat.JsonObject
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False
Debug.WriteLine("Response Body:")
Debug.WriteLine(jResp.Emit())
Dim respStatusCode As Integer = resp.StatusCode
Debug.WriteLine("Response Status Code = " & respStatusCode)
If (respStatusCode >= 400) Then
Debug.WriteLine("Response Header:")
Debug.WriteLine(resp.Header)
Debug.WriteLine("Failed.")
Exit Sub
End If
' 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
Dim prefix As String
Dim id As String
Dim label As String
Dim entityIdValue As String
Dim entityValue As String
Dim value As String
Dim templateId As String = jResp.StringOf("templateId")
Dim name As String = jResp.StringOf("name")
Dim description As String = jResp.StringOf("description")
Dim templateType As String = jResp.StringOf("templateType")
Dim Body As String = jResp.StringOf("_expandable.body")
Dim Value As String = jResp.StringOf("body.value")
Dim Representation As String = jResp.StringOf("body.representation")
Dim Content As String = jResp.StringOf("body._expandable.content")
Dim AllValue As String = jResp.StringOf("body.webresource.uris.all.value")
Dim CssValue As String = jResp.StringOf("body.webresource.uris.css.value")
Dim JsValue As String = jResp.StringOf("body.webresource.uris.js.value")
AllValue = jResp.StringOf("body.webresource.tags.all.value")
CssValue = jResp.StringOf("body.webresource.tags.css.value")
Dim DataValue As String = jResp.StringOf("body.webresource.tags.data.value")
JsValue = jResp.StringOf("body.webresource.tags.js.value")
Dim SuperbatchValue As String = jResp.StringOf("body.webresource.superbatch.value")
Dim i As Integer = 0
Dim count_i As Integer = jResp.SizeOfArray("labels")
While i < count_i
jResp.I = i
prefix = jResp.StringOf("labels[i].prefix")
name = jResp.StringOf("labels[i].name")
id = jResp.StringOf("labels[i].id")
label = jResp.StringOf("labels[i].label")
i = i + 1
End While
i = 0
count_i = jResp.SizeOfArray("body.embeddedContent")
While i < count_i
jResp.I = i
entityIdValue = jResp.StringOf("body.embeddedContent[i].entityId.value")
entityValue = jResp.StringOf("body.embeddedContent[i].entity.value")
i = i + 1
End While
i = 0
count_i = jResp.SizeOfArray("body.webresource.keys")
While i < count_i
jResp.I = i
value = jResp.StringOf("body.webresource.keys[i].value")
i = i + 1
End While
i = 0
count_i = jResp.SizeOfArray("body.webresource.contexts")
While i < count_i
jResp.I = i
value = jResp.StringOf("body.webresource.contexts[i].value")
i = i + 1
End While
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": ""
}
]
}
