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.
' {
' "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>"
' }
' }
Dim json As New Chilkat.JsonObject
json.UpdateString("name","<string>")
json.UpdateString("templateType","<string>")
json.UpdateString("body.storage.value","<string>")
json.UpdateString("body.storage.representation","<string>")
json.UpdateString("description","<string>")
json.UpdateString("labels[0].prefix","dolore deserunt ut est anim")
json.UpdateString("labels[0].name","occaecat quis culpa ad non")
json.UpdateString("labels[0].id","laborum nisi ipsum")
json.UpdateString("labels[0].label","labore laborum sint")
json.UpdateString("labels[1].prefix","proident tempor")
json.UpdateString("labels[1].name","incididunt cupidatat ea")
json.UpdateString("labels[1].id","non dolore quis proident")
json.UpdateString("labels[1].label","labore sint")
json.UpdateString("space.key","<string>")
' Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = "<access_token>"
http.SetRequestHeader("Content-Type","application/json")
Dim resp As Chilkat.HttpResponse = http.PostJson3("https://your-domain.atlassian.net/wiki/rest/api/template","application/json",json)
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": "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
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 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": ""
}
]
}
