Back to Collection Items
Use ChilkatAx-win32.pkg
Procedure Test
Handle hoHttp
Boolean iSuccess
Variant vQueryParams
Handle hoQueryParams
Variant vResp
Handle hoResp
Variant vSbResponseBody
Handle hoSbResponseBody
Handle hoJResp
Integer iRespStatusCode
String sValue
String sAttachment
String sComment
String sPage
Integer iStart
Integer iLimit
Integer iSize
Integer iCommentStart
Integer iCommentLimit
Integer iCommentSize
Integer iPageStart
Integer iPageLimit
Integer iPageSize
Integer i
Integer iCount_i
String sTemp1
Boolean bTemp1
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Get Create (RefClass(cComChilkatHttp)) To hoHttp
If (Not(IsComObjectCreated(hoHttp))) Begin
Send CreateComObject of hoHttp
End
Get Create (RefClass(cComChilkatJsonObject)) To hoQueryParams
If (Not(IsComObjectCreated(hoQueryParams))) Begin
Send CreateComObject of hoQueryParams
End
Get ComUpdateString Of hoQueryParams "expand" "<string>" To iSuccess
Get ComUpdateString Of hoQueryParams "expand" "<string>" To iSuccess
Get ComUpdateInt Of hoQueryParams "parentVersion" 0 To iSuccess
// Adds the "Authorization: Bearer <access_token>" header.
Set ComAuthToken Of hoHttp To "<access_token>"
Get pvComObject of hoQueryParams to vQueryParams
Get ComQuickRequestParams Of hoHttp "GET" "https://your-domain.atlassian.net/wiki/rest/api/content/:id/child" vQueryParams To vResp
If (IsComObject(vResp)) Begin
Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
Set pvComObject Of hoResp To vResp
End
Get ComLastMethodSuccess Of hoHttp To bTemp1
If (bTemp1 = False) Begin
Get ComLastErrorText Of hoHttp To sTemp1
Showln sTemp1
Procedure_Return
End
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
Send CreateComObject of hoSbResponseBody
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComGetBodySb Of hoResp vSbResponseBody To iSuccess
Get Create (RefClass(cComChilkatJsonObject)) To hoJResp
If (Not(IsComObjectCreated(hoJResp))) Begin
Send CreateComObject of hoJResp
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComLoadSb Of hoJResp vSbResponseBody To iSuccess
Set ComEmitCompact Of hoJResp To False
Showln "Response Body:"
Get ComEmit Of hoJResp To sTemp1
Showln sTemp1
Get ComStatusCode Of hoResp To iRespStatusCode
Showln "Response Status Code = " iRespStatusCode
If (iRespStatusCode >= 400) Begin
Showln "Response Header:"
Get ComHeader Of hoResp To sTemp1
Showln sTemp1
Showln "Failed."
Send Destroy of hoResp
Procedure_Return
End
Send Destroy of hoResp
// 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
Get ComStringOf Of hoJResp "_expandable.attachment" To sAttachment
Get ComStringOf Of hoJResp "_expandable.comment" To sComment
Get ComStringOf Of hoJResp "_expandable.page" To sPage
Get ComIntOf Of hoJResp "attachment.start" To iStart
Get ComIntOf Of hoJResp "attachment.limit" To iLimit
Get ComIntOf Of hoJResp "attachment.size" To iSize
Get ComIntOf Of hoJResp "comment.start" To iCommentStart
Get ComIntOf Of hoJResp "comment.limit" To iCommentLimit
Get ComIntOf Of hoJResp "comment.size" To iCommentSize
Get ComIntOf Of hoJResp "page.start" To iPageStart
Get ComIntOf Of hoJResp "page.limit" To iPageLimit
Get ComIntOf Of hoJResp "page.size" To iPageSize
Move 0 To i
Get ComSizeOfArray Of hoJResp "attachment.results" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Get ComStringOf Of hoJResp "attachment.results[i].value" To sValue
Move (i + 1) To i
Loop
Move 0 To i
Get ComSizeOfArray Of hoJResp "comment.results" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Get ComStringOf Of hoJResp "comment.results[i].value" To sValue
Move (i + 1) To i
Loop
Move 0 To i
Get ComSizeOfArray Of hoJResp "page.results" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Get ComStringOf Of hoJResp "page.results[i].value" To sValue
Move (i + 1) To i
Loop
End_Procedure
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": ""
}
]
}
