Chilkat Online Tools

TCL / Atlassian Confluence Cloud / Get content children

Back to Collection Items

load ./chilkat.dll

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

set http [new_CkHttp]

set queryParams [new_CkJsonObject]

CkJsonObject_UpdateString $queryParams "expand" "<string>"
CkJsonObject_UpdateString $queryParams "expand" "<string>"
CkJsonObject_UpdateInt $queryParams "parentVersion" 0

# Adds the "Authorization: Bearer <access_token>" header.
CkHttp_put_AuthToken $http "<access_token>"

# resp is a CkHttpResponse
set resp [CkHttp_QuickRequestParams $http "GET" "https://your-domain.atlassian.net/wiki/rest/api/content/:id/child" $queryParams]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkJsonObject $queryParams
    exit
}

set sbResponseBody [new_CkStringBuilder]

CkHttpResponse_GetBodySb $resp $sbResponseBody

set jResp [new_CkJsonObject]

CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0

puts "Response Body:"
puts [CkJsonObject_emit $jResp]

set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
    puts "Response Header:"
    puts [CkHttpResponse_header $resp]
    puts "Failed."
    delete_CkHttpResponse $resp

    delete_CkHttp $http
    delete_CkJsonObject $queryParams
    delete_CkStringBuilder $sbResponseBody
    delete_CkJsonObject $jResp
    exit
}

delete_CkHttpResponse $resp

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

# {
#   "_expandable": {
#     "attachment": "in ut",
#     "comment": "dolor",
#     "page": "eu exercitation"
#   },
#   "_links": {},
#   "attachment": {
#     "results": [
#       {
#         "value": "<Circular reference to #/components/schemas/Content detected>"
#       },
#       {
#         "value": "<Circular reference to #/components/schemas/Content detected>"
#       }
#     ],
#     "start": -75729038,
#     "limit": 34726306,
#     "size": 18934279,
#     "_links": {}
#   },
#   "comment": {
#     "results": [
#       {
#         "value": "<Circular reference to #/components/schemas/Content detected>"
#       },
#       {
#         "value": "<Circular reference to #/components/schemas/Content detected>"
#       }
#     ],
#     "start": 37994470,
#     "limit": 2587712,
#     "size": -24049554,
#     "_links": {}
#   },
#   "page": {
#     "results": [
#       {
#         "value": "<Circular reference to #/components/schemas/Content detected>"
#       },
#       {
#         "value": "<Circular reference to #/components/schemas/Content detected>"
#       }
#     ],
#     "start": 66843073,
#     "limit": 57682154,
#     "size": -4004438,
#     "_links": {}
#   }
# }

# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

set Attachment [CkJsonObject_stringOf $jResp "_expandable.attachment"]
set Comment [CkJsonObject_stringOf $jResp "_expandable.comment"]
set Page [CkJsonObject_stringOf $jResp "_expandable.page"]
set Start [CkJsonObject_IntOf $jResp "attachment.start"]
set Limit [CkJsonObject_IntOf $jResp "attachment.limit"]
set Size [CkJsonObject_IntOf $jResp "attachment.size"]
set commentStart [CkJsonObject_IntOf $jResp "comment.start"]
set commentLimit [CkJsonObject_IntOf $jResp "comment.limit"]
set commentSize [CkJsonObject_IntOf $jResp "comment.size"]
set pageStart [CkJsonObject_IntOf $jResp "page.start"]
set pageLimit [CkJsonObject_IntOf $jResp "page.limit"]
set pageSize [CkJsonObject_IntOf $jResp "page.size"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "attachment.results"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set value [CkJsonObject_stringOf $jResp "attachment.results[i].value"]
    set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "comment.results"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set value [CkJsonObject_stringOf $jResp "comment.results[i].value"]
    set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "page.results"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set value [CkJsonObject_stringOf $jResp "page.results[i].value"]
    set i [expr $i + 1]
}

delete_CkHttp $http
delete_CkJsonObject $queryParams
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp

Curl Command

curl -G -d "expand=%3Cstring%3E"
	-d "expand=%3Cstring%3E"
	-d "parentVersion=0"
	-H "Authorization: Bearer <access_token>"
https://your-domain.atlassian.net/wiki/rest/api/content/:id/child

