Back to Collection Items
<?php
include("chilkat.php");
// Use "chilkat_9_5_0.php" for versions of Chilkat < 10.0.0
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
$http = new CkHttp();
// Use this online tool to generate code from sample JSON: Generate Code to Create JSON
// The following JSON is sent in the request body.
// {
// "key": "<string>",
// "value": "<object>"
// }
$json = new CkJsonObject();
$json->UpdateString('key','<string>');
$json->UpdateString('value','<object>');
// Adds the "Authorization: Bearer <access_token>" header.
$http->put_AuthToken('<access_token>');
$http->SetRequestHeader('Content-Type','application/json');
// resp is a CkHttpResponse
$resp = $http->PostJson3('https://your-domain.atlassian.net/wiki/rest/api/space/:spaceKey/property','application/json',$json);
if ($http->get_LastMethodSuccess() == false) {
print $http->lastErrorText() . "\n";
exit;
}
$sbResponseBody = new CkStringBuilder();
$resp->GetBodySb($sbResponseBody);
$jResp = new CkJsonObject();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(false);
print 'Response Body:' . "\n";
print $jResp->emit() . "\n";
$respStatusCode = $resp->get_StatusCode();
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
print 'Response Header:' . "\n";
print $resp->header() . "\n";
print 'Failed.' . "\n";
exit;
}
// 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
$id = $jResp->IntOf('id');
$key = $jResp->stringOf('key');
$Version = $jResp->stringOf('_expandable.version');
$Space = $jResp->stringOf('_expandable.space');
$When = $jResp->stringOf('version.when');
$Message = $jResp->stringOf('version.message');
$v_Number = $jResp->IntOf('version.number');
$MinorEdit = $jResp->BoolOf('version.minorEdit');
$Id = $jResp->IntOf('space.id');
$Key = $jResp->stringOf('space.key');
$Name = $jResp->stringOf('space.name');
$v_Type = $jResp->stringOf('space.type');
$Status = $jResp->stringOf('space.status');
$Settings = $jResp->stringOf('space._expandable.settings');
$Metadata = $jResp->stringOf('space._expandable.metadata');
$Operations = $jResp->stringOf('space._expandable.operations');
$LookAndFeel = $jResp->stringOf('space._expandable.lookAndFeel');
$Permissions = $jResp->stringOf('space._expandable.permissions');
$Icon = $jResp->stringOf('space._expandable.icon');
$Description = $jResp->stringOf('space._expandable.description');
$Theme = $jResp->stringOf('space._expandable.theme');
$History = $jResp->stringOf('space._expandable.history');
$Homepage = $jResp->stringOf('space._expandable.homepage');
$Path = $jResp->stringOf('space.icon.path');
$Width = $jResp->IntOf('space.icon.width');
$Height = $jResp->IntOf('space.icon.height');
$IsDefault = $jResp->BoolOf('space.icon.isDefault');
$Value = $jResp->stringOf('space.description.plain.value');
$Representation = $jResp->stringOf('space.description.plain.representation');
$ViewValue = $jResp->stringOf('space.description.view.value');
$ViewRepresentation = $jResp->stringOf('space.description.view.representation');
$HomepageValue = $jResp->stringOf('space.homepage.value');
$Start = $jResp->IntOf('space.metadata.labels.start');
$Limit = $jResp->IntOf('space.metadata.labels.limit');
$Size = $jResp->IntOf('space.metadata.labels.size');
$RouteOverrideEnabled = $jResp->BoolOf('space.settings.routeOverrideEnabled');
$Color = $jResp->stringOf('space.lookAndFeel.headings.color');
$LinksColor = $jResp->stringOf('space.lookAndFeel.links.color');
$HoverOrFocusValue = $jResp->stringOf('space.lookAndFeel.menus.hoverOrFocus.value');
$ColorValue = $jResp->stringOf('space.lookAndFeel.menus.color.value');
$BackgroundColorValue = $jResp->stringOf('space.lookAndFeel.header.backgroundColor.value');
$ButtonValue = $jResp->stringOf('space.lookAndFeel.header.button.value');
$PrimaryNavigationValue = $jResp->stringOf('space.lookAndFeel.header.primaryNavigation.value');
$SecondaryNavigationValue = $jResp->stringOf('space.lookAndFeel.header.secondaryNavigation.value');
$SearchValue = $jResp->stringOf('space.lookAndFeel.header.search.value');
$ScreenValue = $jResp->stringOf('space.lookAndFeel.content.screen.value');
$ContainerValue = $jResp->stringOf('space.lookAndFeel.content.container.value');
$HeaderValue = $jResp->stringOf('space.lookAndFeel.content.header.value');
$BodyValue = $jResp->stringOf('space.lookAndFeel.content.body.value');
$BordersAndDividersColor = $jResp->stringOf('space.lookAndFeel.bordersAndDividers.color');
$CreatedDate = $jResp->stringOf('space.history.createdDate');
$i = 0;
$count_i = $jResp->SizeOfArray('space.description.plain.embeddedContent');
while ($i < $count_i) {
$jResp->put_I($i);
$value = $jResp->stringOf('space.description.plain.embeddedContent[i].value');
$i = $i + 1;
}
$i = 0;
$count_i = $jResp->SizeOfArray('space.description.view.embeddedContent');
while ($i < $count_i) {
$jResp->put_I($i);
$value = $jResp->stringOf('space.description.view.embeddedContent[i].value');
$i = $i + 1;
}
$i = 0;
$count_i = $jResp->SizeOfArray('space.metadata.labels.results');
while ($i < $count_i) {
$jResp->put_I($i);
$value = $jResp->stringOf('space.metadata.labels.results[i].value');
$i = $i + 1;
}
$i = 0;
$count_i = $jResp->SizeOfArray('space.operations');
while ($i < $count_i) {
$jResp->put_I($i);
$operation = $jResp->stringOf('space.operations[i].operation');
$targetType = $jResp->stringOf('space.operations[i].targetType');
$i = $i + 1;
}
$i = 0;
$count_i = $jResp->SizeOfArray('space.permissions');
while ($i < $count_i) {
$jResp->put_I($i);
$v_expandableValue = $jResp->stringOf('space.permissions[i].subjects._expandable.value');
$UserValue = $jResp->stringOf('space.permissions[i].subjects.user.value');
$GroupValue = $jResp->stringOf('space.permissions[i].subjects.group.value');
$Operation = $jResp->stringOf('space.permissions[i].operation.operation');
$TargetType = $jResp->stringOf('space.permissions[i].operation.targetType');
$anonymousAccess = $jResp->BoolOf('space.permissions[i].anonymousAccess');
$unlicensedAccess = $jResp->BoolOf('space.permissions[i].unlicensedAccess');
$i = $i + 1;
}
?>
Curl Command
curl -X POST
-H "Authorization: Bearer <access_token>"
-H "Content-Type: application/json"
-d '{
"key": "<string>",
"value": "<object>"
}'
https://your-domain.atlassian.net/wiki/rest/api/space/:spaceKey/property
Postman Collection Item JSON
{
"name": "Create space property",
"request": {
"auth": {
"type": "oauth2"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"key\": \"<string>\",\n \"value\": \"<object>\"\n}"
},
"url": {
"raw": "{{baseUrl}}/api/space/:spaceKey/property",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"space",
":spaceKey",
"property"
],
"variable": [
{
"key": "spaceKey",
"value": "<string>",
"type": "string",
"description": "(Required) The key of the space that the property will be created in."
}
]
},
"description": "Creates a new space property.\n\n**[Permissions required](https://confluence.atlassian.com/x/_AozKw)**:\n‘Admin’ permission for the space."
},
"response": [
{
"name": "Returned if the space property is created.",
"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 \"key\": \"<string>\",\n \"value\": \"<object>\"\n}"
},
"url": {
"raw": "{{baseUrl}}/api/space/:spaceKey/property",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"space",
":spaceKey",
"property"
],
"variable": [
{
"key": "spaceKey"
}
]
}
},
"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- The space already has a value with the given key.\n- No property value was provided.",
"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 \"key\": \"<string>\",\n \"value\": \"<object>\"\n}"
},
"url": {
"raw": "{{baseUrl}}/api/space/:spaceKey/property",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"space",
":spaceKey",
"property"
],
"variable": [
{
"key": "spaceKey"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
},
{
"name": "Returned if the user does not have 'Admin' permission for the space.",
"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 \"key\": \"<string>\",\n \"value\": \"<object>\"\n}"
},
"url": {
"raw": "{{baseUrl}}/api/space/:spaceKey/property",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"space",
":spaceKey",
"property"
],
"variable": [
{
"key": "spaceKey"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
},
{
"name": "Returned if the value for the property is too long.",
"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 \"key\": \"<string>\",\n \"value\": \"<object>\"\n}"
},
"url": {
"raw": "{{baseUrl}}/api/space/:spaceKey/property",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"space",
":spaceKey",
"property"
],
"variable": [
{
"key": "spaceKey"
}
]
}
},
"status": "Request Entity Too Large",
"code": 413,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}
