Back to Collection Items
load ./chilkat.dll
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
set 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.
# {
# "value": "<object>"
# }
set json [new_CkJsonObject]
CkJsonObject_UpdateString $json "value" "<object>"
# Adds the "Authorization: Bearer <access_token>" header.
CkHttp_put_AuthToken $http "<access_token>"
CkHttp_SetRequestHeader $http "Content-Type" "application/json"
# resp is a CkHttpResponse
set resp [CkHttp_PostJson3 $http "https://your-domain.atlassian.net/wiki/rest/api/space/:spaceKey/property/:key" "application/json" $json]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkJsonObject $json
exit
}
set sbResponseBody [new_CkStringBuilder]
CkHttpResponse_GetBodySb $resp $sbResponseBody
set jResp [new_CkJsonObject]
CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0
puts "Response Body:"
puts [CkJsonObject_emit $jResp]
set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
puts "Response Header:"
puts [CkHttpResponse_header $resp]
puts "Failed."
delete_CkHttpResponse $resp
delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
exit
}
delete_CkHttpResponse $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
set id [CkJsonObject_IntOf $jResp "id"]
set key [CkJsonObject_stringOf $jResp "key"]
set Version [CkJsonObject_stringOf $jResp "_expandable.version"]
set Space [CkJsonObject_stringOf $jResp "_expandable.space"]
set When [CkJsonObject_stringOf $jResp "version.when"]
set Message [CkJsonObject_stringOf $jResp "version.message"]
set v_Number [CkJsonObject_IntOf $jResp "version.number"]
set MinorEdit [CkJsonObject_BoolOf $jResp "version.minorEdit"]
set Id [CkJsonObject_IntOf $jResp "space.id"]
set Key [CkJsonObject_stringOf $jResp "space.key"]
set Name [CkJsonObject_stringOf $jResp "space.name"]
set v_Type [CkJsonObject_stringOf $jResp "space.type"]
set Status [CkJsonObject_stringOf $jResp "space.status"]
set Settings [CkJsonObject_stringOf $jResp "space._expandable.settings"]
set Metadata [CkJsonObject_stringOf $jResp "space._expandable.metadata"]
set Operations [CkJsonObject_stringOf $jResp "space._expandable.operations"]
set LookAndFeel [CkJsonObject_stringOf $jResp "space._expandable.lookAndFeel"]
set Permissions [CkJsonObject_stringOf $jResp "space._expandable.permissions"]
set Icon [CkJsonObject_stringOf $jResp "space._expandable.icon"]
set Description [CkJsonObject_stringOf $jResp "space._expandable.description"]
set Theme [CkJsonObject_stringOf $jResp "space._expandable.theme"]
set History [CkJsonObject_stringOf $jResp "space._expandable.history"]
set Homepage [CkJsonObject_stringOf $jResp "space._expandable.homepage"]
set Path [CkJsonObject_stringOf $jResp "space.icon.path"]
set Width [CkJsonObject_IntOf $jResp "space.icon.width"]
set Height [CkJsonObject_IntOf $jResp "space.icon.height"]
set IsDefault [CkJsonObject_BoolOf $jResp "space.icon.isDefault"]
set Value [CkJsonObject_stringOf $jResp "space.description.plain.value"]
set Representation [CkJsonObject_stringOf $jResp "space.description.plain.representation"]
set ViewValue [CkJsonObject_stringOf $jResp "space.description.view.value"]
set ViewRepresentation [CkJsonObject_stringOf $jResp "space.description.view.representation"]
set HomepageValue [CkJsonObject_stringOf $jResp "space.homepage.value"]
set Start [CkJsonObject_IntOf $jResp "space.metadata.labels.start"]
set Limit [CkJsonObject_IntOf $jResp "space.metadata.labels.limit"]
set Size [CkJsonObject_IntOf $jResp "space.metadata.labels.size"]
set RouteOverrideEnabled [CkJsonObject_BoolOf $jResp "space.settings.routeOverrideEnabled"]
set Color [CkJsonObject_stringOf $jResp "space.lookAndFeel.headings.color"]
set LinksColor [CkJsonObject_stringOf $jResp "space.lookAndFeel.links.color"]
set HoverOrFocusValue [CkJsonObject_stringOf $jResp "space.lookAndFeel.menus.hoverOrFocus.value"]
set ColorValue [CkJsonObject_stringOf $jResp "space.lookAndFeel.menus.color.value"]
set BackgroundColorValue [CkJsonObject_stringOf $jResp "space.lookAndFeel.header.backgroundColor.value"]
set ButtonValue [CkJsonObject_stringOf $jResp "space.lookAndFeel.header.button.value"]
set PrimaryNavigationValue [CkJsonObject_stringOf $jResp "space.lookAndFeel.header.primaryNavigation.value"]
set SecondaryNavigationValue [CkJsonObject_stringOf $jResp "space.lookAndFeel.header.secondaryNavigation.value"]
set SearchValue [CkJsonObject_stringOf $jResp "space.lookAndFeel.header.search.value"]
set ScreenValue [CkJsonObject_stringOf $jResp "space.lookAndFeel.content.screen.value"]
set ContainerValue [CkJsonObject_stringOf $jResp "space.lookAndFeel.content.container.value"]
set HeaderValue [CkJsonObject_stringOf $jResp "space.lookAndFeel.content.header.value"]
set BodyValue [CkJsonObject_stringOf $jResp "space.lookAndFeel.content.body.value"]
set BordersAndDividersColor [CkJsonObject_stringOf $jResp "space.lookAndFeel.bordersAndDividers.color"]
set CreatedDate [CkJsonObject_stringOf $jResp "space.history.createdDate"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "space.description.plain.embeddedContent"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set value [CkJsonObject_stringOf $jResp "space.description.plain.embeddedContent[i].value"]
set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "space.description.view.embeddedContent"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set value [CkJsonObject_stringOf $jResp "space.description.view.embeddedContent[i].value"]
set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "space.metadata.labels.results"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set value [CkJsonObject_stringOf $jResp "space.metadata.labels.results[i].value"]
set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "space.operations"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set operation [CkJsonObject_stringOf $jResp "space.operations[i].operation"]
set targetType [CkJsonObject_stringOf $jResp "space.operations[i].targetType"]
set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "space.permissions"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set v_expandableValue [CkJsonObject_stringOf $jResp "space.permissions[i].subjects._expandable.value"]
set UserValue [CkJsonObject_stringOf $jResp "space.permissions[i].subjects.user.value"]
set GroupValue [CkJsonObject_stringOf $jResp "space.permissions[i].subjects.group.value"]
set Operation [CkJsonObject_stringOf $jResp "space.permissions[i].operation.operation"]
set TargetType [CkJsonObject_stringOf $jResp "space.permissions[i].operation.targetType"]
set anonymousAccess [CkJsonObject_BoolOf $jResp "space.permissions[i].anonymousAccess"]
set unlicensedAccess [CkJsonObject_BoolOf $jResp "space.permissions[i].unlicensedAccess"]
set i [expr $i + 1]
}
delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
Curl Command
curl -X POST
-H "Authorization: Bearer <access_token>"
-H "Content-Type: application/json"
-d '{
"value": "<object>"
}'
https://your-domain.atlassian.net/wiki/rest/api/space/:spaceKey/property/:key
Postman Collection Item JSON
{
"name": "Create space property for key",
"request": {
"auth": {
"type": "oauth2"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"value\": \"<object>\"\n}"
},
"url": {
"raw": "{{baseUrl}}/api/space/:spaceKey/property/:key",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"space",
":spaceKey",
"property",
":key"
],
"variable": [
{
"key": "spaceKey",
"value": "<string>",
"type": "string",
"description": "(Required) The key of the space that the property will be created in."
},
{
"key": "key",
"value": "<string>",
"type": "string",
"description": "(Required) The key of the property to be created."
}
]
},
"description": "Creates a new space property. This is the same as `POST\n/api/space/{spaceKey}/property` but the key for the property is passed as a\npath parameter, rather than in the request body.\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 \"value\": \"<object>\"\n}"
},
"url": {
"raw": "{{baseUrl}}/api/space/:spaceKey/property/:key",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"space",
":spaceKey",
"property",
":key"
],
"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- 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 \"value\": \"<object>\"\n}"
},
"url": {
"raw": "{{baseUrl}}/api/space/:spaceKey/property/:key",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"space",
":spaceKey",
"property",
":key"
],
"variable": [
{
"key": "spaceKey"
},
{
"key": "key"
}
]
}
},
"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 the 'Admin' permission for the\nspace.",
"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 \"value\": \"<object>\"\n}"
},
"url": {
"raw": "{{baseUrl}}/api/space/:spaceKey/property/:key",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"space",
":spaceKey",
"property",
":key"
],
"variable": [
{
"key": "spaceKey"
},
{
"key": "key"
}
]
}
},
"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 \"value\": \"<object>\"\n}"
},
"url": {
"raw": "{{baseUrl}}/api/space/:spaceKey/property/:key",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"space",
":spaceKey",
"property",
":key"
],
"variable": [
{
"key": "spaceKey"
},
{
"key": "key"
}
]
}
},
"status": "Request Entity Too Large",
"code": 413,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}
