Chilkat Online Tools

Java / Atlassian Confluence Cloud / Update content template

Back to Collection Items

import com.chilkatsoft.*;

public class ChilkatExample {

  static {
    try {
        System.loadLibrary("chilkat");
    } catch (UnsatisfiedLinkError e) {
      System.err.println("Native code library failed to load.\n" + e);
      System.exit(1);
    }
  }

  public static void main(String argv[])
  {
    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    CkHttp http = new CkHttp();
    boolean success;

    // Use this online tool to generate code from sample JSON: Generate Code to Create JSON

    // The following JSON is sent in the request body.

    // {
    //   "templateId": "<string>",
    //   "name": "<string>",
    //   "templateType": "<string>",
    //   "body": {
    //     "value": "<string>",
    //     "representation": "<string>"
    //   },
    //   "description": "<string>",
    //   "labels": [
    //     {
    //       "prefix": "ipsum dolor Excepteur Duis",
    //       "name": "nulla et ipsum voluptate consectetur",
    //       "id": "nostrud enim proident cupidatat eu",
    //       "label": "enim Lorem veniam amet"
    //     },
    //     {
    //       "prefix": "amet",
    //       "name": "officia adipisicing ut labo",
    //       "id": "ipsum in tempor",
    //       "label": "est occaecat magna"
    //     }
    //   ],
    //   "space": {
    //     "key": "<string>"
    //   }
    // }

    CkJsonObject json = new CkJsonObject();
    json.UpdateString("templateId","<string>");
    json.UpdateString("name","<string>");
    json.UpdateString("templateType","<string>");
    json.UpdateString("body.value","<string>");
    json.UpdateString("body.representation","<string>");
    json.UpdateString("description","<string>");
    json.UpdateString("labels[0].prefix","ipsum dolor Excepteur Duis");
    json.UpdateString("labels[0].name","nulla et ipsum voluptate consectetur");
    json.UpdateString("labels[0].id","nostrud enim proident cupidatat eu");
    json.UpdateString("labels[0].label","enim Lorem veniam amet");
    json.UpdateString("labels[1].prefix","amet");
    json.UpdateString("labels[1].name","officia adipisicing ut labo");
    json.UpdateString("labels[1].id","ipsum in tempor");
    json.UpdateString("labels[1].label","est occaecat magna");
    json.UpdateString("space.key","<string>");

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

    CkStringBuilder sbRequestBody = new CkStringBuilder();
    json.EmitSb(sbRequestBody);

    CkHttpResponse resp = http.PTextSb("PUT","https://your-domain.atlassian.net/wiki/rest/api/template",sbRequestBody,"utf-8","application/json",false,false);
    if (http.get_LastMethodSuccess() == false) {
        System.out.println(http.lastErrorText());
        return;
        }

    CkStringBuilder sbResponseBody = new CkStringBuilder();
    resp.GetBodySb(sbResponseBody);

    CkJsonObject jResp = new CkJsonObject();
    jResp.LoadSb(sbResponseBody);
    jResp.put_EmitCompact(false);

    System.out.println("Response Body:");
    System.out.println(jResp.emit());

    int respStatusCode = resp.get_StatusCode();
    System.out.println("Response Status Code = " + respStatusCode);
    if (respStatusCode >= 400) {
        System.out.println("Response Header:");
        System.out.println(resp.header());
        System.out.println("Failed.");

        return;
        }

    // Sample JSON response:
    // (Sample code for parsing the JSON response is shown below)

    // {
    //   "templateId": "id ipsum ut",
    //   "name": "sit dolor sint dolore",
    //   "description": "magna",
    //   "labels": [
    //     {
    //       "prefix": "fugiat sit Ut in ea",
    //       "name": "dolor in",
    //       "id": "aliqua culpa veniam ea",
    //       "label": "officia tempor ea"
    //     },
    //     {
    //       "prefix": "exercitation culpa proident",
    //       "name": "nulla mollit adipis",
    //       "id": "laborum sint",
    //       "label": "fugiat"
    //     }
    //   ],
    //   "templateType": "in cillum",
    //   "_expandable": {
    //     "body": "anim aute officia in culpa"
    //   },
    //   "_links": {},
    //   "body": {
    //     "value": "aute sit pariatur consequat deserunt",
    //     "representation": "anonymous_export_view",
    //     "_expandable": {
    //       "content": "nulla cillum reprehenderit"
    //     },
    //     "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

    String prefix;
    String id;
    String label;
    String entityIdValue;
    String entityValue;
    String value;

    String templateId = jResp.stringOf("templateId");
    String name = jResp.stringOf("name");
    String description = jResp.stringOf("description");
    String templateType = jResp.stringOf("templateType");
    String Body = jResp.stringOf("_expandable.body");
    String Value = jResp.stringOf("body.value");
    String Representation = jResp.stringOf("body.representation");
    String Content = jResp.stringOf("body._expandable.content");
    String AllValue = jResp.stringOf("body.webresource.uris.all.value");
    String CssValue = jResp.stringOf("body.webresource.uris.css.value");
    String JsValue = jResp.stringOf("body.webresource.uris.js.value");
    AllValue = jResp.stringOf("body.webresource.tags.all.value");
    CssValue = jResp.stringOf("body.webresource.tags.css.value");
    String DataValue = jResp.stringOf("body.webresource.tags.data.value");
    JsValue = jResp.stringOf("body.webresource.tags.js.value");
    String SuperbatchValue = jResp.stringOf("body.webresource.superbatch.value");
    int i = 0;
    int count_i = jResp.SizeOfArray("labels");
    while (i < count_i) {
        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");
    while (i < count_i) {
        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");
    while (i < count_i) {
        jResp.put_I(i);
        value = jResp.stringOf("body.webresource.keys[i].value");
        i = i+1;
        }

    i = 0;
    count_i = jResp.SizeOfArray("body.webresource.contexts");
    while (i < count_i) {
        jResp.put_I(i);
        value = jResp.stringOf("body.webresource.contexts[i].value");
        i = i+1;
        }
  }
}

Curl Command

curl -X PUT
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json"
	-d '{
    "templateId": "<string>",
    "name": "<string>",
    "templateType": "<string>",
    "body": {
        "value": "<string>",
        "representation": "<string>"
    },
    "description": "<string>",
    "labels": [
        {
            "prefix": "ipsum dolor Excepteur Duis",
            "name": "nulla et ipsum voluptate consectetur",
            "id": "nostrud enim proident cupidatat eu",
            "label": "enim Lorem veniam amet"
        },
        {
            "prefix": "amet",
            "name": "officia adipisicing ut labo",
            "id": "ipsum in tempor",
            "label": "est occaecat magna"
        }
    ],
    "space": {
        "key": "<string>"
    }
}'
https://your-domain.atlassian.net/wiki/rest/api/template

Postman Collection Item JSON

{
  "name": "Update content template",
  "request": {
    "auth": {
      "type": "oauth2"
    },
    "method": "PUT",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"templateId\": \"<string>\",\n    \"name\": \"<string>\",\n    \"templateType\": \"<string>\",\n    \"body\": {\n        \"value\": \"<string>\",\n        \"representation\": \"<string>\"\n    },\n    \"description\": \"<string>\",\n    \"labels\": [\n        {\n            \"prefix\": \"ipsum dolor Excepteur Duis\",\n            \"name\": \"nulla et ipsum voluptate consectetur\",\n            \"id\": \"nostrud enim proident cupidatat eu\",\n            \"label\": \"enim Lorem veniam amet\"\n        },\n        {\n            \"prefix\": \"amet\",\n            \"name\": \"officia adipisicing ut labo\",\n            \"id\": \"ipsum in tempor\",\n            \"label\": \"est occaecat magna\"\n        }\n    ],\n    \"space\": {\n        \"key\": \"<string>\"\n    }\n}"
    },
    "url": {
      "raw": "{{baseUrl}}/api/template",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "template"
      ]
    },
    "description": "Updates a content template. Note, blueprint templates cannot be updated\nvia 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 updated.",
      "originalRequest": {
        "method": "PUT",
        "header": [
          {
            "description": {
              "content": "Added as a part of security scheme: oauth2",
              "type": "text/plain"
            },
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"templateId\": \"<string>\",\n    \"name\": \"<string>\",\n    \"templateType\": \"<string>\",\n    \"body\": {\n        \"value\": \"<string>\",\n        \"representation\": \"<string>\"\n    },\n    \"description\": \"<string>\",\n    \"labels\": [\n        {\n            \"prefix\": \"officia ea in eu\",\n            \"name\": \"commodo mollit\",\n            \"id\": \"veniam minim nisi quis officia\",\n            \"label\": \"commodo\"\n        },\n        {\n            \"prefix\": \"cupidatat dolor aliqua laboris\",\n            \"name\": \"officia amet\",\n            \"id\": \"voluptate ad quis p\",\n            \"label\": \"eu sit adipisicing ea Ut\"\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\": \"id ipsum ut\",\n \"name\": \"sit dolor sint dolore\",\n \"description\": \"magna\",\n \"labels\": [\n  {\n   \"prefix\": \"fugiat sit Ut in ea\",\n   \"name\": \"dolor in\",\n   \"id\": \"aliqua culpa veniam ea\",\n   \"label\": \"officia tempor ea\"\n  },\n  {\n   \"prefix\": \"exercitation culpa proident\",\n   \"name\": \"nulla mollit adipis\",\n   \"id\": \"laborum sint\",\n   \"label\": \"fugiat\"\n  }\n ],\n \"templateType\": \"in cillum\",\n \"_expandable\": {\n  \"body\": \"anim aute officia in culpa\"\n },\n \"_links\": {},\n \"body\": {\n  \"value\": \"aute sit pariatur consequat deserunt\",\n  \"representation\": \"anonymous_export_view\",\n  \"_expandable\": {\n   \"content\": \"nulla cillum reprehenderit\"\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 update the\ntemplate.",
      "originalRequest": {
        "method": "PUT",
        "header": [
          {
            "description": {
              "content": "Added as a part of security scheme: oauth2",
              "type": "text/plain"
            },
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"templateId\": \"<string>\",\n    \"name\": \"<string>\",\n    \"templateType\": \"<string>\",\n    \"body\": {\n        \"value\": \"<string>\",\n        \"representation\": \"<string>\"\n    },\n    \"description\": \"<string>\",\n    \"labels\": [\n        {\n            \"prefix\": \"officia ea in eu\",\n            \"name\": \"commodo mollit\",\n            \"id\": \"veniam minim nisi quis officia\",\n            \"label\": \"commodo\"\n        },\n        {\n            \"prefix\": \"cupidatat dolor aliqua laboris\",\n            \"name\": \"officia amet\",\n            \"id\": \"voluptate ad quis p\",\n            \"label\": \"eu sit adipisicing ea Ut\"\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": ""
    }
  ]
}