Chilkat Online Tools

Swift / Atlassian Confluence Cloud / Convert content body

Back to Collection Items

func chilkatTest() {
    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    let http = CkoHttp()
    var success: Bool

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

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

    // {
    //   "value": "<string>",
    //   "representation": "<string>"
    // }

    let json = CkoJsonObject()
    json.UpdateString("value", value: "<string>")
    json.UpdateString("representation", value: "<string>")

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

    var resp: CkoHttpResponse? = http.PostJson3("https://your-domain.atlassian.net/wiki/rest/api/contentbody/convert/:to?expand=<string>&expand=<string>&spaceKeyContext=<string>&contentIdContext=<string>&embeddedContentRender=current", contentType: "application/json", json: json)
    if http.LastMethodSuccess == false {
        print("\(http.LastErrorText)")
        return
    }

    let sbResponseBody = CkoStringBuilder()
    resp!.GetBodySb(sbResponseBody)

    let jResp = CkoJsonObject()
    jResp.LoadSb(sbResponseBody)
    jResp.EmitCompact = false

    print("Response Body:")
    print("\(jResp.Emit())")

    var respStatusCode: Int = resp!.StatusCode.intValue
    print("Response Status Code = \(respStatusCode)")
    if respStatusCode >= 400 {
        print("Response Header:")
        print("\(resp!.Header)")
        print("Failed.")
        resp = nil
        return
    }

    resp = nil

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

    // {
    //   "value": "eu dolor",
    //   "representation": "editor2",
    //   "_expandable": {
    //     "content": "anim"
    //   },
    //   "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

    var entityIdValue: String?
    var entityValue: String?

    var value: String? = jResp.StringOf("value")
    var representation: String? = jResp.StringOf("representation")
    var Content: String? = jResp.StringOf("_expandable.content")
    var Value: String? = jResp.StringOf("webresource.uris.all.value")
    var CssValue: String? = jResp.StringOf("webresource.uris.css.value")
    var JsValue: String? = jResp.StringOf("webresource.uris.js.value")
    var AllValue: String? = jResp.StringOf("webresource.tags.all.value")
    CssValue = jResp.StringOf("webresource.tags.css.value")
    var DataValue: String? = jResp.StringOf("webresource.tags.data.value")
    JsValue = jResp.StringOf("webresource.tags.js.value")
    var SuperbatchValue: String? = jResp.StringOf("webresource.superbatch.value")
    var i: Int = 0
    var count_i: Int = jResp.SizeOfArray("embeddedContent").intValue
    while i < count_i {
        jResp.I = i
        entityIdValue = jResp.StringOf("embeddedContent[i].entityId.value")
        entityValue = jResp.StringOf("embeddedContent[i].entity.value")
        i = i + 1
    }

    i = 0
    count_i = jResp.SizeOfArray("webresource.keys").intValue
    while i < count_i {
        jResp.I = i
        value = jResp.StringOf("webresource.keys[i].value")
        i = i + 1
    }

    i = 0
    count_i = jResp.SizeOfArray("webresource.contexts").intValue
    while i < count_i {
        jResp.I = i
        value = jResp.StringOf("webresource.contexts[i].value")
        i = i + 1
    }


}

Curl Command

curl -X POST
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json"
	-d '{
    "value": "<string>",
    "representation": "<string>"
}'
https://your-domain.atlassian.net/wiki/rest/api/contentbody/convert/:to?expand=<string>&expand=<string>&spaceKeyContext=<string>&contentIdContext=<string>&embeddedContentRender=current

Postman Collection Item JSON

