Back to Collection Items
#include <CkHttp.h>
#include <CkJsonObject.h>
#include <CkHttpResponse.h>
#include <CkStringBuilder.h>
void ChilkatSample(void)
{
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
CkHttp http;
bool success;
CkJsonObject queryParams;
queryParams.UpdateString("expand","<string>");
queryParams.UpdateString("expand","<string>");
// Adds the "Authorization: Bearer <access_token>" header.
http.put_AuthToken("<access_token>");
CkHttpResponse *resp = http.QuickRequestParams("GET","https://your-domain.atlassian.net/wiki/rest/api/content/:id/descendant",queryParams);
if (http.get_LastMethodSuccess() == false) {
std::cout << http.lastErrorText() << "\r\n";
return;
}
CkStringBuilder sbResponseBody;
resp->GetBodySb(sbResponseBody);
CkJsonObject jResp;
jResp.LoadSb(sbResponseBody);
jResp.put_EmitCompact(false);
std::cout << "Response Body:" << "\r\n";
std::cout << jResp.emit() << "\r\n";
int respStatusCode = resp->get_StatusCode();
std::cout << "Response Status Code = " << respStatusCode << "\r\n";
if (respStatusCode >= 400) {
std::cout << "Response Header:" << "\r\n";
std::cout << resp->header() << "\r\n";
std::cout << "Failed." << "\r\n";
delete resp;
return;
}
delete 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.
const char *value = 0;
const char *Attachment = jResp.stringOf("_expandable.attachment");
const char *Comment = jResp.stringOf("_expandable.comment");
const char *Page = jResp.stringOf("_expandable.page");
int Start = jResp.IntOf("attachment.start");
int Limit = jResp.IntOf("attachment.limit");
int Size = jResp.IntOf("attachment.size");
int commentStart = jResp.IntOf("comment.start");
int commentLimit = jResp.IntOf("comment.limit");
int commentSize = jResp.IntOf("comment.size");
int pageStart = jResp.IntOf("page.start");
int pageLimit = jResp.IntOf("page.limit");
int pageSize = jResp.IntOf("page.size");
int i = 0;
int count_i = jResp.SizeOfArray("attachment.results");
while (i < count_i) {
jResp.put_I(i);
value = jResp.stringOf("attachment.results[i].value");
i = i + 1;
}
i = 0;
count_i = jResp.SizeOfArray("comment.results");
while (i < count_i) {
jResp.put_I(i);
value = jResp.stringOf("comment.results[i].value");
i = i + 1;
}
i = 0;
count_i = jResp.SizeOfArray("page.results");
while (i < count_i) {
jResp.put_I(i);
value = jResp.stringOf("page.results[i].value");
i = i + 1;
}
}
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": ""
}
]
}
