Back to Collection Items
<?php
include("chilkat.php");
// Use "chilkat_9_5_0.php" for versions of Chilkat < 10.0.0
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
$http = new CkHttp();
$queryParams = new CkJsonObject();
$queryParams->UpdateString('spaceKey','<string>');
$queryParams->UpdateInt('start',0);
$queryParams->UpdateInt('limit',25);
$queryParams->UpdateString('expand','<string>');
$queryParams->UpdateString('expand','<string>');
// Adds the "Authorization: Bearer <access_token>" header.
$http->put_AuthToken('<access_token>');
// resp is a CkHttpResponse
$resp = $http->QuickRequestParams('GET','https://your-domain.atlassian.net/wiki/rest/api/template/page',$queryParams);
if ($http->get_LastMethodSuccess() == false) {
print $http->lastErrorText() . "\n";
exit;
}
$sbResponseBody = new CkStringBuilder();
$resp->GetBodySb($sbResponseBody);
$jResp = new CkJsonObject();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(false);
print 'Response Body:' . "\n";
print $jResp->emit() . "\n";
$respStatusCode = $resp->get_StatusCode();
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
print 'Response Header:' . "\n";
print $resp->header() . "\n";
print 'Failed.' . "\n";
exit;
}
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "results": [
// {
// "templateId": "pariatur adipisicing non Ut",
// "name": "enim ullamco officia eu",
// "description": "culpa",
// "labels": [
// {
// "prefix": "Ut id pariatur",
// "name": "amet ipsum reprehenderit",
// "id": "ipsum",
// "label": "do consectetur"
// },
// {
// "prefix": "irure elit",
// "name": "laboris cillum dolor pariatur aliquip",
// "id": "deserunt consectetur d",
// "label": "nisi ex"
// }
// ],
// "templateType": "sunt eu",
// "_expandable": {
// "body": "Excepteur velit aliquip"
// },
// "_links": {},
// "body": {
// "value": "sint dolor mollit",
// "representation": "view",
// "_expandable": {
// "content": "dolor"
// },
// "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": "qui officia aute",
// "name": "deserunt",
// "description": "velit laborum cupidatat anim",
// "labels": [
// {
// "prefix": "magna Ut",
// "name": "culpa quis Duis",
// "id": "et enim eiusmod quis",
// "label": "elit qui"
// },
// {
// "prefix": "eu proident",
// "name": "pariatur non",
// "id": "magna adipisicing ea amet sunt",
// "label": "qui"
// }
// ],
// "templateType": "nulla exercitation",
// "_expandable": {
// "body": "amet"
// },
// "_links": {},
// "body": {
// "value": "in ea consectetur",
// "representation": "storage",
// "_expandable": {
// "content": "aliquip magna eu do "
// },
// "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": -93900983,
// "limit": -84771492,
// "size": -63798652,
// "_links": {}
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
$start = $jResp->IntOf('start');
$limit = $jResp->IntOf('limit');
$size = $jResp->IntOf('size');
$i = 0;
$count_i = $jResp->SizeOfArray('results');
while ($i < $count_i) {
$jResp->put_I($i);
$templateId = $jResp->stringOf('results[i].templateId');
$name = $jResp->stringOf('results[i].name');
$description = $jResp->stringOf('results[i].description');
$templateType = $jResp->stringOf('results[i].templateType');
$Body = $jResp->stringOf('results[i]._expandable.body');
$Value = $jResp->stringOf('results[i].body.value');
$Representation = $jResp->stringOf('results[i].body.representation');
$Content = $jResp->stringOf('results[i].body._expandable.content');
$AllValue = $jResp->stringOf('results[i].body.webresource.uris.all.value');
$CssValue = $jResp->stringOf('results[i].body.webresource.uris.css.value');
$JsValue = $jResp->stringOf('results[i].body.webresource.uris.js.value');
$AllValue = $jResp->stringOf('results[i].body.webresource.tags.all.value');
$CssValue = $jResp->stringOf('results[i].body.webresource.tags.css.value');
$DataValue = $jResp->stringOf('results[i].body.webresource.tags.data.value');
$JsValue = $jResp->stringOf('results[i].body.webresource.tags.js.value');
$SuperbatchValue = $jResp->stringOf('results[i].body.webresource.superbatch.value');
$j = 0;
$count_j = $jResp->SizeOfArray('results[i].labels');
while ($j < $count_j) {
$jResp->put_J($j);
$prefix = $jResp->stringOf('results[i].labels[j].prefix');
$name = $jResp->stringOf('results[i].labels[j].name');
$id = $jResp->stringOf('results[i].labels[j].id');
$label = $jResp->stringOf('results[i].labels[j].label');
$j = $j + 1;
}
$j = 0;
$count_j = $jResp->SizeOfArray('results[i].body.embeddedContent');
while ($j < $count_j) {
$jResp->put_J($j);
$entityIdValue = $jResp->stringOf('results[i].body.embeddedContent[j].entityId.value');
$entityValue = $jResp->stringOf('results[i].body.embeddedContent[j].entity.value');
$j = $j + 1;
}
$j = 0;
$count_j = $jResp->SizeOfArray('results[i].body.webresource.keys');
while ($j < $count_j) {
$jResp->put_J($j);
$value = $jResp->stringOf('results[i].body.webresource.keys[j].value');
$j = $j + 1;
}
$j = 0;
$count_j = $jResp->SizeOfArray('results[i].body.webresource.contexts');
while ($j < $count_j) {
$jResp->put_J($j);
$value = $jResp->stringOf('results[i].body.webresource.contexts[j].value');
$j = $j + 1;
}
$i = $i + 1;
}
?>
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/page
Postman Collection Item JSON
{
"name": "Get content templates",
"request": {
"auth": {
"type": "oauth2"
},
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/api/template/page?spaceKey=<string>&start=0&limit=25&expand=<string>&expand=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"template",
"page"
],
"query": [
{
"key": "spaceKey",
"value": "<string>",
"description": "The key of the space to be queried for templates. If the `spaceKey`\nis not specified, global 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 content templates. Use this method to retrieve all global\ncontent templates or all content templates in a space.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\n'Admin' permission for the space to view space templates and 'Confluence\nAdministrator' global permission to view global templates."
},
"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/page?spaceKey=<string>&start=0&limit=25&expand=<string>&expand=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"template",
"page"
],
"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\": \"pariatur adipisicing non Ut\",\n \"name\": \"enim ullamco officia eu\",\n \"description\": \"culpa\",\n \"labels\": [\n {\n \"prefix\": \"Ut id pariatur\",\n \"name\": \"amet ipsum reprehenderit\",\n \"id\": \"ipsum\",\n \"label\": \"do consectetur\"\n },\n {\n \"prefix\": \"irure elit\",\n \"name\": \"laboris cillum dolor pariatur aliquip\",\n \"id\": \"deserunt consectetur d\",\n \"label\": \"nisi ex\"\n }\n ],\n \"templateType\": \"sunt eu\",\n \"_expandable\": {\n \"body\": \"Excepteur velit aliquip\"\n },\n \"_links\": {},\n \"body\": {\n \"value\": \"sint dolor mollit\",\n \"representation\": \"view\",\n \"_expandable\": {\n \"content\": \"dolor\"\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\": \"qui officia aute\",\n \"name\": \"deserunt\",\n \"description\": \"velit laborum cupidatat anim\",\n \"labels\": [\n {\n \"prefix\": \"magna Ut\",\n \"name\": \"culpa quis Duis\",\n \"id\": \"et enim eiusmod quis\",\n \"label\": \"elit qui\"\n },\n {\n \"prefix\": \"eu proident\",\n \"name\": \"pariatur non\",\n \"id\": \"magna adipisicing ea amet sunt\",\n \"label\": \"qui\"\n }\n ],\n \"templateType\": \"nulla exercitation\",\n \"_expandable\": {\n \"body\": \"amet\"\n },\n \"_links\": {},\n \"body\": {\n \"value\": \"in ea consectetur\",\n \"representation\": \"storage\",\n \"_expandable\": {\n \"content\": \"aliquip magna eu do \"\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\": -93900983,\n \"limit\": -84771492,\n \"size\": -63798652,\n \"_links\": {}\n}"
},
{
"name": "Returned if the calling user does not have permission to view the\ncontent 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/page?spaceKey=<string>&start=0&limit=25&expand=<string>&expand=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"template",
"page"
],
"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": ""
}
]
}
