Chilkat Online Tools

Xojo / Atlassian Confluence Cloud / Get content children

Back to Collection Items

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

Dim http As New Chilkat.Http
Dim success As Boolean

Dim queryParams As New Chilkat.JsonObject
success = queryParams.UpdateString("expand","<string>")
success = queryParams.UpdateString("expand","<string>")
success = queryParams.UpdateInt("parentVersion",0)

// Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = "<access_token>"

Dim resp As Chilkat.HttpResponse
resp = http.QuickRequestParams("GET","https://your-domain.atlassian.net/wiki/rest/api/content/:id/child",queryParams)
If (http.LastMethodSuccess = False) Then
    System.DebugLog(http.LastErrorText)
    Return
End If

Dim sbResponseBody As New Chilkat.StringBuilder
success = resp.GetBodySb(sbResponseBody)

Dim jResp As New Chilkat.JsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False

System.DebugLog("Response Body:")
System.DebugLog(jResp.Emit())

Dim respStatusCode As Int32
respStatusCode = resp.StatusCode
System.DebugLog("Response Status Code = " + Str(respStatusCode))
If (respStatusCode >= 400) Then
    System.DebugLog("Response Header:")
    System.DebugLog(resp.Header)
    System.DebugLog("Failed.")

    Return
End If

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

Dim value As String

Dim Attachment As String
Attachment = jResp.StringOf("_expandable.attachment")
Dim Comment As String
Comment = jResp.StringOf("_expandable.comment")
Dim Page As String
Page = jResp.StringOf("_expandable.page")
Dim Start As Int32
Start = jResp.IntOf("attachment.start")
Dim Limit As Int32
Limit = jResp.IntOf("attachment.limit")
Dim Size As Int32
Size = jResp.IntOf("attachment.size")
Dim commentStart As Int32
commentStart = jResp.IntOf("comment.start")
Dim commentLimit As Int32
commentLimit = jResp.IntOf("comment.limit")
Dim commentSize As Int32
commentSize = jResp.IntOf("comment.size")
Dim pageStart As Int32
pageStart = jResp.IntOf("page.start")
Dim pageLimit As Int32
pageLimit = jResp.IntOf("page.limit")
Dim pageSize As Int32
pageSize = jResp.IntOf("page.size")
Dim i As Int32
i = 0
Dim count_i As Int32
count_i = jResp.SizeOfArray("attachment.results")
While i < count_i
    jResp.I = i
    value = jResp.StringOf("attachment.results[i].value")
    i = i + 1
Wend
i = 0
count_i = jResp.SizeOfArray("comment.results")
While i < count_i
    jResp.I = i
    value = jResp.StringOf("comment.results[i].value")
    i = i + 1
Wend
i = 0
count_i = jResp.SizeOfArray("page.results")
While i < count_i
    jResp.I = i
    value = jResp.StringOf("page.results[i].value")
    i = i + 1
Wend

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