Chilkat Online Tools

PHP (Extension) / Atlassian Confluence Cloud / Create content template

Back to Collection Items

<?php

include("chilkat.php");

$json->UpdateString('name','<string>');$json->UpdateString('templateType','<string>');$json->UpdateString('body.storage.value','<string>');$json->UpdateString('body.storage.representation','<string>');$json->UpdateString('description','<string>');$json->UpdateString('labels[0].prefix','dolore deserunt ut est anim');$json->UpdateString('labels[0].name','occaecat quis culpa ad non');$json->UpdateString('labels[0].id','laborum nisi ipsum');$json->UpdateString('labels[0].label','labore laborum sint');$json->UpdateString('labels[1].prefix','proident tempor');$json->UpdateString('labels[1].name','incididunt cupidatat ea');$json->UpdateString('labels[1].id','non dolore quis proident');$json->UpdateString('labels[1].label','labore sint');$json->UpdateString('space.key','<string>');$http->put_AuthToken('<access_token>');$success = $http->HttpJson('POST','https://your-domain.atlassian.net/wiki/rest/api/template',$json,'application/json',$resp);$resp->GetBodySb($sbResponseBody);$jResp->LoadSb($sbResponseBody);$jResp->put_EmitCompact(false);$AllValue = $jResp->stringOf('body.webresource.tags.all.value');$CssValue = $jResp->stringOf('body.webresource.tags.css.value');$JsValue = $jResp->stringOf('body.webresource.tags.js.value');$jResp->put_I($i);$prefix = $jResp->stringOf('labels[i].prefix');$name = $jResp->stringOf('labels[i].name');$id = $jResp->stringOf('labels[i].id');$label = $jResp->stringOf('labels[i].label');$i = $i + 1;$i = 0;$count_i = $jResp->SizeOfArray('body.embeddedContent');$jResp->put_I($i);$entityIdValue = $jResp->stringOf('body.embeddedContent[i].entityId.value');$entityValue = $jResp->stringOf('body.embeddedContent[i].entity.value');$i = $i + 1;$i = 0;$count_i = $jResp->SizeOfArray('body.webresource.keys');$jResp->put_I($i);$value = $jResp->stringOf('body.webresource.keys[i].value');$i = $i + 1;$i = 0;$count_i = $jResp->SizeOfArray('body.webresource.contexts');$jResp->put_I($i);$value = $jResp->stringOf('body.webresource.contexts[i].value');$i = $i + 1;
?>

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": ""
    }
  ]
}