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 ChilkatHttp
Dim success As Long
Dim queryParams As New ChilkatJsonObject
success = queryParams.UpdateString("expand","<string>")
success = queryParams.UpdateString("expand","<string>")
success = queryParams.UpdateInt("start",0)
success = queryParams.UpdateInt("limit",100)
' Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = "<access_token>"
Dim resp As ChilkatHttpResponse
Set resp = http.QuickRequestParams("GET","https://your-domain.atlassian.net/wiki/rest/api/content/:id/restriction",queryParams)
If (http.LastMethodSuccess = 0) Then
Debug.Print http.LastErrorText
Exit Sub
End If
Dim sbResponseBody As New ChilkatStringBuilder
success = resp.GetBodySb(sbResponseBody)
Dim jResp As New ChilkatJsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = 0
Debug.Print "Response Body:"
Debug.Print jResp.Emit()
Dim respStatusCode As Long
respStatusCode = resp.StatusCode
Debug.Print "Response Status Code = " & respStatusCode
If (respStatusCode >= 400) Then
Debug.Print "Response Header:"
Debug.Print resp.Header
Debug.Print "Failed."
Exit Sub
End If
' Sample JSON response:
' (Sample code for parsing the JSON response is shown below)
' {
' "results": [
' {
' "operation": "copy",
' "_expandable": {
' "restrictions": "incididunt anim ut id nulla",
' "content": "cupidatat"
' },
' "_links": {},
' "restrictions": {
' "user": {
' "results": {
' "value": "<Error: Too many levels of nesting to fake this schema>"
' },
' "start": {
' "value": "<Error: Too many levels of nesting to fake this schema>"
' },
' "limit": {
' "value": "<Error: Too many levels of nesting to fake this schema>"
' },
' "size": {
' "value": "<Error: Too many levels of nesting to fake this schema>"
' }
' },
' "group": {
' "results": {
' "value": "<Error: Too many levels of nesting to fake this schema>"
' },
' "start": {
' "value": "<Error: Too many levels of nesting to fake this schema>"
' },
' "limit": {
' "value": "<Error: Too many levels of nesting to fake this schema>"
' },
' "size": {
' "value": "<Error: Too many levels of nesting to fake this schema>"
' }
' },
' "_expandable": {
' "user": "et laborum",
' "group": "qui consequat"
' }
' },
' "content": {
' "value": "<Circular reference to #/components/schemas/Content detected>"
' }
' },
' {
' "operation": "copy",
' "_expandable": {
' "restrictions": "ullamco velit Lorem",
' "content": "culpa esse sit anim aliqua"
' },
' "_links": {},
' "restrictions": {
' "user": {
' "results": {
' "value": "<Error: Too many levels of nesting to fake this schema>"
' },
' "start": {
' "value": "<Error: Too many levels of nesting to fake this schema>"
' },
' "limit": {
' "value": "<Error: Too many levels of nesting to fake this schema>"
' },
' "size": {
' "value": "<Error: Too many levels of nesting to fake this schema>"
' }
' },
' "group": {
' "results": {
' "value": "<Error: Too many levels of nesting to fake this schema>"
' },
' "start": {
' "value": "<Error: Too many levels of nesting to fake this schema>"
' },
' "limit": {
' "value": "<Error: Too many levels of nesting to fake this schema>"
' },
' "size": {
' "value": "<Error: Too many levels of nesting to fake this schema>"
' }
' },
' "_expandable": {
' "user": "ut",
' "group": "ad Ut"
' }
' },
' "content": {
' "value": "<Circular reference to #/components/schemas/Content detected>"
' }
' }
' ],
' "start": 8238998,
' "limit": -43753388,
' "size": -64805454,
' "restrictionsHash": "ut commodo",
' "_links": {}
' }
' Sample code for parsing the JSON response...
' Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Dim operation As String
Dim Restrictions As String
Dim Content As String
Dim Value As String
Dim StartValue As String
Dim LimitValue As String
Dim SizeValue As String
Dim ResultsValue As String
Dim User As String
Dim Group As String
Dim contentValue As String
Dim start As Long
start = jResp.IntOf("start")
Dim limit As Long
limit = jResp.IntOf("limit")
Dim size As Long
size = jResp.IntOf("size")
Dim restrictionsHash As String
restrictionsHash = jResp.StringOf("restrictionsHash")
Dim i As Long
i = 0
Dim count_i As Long
count_i = jResp.SizeOfArray("results")
Do While i < count_i
jResp.I = i
operation = jResp.StringOf("results[i].operation")
Restrictions = jResp.StringOf("results[i]._expandable.restrictions")
Content = jResp.StringOf("results[i]._expandable.content")
Value = jResp.StringOf("results[i].restrictions.user.results.value")
StartValue = jResp.StringOf("results[i].restrictions.user.start.value")
LimitValue = jResp.StringOf("results[i].restrictions.user.limit.value")
SizeValue = jResp.StringOf("results[i].restrictions.user.size.value")
ResultsValue = jResp.StringOf("results[i].restrictions.group.results.value")
StartValue = jResp.StringOf("results[i].restrictions.group.start.value")
LimitValue = jResp.StringOf("results[i].restrictions.group.limit.value")
SizeValue = jResp.StringOf("results[i].restrictions.group.size.value")
User = jResp.StringOf("results[i].restrictions._expandable.user")
Group = jResp.StringOf("results[i].restrictions._expandable.group")
contentValue = jResp.StringOf("results[i].content.value")
i = i + 1
Loop
Curl Command
curl -G -d "expand=%3Cstring%3E"
-d "expand=%3Cstring%3E"
-d "start=0"
-d "limit=100"
-H "Authorization: Bearer <access_token>"
https://your-domain.atlassian.net/wiki/rest/api/content/:id/restriction
Postman Collection Item JSON
{
"name": "Get restrictions",
"request": {
"auth": {
"type": "oauth2"
},
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/api/content/:id/restriction?expand=<string>&expand=<string>&start=0&limit=100",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"content",
":id",
"restriction"
],
"query": [
{
"key": "expand",
"value": "<string>",
"description": "A multi-value parameter indicating which properties of the content\nrestrictions to expand. By default, the following objects are expanded:\n`restrictions.user`, `restrictions.group`.\n\n- `restrictions.user` returns the piece of content that the restrictions are\napplied to.\n- `restrictions.group` returns the piece of content that the restrictions are\napplied to.\n- `content` returns the piece of content that the restrictions are\napplied to."
},
{
"key": "expand",
"value": "<string>",
"description": "A multi-value parameter indicating which properties of the content\nrestrictions to expand. By default, the following objects are expanded:\n`restrictions.user`, `restrictions.group`.\n\n- `restrictions.user` returns the piece of content that the restrictions are\napplied to.\n- `restrictions.group` returns the piece of content that the restrictions are\napplied to.\n- `content` returns the piece of content that the restrictions are\napplied to."
},
{
"key": "start",
"value": "0",
"description": "The starting index of the users and groups in the returned restrictions."
},
{
"key": "limit",
"value": "100",
"description": "The maximum number of users and the maximum number of groups, in the\nreturned restrictions, to return per page. Note, this may be restricted\nby fixed system limits."
}
],
"variable": [
{
"key": "id",
"value": "<string>",
"type": "string",
"description": "(Required) The ID of the content to be queried for its restrictions."
}
]
},
"description": "Returns the restrictions on a piece of content.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to view the content."
},
"response": [
{
"name": "Returned if the requested restrictions 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/restriction?expand=<string>&expand=<string>&start=0&limit=100",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"content",
":id",
"restriction"
],
"query": [
{
"key": "expand",
"value": "<string>"
},
{
"key": "expand",
"value": "<string>"
},
{
"key": "start",
"value": "0"
},
{
"key": "limit",
"value": "100"
}
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"results\": [\n {\n \"operation\": \"copy\",\n \"_expandable\": {\n \"restrictions\": \"incididunt anim ut id nulla\",\n \"content\": \"cupidatat\"\n },\n \"_links\": {},\n \"restrictions\": {\n \"user\": {\n \"results\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"start\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"limit\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"size\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n \"group\": {\n \"results\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"start\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"limit\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"size\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n \"_expandable\": {\n \"user\": \"et laborum\",\n \"group\": \"qui consequat\"\n }\n },\n \"content\": {\n \"value\": \"<Circular reference to #/components/schemas/Content detected>\"\n }\n },\n {\n \"operation\": \"copy\",\n \"_expandable\": {\n \"restrictions\": \"ullamco velit Lorem\",\n \"content\": \"culpa esse sit anim aliqua\"\n },\n \"_links\": {},\n \"restrictions\": {\n \"user\": {\n \"results\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"start\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"limit\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"size\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n \"group\": {\n \"results\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"start\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"limit\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"size\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n \"_expandable\": {\n \"user\": \"ut\",\n \"group\": \"ad Ut\"\n }\n },\n \"content\": {\n \"value\": \"<Circular reference to #/components/schemas/Content detected>\"\n }\n }\n ],\n \"start\": 8238998,\n \"limit\": -43753388,\n \"size\": -64805454,\n \"restrictionsHash\": \"ut commodo\",\n \"_links\": {}\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/restriction?expand=<string>&expand=<string>&start=0&limit=100",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"content",
":id",
"restriction"
],
"query": [
{
"key": "expand",
"value": "<string>"
},
{
"key": "expand",
"value": "<string>"
},
{
"key": "start",
"value": "0"
},
{
"key": "limit",
"value": "100"
}
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}
