Back to Collection Items
integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_QueryParams
oleobject loo_Resp
oleobject loo_SbResponseBody
oleobject loo_JResp
integer li_RespStatusCode
string ls_TemplateId
string ls_PluginKey
string ls_ModuleKey
string ls_ReferencingBlueprint
string ls_Name
string ls_Description
string ls_TemplateType
string ls_Body
string ls_Value
string ls_Representation
string ls_Content
string ls_AllValue
string ls_CssValue
string ls_JsValue
string ls_DataValue
string ls_SuperbatchValue
integer j
integer li_Count_j
string ls_Prefix
string ls_Id
string ls_Label
string ls_EntityIdValue
string ls_EntityValue
string ls_Value
integer li_Start
integer li_Limit
integer li_Size
integer i
integer li_Count_i
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loo_Http = create oleobject
// Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
li_rc = loo_Http.ConnectToNewObject("Chilkat.Http")
if li_rc < 0 then
destroy loo_Http
MessageBox("Error","Connecting to COM object failed")
return
end if
loo_QueryParams = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_QueryParams.ConnectToNewObject("Chilkat.JsonObject")
loo_QueryParams.UpdateString("spaceKey","<string>")
loo_QueryParams.UpdateInt("start",0)
loo_QueryParams.UpdateInt("limit",25)
loo_QueryParams.UpdateString("expand","<string>")
loo_QueryParams.UpdateString("expand","<string>")
// Adds the "Authorization: Bearer <access_token>" header.
loo_Http.AuthToken = "<access_token>"
loo_Resp = loo_Http.QuickRequestParams("GET","https://your-domain.atlassian.net/wiki/rest/api/template/blueprint",loo_QueryParams)
if loo_Http.LastMethodSuccess = 0 then
Write-Debug loo_Http.LastErrorText
destroy loo_Http
destroy loo_QueryParams
return
end if
loo_SbResponseBody = create oleobject
// Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat.StringBuilder")
loo_Resp.GetBodySb(loo_SbResponseBody)
loo_JResp = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_JResp.ConnectToNewObject("Chilkat.JsonObject")
loo_JResp.LoadSb(loo_SbResponseBody)
loo_JResp.EmitCompact = 0
Write-Debug "Response Body:"
Write-Debug loo_JResp.Emit()
li_RespStatusCode = loo_Resp.StatusCode
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_RespStatusCode >= 400 then
Write-Debug "Response Header:"
Write-Debug loo_Resp.Header
Write-Debug "Failed."
destroy loo_Resp
destroy loo_Http
destroy loo_QueryParams
destroy loo_SbResponseBody
destroy loo_JResp
return
end if
destroy loo_Resp
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "results": [
// {
// "templateId": "velit aute fug",
// "originalTemplate": {
// "pluginKey": "id adipisicing ex ea amet",
// "moduleKey": "elit occaecat exercitation"
// },
// "referencingBlueprint": "fug",
// "name": "do sit esse officia dolore",
// "description": "commodo et eu",
// "labels": [
// {
// "prefix": "nisi cupidatat in proident",
// "name": "deserunt magna ut eu",
// "id": "dolor in",
// "label": "nostrud culpa enim"
// },
// {
// "prefix": "sint qui labore",
// "name": "Ut qui exercitation dolore",
// "id": "non dolor aute",
// "label": "dolor quis magna ex"
// }
// ],
// "templateType": "officia",
// "_expandable": {
// "body": "pariatur Ut deserunt"
// },
// "_links": {},
// "body": {
// "value": "nulla aliqua culpa anim sunt",
// "representation": "anonymous_export_view",
// "_expandable": {
// "content": "ut est pariatur"
// },
// "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>"
// }
// }
// }
// },
// {
// "templateId": "voluptate mollit in",
// "originalTemplate": {
// "pluginKey": "Excepteur laborum",
// "moduleKey": "ea nulla"
// },
// "referencingBlueprint": "ipsum magna velit adipisicing est",
// "name": "in velit pariatur",
// "description": "ipsum qui et",
// "labels": [
// {
// "prefix": "incididunt non laborum sit",
// "name": "id tempor",
// "id": "mollit",
// "label": "deserunt exercitation tempor nulla"
// },
// {
// "prefix": "nostrud dolor",
// "name": "eiusmod in ad",
// "id": "cupidatat labore in",
// "label": "do deserunt amet"
// }
// ],
// "templateType": "aute",
// "_expandable": {
// "body": "labore deserunt"
// },
// "_links": {},
// "body": {
// "value": "aute qui",
// "representation": "editor2",
// "_expandable": {
// "content": "occaecat ea voluptate nostrud"
// },
// "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>"
// }
// }
// }
// }
// ],
// "start": -43882824,
// "limit": 59508609,
// "size": -8662482,
// "_links": {}
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
li_Start = loo_JResp.IntOf("start")
li_Limit = loo_JResp.IntOf("limit")
li_Size = loo_JResp.IntOf("size")
i = 0
li_Count_i = loo_JResp.SizeOfArray("results")
do while i < li_Count_i
loo_JResp.I = i
ls_TemplateId = loo_JResp.StringOf("results[i].templateId")
ls_PluginKey = loo_JResp.StringOf("results[i].originalTemplate.pluginKey")
ls_ModuleKey = loo_JResp.StringOf("results[i].originalTemplate.moduleKey")
ls_ReferencingBlueprint = loo_JResp.StringOf("results[i].referencingBlueprint")
ls_Name = loo_JResp.StringOf("results[i].name")
ls_Description = loo_JResp.StringOf("results[i].description")
ls_TemplateType = loo_JResp.StringOf("results[i].templateType")
ls_Body = loo_JResp.StringOf("results[i]._expandable.body")
ls_Value = loo_JResp.StringOf("results[i].body.value")
ls_Representation = loo_JResp.StringOf("results[i].body.representation")
ls_Content = loo_JResp.StringOf("results[i].body._expandable.content")
ls_AllValue = loo_JResp.StringOf("results[i].body.webresource.uris.all.value")
ls_CssValue = loo_JResp.StringOf("results[i].body.webresource.uris.css.value")
ls_JsValue = loo_JResp.StringOf("results[i].body.webresource.uris.js.value")
ls_AllValue = loo_JResp.StringOf("results[i].body.webresource.tags.all.value")
ls_CssValue = loo_JResp.StringOf("results[i].body.webresource.tags.css.value")
ls_DataValue = loo_JResp.StringOf("results[i].body.webresource.tags.data.value")
ls_JsValue = loo_JResp.StringOf("results[i].body.webresource.tags.js.value")
ls_SuperbatchValue = loo_JResp.StringOf("results[i].body.webresource.superbatch.value")
j = 0
li_Count_j = loo_JResp.SizeOfArray("results[i].labels")
do while j < li_Count_j
loo_JResp.J = j
ls_Prefix = loo_JResp.StringOf("results[i].labels[j].prefix")
ls_Name = loo_JResp.StringOf("results[i].labels[j].name")
ls_Id = loo_JResp.StringOf("results[i].labels[j].id")
ls_Label = loo_JResp.StringOf("results[i].labels[j].label")
j = j + 1
loop
j = 0
li_Count_j = loo_JResp.SizeOfArray("results[i].body.embeddedContent")
do while j < li_Count_j
loo_JResp.J = j
ls_EntityIdValue = loo_JResp.StringOf("results[i].body.embeddedContent[j].entityId.value")
ls_EntityValue = loo_JResp.StringOf("results[i].body.embeddedContent[j].entity.value")
j = j + 1
loop
j = 0
li_Count_j = loo_JResp.SizeOfArray("results[i].body.webresource.keys")
do while j < li_Count_j
loo_JResp.J = j
ls_Value = loo_JResp.StringOf("results[i].body.webresource.keys[j].value")
j = j + 1
loop
j = 0
li_Count_j = loo_JResp.SizeOfArray("results[i].body.webresource.contexts")
do while j < li_Count_j
loo_JResp.J = j
ls_Value = loo_JResp.StringOf("results[i].body.webresource.contexts[j].value")
j = j + 1
loop
i = i + 1
loop
destroy loo_Http
destroy loo_QueryParams
destroy loo_SbResponseBody
destroy loo_JResp
Curl Command
curl -G -d "spaceKey=%3Cstring%3E"
-d "start=0"
-d "limit=25"
-d "expand=%3Cstring%3E"
-d "expand=%3Cstring%3E"
-H "Authorization: Bearer <access_token>"
https://your-domain.atlassian.net/wiki/rest/api/template/blueprint
Postman Collection Item JSON
{
"name": "Get blueprint templates",
"request": {
"auth": {
"type": "oauth2"
},
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/api/template/blueprint?spaceKey=<string>&start=0&limit=25&expand=<string>&expand=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"template",
"blueprint"
],
"query": [
{
"key": "spaceKey",
"value": "<string>",
"description": "The key of the space to be queried for templates. If the `spaceKey`\nis not specified, global blueprint templates will be returned."
},
{
"key": "start",
"value": "0",
"description": "The starting index of the returned templates."
},
{
"key": "limit",
"value": "25",
"description": "The maximum number of templates to return per page.\nNote, this may be restricted by fixed system limits."
},
{
"key": "expand",
"value": "<string>",
"description": "A multi-value parameter indicating which properties of the template\nto expand.\n\n- `body` returns the content of the template in storage format."
},
{
"key": "expand",
"value": "<string>",
"description": "A multi-value parameter indicating which properties of the template\nto expand.\n\n- `body` returns the content of the template in storage format."
}
]
},
"description": "Returns all templates provided by blueprints. Use this method to retrieve\nall global blueprint templates or all blueprint templates in a space.\n\nNote, all global blueprints are inherited by each space. Space blueprints\ncan be customised without affecting the global blueprints.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to access the Confluence site ('Can use' global permission)."
},
"response": [
{
"name": "Returned if the requested templates are returned.",
"originalRequest": {
"method": "GET",
"header": [
{
"description": {
"content": "Added as a part of security scheme: oauth2",
"type": "text/plain"
},
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/api/template/blueprint?spaceKey=<string>&start=0&limit=25&expand=<string>&expand=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"template",
"blueprint"
],
"query": [
{
"key": "spaceKey",
"value": "<string>"
},
{
"key": "start",
"value": "0"
},
{
"key": "limit",
"value": "25"
},
{
"key": "expand",
"value": "<string>"
},
{
"key": "expand",
"value": "<string>"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"results\": [\n {\n \"templateId\": \"velit aute fug\",\n \"originalTemplate\": {\n \"pluginKey\": \"id adipisicing ex ea amet\",\n \"moduleKey\": \"elit occaecat exercitation\"\n },\n \"referencingBlueprint\": \"fug\",\n \"name\": \"do sit esse officia dolore\",\n \"description\": \"commodo et eu\",\n \"labels\": [\n {\n \"prefix\": \"nisi cupidatat in proident\",\n \"name\": \"deserunt magna ut eu\",\n \"id\": \"dolor in\",\n \"label\": \"nostrud culpa enim\"\n },\n {\n \"prefix\": \"sint qui labore\",\n \"name\": \"Ut qui exercitation dolore\",\n \"id\": \"non dolor aute\",\n \"label\": \"dolor quis magna ex\"\n }\n ],\n \"templateType\": \"officia\",\n \"_expandable\": {\n \"body\": \"pariatur Ut deserunt\"\n },\n \"_links\": {},\n \"body\": {\n \"value\": \"nulla aliqua culpa anim sunt\",\n \"representation\": \"anonymous_export_view\",\n \"_expandable\": {\n \"content\": \"ut est pariatur\"\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 },\n {\n \"templateId\": \"voluptate mollit in\",\n \"originalTemplate\": {\n \"pluginKey\": \"Excepteur laborum\",\n \"moduleKey\": \"ea nulla\"\n },\n \"referencingBlueprint\": \"ipsum magna velit adipisicing est\",\n \"name\": \"in velit pariatur\",\n \"description\": \"ipsum qui et\",\n \"labels\": [\n {\n \"prefix\": \"incididunt non laborum sit\",\n \"name\": \"id tempor\",\n \"id\": \"mollit\",\n \"label\": \"deserunt exercitation tempor nulla\"\n },\n {\n \"prefix\": \"nostrud dolor\",\n \"name\": \"eiusmod in ad\",\n \"id\": \"cupidatat labore in\",\n \"label\": \"do deserunt amet\"\n }\n ],\n \"templateType\": \"aute\",\n \"_expandable\": {\n \"body\": \"labore deserunt\"\n },\n \"_links\": {},\n \"body\": {\n \"value\": \"aute qui\",\n \"representation\": \"editor2\",\n \"_expandable\": {\n \"content\": \"occaecat ea voluptate nostrud\"\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 }\n ],\n \"start\": -43882824,\n \"limit\": 59508609,\n \"size\": -8662482,\n \"_links\": {}\n}"
},
{
"name": "Returned if the calling user does not have permission to view\nblueprint templates.",
"originalRequest": {
"method": "GET",
"header": [
{
"description": {
"content": "Added as a part of security scheme: oauth2",
"type": "text/plain"
},
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/api/template/blueprint?spaceKey=<string>&start=0&limit=25&expand=<string>&expand=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"template",
"blueprint"
],
"query": [
{
"key": "spaceKey",
"value": "<string>"
},
{
"key": "start",
"value": "0"
},
{
"key": "limit",
"value": "25"
},
{
"key": "expand",
"value": "<string>"
},
{
"key": "expand",
"value": "<string>"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}