Postman Collection Item JSON

{
  "name": "Get content children",
  "request": {
    "auth": {
      "type": "oauth2"
    },
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{baseUrl}}/api/content/:id/child?expand=<string>&expand=<string>&parentVersion=0",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "content",
        ":id",
        "child"
      ],
      "query": [
        {
          "key": "expand",
          "value": "<string>",
          "description": "A multi-value parameter indicating which properties of the children to expand, where:\n\n- `attachment` returns all attachments for the content.\n- `comments` returns all comments for the content.\n- `page` returns all child pages of the content."
        },
        {
          "key": "expand",
          "value": "<string>",
          "description": "A multi-value parameter indicating which properties of the children to expand, where:\n\n- `attachment` returns all attachments for the content.\n- `comments` returns all comments for the content.\n- `page` returns all child pages of the content."
        },
        {
          "key": "parentVersion",
          "value": "0",
          "description": "The version of the parent content to retrieve children for.\nCurrently, this only works for the latest version."
        }
      ],
      "variable": [
        {
          "key": "id",
          "value": "<string>",
          "type": "string",
          "description": "(Required) The ID of the content to be queried for its children."
        }
      ]
    },
    "description": "Returns a map of the direct children of a piece of content. A piece of content\nhas different types of child content, depending on its type. These are\nthe default parent-child content type relationships:\n\n- `page`: child content is `page`, `comment`, `attachment`\n- `blogpost`: child content is `comment`, `attachment`\n- `attachment`: child content is `comment`\n- `comment`: child content is `attachment`\n\nApps can override these default relationships. Apps can also introduce\nnew content types that create new parent-child content relationships.\n\nNote, the map will always include all child content types that are valid\nfor the content. However, if the content has no instances of a child content\ntype, the map will contain an empty array for that child content type.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View' permission for the space,\nand permission to view the content if it is a page."
  },
  "response": [
    {
      "name": "Returned if the requested content children 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/content/:id/child?expand=<string>&expand=<string>&parentVersion=0",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "content",
            ":id",
            "child"
          ],
          "query": [
            {
              "key": "expand",
              "value": "<string>"
            },
            {
              "key": "expand",
              "value": "<string>"
            },
            {
              "key": "parentVersion",
              "value": "0"
            }
          ],
          "variable": [
            {
              "key": "id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"_expandable\": {\n  \"attachment\": \"in ut\",\n  \"comment\": \"dolor\",\n  \"page\": \"eu exercitation\"\n },\n \"_links\": {},\n \"attachment\": {\n  \"results\": [\n   {\n    \"value\": \"<Circular reference to #/components/schemas/Content detected>\"\n   },\n   {\n    \"value\": \"<Circular reference to #/components/schemas/Content detected>\"\n   }\n  ],\n  \"start\": -75729038,\n  \"limit\": 34726306,\n  \"size\": 18934279,\n  \"_links\": {}\n },\n \"comment\": {\n  \"results\": [\n   {\n    \"value\": \"<Circular reference to #/components/schemas/Content detected>\"\n   },\n   {\n    \"value\": \"<Circular reference to #/components/schemas/Content detected>\"\n   }\n  ],\n  \"start\": 37994470,\n  \"limit\": 2587712,\n  \"size\": -24049554,\n  \"_links\": {}\n },\n \"page\": {\n  \"results\": [\n   {\n    \"value\": \"<Circular reference to #/components/schemas/Content detected>\"\n   },\n   {\n    \"value\": \"<Circular reference to #/components/schemas/Content detected>\"\n   }\n  ],\n  \"start\": 66843073,\n  \"limit\": 57682154,\n  \"size\": -4004438,\n  \"_links\": {}\n }\n}"
    },
    {
      "name": "Returned if;\n\n- There is no content with the given ID.\n- The calling user does not have permission to view the content.",
      "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/content/:id/child?expand=<string>&expand=<string>&parentVersion=0",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "content",
            ":id",
            "child"
          ],
          "query": [
            {
              "key": "expand",
              "value": "<string>"
            },
            {
              "key": "expand",
              "value": "<string>"
            },
            {
              "key": "parentVersion",
              "value": "0"
            }
          ],
          "variable": [
            {
              "key": "id"
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}