Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
; 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>"
; }
; }
json.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(json,"templateId","<string>")
CkJsonObject::ckUpdateString(json,"name","<string>")
CkJsonObject::ckUpdateString(json,"templateType","<string>")
CkJsonObject::ckUpdateString(json,"body.value","<string>")
CkJsonObject::ckUpdateString(json,"body.representation","<string>")
CkJsonObject::ckUpdateString(json,"description","<string>")
CkJsonObject::ckUpdateString(json,"labels[0].prefix","ipsum dolor Excepteur Duis")
CkJsonObject::ckUpdateString(json,"labels[0].name","nulla et ipsum voluptate consectetur")
CkJsonObject::ckUpdateString(json,"labels[0].id","nostrud enim proident cupidatat eu")
CkJsonObject::ckUpdateString(json,"labels[0].label","enim Lorem veniam amet")
CkJsonObject::ckUpdateString(json,"labels[1].prefix","amet")
CkJsonObject::ckUpdateString(json,"labels[1].name","officia adipisicing ut labo")
CkJsonObject::ckUpdateString(json,"labels[1].id","ipsum in tempor")
CkJsonObject::ckUpdateString(json,"labels[1].label","est occaecat magna")
CkJsonObject::ckUpdateString(json,"space.key","<string>")
; Adds the "Authorization: Bearer <access_token>" header.
CkHttp::setCkAuthToken(http, "<access_token>")
CkHttp::ckSetRequestHeader(http,"Content-Type","application/json")
sbRequestBody.i = CkStringBuilder::ckCreate()
If sbRequestBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckEmitSb(json,sbRequestBody)
resp.i = CkHttp::ckPTextSb(http,"PUT","https://your-domain.atlassian.net/wiki/rest/api/template",sbRequestBody,"utf-8","application/json",0,0)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
ProcedureReturn
EndIf
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHttpResponse::ckGetBodySb(resp,sbResponseBody)
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttpResponse::ckHeader(resp)
Debug "Failed."
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
CkHttpResponse::ckDispose(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
prefix.s
id.s
label.s
entityIdValue.s
entityValue.s
value.s
templateId.s = CkJsonObject::ckStringOf(jResp,"templateId")
name.s = CkJsonObject::ckStringOf(jResp,"name")
description.s = CkJsonObject::ckStringOf(jResp,"description")
templateType.s = CkJsonObject::ckStringOf(jResp,"templateType")
Body.s = CkJsonObject::ckStringOf(jResp,"_expandable.body")
Value.s = CkJsonObject::ckStringOf(jResp,"body.value")
Representation.s = CkJsonObject::ckStringOf(jResp,"body.representation")
Content.s = CkJsonObject::ckStringOf(jResp,"body._expandable.content")
AllValue.s = CkJsonObject::ckStringOf(jResp,"body.webresource.uris.all.value")
CssValue.s = CkJsonObject::ckStringOf(jResp,"body.webresource.uris.css.value")
JsValue.s = CkJsonObject::ckStringOf(jResp,"body.webresource.uris.js.value")
AllValue = CkJsonObject::ckStringOf(jResp,"body.webresource.tags.all.value")
CssValue = CkJsonObject::ckStringOf(jResp,"body.webresource.tags.css.value")
DataValue.s = CkJsonObject::ckStringOf(jResp,"body.webresource.tags.data.value")
JsValue = CkJsonObject::ckStringOf(jResp,"body.webresource.tags.js.value")
SuperbatchValue.s = CkJsonObject::ckStringOf(jResp,"body.webresource.superbatch.value")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"labels")
While i < count_i
CkJsonObject::setCkI(jResp, i)
prefix = CkJsonObject::ckStringOf(jResp,"labels[i].prefix")
name = CkJsonObject::ckStringOf(jResp,"labels[i].name")
id = CkJsonObject::ckStringOf(jResp,"labels[i].id")
label = CkJsonObject::ckStringOf(jResp,"labels[i].label")
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"body.embeddedContent")
While i < count_i
CkJsonObject::setCkI(jResp, i)
entityIdValue = CkJsonObject::ckStringOf(jResp,"body.embeddedContent[i].entityId.value")
entityValue = CkJsonObject::ckStringOf(jResp,"body.embeddedContent[i].entity.value")
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"body.webresource.keys")
While i < count_i
CkJsonObject::setCkI(jResp, i)
value = CkJsonObject::ckStringOf(jResp,"body.webresource.keys[i].value")
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"body.webresource.contexts")
While i < count_i
CkJsonObject::setCkI(jResp, i)
value = CkJsonObject::ckStringOf(jResp,"body.webresource.contexts[i].value")
i = i + 1
Wend
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
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": ""
}
]
}
