Back to Collection Items
-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
DECLARE @hr int
DECLARE @iTmp0 int
-- Important: Do not use nvarchar(max). See the warning about using nvarchar(max).
DECLARE @sTmp0 nvarchar(4000)
-- This example assumes the Chilkat API to have been previously unlocked.
-- See Global Unlock Sample for sample code.
DECLARE @http int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.Http', @http OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
DECLARE @success int
-- 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>"
-- }
-- }
DECLARE @json int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.JsonObject', @json OUT
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'name', '<string>'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'templateType', '<string>'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'body.storage.value', '<string>'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'body.storage.representation', '<string>'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'description', '<string>'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'labels[0].prefix', 'dolore deserunt ut est anim'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'labels[0].name', 'occaecat quis culpa ad non'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'labels[0].id', 'laborum nisi ipsum'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'labels[0].label', 'labore laborum sint'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'labels[1].prefix', 'proident tempor'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'labels[1].name', 'incididunt cupidatat ea'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'labels[1].id', 'non dolore quis proident'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'labels[1].label', 'labore sint'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'space.key', '<string>'
-- Adds the "Authorization: Bearer <access_token>" header.
EXEC sp_OASetProperty @http, 'AuthToken', '<access_token>'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Content-Type', 'application/json'
DECLARE @resp int
EXEC sp_OAMethod @http, 'PostJson3', @resp OUT, 'https://your-domain.atlassian.net/wiki/rest/api/template', 'application/json', @json
EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
IF @iTmp0 = 0
BEGIN
EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @json
RETURN
END
DECLARE @sbResponseBody int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.StringBuilder', @sbResponseBody OUT
EXEC sp_OAMethod @resp, 'GetBodySb', @success OUT, @sbResponseBody
DECLARE @jResp int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.JsonObject', @jResp OUT
EXEC sp_OAMethod @jResp, 'LoadSb', @success OUT, @sbResponseBody
EXEC sp_OASetProperty @jResp, 'EmitCompact', 0
PRINT 'Response Body:'
EXEC sp_OAMethod @jResp, 'Emit', @sTmp0 OUT
PRINT @sTmp0
DECLARE @respStatusCode int
EXEC sp_OAGetProperty @resp, 'StatusCode', @respStatusCode OUT
PRINT 'Response Status Code = ' + @respStatusCode
IF @respStatusCode >= 400
BEGIN
PRINT 'Response Header:'
EXEC sp_OAGetProperty @resp, 'Header', @sTmp0 OUT
PRINT @sTmp0
PRINT 'Failed.'
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @json
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
RETURN
END
EXEC @hr = sp_OADestroy @resp
-- 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
DECLARE @prefix nvarchar(4000)
DECLARE @id nvarchar(4000)
DECLARE @label nvarchar(4000)
DECLARE @entityIdValue nvarchar(4000)
DECLARE @entityValue nvarchar(4000)
DECLARE @value nvarchar(4000)
DECLARE @templateId nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @templateId OUT, 'templateId'
DECLARE @name nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @name OUT, 'name'
DECLARE @description nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @description OUT, 'description'
DECLARE @templateType nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @templateType OUT, 'templateType'
DECLARE @Body nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Body OUT, '_expandable.body'
DECLARE @Value nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Value OUT, 'body.value'
DECLARE @Representation nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Representation OUT, 'body.representation'
DECLARE @Content nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Content OUT, 'body._expandable.content'
DECLARE @AllValue nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @AllValue OUT, 'body.webresource.uris.all.value'
DECLARE @CssValue nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @CssValue OUT, 'body.webresource.uris.css.value'
DECLARE @JsValue nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @JsValue OUT, 'body.webresource.uris.js.value'
EXEC sp_OAMethod @jResp, 'StringOf', @AllValue OUT, 'body.webresource.tags.all.value'
EXEC sp_OAMethod @jResp, 'StringOf', @CssValue OUT, 'body.webresource.tags.css.value'
DECLARE @DataValue nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @DataValue OUT, 'body.webresource.tags.data.value'
EXEC sp_OAMethod @jResp, 'StringOf', @JsValue OUT, 'body.webresource.tags.js.value'
DECLARE @SuperbatchValue nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @SuperbatchValue OUT, 'body.webresource.superbatch.value'
DECLARE @i int
SELECT @i = 0
DECLARE @count_i int
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'labels'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @prefix OUT, 'labels[i].prefix'
EXEC sp_OAMethod @jResp, 'StringOf', @name OUT, 'labels[i].name'
EXEC sp_OAMethod @jResp, 'StringOf', @id OUT, 'labels[i].id'
EXEC sp_OAMethod @jResp, 'StringOf', @label OUT, 'labels[i].label'
SELECT @i = @i + 1
END
SELECT @i = 0
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'body.embeddedContent'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @entityIdValue OUT, 'body.embeddedContent[i].entityId.value'
EXEC sp_OAMethod @jResp, 'StringOf', @entityValue OUT, 'body.embeddedContent[i].entity.value'
SELECT @i = @i + 1
END
SELECT @i = 0
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'body.webresource.keys'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @value OUT, 'body.webresource.keys[i].value'
SELECT @i = @i + 1
END
SELECT @i = 0
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'body.webresource.contexts'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @value OUT, 'body.webresource.contexts[i].value'
SELECT @i = @i + 1
END
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @json
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
END
GO
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": ""
}
]
}
