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
' Use this online tool to generate code from sample JSON: Generate Code to Create JSON
' The following JSON is sent in the request body.
' [
' {
' "operation": "<string>",
' "restrictions": {
' "user": [
' {
' "type": "<string>",
' "accountId": "<string>",
' "username": "<string>",
' "userKey": "<string>"
' },
' {
' "type": "<string>",
' "accountId": "<string>",
' "username": "<string>",
' "userKey": "<string>"
' }
' ],
' "group": [
' {
' "type": "<string>",
' "name": "<string>"
' },
' {
' "type": "<string>",
' "name": "<string>"
' }
' ]
' }
' },
' {
' "operation": "<string>",
' "restrictions": {
' "user": [
' {
' "type": "<string>",
' "accountId": "<string>",
' "username": "<string>",
' "userKey": "<string>"
' },
' {
' "type": "<string>",
' "accountId": "<string>",
' "username": "<string>",
' "userKey": "<string>"
' }
' ],
' "group": [
' {
' "type": "<string>",
' "name": "<string>"
' },
' {
' "type": "<string>",
' "name": "<string>"
' }
' ]
' }
' }
' ]
Dim jarr As New ChilkatJsonArray
success = jarr.AddObjectAt(-1)
Dim jsonObj_1 As ChilkatJsonObject
Set jsonObj_1 = jarr.ObjectAt(jarr.Size - 1)
success = jsonObj_1.UpdateString("operation","<string>")
success = jsonObj_1.UpdateString("restrictions.user[0].type","<string>")
success = jsonObj_1.UpdateString("restrictions.user[0].accountId","<string>")
success = jsonObj_1.UpdateString("restrictions.user[0].username","<string>")
success = jsonObj_1.UpdateString("restrictions.user[0].userKey","<string>")
success = jsonObj_1.UpdateString("restrictions.user[1].type","<string>")
success = jsonObj_1.UpdateString("restrictions.user[1].accountId","<string>")
success = jsonObj_1.UpdateString("restrictions.user[1].username","<string>")
success = jsonObj_1.UpdateString("restrictions.user[1].userKey","<string>")
success = jsonObj_1.UpdateString("restrictions.group[0].type","<string>")
success = jsonObj_1.UpdateString("restrictions.group[0].name","<string>")
success = jsonObj_1.UpdateString("restrictions.group[1].type","<string>")
success = jsonObj_1.UpdateString("restrictions.group[1].name","<string>")
success = jarr.AddObjectAt(-1)
Set jsonObj_1 = jarr.ObjectAt(jarr.Size - 1)
success = jsonObj_1.UpdateString("operation","<string>")
success = jsonObj_1.UpdateString("restrictions.user[0].type","<string>")
success = jsonObj_1.UpdateString("restrictions.user[0].accountId","<string>")
success = jsonObj_1.UpdateString("restrictions.user[0].username","<string>")
success = jsonObj_1.UpdateString("restrictions.user[0].userKey","<string>")
success = jsonObj_1.UpdateString("restrictions.user[1].type","<string>")
success = jsonObj_1.UpdateString("restrictions.user[1].accountId","<string>")
success = jsonObj_1.UpdateString("restrictions.user[1].username","<string>")
success = jsonObj_1.UpdateString("restrictions.user[1].userKey","<string>")
success = jsonObj_1.UpdateString("restrictions.group[0].type","<string>")
success = jsonObj_1.UpdateString("restrictions.group[0].name","<string>")
success = jsonObj_1.UpdateString("restrictions.group[1].type","<string>")
success = jsonObj_1.UpdateString("restrictions.group[1].name","<string>")
' Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = "<access_token>"
http.SetRequestHeader "Content-Type","application/json"
Dim sbRequestBody As New ChilkatStringBuilder
success = jarr.EmitSb(sbRequestBody)
Dim resp As ChilkatHttpResponse
Set resp = http.PTextSb("PUT","https://your-domain.atlassian.net/wiki/rest/api/content/:id/restriction?expand=<string>&expand=<string>",sbRequestBody,"utf-8","application/json",0,0)
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": "purge",
' "_expandable": {
' "restrictions": "Excepteur dolore Ut labore",
' "content": "tempor esse officia"
' },
' "_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": "in in mollit Ut occaecat",
' "group": "irure qui consectetur incididunt"
' }
' },
' "content": {
' "value": "<Circular reference to #/components/schemas/Content detected>"
' }
' },
' {
' "operation": "delete",
' "_expandable": {
' "restrictions": "nisi id",
' "content": "ut in mollit enim"
' },
' "_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": "est voluptate",
' "group": "in"
' }
' },
' "content": {
' "value": "<Circular reference to #/components/schemas/Content detected>"
' }
' }
' ],
' "start": 17789838,
' "limit": 13313455,
' "size": -47874490,
' "restrictionsHash": "Lorem commodo pariatur Ut eiusmod",
' "_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 -X PUT
-H "Authorization: Bearer <access_token>"
-H "Content-Type: application/json"
-d '[
{
"operation": "<string>",
"restrictions": {
"user": [
{
"type": "<string>",
"accountId": "<string>",
"username": "<string>",
"userKey": "<string>"
},
{
"type": "<string>",
"accountId": "<string>",
"username": "<string>",
"userKey": "<string>"
}
],
"group": [
{
"type": "<string>",
"name": "<string>"
},
{
"type": "<string>",
"name": "<string>"
}
]
}
},
{
"operation": "<string>",
"restrictions": {
"user": [
{
"type": "<string>",
"accountId": "<string>",
"username": "<string>",
"userKey": "<string>"
},
{
"type": "<string>",
"accountId": "<string>",
"username": "<string>",
"userKey": "<string>"
}
],
"group": [
{
"type": "<string>",
"name": "<string>"
},
{
"type": "<string>",
"name": "<string>"
}
]
}
}
]'
https://your-domain.atlassian.net/wiki/rest/api/content/:id/restriction?expand=<string>&expand=<string>
Postman Collection Item JSON
{
"name": "Update restrictions",
"request": {
"auth": {
"type": "oauth2"
},
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "[\n {\n \"operation\": \"<string>\",\n \"restrictions\": {\n \"user\": [\n {\n \"type\": \"<string>\",\n \"accountId\": \"<string>\",\n \"username\": \"<string>\",\n \"userKey\": \"<string>\"\n },\n {\n \"type\": \"<string>\",\n \"accountId\": \"<string>\",\n \"username\": \"<string>\",\n \"userKey\": \"<string>\"\n }\n ],\n \"group\": [\n {\n \"type\": \"<string>\",\n \"name\": \"<string>\"\n },\n {\n \"type\": \"<string>\",\n \"name\": \"<string>\"\n }\n ]\n }\n },\n {\n \"operation\": \"<string>\",\n \"restrictions\": {\n \"user\": [\n {\n \"type\": \"<string>\",\n \"accountId\": \"<string>\",\n \"username\": \"<string>\",\n \"userKey\": \"<string>\"\n },\n {\n \"type\": \"<string>\",\n \"accountId\": \"<string>\",\n \"username\": \"<string>\",\n \"userKey\": \"<string>\"\n }\n ],\n \"group\": [\n {\n \"type\": \"<string>\",\n \"name\": \"<string>\"\n },\n {\n \"type\": \"<string>\",\n \"name\": \"<string>\"\n }\n ]\n }\n }\n]"
},
"url": {
"raw": "{{baseUrl}}/api/content/:id/restriction?expand=<string>&expand=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"content",
":id",
"restriction"
],
"query": [
{
"key": "expand",
"value": "<string>",
"description": "A multi-value parameter indicating which properties of the content\nrestrictions (returned in response) to expand.\n\n- `restrictions.user` returns the piece of content that the restrictions are\napplied to. Expanded by default.\n- `restrictions.group` returns the piece of content that the restrictions are\napplied to. Expanded by default.\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 (returned in response) to expand.\n\n- `restrictions.user` returns the piece of content that the restrictions are\napplied to. Expanded by default.\n- `restrictions.group` returns the piece of content that the restrictions are\napplied to. Expanded by default.\n- `content` returns the piece of content that the restrictions are\napplied to."
}
],
"variable": [
{
"key": "id",
"value": "<string>",
"type": "string",
"description": "(Required) The ID of the content to update restrictions for."
}
]
},
"description": "Updates restrictions for a piece of content. This removes the existing\nrestrictions and replaces them with the restrictions in the request.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to edit the content."
},
"response": [
{
"name": "Returned if the requested restrictions are updated.",
"originalRequest": {
"method": "PUT",
"header": [
{
"description": {
"content": "Added as a part of security scheme: oauth2",
"type": "text/plain"
},
"key": "Authorization",
"value": "<token>"
}
],
"body": {
"mode": "raw",
"raw": "[\n {\n \"operation\": \"<string>\",\n \"restrictions\": {\n \"user\": [\n {\n \"type\": \"<string>\",\n \"accountId\": \"<string>\",\n \"username\": \"<string>\",\n \"userKey\": \"<string>\"\n },\n {\n \"type\": \"<string>\",\n \"accountId\": \"<string>\",\n \"username\": \"<string>\",\n \"userKey\": \"<string>\"\n }\n ],\n \"group\": [\n {\n \"type\": \"<string>\",\n \"name\": \"<string>\"\n },\n {\n \"type\": \"<string>\",\n \"name\": \"<string>\"\n }\n ]\n }\n },\n {\n \"operation\": \"<string>\",\n \"restrictions\": {\n \"user\": [\n {\n \"type\": \"<string>\",\n \"accountId\": \"<string>\",\n \"username\": \"<string>\",\n \"userKey\": \"<string>\"\n },\n {\n \"type\": \"<string>\",\n \"accountId\": \"<string>\",\n \"username\": \"<string>\",\n \"userKey\": \"<string>\"\n }\n ],\n \"group\": [\n {\n \"type\": \"<string>\",\n \"name\": \"<string>\"\n },\n {\n \"type\": \"<string>\",\n \"name\": \"<string>\"\n }\n ]\n }\n }\n]"
},
"url": {
"raw": "{{baseUrl}}/api/content/:id/restriction?expand=<string>&expand=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"content",
":id",
"restriction"
],
"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 \"results\": [\n {\n \"operation\": \"purge\",\n \"_expandable\": {\n \"restrictions\": \"Excepteur dolore Ut labore\",\n \"content\": \"tempor esse officia\"\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\": \"in in mollit Ut occaecat\",\n \"group\": \"irure qui consectetur incididunt\"\n }\n },\n \"content\": {\n \"value\": \"<Circular reference to #/components/schemas/Content detected>\"\n }\n },\n {\n \"operation\": \"delete\",\n \"_expandable\": {\n \"restrictions\": \"nisi id\",\n \"content\": \"ut in mollit enim\"\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\": \"est voluptate\",\n \"group\": \"in\"\n }\n },\n \"content\": {\n \"value\": \"<Circular reference to #/components/schemas/Content detected>\"\n }\n }\n ],\n \"start\": 17789838,\n \"limit\": 13313455,\n \"size\": -47874490,\n \"restrictionsHash\": \"Lorem commodo pariatur Ut eiusmod\",\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 update restrictions\nfor the content.",
"originalRequest": {
"method": "PUT",
"header": [
{
"description": {
"content": "Added as a part of security scheme: oauth2",
"type": "text/plain"
},
"key": "Authorization",
"value": "<token>"
}
],
"body": {
"mode": "raw",
"raw": "[\n {\n \"operation\": \"<string>\",\n \"restrictions\": {\n \"user\": [\n {\n \"type\": \"<string>\",\n \"accountId\": \"<string>\",\n \"username\": \"<string>\",\n \"userKey\": \"<string>\"\n },\n {\n \"type\": \"<string>\",\n \"accountId\": \"<string>\",\n \"username\": \"<string>\",\n \"userKey\": \"<string>\"\n }\n ],\n \"group\": [\n {\n \"type\": \"<string>\",\n \"name\": \"<string>\"\n },\n {\n \"type\": \"<string>\",\n \"name\": \"<string>\"\n }\n ]\n }\n },\n {\n \"operation\": \"<string>\",\n \"restrictions\": {\n \"user\": [\n {\n \"type\": \"<string>\",\n \"accountId\": \"<string>\",\n \"username\": \"<string>\",\n \"userKey\": \"<string>\"\n },\n {\n \"type\": \"<string>\",\n \"accountId\": \"<string>\",\n \"username\": \"<string>\",\n \"userKey\": \"<string>\"\n }\n ],\n \"group\": [\n {\n \"type\": \"<string>\",\n \"name\": \"<string>\"\n },\n {\n \"type\": \"<string>\",\n \"name\": \"<string>\"\n }\n ]\n }\n }\n]"
},
"url": {
"raw": "{{baseUrl}}/api/content/:id/restriction?expand=<string>&expand=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"content",
":id",
"restriction"
],
"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": ""
}
]
}
