Back to Collection Items
void ChilkatSample(void)
{
queryParams.UpdateString(L"expand",L"<string>"); queryParams.UpdateString(L"expand",L"<string>"); queryParams.UpdateInt(L"start",0); queryParams.UpdateInt(L"limit",10); http.put_AuthToken(L"<access_token>"); success = http.HttpParams(L"GET",L"https://your-domain.atlassian.net/wiki/rest/api/space/:spaceKey/property",queryParams,resp); resp.GetBodySb(sbResponseBody); jResp.LoadSb(sbResponseBody); jResp.put_EmitCompact(false); jResp.put_I(i); id = jResp.IntOf(L"results[i].id"); key = jResp.stringOf(L"results[i].key"); Version = jResp.stringOf(L"results[i]._expandable.version"); Space = jResp.stringOf(L"results[i]._expandable.space"); When = jResp.stringOf(L"results[i].version.when"); Message = jResp.stringOf(L"results[i].version.message"); v_Number = jResp.IntOf(L"results[i].version.number"); MinorEdit = jResp.BoolOf(L"results[i].version.minorEdit"); Id = jResp.IntOf(L"results[i].space.id"); Key = jResp.stringOf(L"results[i].space.key"); Name = jResp.stringOf(L"results[i].space.name"); v_Type = jResp.stringOf(L"results[i].space.type"); Status = jResp.stringOf(L"results[i].space.status"); Settings = jResp.stringOf(L"results[i].space._expandable.settings"); Metadata = jResp.stringOf(L"results[i].space._expandable.metadata"); Operations = jResp.stringOf(L"results[i].space._expandable.operations"); LookAndFeel = jResp.stringOf(L"results[i].space._expandable.lookAndFeel"); Permissions = jResp.stringOf(L"results[i].space._expandable.permissions"); Icon = jResp.stringOf(L"results[i].space._expandable.icon"); Description = jResp.stringOf(L"results[i].space._expandable.description"); Theme = jResp.stringOf(L"results[i].space._expandable.theme"); History = jResp.stringOf(L"results[i].space._expandable.history"); Homepage = jResp.stringOf(L"results[i].space._expandable.homepage"); Path = jResp.stringOf(L"results[i].space.icon.path"); Width = jResp.IntOf(L"results[i].space.icon.width"); Height = jResp.IntOf(L"results[i].space.icon.height"); IsDefault = jResp.BoolOf(L"results[i].space.icon.isDefault"); Value = jResp.stringOf(L"results[i].space.description.plain.value"); Representation = jResp.stringOf(L"results[i].space.description.plain.representation"); ViewValue = jResp.stringOf(L"results[i].space.description.view.value"); ViewRepresentation = jResp.stringOf(L"results[i].space.description.view.representation"); HomepageValue = jResp.stringOf(L"results[i].space.homepage.value"); Start = jResp.IntOf(L"results[i].space.metadata.labels.start"); Limit = jResp.IntOf(L"results[i].space.metadata.labels.limit"); Size = jResp.IntOf(L"results[i].space.metadata.labels.size"); RouteOverrideEnabled = jResp.BoolOf(L"results[i].space.settings.routeOverrideEnabled"); Color = jResp.stringOf(L"results[i].space.lookAndFeel.headings.color"); LinksColor = jResp.stringOf(L"results[i].space.lookAndFeel.links.color"); HoverOrFocusValue = jResp.stringOf(L"results[i].space.lookAndFeel.menus.hoverOrFocus.value"); ColorValue = jResp.stringOf(L"results[i].space.lookAndFeel.menus.color.value"); BackgroundColorValue = jResp.stringOf(L"results[i].space.lookAndFeel.header.backgroundColor.value"); ButtonValue = jResp.stringOf(L"results[i].space.lookAndFeel.header.button.value"); PrimaryNavigationValue = jResp.stringOf(L"results[i].space.lookAndFeel.header.primaryNavigation.value"); SecondaryNavigationValue = jResp.stringOf(L"results[i].space.lookAndFeel.header.secondaryNavigation.value"); SearchValue = jResp.stringOf(L"results[i].space.lookAndFeel.header.search.value"); ScreenValue = jResp.stringOf(L"results[i].space.lookAndFeel.content.screen.value"); ContainerValue = jResp.stringOf(L"results[i].space.lookAndFeel.content.container.value"); HeaderValue = jResp.stringOf(L"results[i].space.lookAndFeel.content.header.value"); BodyValue = jResp.stringOf(L"results[i].space.lookAndFeel.content.body.value"); BordersAndDividersColor = jResp.stringOf(L"results[i].space.lookAndFeel.bordersAndDividers.color"); CreatedDate = jResp.stringOf(L"results[i].space.history.createdDate"); j = 0; count_j = jResp.SizeOfArray(L"results[i].space.description.plain.embeddedContent"); jResp.put_J(j); value = jResp.stringOf(L"results[i].space.description.plain.embeddedContent[j].value"); j = j + 1; j = 0; count_j = jResp.SizeOfArray(L"results[i].space.description.view.embeddedContent"); jResp.put_J(j); value = jResp.stringOf(L"results[i].space.description.view.embeddedContent[j].value"); j = j + 1; j = 0; count_j = jResp.SizeOfArray(L"results[i].space.metadata.labels.results"); jResp.put_J(j); value = jResp.stringOf(L"results[i].space.metadata.labels.results[j].value"); j = j + 1; j = 0; count_j = jResp.SizeOfArray(L"results[i].space.operations"); jResp.put_J(j); operation = jResp.stringOf(L"results[i].space.operations[j].operation"); targetType = jResp.stringOf(L"results[i].space.operations[j].targetType"); j = j + 1; j = 0; count_j = jResp.SizeOfArray(L"results[i].space.permissions"); jResp.put_J(j); v_expandableValue = jResp.stringOf(L"results[i].space.permissions[j].subjects._expandable.value"); UserValue = jResp.stringOf(L"results[i].space.permissions[j].subjects.user.value"); GroupValue = jResp.stringOf(L"results[i].space.permissions[j].subjects.group.value"); Operation = jResp.stringOf(L"results[i].space.permissions[j].operation.operation"); TargetType = jResp.stringOf(L"results[i].space.permissions[j].operation.targetType"); anonymousAccess = jResp.BoolOf(L"results[i].space.permissions[j].anonymousAccess"); unlicensedAccess = jResp.BoolOf(L"results[i].space.permissions[j].unlicensedAccess"); j = j + 1; i = i + 1;
}
Curl Command
curl -G -d "expand=%3Cstring%3E"
-d "expand=%3Cstring%3E"
-d "start=0"
-d "limit=10"
-H "Authorization: Bearer <access_token>"
https://your-domain.atlassian.net/wiki/rest/api/space/:spaceKey/property
Postman Collection Item JSON
{
"name": "Get space properties",
"request": {
"auth": {
"type": "oauth2"
},
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/api/space/:spaceKey/property?expand=<string>&expand=<string>&start=0&limit=10",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"space",
":spaceKey",
"property"
],
"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."
},
{
"key": "start",
"value": "0",
"description": "The starting index of the returned objects."
},
{
"key": "limit",
"value": "10",
"description": "The maximum number of properties to return per page. Note, this may be\nrestricted by fixed system limits."
}
],
"variable": [
{
"key": "spaceKey",
"value": "<string>",
"type": "string",
"description": "(Required) The key of the space to be queried for its properties."
}
]
},
"description": "Returns all properties for the given space. Space properties are a key-value storage associated with a space.\n\n**[Permissions required](https://confluence.atlassian.com/x/_AozKw)**: ‘View’ permission for the space."
},
"response": [
{
"name": "Returned if the requested space properties 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/space/:spaceKey/property?expand=<string>&expand=<string>&start=0&limit=10",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"space",
":spaceKey",
"property"
],
"query": [
{
"key": "expand",
"value": "<string>"
},
{
"key": "expand",
"value": "<string>"
},
{
"key": "start",
"value": "0"
},
{
"key": "limit",
"value": "10"
}
],
"variable": [
{
"key": "spaceKey"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"results\": [\n {\n \"id\": 19427264,\n \"key\": \"id non\",\n \"value\": {},\n \"_expandable\": {\n \"version\": \"aute culpa\",\n \"space\": \"sit fugiat\"\n },\n \"version\": {\n \"when\": \"1988-02-08T03:27:37.011Z\",\n \"message\": \"velit aliqua labore incididunt\",\n \"number\": -41582376,\n \"minorEdit\": false\n },\n \"space\": {\n \"id\": 20731255,\n \"key\": \"ut\",\n \"name\": \"do aliqua laboris eiusmod\",\n \"type\": \"exercitation id\",\n \"status\": \"consectetur ullamco\",\n \"_expandable\": {\n \"settings\": \"sint\",\n \"metadata\": \"quis non\",\n \"operations\": \"dolor in cillum\",\n \"lookAndFeel\": \"tempor qui\",\n \"permissions\": \"Duis veniam mollit nisi\",\n \"icon\": \"culpa est\",\n \"description\": \"ex sunt labore id\",\n \"theme\": \"id minim\",\n \"history\": \"inci\",\n \"homepage\": \"occaecat in dolor quis\"\n },\n \"_links\": {},\n \"icon\": {\n \"path\": \"nisi non esse culpa\",\n \"width\": 99533791,\n \"height\": -28134599,\n \"isDefault\": true\n },\n \"description\": {\n \"plain\": {\n \"value\": \"dolor proident ut 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\": \"consequat\",\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\": -59083965,\n \"limit\": 75849140,\n \"size\": 92184684,\n \"_links\": {}\n }\n },\n \"operations\": [\n {\n \"operation\": \"restore\",\n \"targetType\": \"attachment\"\n },\n {\n \"operation\": \"export\",\n \"targetType\": \"application\"\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\": \"create\",\n \"targetType\": \"space\"\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\": \"delete\",\n \"targetType\": \"space\"\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\": \"2003-06-18T11:28:40.383Z\"\n }\n }\n },\n {\n \"id\": 50590702,\n \"key\": \"minim adipisicing mollit ut\",\n \"value\": {},\n \"_expandable\": {\n \"version\": \"sed ad el\",\n \"space\": \"pariatur deserunt in labore aliquip\"\n },\n \"version\": {\n \"when\": \"1970-01-13T15:48:59.108Z\",\n \"message\": \"in mollit pariatur\",\n \"number\": -34696343,\n \"minorEdit\": false\n },\n \"space\": {\n \"id\": 2257956,\n \"key\": \"deserunt \",\n \"name\": \"pariatur\",\n \"type\": \"mollit dolore\",\n \"status\": \"voluptate o\",\n \"_expandable\": {\n \"settings\": \"dolor officia\",\n \"metadata\": \"nostrud proident qui\",\n \"operations\": \"dolore\",\n \"lookAndFeel\": \"ex\",\n \"permissions\": \"et ea ad do\",\n \"icon\": \"ea anim laborum\",\n \"description\": \"nostrud n\",\n \"theme\": \"est irure proident\",\n \"history\": \"aute magna\",\n \"homepage\": \"voluptate labore\"\n },\n \"_links\": {},\n \"icon\": {\n \"path\": \"ex consectetur\",\n \"width\": -6687916,\n \"height\": 6284709,\n \"isDefault\": false\n },\n \"description\": {\n \"plain\": {\n \"value\": \"magna\",\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\": \"mollit\",\n \"representation\": \"view\",\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\": 31563568,\n \"limit\": 7437848,\n \"size\": -50600293,\n \"_links\": {}\n }\n },\n \"operations\": [\n {\n \"operation\": \"export\",\n \"targetType\": \"application\"\n },\n {\n \"operation\": \"read\",\n \"targetType\": \"blogpost\"\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\": \"delete\",\n \"targetType\": \"attachment\"\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\": \"purge\",\n \"targetType\": \"space\"\n },\n \"anonymousAccess\": false,\n \"unlicensedAccess\": false\n }\n ],\n \"settings\": {\n \"routeOverrideEnabled\": true,\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\": \"1946-10-24T07:33:44.994Z\"\n }\n }\n }\n ],\n \"start\": -871862,\n \"limit\": -29998484,\n \"size\": 16090591,\n \"_links\": {}\n}"
},
{
"name": "Returned if any of the following is true:\n\n- There is no space 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?expand=<string>&expand=<string>&start=0&limit=10",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"space",
":spaceKey",
"property"
],
"query": [
{
"key": "expand",
"value": "<string>"
},
{
"key": "expand",
"value": "<string>"
},
{
"key": "start",
"value": "0"
},
{
"key": "limit",
"value": "10"
}
],
"variable": [
{
"key": "spaceKey"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}
