Back to Collection Items
#include <C_CkHttpW.h>
#include <C_CkJsonArrayW.h>
#include <C_CkJsonObjectW.h>
#include <C_CkStringBuilderW.h>
#include <C_CkHttpResponseW.h>
void ChilkatSample(void)
{
HCkHttpW http;
BOOL success;
HCkJsonArrayW jarr;
HCkJsonObjectW jsonObj_1;
HCkStringBuilderW sbRequestBody;
HCkHttpResponseW resp;
HCkStringBuilderW sbResponseBody;
HCkJsonObjectW jResp;
int respStatusCode;
const wchar_t *operation;
const wchar_t *Restrictions;
const wchar_t *Content;
const wchar_t *Value;
const wchar_t *StartValue;
const wchar_t *LimitValue;
const wchar_t *SizeValue;
const wchar_t *ResultsValue;
const wchar_t *User;
const wchar_t *Group;
const wchar_t *contentValue;
int start;
int limit;
int size;
const wchar_t *restrictionsHash;
int i;
int count_i;
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http = CkHttpW_Create();
// 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 = CkJsonArrayW_Create();
CkJsonArrayW_AddObjectAt(jarr,-1);
jsonObj_1 = CkJsonArrayW_ObjectAt(jarr,CkJsonArrayW_getSize(jarr) - 1);
CkJsonObjectW_UpdateString(jsonObj_1,L"operation",L"<string>");
CkJsonObjectW_UpdateString(jsonObj_1,L"restrictions.user[0].type",L"<string>");
CkJsonObjectW_UpdateString(jsonObj_1,L"restrictions.user[0].accountId",L"<string>");
CkJsonObjectW_UpdateString(jsonObj_1,L"restrictions.user[0].username",L"<string>");
CkJsonObjectW_UpdateString(jsonObj_1,L"restrictions.user[0].userKey",L"<string>");
CkJsonObjectW_UpdateString(jsonObj_1,L"restrictions.user[1].type",L"<string>");
CkJsonObjectW_UpdateString(jsonObj_1,L"restrictions.user[1].accountId",L"<string>");
CkJsonObjectW_UpdateString(jsonObj_1,L"restrictions.user[1].username",L"<string>");
CkJsonObjectW_UpdateString(jsonObj_1,L"restrictions.user[1].userKey",L"<string>");
CkJsonObjectW_UpdateString(jsonObj_1,L"restrictions.group[0].type",L"<string>");
CkJsonObjectW_UpdateString(jsonObj_1,L"restrictions.group[0].name",L"<string>");
CkJsonObjectW_UpdateString(jsonObj_1,L"restrictions.group[1].type",L"<string>");
CkJsonObjectW_UpdateString(jsonObj_1,L"restrictions.group[1].name",L"<string>");
CkJsonObjectW_Dispose(jsonObj_1);
CkJsonArrayW_AddObjectAt(jarr,-1);
jsonObj_1 = CkJsonArrayW_ObjectAt(jarr,CkJsonArrayW_getSize(jarr) - 1);
CkJsonObjectW_UpdateString(jsonObj_1,L"operation",L"<string>");
CkJsonObjectW_UpdateString(jsonObj_1,L"restrictions.user[0].type",L"<string>");
CkJsonObjectW_UpdateString(jsonObj_1,L"restrictions.user[0].accountId",L"<string>");
CkJsonObjectW_UpdateString(jsonObj_1,L"restrictions.user[0].username",L"<string>");
CkJsonObjectW_UpdateString(jsonObj_1,L"restrictions.user[0].userKey",L"<string>");
CkJsonObjectW_UpdateString(jsonObj_1,L"restrictions.user[1].type",L"<string>");
CkJsonObjectW_UpdateString(jsonObj_1,L"restrictions.user[1].accountId",L"<string>");
CkJsonObjectW_UpdateString(jsonObj_1,L"restrictions.user[1].username",L"<string>");
CkJsonObjectW_UpdateString(jsonObj_1,L"restrictions.user[1].userKey",L"<string>");
CkJsonObjectW_UpdateString(jsonObj_1,L"restrictions.group[0].type",L"<string>");
CkJsonObjectW_UpdateString(jsonObj_1,L"restrictions.group[0].name",L"<string>");
CkJsonObjectW_UpdateString(jsonObj_1,L"restrictions.group[1].type",L"<string>");
CkJsonObjectW_UpdateString(jsonObj_1,L"restrictions.group[1].name",L"<string>");
CkJsonObjectW_Dispose(jsonObj_1);
// Adds the "Authorization: Bearer <access_token>" header.
CkHttpW_putAuthToken(http,L"<access_token>");
CkHttpW_SetRequestHeader(http,L"Content-Type",L"application/json");
sbRequestBody = CkStringBuilderW_Create();
CkJsonArrayW_EmitSb(jarr,sbRequestBody);
resp = CkHttpW_PTextSb(http,L"POST",L"https://your-domain.atlassian.net/wiki/rest/api/content/:id/restriction?expand=<string>&expand=<string>",sbRequestBody,L"utf-8",L"application/json",FALSE,FALSE);
if (CkHttpW_getLastMethodSuccess(http) == FALSE) {
wprintf(L"%s\n",CkHttpW_lastErrorText(http));
CkHttpW_Dispose(http);
CkJsonArrayW_Dispose(jarr);
CkStringBuilderW_Dispose(sbRequestBody);
return;
}
sbResponseBody = CkStringBuilderW_Create();
CkHttpResponseW_GetBodySb(resp,sbResponseBody);
jResp = CkJsonObjectW_Create();
CkJsonObjectW_LoadSb(jResp,sbResponseBody);
CkJsonObjectW_putEmitCompact(jResp,FALSE);
wprintf(L"Response Body:\n");
wprintf(L"%s\n",CkJsonObjectW_emit(jResp));
respStatusCode = CkHttpResponseW_getStatusCode(resp);
wprintf(L"Response Status Code = %d\n",respStatusCode);
if (respStatusCode >= 400) {
wprintf(L"Response Header:\n");
wprintf(L"%s\n",CkHttpResponseW_header(resp));
wprintf(L"Failed.\n");
CkHttpResponseW_Dispose(resp);
CkHttpW_Dispose(http);
CkJsonArrayW_Dispose(jarr);
CkStringBuilderW_Dispose(sbRequestBody);
CkStringBuilderW_Dispose(sbResponseBody);
CkJsonObjectW_Dispose(jResp);
return;
}
CkHttpResponseW_Dispose(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
// Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.
start = CkJsonObjectW_IntOf(jResp,L"start");
limit = CkJsonObjectW_IntOf(jResp,L"limit");
size = CkJsonObjectW_IntOf(jResp,L"size");
restrictionsHash = CkJsonObjectW_stringOf(jResp,L"restrictionsHash");
i = 0;
count_i = CkJsonObjectW_SizeOfArray(jResp,L"results");
while (i < count_i) {
CkJsonObjectW_putI(jResp,i);
operation = CkJsonObjectW_stringOf(jResp,L"results[i].operation");
Restrictions = CkJsonObjectW_stringOf(jResp,L"results[i]._expandable.restrictions");
Content = CkJsonObjectW_stringOf(jResp,L"results[i]._expandable.content");
Value = CkJsonObjectW_stringOf(jResp,L"results[i].restrictions.user.results.value");
StartValue = CkJsonObjectW_stringOf(jResp,L"results[i].restrictions.user.start.value");
LimitValue = CkJsonObjectW_stringOf(jResp,L"results[i].restrictions.user.limit.value");
SizeValue = CkJsonObjectW_stringOf(jResp,L"results[i].restrictions.user.size.value");
ResultsValue = CkJsonObjectW_stringOf(jResp,L"results[i].restrictions.group.results.value");
StartValue = CkJsonObjectW_stringOf(jResp,L"results[i].restrictions.group.start.value");
LimitValue = CkJsonObjectW_stringOf(jResp,L"results[i].restrictions.group.limit.value");
SizeValue = CkJsonObjectW_stringOf(jResp,L"results[i].restrictions.group.size.value");
User = CkJsonObjectW_stringOf(jResp,L"results[i].restrictions._expandable.user");
Group = CkJsonObjectW_stringOf(jResp,L"results[i].restrictions._expandable.group");
contentValue = CkJsonObjectW_stringOf(jResp,L"results[i].content.value");
i = i + 1;
}
CkHttpW_Dispose(http);
CkJsonArrayW_Dispose(jarr);
CkStringBuilderW_Dispose(sbRequestBody);
CkStringBuilderW_Dispose(sbResponseBody);
CkJsonObjectW_Dispose(jResp);
}
Curl Command
curl -X POST
-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": "Add restrictions",
"request": {
"auth": {
"type": "oauth2"
},
"method": "POST",
"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 add restrictions to."
}
]
},
"description": "Adds restrictions to a piece of content. Note, this does not change any\nexisting restrictions on the content.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to edit the content."
},
"response": [
{
"name": "Returned if the requested restrictions are added.",
"originalRequest": {
"method": "POST",
"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 add restrictions to\nthe content.",
"originalRequest": {
"method": "POST",
"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": ""
}
]
}
