Chilkat Online Tools

delphiDll / Atlassian Confluence Cloud / Create content template

Back to Collection Items

var
http: HCkHttp;
success: Boolean;
json: HCkJsonObject;
resp: HCkHttpResponse;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
prefix: PWideChar;
id: PWideChar;
label: PWideChar;
entityIdValue: PWideChar;
entityValue: PWideChar;
value: PWideChar;
templateId: PWideChar;
name: PWideChar;
description: PWideChar;
templateType: PWideChar;
Body: PWideChar;
Value: PWideChar;
Representation: PWideChar;
Content: PWideChar;
AllValue: PWideChar;
CssValue: PWideChar;
JsValue: PWideChar;
DataValue: PWideChar;
SuperbatchValue: PWideChar;
i: Integer;
count_i: Integer;

begin
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

http := CkHttp_Create();

// 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>"
//   }
// }

json := CkJsonObject_Create();
CkJsonObject_UpdateString(json,'name','<string>');
CkJsonObject_UpdateString(json,'templateType','<string>');
CkJsonObject_UpdateString(json,'body.storage.value','<string>');
CkJsonObject_UpdateString(json,'body.storage.representation','<string>');
CkJsonObject_UpdateString(json,'description','<string>');
CkJsonObject_UpdateString(json,'labels[0].prefix','dolore deserunt ut est anim');
CkJsonObject_UpdateString(json,'labels[0].name','occaecat quis culpa ad non');
CkJsonObject_UpdateString(json,'labels[0].id','laborum nisi ipsum');
CkJsonObject_UpdateString(json,'labels[0].label','labore laborum sint');
CkJsonObject_UpdateString(json,'labels[1].prefix','proident tempor');
CkJsonObject_UpdateString(json,'labels[1].name','incididunt cupidatat ea');
CkJsonObject_UpdateString(json,'labels[1].id','non dolore quis proident');
CkJsonObject_UpdateString(json,'labels[1].label','labore sint');
CkJsonObject_UpdateString(json,'space.key','<string>');

// Adds the "Authorization: Bearer <access_token>" header.
CkHttp_putAuthToken(http,'<access_token>');
CkHttp_SetRequestHeader(http,'Content-Type','application/json');

resp := CkHttp_PostJson3(http,'https://your-domain.atlassian.net/wiki/rest/api/template','application/json',json);
if (CkHttp_getLastMethodSuccess(http) = False) then
  begin
    Memo1.Lines.Add(CkHttp__lastErrorText(http));
    Exit;
  end;

sbResponseBody := CkStringBuilder_Create();
CkHttpResponse_GetBodySb(resp,sbResponseBody);

jResp := CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,False);

Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(CkJsonObject__emit(jResp));

respStatusCode := CkHttpResponse_getStatusCode(resp);
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
  begin
    Memo1.Lines.Add('Response Header:');
    Memo1.Lines.Add(CkHttpResponse__header(resp));
    Memo1.Lines.Add('Failed.');
    CkHttpResponse_Dispose(resp);
    Exit;
  end;
CkHttpResponse_Dispose(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

templateId := CkJsonObject__stringOf(jResp,'templateId');
name := CkJsonObject__stringOf(jResp,'name');
description := CkJsonObject__stringOf(jResp,'description');
templateType := CkJsonObject__stringOf(jResp,'templateType');
Body := CkJsonObject__stringOf(jResp,'_expandable.body');
Value := CkJsonObject__stringOf(jResp,'body.value');
Representation := CkJsonObject__stringOf(jResp,'body.representation');
Content := CkJsonObject__stringOf(jResp,'body._expandable.content');
AllValue := CkJsonObject__stringOf(jResp,'body.webresource.uris.all.value');
CssValue := CkJsonObject__stringOf(jResp,'body.webresource.uris.css.value');
JsValue := CkJsonObject__stringOf(jResp,'body.webresource.uris.js.value');
AllValue := CkJsonObject__stringOf(jResp,'body.webresource.tags.all.value');
CssValue := CkJsonObject__stringOf(jResp,'body.webresource.tags.css.value');
DataValue := CkJsonObject__stringOf(jResp,'body.webresource.tags.data.value');
JsValue := CkJsonObject__stringOf(jResp,'body.webresource.tags.js.value');
SuperbatchValue := CkJsonObject__stringOf(jResp,'body.webresource.superbatch.value');
i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'labels');
while i < count_i do
  begin
    CkJsonObject_putI(jResp,i);
    prefix := CkJsonObject__stringOf(jResp,'labels[i].prefix');
    name := CkJsonObject__stringOf(jResp,'labels[i].name');
    id := CkJsonObject__stringOf(jResp,'labels[i].id');
    label := CkJsonObject__stringOf(jResp,'labels[i].label');
    i := i + 1;
  end;

i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'body.embeddedContent');
while i < count_i do
  begin
    CkJsonObject_putI(jResp,i);
    entityIdValue := CkJsonObject__stringOf(jResp,'body.embeddedContent[i].entityId.value');
    entityValue := CkJsonObject__stringOf(jResp,'body.embeddedContent[i].entity.value');
    i := i + 1;
  end;

i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'body.webresource.keys');
while i < count_i do
  begin
    CkJsonObject_putI(jResp,i);
    value := CkJsonObject__stringOf(jResp,'body.webresource.keys[i].value');
    i := i + 1;
  end;

i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'body.webresource.contexts');
while i < count_i do
  begin
    CkJsonObject_putI(jResp,i);
    value := CkJsonObject__stringOf(jResp,'body.webresource.contexts[i].value');
    i := i + 1;
  end;

CkHttp_Dispose(http);
CkJsonObject_Dispose(json);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);

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