Chilkat Online Tools

unicodeC / Atlassian Confluence Cloud / Get content descendants

Back to Collection Items

#include <C_CkHttpW.h>
#include <C_CkJsonObjectW.h>
#include <C_CkHttpResponseW.h>
#include <C_CkStringBuilderW.h>

void ChilkatSample(void)
    {
    HCkHttpW http;
    BOOL success;
    HCkJsonObjectW queryParams;
    HCkHttpResponseW resp;
    HCkStringBuilderW sbResponseBody;
    HCkJsonObjectW jResp;
    int respStatusCode;
    const wchar_t *value;
    const wchar_t *Attachment;
    const wchar_t *Comment;
    const wchar_t *Page;
    int Start;
    int Limit;
    int Size;
    int commentStart;
    int commentLimit;
    int commentSize;
    int pageStart;
    int pageLimit;
    int pageSize;
    int i;
    int count_i;

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

    http = CkHttpW_Create();

    queryParams = CkJsonObjectW_Create();
    CkJsonObjectW_UpdateString(queryParams,L"expand",L"<string>");
    CkJsonObjectW_UpdateString(queryParams,L"expand",L"<string>");

    // Adds the "Authorization: Bearer <access_token>" header.
    CkHttpW_putAuthToken(http,L"<access_token>");

    resp = CkHttpW_QuickRequestParams(http,L"GET",L"https://your-domain.atlassian.net/wiki/rest/api/content/:id/descendant",queryParams);
    if (CkHttpW_getLastMethodSuccess(http) == FALSE) {
        wprintf(L"%s\n",CkHttpW_lastErrorText(http));
        CkHttpW_Dispose(http);
        CkJsonObjectW_Dispose(queryParams);
        return;
    }

    sbResponseBody = CkStringBuilderW_Create();
    CkHttpResponseW_GetBodySb(resp,sbResponseBody);

    jResp = CkJsonObjectW_Create();
    CkJsonObjectW_LoadSb(jResp,sbResponseBody);
    CkJsonObjectW_putEmitCompact(jResp,FALSE);

    wprintf(L"Response Body:\n");
    wprintf(L"%s\n",CkJsonObjectW_emit(jResp));

    respStatusCode = CkHttpResponseW_getStatusCode(resp);
    wprintf(L"Response Status Code = %d\n",respStatusCode);
    if (respStatusCode >= 400) {
        wprintf(L"Response Header:\n");
        wprintf(L"%s\n",CkHttpResponseW_header(resp));
        wprintf(L"Failed.\n");
        CkHttpResponseW_Dispose(resp);
        CkHttpW_Dispose(http);
        CkJsonObjectW_Dispose(queryParams);
        CkStringBuilderW_Dispose(sbResponseBody);
        CkJsonObjectW_Dispose(jResp);
        return;
    }

    CkHttpResponseW_Dispose(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

    // Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.

    Attachment = CkJsonObjectW_stringOf(jResp,L"_expandable.attachment");
    Comment = CkJsonObjectW_stringOf(jResp,L"_expandable.comment");
    Page = CkJsonObjectW_stringOf(jResp,L"_expandable.page");
    Start = CkJsonObjectW_IntOf(jResp,L"attachment.start");
    Limit = CkJsonObjectW_IntOf(jResp,L"attachment.limit");
    Size = CkJsonObjectW_IntOf(jResp,L"attachment.size");
    commentStart = CkJsonObjectW_IntOf(jResp,L"comment.start");
    commentLimit = CkJsonObjectW_IntOf(jResp,L"comment.limit");
    commentSize = CkJsonObjectW_IntOf(jResp,L"comment.size");
    pageStart = CkJsonObjectW_IntOf(jResp,L"page.start");
    pageLimit = CkJsonObjectW_IntOf(jResp,L"page.limit");
    pageSize = CkJsonObjectW_IntOf(jResp,L"page.size");
    i = 0;
    count_i = CkJsonObjectW_SizeOfArray(jResp,L"attachment.results");
    while (i < count_i) {
        CkJsonObjectW_putI(jResp,i);
        value = CkJsonObjectW_stringOf(jResp,L"attachment.results[i].value");
        i = i + 1;
    }

    i = 0;
    count_i = CkJsonObjectW_SizeOfArray(jResp,L"comment.results");
    while (i < count_i) {
        CkJsonObjectW_putI(jResp,i);
        value = CkJsonObjectW_stringOf(jResp,L"comment.results[i].value");
        i = i + 1;
    }

    i = 0;
    count_i = CkJsonObjectW_SizeOfArray(jResp,L"page.results");
    while (i < count_i) {
        CkJsonObjectW_putI(jResp,i);
        value = CkJsonObjectW_stringOf(jResp,L"page.results[i].value");
        i = i + 1;
    }



    CkHttpW_Dispose(http);
    CkJsonObjectW_Dispose(queryParams);
    CkStringBuilderW_Dispose(sbResponseBody);
    CkJsonObjectW_Dispose(jResp);

    }

Curl Command

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

Postman Collection Item JSON

{
  "name": "Get content descendants",
  "request": {
    "auth": {
      "type": "oauth2"
    },
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{baseUrl}}/api/content/:id/descendant?expand=<string>&expand=<string>",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "content",
        ":id",
        "descendant"
      ],
      "query": [
        {
          "key": "expand",
          "value": "<string>",
          "description": "A multi-value parameter indicating which properties of the children to\nexpand, 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\nexpand, 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."
        }
      ],
      "variable": [
        {
          "key": "id",
          "value": "<string>",
          "type": "string",
          "description": "(Required) The ID of the content to be queried for its descendants."
        }
      ]
    },
    "description": "Returns a map of the descendants of a piece of content. This is similar\nto [Get content children](#api-content-id-child-get), except that this\nmethod returns child pages at all levels, rather than just the direct\nchild pages.\n\nA piece of content has different types of descendants, depending on its type:\n\n- `page`: descendant is `page`, `comment`, `attachment`\n- `blogpost`: descendant is `comment`, `attachment`\n- `attachment`: descendant is `comment`\n- `comment`: descendant is `attachment`\n\nThe map will always include all descendant types that are valid for the content.\nHowever, if the content has no instances of a descendant type, the map will\ncontain an empty array for that descendant type.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\n'View' permission for the space, and permission to view the content if it\nis a page."
  },
  "response": [
    {
      "name": "Returned if the requested descendants 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/descendant?expand=<string>&expand=<string>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "content",
            ":id",
            "descendant"
          ],
          "query": [
            {
              "key": "expand",
              "value": "<string>"
            },
            {
              "key": "expand",
              "value": "<string>"
            }
          ],
          "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/descendant?expand=<string>&expand=<string>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "content",
            ":id",
            "descendant"
          ],
          "query": [
            {
              "key": "expand",
              "value": "<string>"
            },
            {
              "key": "expand",
              "value": "<string>"
            }
          ],
          "variable": [
            {
              "key": "id"
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}