Back to Collection Items
#include <C_CkHttp.h>
#include <C_CkJsonObject.h>
#include <C_CkHttpResponse.h>
#include <C_CkStringBuilder.h>
void ChilkatSample(void)
{
HCkHttp http;
BOOL success;
HCkJsonObject queryParams;
HCkHttpResponse resp;
HCkStringBuilder sbResponseBody;
HCkJsonObject jResp;
int respStatusCode;
const char *value;
const char *operation;
const char *targetType;
const char *v_expandableValue;
const char *UserValue;
const char *GroupValue;
const char *Operation;
const char *TargetType;
BOOL anonymousAccess;
BOOL unlicensedAccess;
int id;
const char *key;
const char *Version;
const char *Space;
const char *When;
const char *Message;
int v_Number;
BOOL MinorEdit;
int Id;
const char *Key;
const char *Name;
const char *v_Type;
const char *Status;
const char *Settings;
const char *Metadata;
const char *Operations;
const char *LookAndFeel;
const char *Permissions;
const char *Icon;
const char *Description;
const char *Theme;
const char *History;
const char *Homepage;
const char *Path;
int Width;
int Height;
BOOL IsDefault;
const char *Value;
const char *Representation;
const char *ViewValue;
const char *ViewRepresentation;
const char *HomepageValue;
int Start;
int Limit;
int Size;
BOOL RouteOverrideEnabled;
const char *Color;
const char *LinksColor;
const char *HoverOrFocusValue;
const char *ColorValue;
const char *BackgroundColorValue;
const char *ButtonValue;
const char *PrimaryNavigationValue;
const char *SecondaryNavigationValue;
const char *SearchValue;
const char *ScreenValue;
const char *ContainerValue;
const char *HeaderValue;
const char *BodyValue;
const char *BordersAndDividersColor;
const char *CreatedDate;
int i;
int count_i;
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http = CkHttp_Create();
queryParams = CkJsonObject_Create();
CkJsonObject_UpdateString(queryParams,"expand","<string>");
CkJsonObject_UpdateString(queryParams,"expand","<string>");
// Adds the "Authorization: Bearer <access_token>" header.
CkHttp_putAuthToken(http,"<access_token>");
resp = CkHttp_QuickRequestParams(http,"GET","https://your-domain.atlassian.net/wiki/rest/api/space/:spaceKey/property/:key",queryParams);
if (CkHttp_getLastMethodSuccess(http) == FALSE) {
printf("%s\n",CkHttp_lastErrorText(http));
CkHttp_Dispose(http);
CkJsonObject_Dispose(queryParams);
return;
}
sbResponseBody = CkStringBuilder_Create();
CkHttpResponse_GetBodySb(resp,sbResponseBody);
jResp = CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,FALSE);
printf("Response Body:\n");
printf("%s\n",CkJsonObject_emit(jResp));
respStatusCode = CkHttpResponse_getStatusCode(resp);
printf("Response Status Code = %d\n",respStatusCode);
if (respStatusCode >= 400) {
printf("Response Header:\n");
printf("%s\n",CkHttpResponse_header(resp));
printf("Failed.\n");
CkHttpResponse_Dispose(resp);
CkHttp_Dispose(http);
CkJsonObject_Dispose(queryParams);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
return;
}
CkHttpResponse_Dispose(resp);
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "id": -13429300,
// "key": "ut veniam dolor",
// "value": {},
// "_expandable": {
// "version": "cillum officia ipsum ut",
// "space": "in Lorem consectetur"
// },
// "version": {
// "when": "1951-11-29T18:04:27.736Z",
// "message": "dolore magna nisi incididunt",
// "number": -49820236,
// "minorEdit": true
// },
// "space": {
// "id": -20471082,
// "key": "in pr",
// "name": "culpa dolor si",
// "type": "irure dolor ea aliquip",
// "status": "sed ex",
// "_expandable": {
// "settings": "exercitation ea nisi Lorem",
// "metadata": "elit",
// "operations": "Lorem consequat aliquip",
// "lookAndFeel": "non occaecat nisi dolor",
// "permissions": "pariatur cupidatat dolor sed dolor",
// "icon": "aliquip",
// "description": "in",
// "theme": "qui",
// "history": "et fugiat culpa irure amet",
// "homepage": "commodo ut amet aute sint"
// },
// "_links": {},
// "icon": {
// "path": "laborum velit dolore",
// "width": -4680192,
// "height": 21898365,
// "isDefault": false
// },
// "description": {
// "plain": {
// "value": "sit deserunt",
// "representation": "plain",
// "embeddedContent": [
// {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// }
// ]
// },
// "view": {
// "value": "commodo dolore do",
// "representation": "plain",
// "embeddedContent": [
// {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// }
// ]
// }
// },
// "homepage": {
// "value": "<Circular reference to #/components/schemas/Content detected>"
// },
// "metadata": {
// "labels": {
// "results": [
// {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// }
// ],
// "start": 4373903,
// "limit": -70310049,
// "size": -89717135,
// "_links": {}
// }
// },
// "operations": [
// {
// "operation": "update",
// "targetType": "space"
// },
// {
// "operation": "update",
// "targetType": "attachment"
// }
// ],
// "permissions": [
// {
// "subjects": {
// "_expandable": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "user": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "group": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// }
// },
// "operation": {
// "operation": "restore",
// "targetType": "comment"
// },
// "anonymousAccess": false,
// "unlicensedAccess": false
// },
// {
// "subjects": {
// "_expandable": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "user": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "group": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// }
// },
// "operation": {
// "operation": "export",
// "targetType": "attachment"
// },
// "anonymousAccess": false,
// "unlicensedAccess": false
// }
// ],
// "settings": {
// "routeOverrideEnabled": false,
// "_links": {}
// },
// "theme": {},
// "lookAndFeel": {
// "headings": {
// "color": "<string>"
// },
// "links": {
// "color": "<string>"
// },
// "menus": {
// "hoverOrFocus": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "color": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// }
// },
// "header": {
// "backgroundColor": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "button": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "primaryNavigation": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "secondaryNavigation": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "search": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// }
// },
// "content": {
// "screen": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "container": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "header": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "body": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// }
// },
// "bordersAndDividers": {
// "color": "<string>"
// }
// },
// "history": {
// "createdDate": "1978-05-15T09:31:11.737Z"
// }
// }
// }
// 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.
id = CkJsonObject_IntOf(jResp,"id");
key = CkJsonObject_stringOf(jResp,"key");
Version = CkJsonObject_stringOf(jResp,"_expandable.version");
Space = CkJsonObject_stringOf(jResp,"_expandable.space");
When = CkJsonObject_stringOf(jResp,"version.when");
Message = CkJsonObject_stringOf(jResp,"version.message");
v_Number = CkJsonObject_IntOf(jResp,"version.number");
MinorEdit = CkJsonObject_BoolOf(jResp,"version.minorEdit");
Id = CkJsonObject_IntOf(jResp,"space.id");
Key = CkJsonObject_stringOf(jResp,"space.key");
Name = CkJsonObject_stringOf(jResp,"space.name");
v_Type = CkJsonObject_stringOf(jResp,"space.type");
Status = CkJsonObject_stringOf(jResp,"space.status");
Settings = CkJsonObject_stringOf(jResp,"space._expandable.settings");
Metadata = CkJsonObject_stringOf(jResp,"space._expandable.metadata");
Operations = CkJsonObject_stringOf(jResp,"space._expandable.operations");
LookAndFeel = CkJsonObject_stringOf(jResp,"space._expandable.lookAndFeel");
Permissions = CkJsonObject_stringOf(jResp,"space._expandable.permissions");
Icon = CkJsonObject_stringOf(jResp,"space._expandable.icon");
Description = CkJsonObject_stringOf(jResp,"space._expandable.description");
Theme = CkJsonObject_stringOf(jResp,"space._expandable.theme");
History = CkJsonObject_stringOf(jResp,"space._expandable.history");
Homepage = CkJsonObject_stringOf(jResp,"space._expandable.homepage");
Path = CkJsonObject_stringOf(jResp,"space.icon.path");
Width = CkJsonObject_IntOf(jResp,"space.icon.width");
Height = CkJsonObject_IntOf(jResp,"space.icon.height");
IsDefault = CkJsonObject_BoolOf(jResp,"space.icon.isDefault");
Value = CkJsonObject_stringOf(jResp,"space.description.plain.value");
Representation = CkJsonObject_stringOf(jResp,"space.description.plain.representation");
ViewValue = CkJsonObject_stringOf(jResp,"space.description.view.value");
ViewRepresentation = CkJsonObject_stringOf(jResp,"space.description.view.representation");
HomepageValue = CkJsonObject_stringOf(jResp,"space.homepage.value");
Start = CkJsonObject_IntOf(jResp,"space.metadata.labels.start");
Limit = CkJsonObject_IntOf(jResp,"space.metadata.labels.limit");
Size = CkJsonObject_IntOf(jResp,"space.metadata.labels.size");
RouteOverrideEnabled = CkJsonObject_BoolOf(jResp,"space.settings.routeOverrideEnabled");
Color = CkJsonObject_stringOf(jResp,"space.lookAndFeel.headings.color");
LinksColor = CkJsonObject_stringOf(jResp,"space.lookAndFeel.links.color");
HoverOrFocusValue = CkJsonObject_stringOf(jResp,"space.lookAndFeel.menus.hoverOrFocus.value");
ColorValue = CkJsonObject_stringOf(jResp,"space.lookAndFeel.menus.color.value");
BackgroundColorValue = CkJsonObject_stringOf(jResp,"space.lookAndFeel.header.backgroundColor.value");
ButtonValue = CkJsonObject_stringOf(jResp,"space.lookAndFeel.header.button.value");
PrimaryNavigationValue = CkJsonObject_stringOf(jResp,"space.lookAndFeel.header.primaryNavigation.value");
SecondaryNavigationValue = CkJsonObject_stringOf(jResp,"space.lookAndFeel.header.secondaryNavigation.value");
SearchValue = CkJsonObject_stringOf(jResp,"space.lookAndFeel.header.search.value");
ScreenValue = CkJsonObject_stringOf(jResp,"space.lookAndFeel.content.screen.value");
ContainerValue = CkJsonObject_stringOf(jResp,"space.lookAndFeel.content.container.value");
HeaderValue = CkJsonObject_stringOf(jResp,"space.lookAndFeel.content.header.value");
BodyValue = CkJsonObject_stringOf(jResp,"space.lookAndFeel.content.body.value");
BordersAndDividersColor = CkJsonObject_stringOf(jResp,"space.lookAndFeel.bordersAndDividers.color");
CreatedDate = CkJsonObject_stringOf(jResp,"space.history.createdDate");
i = 0;
count_i = CkJsonObject_SizeOfArray(jResp,"space.description.plain.embeddedContent");
while (i < count_i) {
CkJsonObject_putI(jResp,i);
value = CkJsonObject_stringOf(jResp,"space.description.plain.embeddedContent[i].value");
i = i + 1;
}
i = 0;
count_i = CkJsonObject_SizeOfArray(jResp,"space.description.view.embeddedContent");
while (i < count_i) {
CkJsonObject_putI(jResp,i);
value = CkJsonObject_stringOf(jResp,"space.description.view.embeddedContent[i].value");
i = i + 1;
}
i = 0;
count_i = CkJsonObject_SizeOfArray(jResp,"space.metadata.labels.results");
while (i < count_i) {
CkJsonObject_putI(jResp,i);
value = CkJsonObject_stringOf(jResp,"space.metadata.labels.results[i].value");
i = i + 1;
}
i = 0;
count_i = CkJsonObject_SizeOfArray(jResp,"space.operations");
while (i < count_i) {
CkJsonObject_putI(jResp,i);
operation = CkJsonObject_stringOf(jResp,"space.operations[i].operation");
targetType = CkJsonObject_stringOf(jResp,"space.operations[i].targetType");
i = i + 1;
}
i = 0;
count_i = CkJsonObject_SizeOfArray(jResp,"space.permissions");
while (i < count_i) {
CkJsonObject_putI(jResp,i);
v_expandableValue = CkJsonObject_stringOf(jResp,"space.permissions[i].subjects._expandable.value");
UserValue = CkJsonObject_stringOf(jResp,"space.permissions[i].subjects.user.value");
GroupValue = CkJsonObject_stringOf(jResp,"space.permissions[i].subjects.group.value");
Operation = CkJsonObject_stringOf(jResp,"space.permissions[i].operation.operation");
TargetType = CkJsonObject_stringOf(jResp,"space.permissions[i].operation.targetType");
anonymousAccess = CkJsonObject_BoolOf(jResp,"space.permissions[i].anonymousAccess");
unlicensedAccess = CkJsonObject_BoolOf(jResp,"space.permissions[i].unlicensedAccess");
i = i + 1;
}
CkHttp_Dispose(http);
CkJsonObject_Dispose(queryParams);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
}
Curl Command
curl -G -d "expand=%3Cstring%3E"
-d "expand=%3Cstring%3E"
-H "Authorization: Bearer <access_token>"
https://your-domain.atlassian.net/wiki/rest/api/space/:spaceKey/property/:key
Postman Collection Item JSON
{
"name": "Get space property",
"request": {
"auth": {
"type": "oauth2"
},
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/api/space/:spaceKey/property/:key?expand=<string>&expand=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"space",
":spaceKey",
"property",
":key"
],
"query": [
{
"key": "expand",
"value": "<string>",
"description": "A multi-value parameter indicating which properties of the space\nproperty to expand. By default, the `version` object is expanded.\n\n- `version` returns information about the version of the content.\n- `space` returns the space that the properties are in."
},
{
"key": "expand",
"value": "<string>",
"description": "A multi-value parameter indicating which properties of the space\nproperty to expand. By default, the `version` object is expanded.\n\n- `version` returns information about the version of the content.\n- `space` returns the space that the properties are in."
}
],
"variable": [
{
"key": "spaceKey",
"value": "<string>",
"type": "string",
"description": "(Required) The key of the space that the property is in."
},
{
"key": "key",
"value": "<string>",
"type": "string",
"description": "(Required) The key of the space property."
}
]
},
"description": "Returns a space property.\n\n**[Permissions required](https://confluence.atlassian.com/x/_AozKw)**: ‘View’ permission for the space."
},
"response": [
{
"name": "Returned if the requested space property is 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/space/:spaceKey/property/:key?expand=<string>&expand=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"space",
":spaceKey",
"property",
":key"
],
"query": [
{
"key": "expand",
"value": "<string>"
},
{
"key": "expand",
"value": "<string>"
}
],
"variable": [
{
"key": "spaceKey"
},
{
"key": "key"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"id\": -13429300,\n \"key\": \"ut veniam dolor\",\n \"value\": {},\n \"_expandable\": {\n \"version\": \"cillum officia ipsum ut\",\n \"space\": \"in Lorem consectetur\"\n },\n \"version\": {\n \"when\": \"1951-11-29T18:04:27.736Z\",\n \"message\": \"dolore magna nisi incididunt\",\n \"number\": -49820236,\n \"minorEdit\": true\n },\n \"space\": {\n \"id\": -20471082,\n \"key\": \"in pr\",\n \"name\": \"culpa dolor si\",\n \"type\": \"irure dolor ea aliquip\",\n \"status\": \"sed ex\",\n \"_expandable\": {\n \"settings\": \"exercitation ea nisi Lorem\",\n \"metadata\": \"elit\",\n \"operations\": \"Lorem consequat aliquip\",\n \"lookAndFeel\": \"non occaecat nisi dolor\",\n \"permissions\": \"pariatur cupidatat dolor sed dolor\",\n \"icon\": \"aliquip\",\n \"description\": \"in\",\n \"theme\": \"qui\",\n \"history\": \"et fugiat culpa irure amet\",\n \"homepage\": \"commodo ut amet aute sint\"\n },\n \"_links\": {},\n \"icon\": {\n \"path\": \"laborum velit dolore\",\n \"width\": -4680192,\n \"height\": 21898365,\n \"isDefault\": false\n },\n \"description\": {\n \"plain\": {\n \"value\": \"sit deserunt\",\n \"representation\": \"plain\",\n \"embeddedContent\": [\n {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n ]\n },\n \"view\": {\n \"value\": \"commodo dolore do\",\n \"representation\": \"plain\",\n \"embeddedContent\": [\n {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n ]\n }\n },\n \"homepage\": {\n \"value\": \"<Circular reference to #/components/schemas/Content detected>\"\n },\n \"metadata\": {\n \"labels\": {\n \"results\": [\n {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n ],\n \"start\": 4373903,\n \"limit\": -70310049,\n \"size\": -89717135,\n \"_links\": {}\n }\n },\n \"operations\": [\n {\n \"operation\": \"update\",\n \"targetType\": \"space\"\n },\n {\n \"operation\": \"update\",\n \"targetType\": \"attachment\"\n }\n ],\n \"permissions\": [\n {\n \"subjects\": {\n \"_expandable\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"user\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"group\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n \"operation\": {\n \"operation\": \"restore\",\n \"targetType\": \"comment\"\n },\n \"anonymousAccess\": false,\n \"unlicensedAccess\": false\n },\n {\n \"subjects\": {\n \"_expandable\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"user\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"group\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n \"operation\": {\n \"operation\": \"export\",\n \"targetType\": \"attachment\"\n },\n \"anonymousAccess\": false,\n \"unlicensedAccess\": false\n }\n ],\n \"settings\": {\n \"routeOverrideEnabled\": false,\n \"_links\": {}\n },\n \"theme\": {},\n \"lookAndFeel\": {\n \"headings\": {\n \"color\": \"<string>\"\n },\n \"links\": {\n \"color\": \"<string>\"\n },\n \"menus\": {\n \"hoverOrFocus\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"color\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n \"header\": {\n \"backgroundColor\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"button\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"primaryNavigation\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"secondaryNavigation\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"search\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n \"content\": {\n \"screen\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"container\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"header\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"body\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n \"bordersAndDividers\": {\n \"color\": \"<string>\"\n }\n },\n \"history\": {\n \"createdDate\": \"1978-05-15T09:31:11.737Z\"\n }\n }\n}"
},
{
"name": "Returned if any of the following is true:\n\n- There is no space with the given key.\n- There is no property with the given key.\n- The calling user does not have permission to view the space.",
"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/space/:spaceKey/property/:key?expand=<string>&expand=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"space",
":spaceKey",
"property",
":key"
],
"query": [
{
"key": "expand",
"value": "<string>"
},
{
"key": "expand",
"value": "<string>"
}
],
"variable": [
{
"key": "spaceKey"
},
{
"key": "key"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}