{
  "name": "Convert content body",
  "request": {
    "auth": {
      "type": "oauth2"
    },
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"value\": \"<string>\",\n    \"representation\": \"<string>\"\n}"
    },
    "url": {
      "raw": "{{baseUrl}}/api/contentbody/convert/:to?expand=<string>&expand=<string>&spaceKeyContext=<string>&contentIdContext=<string>&embeddedContentRender=current",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "contentbody",
        "convert",
        ":to"
      ],
      "query": [
        {
          "key": "expand",
          "value": "<string>",
          "description": "A multi-value parameter indicating which properties of the content to expand.\n\n- `childTypes.all` returns whether the content has attachments, comments, or child pages.\nUse this if you only need to check whether the content has children of a particular type.\n- `childTypes.attachment` returns whether the content has attachments.\n- `childTypes.comment` returns whether the content has comments.\n- `childTypes.page` returns whether the content has child pages.\n- `container` returns the space that the content is in. This is the same as the information\nreturned by [Get space](#api-space-spaceKey-get).\n- `metadata.currentuser` returns information about the current user in relation to the content,\nincluding when they last viewed it, modified it, contributed to it, or added it as a favorite.\n- `metadata.properties` returns content properties that have been set via the Confluence REST API.\n- `metadata.labels` returns the labels that have been added to the content.\n- `metadata.frontend` this property is only used by Atlassian.\n- `operations` returns the operations for the content, which are used when setting permissions.\n- `children.page` returns pages that are descendants at the level immediately below the content.\n- `children.attachment` returns all attachments for the content.\n- `children.comment` returns all comments on the content.\n- `restrictions.read.restrictions.user` returns the users that have permission to read the content.\n- `restrictions.read.restrictions.group` returns the groups that have permission to read the content. Note that\nthis may return deleted groups, because deleting a group doesn't remove associated restrictions.\n- `restrictions.update.restrictions.user` returns the users that have permission to update the content.\n- `restrictions.update.restrictions.group` returns the groups that have permission to update the content. Note that\nthis may return deleted groups because deleting a group doesn't remove associated restrictions.\n- `history` returns the history of the content, including the date it was created.\n- `history.lastUpdated` returns information about the most recent update of the content, including\nwho updated it and when it was updated.\n- `history.previousVersion` returns information about the update prior to the current content update.\n- `history.contributors` returns all of the users who have contributed to the content.\n- `history.nextVersion` returns information about the update after to the current content update.\n- `ancestors` returns the parent page, if the content is a page.\n- `body` returns the body of the content in different formats, including the editor format,\nview format, and export format.\n- `version` returns information about the most recent update of the content, including who updated it\nand when it was updated.\n- `descendants.page` returns pages that are descendants at any level below the content.\n- `descendants.attachment` returns all attachments for the content, same as `children.attachment`.\n- `descendants.comment` returns all comments on the content, same as `children.comment`.\n- `space` returns the space that the content is in. This is the same as the information returned by\n[Get space](#api-space-spaceKey-get).\n\nIn addition, the following comment-specific expansions can be used:\n- `extensions.inlineProperties` returns inline comment-specific properties.\n- `extensions.resolution` returns the resolution status of each comment."
        },
        {
          "key": "expand",
          "value": "<string>",
          "description": "A multi-value parameter indicating which properties of the content to expand.\n\n- `childTypes.all` returns whether the content has attachments, comments, or child pages.\nUse this if you only need to check whether the content has children of a particular type.\n- `childTypes.attachment` returns whether the content has attachments.\n- `childTypes.comment` returns whether the content has comments.\n- `childTypes.page` returns whether the content has child pages.\n- `container` returns the space that the content is in. This is the same as the information\nreturned by [Get space](#api-space-spaceKey-get).\n- `metadata.currentuser` returns information about the current user in relation to the content,\nincluding when they last viewed it, modified it, contributed to it, or added it as a favorite.\n- `metadata.properties` returns content properties that have been set via the Confluence REST API.\n- `metadata.labels` returns the labels that have been added to the content.\n- `metadata.frontend` this property is only used by Atlassian.\n- `operations` returns the operations for the content, which are used when setting permissions.\n- `children.page` returns pages that are descendants at the level immediately below the content.\n- `children.attachment` returns all attachments for the content.\n- `children.comment` returns all comments on the content.\n- `restrictions.read.restrictions.user` returns the users that have permission to read the content.\n- `restrictions.read.restrictions.group` returns the groups that have permission to read the content. Note that\nthis may return deleted groups, because deleting a group doesn't remove associated restrictions.\n- `restrictions.update.restrictions.user` returns the users that have permission to update the content.\n- `restrictions.update.restrictions.group` returns the groups that have permission to update the content. Note that\nthis may return deleted groups because deleting a group doesn't remove associated restrictions.\n- `history` returns the history of the content, including the date it was created.\n- `history.lastUpdated` returns information about the most recent update of the content, including\nwho updated it and when it was updated.\n- `history.previousVersion` returns information about the update prior to the current content update.\n- `history.contributors` returns all of the users who have contributed to the content.\n- `history.nextVersion` returns information about the update after to the current content update.\n- `ancestors` returns the parent page, if the content is a page.\n- `body` returns the body of the content in different formats, including the editor format,\nview format, and export format.\n- `version` returns information about the most recent update of the content, including who updated it\nand when it was updated.\n- `descendants.page` returns pages that are descendants at any level below the content.\n- `descendants.attachment` returns all attachments for the content, same as `children.attachment`.\n- `descendants.comment` returns all comments on the content, same as `children.comment`.\n- `space` returns the space that the content is in. This is the same as the information returned by\n[Get space](#api-space-spaceKey-get).\n\nIn addition, the following comment-specific expansions can be used:\n- `extensions.inlineProperties` returns inline comment-specific properties.\n- `extensions.resolution` returns the resolution status of each comment."
        },
        {
          "key": "spaceKeyContext",
          "value": "<string>",
          "description": "The space key used for resolving embedded content (page includes,\nfiles, and links) in the content body. For example, if the source content\ncontains the link `<ac:link><ri:page ri:content-title=\"Example page\" /><ac:link>`\nand the `spaceKeyContext=TEST` parameter is provided, then the link\nwill be converted to a link to the \"Example page\" page in the \"TEST\" space."
        },
        {
          "key": "contentIdContext",
          "value": "<string>",
          "description": "The content ID used to find the space for resolving embedded content\n(page includes, files, and links) in the content body. For example,\nif the source content contains the link `<ac:link><ri:page ri:content-title=\"Example page\" /><ac:link>`\nand the `contentIdContext=123` parameter is provided, then the link\nwill be converted to a link to the \"Example page\" page in the same space\nthat has the content with ID=123. Note, `spaceKeyContext` will be ignored\nif this parameter is provided."
        },
        {
          "key": "embeddedContentRender",
          "value": "current",
          "description": "Mode used for rendering embedded content, like attachments.\n\n- `current` renders the embedded content using the latest version.\n- `version-at-save` renders the embedded content using the version at\nthe time of save."
        }
      ],
      "variable": [
        {
          "key": "to",
          "value": "<string>",
          "type": "string",
          "description": "(Required) The name of the target format for the content body."
        }
      ]
    },
    "description": "Converts a content body from one format to another format.\n\nSupported conversions:\n\n- storage: view, export_view, styled_view, editor\n- editor: storage\n- view: none\n- export_view: none\n- styled_view: none\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nIf request specifies 'contentIdContext', 'View' permission for the space, and permission to view the content."
  },
  "response": [
    {
      "name": "Returned if the content is converted.",
      "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    \"value\": \"<string>\",\n    \"representation\": \"<string>\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/api/contentbody/convert/:to?expand=<string>&expand=<string>&spaceKeyContext=<string>&contentIdContext=<string>&embeddedContentRender=current",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "contentbody",
            "convert",
            ":to"
          ],
          "query": [
            {
              "key": "expand",
              "value": "<string>"
            },
            {
              "key": "expand",
              "value": "<string>"
            },
            {
              "key": "spaceKeyContext",
              "value": "<string>"
            },
            {
              "key": "contentIdContext",
              "value": "<string>"
            },
            {
              "key": "embeddedContentRender",
              "value": "current"
            }
          ],
          "variable": [
            {
              "key": "to"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"value\": \"eu dolor\",\n \"representation\": \"editor2\",\n \"_expandable\": {\n  \"content\": \"anim\"\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}"
    }
  ]
}