Back to Collection Items
IncludeFile "CkJsonArray.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"
IncludeFile "CkJsonObject.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
; 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>"
; }
; ]
; }
; }
; ]
jarr.i = CkJsonArray::ckCreate()
If jarr.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonArray::ckAddObjectAt(jarr,-1)
jsonObj_1.i = CkJsonArray::ckObjectAt(jarr,CkJsonArray::ckSize(jarr) - 1)
CkJsonObject::ckUpdateString(jsonObj_1,"operation","<string>")
CkJsonObject::ckUpdateString(jsonObj_1,"restrictions.user[0].type","<string>")
CkJsonObject::ckUpdateString(jsonObj_1,"restrictions.user[0].accountId","<string>")
CkJsonObject::ckUpdateString(jsonObj_1,"restrictions.user[0].username","<string>")
CkJsonObject::ckUpdateString(jsonObj_1,"restrictions.user[0].userKey","<string>")
CkJsonObject::ckUpdateString(jsonObj_1,"restrictions.user[1].type","<string>")
CkJsonObject::ckUpdateString(jsonObj_1,"restrictions.user[1].accountId","<string>")
CkJsonObject::ckUpdateString(jsonObj_1,"restrictions.user[1].username","<string>")
CkJsonObject::ckUpdateString(jsonObj_1,"restrictions.user[1].userKey","<string>")
CkJsonObject::ckUpdateString(jsonObj_1,"restrictions.group[0].type","<string>")
CkJsonObject::ckUpdateString(jsonObj_1,"restrictions.group[0].name","<string>")
CkJsonObject::ckUpdateString(jsonObj_1,"restrictions.group[1].type","<string>")
CkJsonObject::ckUpdateString(jsonObj_1,"restrictions.group[1].name","<string>")
CkJsonObject::ckDispose(jsonObj_1)
CkJsonArray::ckAddObjectAt(jarr,-1)
jsonObj_1 = CkJsonArray::ckObjectAt(jarr,CkJsonArray::ckSize(jarr) - 1)
CkJsonObject::ckUpdateString(jsonObj_1,"operation","<string>")
CkJsonObject::ckUpdateString(jsonObj_1,"restrictions.user[0].type","<string>")
CkJsonObject::ckUpdateString(jsonObj_1,"restrictions.user[0].accountId","<string>")
CkJsonObject::ckUpdateString(jsonObj_1,"restrictions.user[0].username","<string>")
CkJsonObject::ckUpdateString(jsonObj_1,"restrictions.user[0].userKey","<string>")
CkJsonObject::ckUpdateString(jsonObj_1,"restrictions.user[1].type","<string>")
CkJsonObject::ckUpdateString(jsonObj_1,"restrictions.user[1].accountId","<string>")
CkJsonObject::ckUpdateString(jsonObj_1,"restrictions.user[1].username","<string>")
CkJsonObject::ckUpdateString(jsonObj_1,"restrictions.user[1].userKey","<string>")
CkJsonObject::ckUpdateString(jsonObj_1,"restrictions.group[0].type","<string>")
CkJsonObject::ckUpdateString(jsonObj_1,"restrictions.group[0].name","<string>")
CkJsonObject::ckUpdateString(jsonObj_1,"restrictions.group[1].type","<string>")
CkJsonObject::ckUpdateString(jsonObj_1,"restrictions.group[1].name","<string>")
CkJsonObject::ckDispose(jsonObj_1)
; Adds the "Authorization: Bearer <access_token>" header.
CkHttp::setCkAuthToken(http, "<access_token>")
CkHttp::ckSetRequestHeader(http,"Content-Type","application/json")
sbRequestBody.i = CkStringBuilder::ckCreate()
If sbRequestBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonArray::ckEmitSb(jarr,sbRequestBody)
resp.i = CkHttp::ckPTextSb(http,"PUT","https://your-domain.atlassian.net/wiki/rest/api/content/:id/restriction?expand=<string>&expand=<string>",sbRequestBody,"utf-8","application/json",0,0)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonArray::ckDispose(jarr)
CkStringBuilder::ckDispose(sbRequestBody)
ProcedureReturn
EndIf
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHttpResponse::ckGetBodySb(resp,sbResponseBody)
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttpResponse::ckHeader(resp)
Debug "Failed."
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonArray::ckDispose(jarr)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
CkHttpResponse::ckDispose(resp)
; 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
operation.s
Restrictions.s
Content.s
Value.s
StartValue.s
LimitValue.s
SizeValue.s
ResultsValue.s
User.s
Group.s
contentValue.s
start.i = CkJsonObject::ckIntOf(jResp,"start")
limit.i = CkJsonObject::ckIntOf(jResp,"limit")
size.i = CkJsonObject::ckIntOf(jResp,"size")
restrictionsHash.s = CkJsonObject::ckStringOf(jResp,"restrictionsHash")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"results")
While i < count_i
CkJsonObject::setCkI(jResp, i)
operation = CkJsonObject::ckStringOf(jResp,"results[i].operation")
Restrictions = CkJsonObject::ckStringOf(jResp,"results[i]._expandable.restrictions")
Content = CkJsonObject::ckStringOf(jResp,"results[i]._expandable.content")
Value = CkJsonObject::ckStringOf(jResp,"results[i].restrictions.user.results.value")
StartValue = CkJsonObject::ckStringOf(jResp,"results[i].restrictions.user.start.value")
LimitValue = CkJsonObject::ckStringOf(jResp,"results[i].restrictions.user.limit.value")
SizeValue = CkJsonObject::ckStringOf(jResp,"results[i].restrictions.user.size.value")
ResultsValue = CkJsonObject::ckStringOf(jResp,"results[i].restrictions.group.results.value")
StartValue = CkJsonObject::ckStringOf(jResp,"results[i].restrictions.group.start.value")
LimitValue = CkJsonObject::ckStringOf(jResp,"results[i].restrictions.group.limit.value")
SizeValue = CkJsonObject::ckStringOf(jResp,"results[i].restrictions.group.size.value")
User = CkJsonObject::ckStringOf(jResp,"results[i].restrictions._expandable.user")
Group = CkJsonObject::ckStringOf(jResp,"results[i].restrictions._expandable.group")
contentValue = CkJsonObject::ckStringOf(jResp,"results[i].content.value")
i = i + 1
Wend
CkHttp::ckDispose(http)
CkJsonArray::ckDispose(jarr)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
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": ""
}
]
}
