Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loJson
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcPrefix
LOCAL lcId
LOCAL lcLabel
LOCAL lcEntityIdValue
LOCAL lcEntityValue
LOCAL lcValue
LOCAL lcTemplateId
LOCAL lcName
LOCAL lcDescription
LOCAL lcTemplateType
LOCAL lcBody
LOCAL lcValue
LOCAL lcRepresentation
LOCAL lcContent
LOCAL lcAllValue
LOCAL lcCssValue
LOCAL lcJsValue
LOCAL lcDataValue
LOCAL lcSuperbatchValue
LOCAL i
LOCAL lnCount_i
* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')
* 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>"
* }
* }
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJson = CreateObject('Chilkat.JsonObject')
loJson.UpdateString("name","<string>")
loJson.UpdateString("templateType","<string>")
loJson.UpdateString("body.storage.value","<string>")
loJson.UpdateString("body.storage.representation","<string>")
loJson.UpdateString("description","<string>")
loJson.UpdateString("labels[0].prefix","dolore deserunt ut est anim")
loJson.UpdateString("labels[0].name","occaecat quis culpa ad non")
loJson.UpdateString("labels[0].id","laborum nisi ipsum")
loJson.UpdateString("labels[0].label","labore laborum sint")
loJson.UpdateString("labels[1].prefix","proident tempor")
loJson.UpdateString("labels[1].name","incididunt cupidatat ea")
loJson.UpdateString("labels[1].id","non dolore quis proident")
loJson.UpdateString("labels[1].label","labore sint")
loJson.UpdateString("space.key","<string>")
* Adds the "Authorization: Bearer <access_token>" header.
loHttp.AuthToken = "<access_token>"
loHttp.SetRequestHeader("Content-Type","application/json")
loResp = loHttp.PostJson3("https://your-domain.atlassian.net/wiki/rest/api/template","application/json",loJson)
IF (loHttp.LastMethodSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
RELEASE loJson
CANCEL
ENDIF
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
loResp.GetBodySb(loSbResponseBody)
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
? "Response Header:"
? loResp.Header
? "Failed."
RELEASE loResp
RELEASE loHttp
RELEASE loJson
RELEASE loSbResponseBody
RELEASE loJResp
CANCEL
ENDIF
RELEASE loResp
* 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
lcTemplateId = loJResp.StringOf("templateId")
lcName = loJResp.StringOf("name")
lcDescription = loJResp.StringOf("description")
lcTemplateType = loJResp.StringOf("templateType")
lcBody = loJResp.StringOf("_expandable.body")
lcValue = loJResp.StringOf("body.value")
lcRepresentation = loJResp.StringOf("body.representation")
lcContent = loJResp.StringOf("body._expandable.content")
lcAllValue = loJResp.StringOf("body.webresource.uris.all.value")
lcCssValue = loJResp.StringOf("body.webresource.uris.css.value")
lcJsValue = loJResp.StringOf("body.webresource.uris.js.value")
lcAllValue = loJResp.StringOf("body.webresource.tags.all.value")
lcCssValue = loJResp.StringOf("body.webresource.tags.css.value")
lcDataValue = loJResp.StringOf("body.webresource.tags.data.value")
lcJsValue = loJResp.StringOf("body.webresource.tags.js.value")
lcSuperbatchValue = loJResp.StringOf("body.webresource.superbatch.value")
i = 0
lnCount_i = loJResp.SizeOfArray("labels")
DO WHILE i < lnCount_i
loJResp.I = i
lcPrefix = loJResp.StringOf("labels[i].prefix")
lcName = loJResp.StringOf("labels[i].name")
lcId = loJResp.StringOf("labels[i].id")
lcLabel = loJResp.StringOf("labels[i].label")
i = i + 1
ENDDO
i = 0
lnCount_i = loJResp.SizeOfArray("body.embeddedContent")
DO WHILE i < lnCount_i
loJResp.I = i
lcEntityIdValue = loJResp.StringOf("body.embeddedContent[i].entityId.value")
lcEntityValue = loJResp.StringOf("body.embeddedContent[i].entity.value")
i = i + 1
ENDDO
i = 0
lnCount_i = loJResp.SizeOfArray("body.webresource.keys")
DO WHILE i < lnCount_i
loJResp.I = i
lcValue = loJResp.StringOf("body.webresource.keys[i].value")
i = i + 1
ENDDO
i = 0
lnCount_i = loJResp.SizeOfArray("body.webresource.contexts")
DO WHILE i < lnCount_i
loJResp.I = i
lcValue = loJResp.StringOf("body.webresource.contexts[i].value")
i = i + 1
ENDDO
RELEASE loHttp
RELEASE loJson
RELEASE loSbResponseBody
RELEASE loJResp
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": ""
}
]
}
