Back to Collection Items
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess
; 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>"
; }
$oJson = ObjCreate("Chilkat.JsonObject")
$oJson.UpdateString("key","<string>")
$oJson.UpdateString("value","<object>")
; Adds the "Authorization: Bearer <access_token>" header.
$oHttp.AuthToken = "<access_token>"
$oHttp.SetRequestHeader "Content-Type","application/json"
Local $oResp = $oHttp.PostJson3("https://your-domain.atlassian.net/wiki/rest/api/space/:spaceKey/property","application/json",$oJson)
If ($oHttp.LastMethodSuccess = False) Then
ConsoleWrite($oHttp.LastErrorText & @CRLF)
Exit
EndIf
$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$oResp.GetBodySb($oSbResponseBody)
$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False
ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)
Local $iRespStatusCode = $oResp.StatusCode
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
ConsoleWrite("Response Header:" & @CRLF)
ConsoleWrite($oResp.Header & @CRLF)
ConsoleWrite("Failed." & @CRLF)
Exit
EndIf
; 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
Local $sValue
Local $sOperation
Local $sTargetType
Local $sV_expandableValue
Local $sUserValue
Local $sGroupValue
Local $sOperation
Local $sTargetType
Local $bAnonymousAccess
Local $bUnlicensedAccess
Local $id = $oJResp.IntOf("id")
Local $sKey = $oJResp.StringOf("key")
Local $sVersion = $oJResp.StringOf("_expandable.version")
Local $sSpace = $oJResp.StringOf("_expandable.space")
Local $sWhen = $oJResp.StringOf("version.when")
Local $sMessage = $oJResp.StringOf("version.message")
Local $iV_Number = $oJResp.IntOf("version.number")
Local $bMinorEdit = $oJResp.BoolOf("version.minorEdit")
Local $iId = $oJResp.IntOf("space.id")
Local $sKey = $oJResp.StringOf("space.key")
Local $sName = $oJResp.StringOf("space.name")
Local $sV_Type = $oJResp.StringOf("space.type")
Local $sStatus = $oJResp.StringOf("space.status")
Local $sSettings = $oJResp.StringOf("space._expandable.settings")
Local $sMetadata = $oJResp.StringOf("space._expandable.metadata")
Local $sOperations = $oJResp.StringOf("space._expandable.operations")
Local $sLookAndFeel = $oJResp.StringOf("space._expandable.lookAndFeel")
Local $sPermissions = $oJResp.StringOf("space._expandable.permissions")
Local $sIcon = $oJResp.StringOf("space._expandable.icon")
Local $sDescription = $oJResp.StringOf("space._expandable.description")
Local $sTheme = $oJResp.StringOf("space._expandable.theme")
Local $sHistory = $oJResp.StringOf("space._expandable.history")
Local $sHomepage = $oJResp.StringOf("space._expandable.homepage")
Local $sPath = $oJResp.StringOf("space.icon.path")
Local $iWidth = $oJResp.IntOf("space.icon.width")
Local $iHeight = $oJResp.IntOf("space.icon.height")
Local $bIsDefault = $oJResp.BoolOf("space.icon.isDefault")
Local $sValue = $oJResp.StringOf("space.description.plain.value")
Local $sRepresentation = $oJResp.StringOf("space.description.plain.representation")
Local $sViewValue = $oJResp.StringOf("space.description.view.value")
Local $sViewRepresentation = $oJResp.StringOf("space.description.view.representation")
Local $sHomepageValue = $oJResp.StringOf("space.homepage.value")
Local $iStart = $oJResp.IntOf("space.metadata.labels.start")
Local $iLimit = $oJResp.IntOf("space.metadata.labels.limit")
Local $iSize = $oJResp.IntOf("space.metadata.labels.size")
Local $bRouteOverrideEnabled = $oJResp.BoolOf("space.settings.routeOverrideEnabled")
Local $sColor = $oJResp.StringOf("space.lookAndFeel.headings.color")
Local $sLinksColor = $oJResp.StringOf("space.lookAndFeel.links.color")
Local $sHoverOrFocusValue = $oJResp.StringOf("space.lookAndFeel.menus.hoverOrFocus.value")
Local $sColorValue = $oJResp.StringOf("space.lookAndFeel.menus.color.value")
Local $sBackgroundColorValue = $oJResp.StringOf("space.lookAndFeel.header.backgroundColor.value")
Local $sButtonValue = $oJResp.StringOf("space.lookAndFeel.header.button.value")
Local $sPrimaryNavigationValue = $oJResp.StringOf("space.lookAndFeel.header.primaryNavigation.value")
Local $sSecondaryNavigationValue = $oJResp.StringOf("space.lookAndFeel.header.secondaryNavigation.value")
Local $sSearchValue = $oJResp.StringOf("space.lookAndFeel.header.search.value")
Local $sScreenValue = $oJResp.StringOf("space.lookAndFeel.content.screen.value")
Local $sContainerValue = $oJResp.StringOf("space.lookAndFeel.content.container.value")
Local $sHeaderValue = $oJResp.StringOf("space.lookAndFeel.content.header.value")
Local $sBodyValue = $oJResp.StringOf("space.lookAndFeel.content.body.value")
Local $sBordersAndDividersColor = $oJResp.StringOf("space.lookAndFeel.bordersAndDividers.color")
Local $sCreatedDate = $oJResp.StringOf("space.history.createdDate")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("space.description.plain.embeddedContent")
While $i < $iCount_i
$oJResp.I = $i
$sValue = $oJResp.StringOf("space.description.plain.embeddedContent[i].value")
$i = $i + 1
Wend
$i = 0
$iCount_i = $oJResp.SizeOfArray("space.description.view.embeddedContent")
While $i < $iCount_i
$oJResp.I = $i
$sValue = $oJResp.StringOf("space.description.view.embeddedContent[i].value")
$i = $i + 1
Wend
$i = 0
$iCount_i = $oJResp.SizeOfArray("space.metadata.labels.results")
While $i < $iCount_i
$oJResp.I = $i
$sValue = $oJResp.StringOf("space.metadata.labels.results[i].value")
$i = $i + 1
Wend
$i = 0
$iCount_i = $oJResp.SizeOfArray("space.operations")
While $i < $iCount_i
$oJResp.I = $i
$sOperation = $oJResp.StringOf("space.operations[i].operation")
$sTargetType = $oJResp.StringOf("space.operations[i].targetType")
$i = $i + 1
Wend
$i = 0
$iCount_i = $oJResp.SizeOfArray("space.permissions")
While $i < $iCount_i
$oJResp.I = $i
$sV_expandableValue = $oJResp.StringOf("space.permissions[i].subjects._expandable.value")
$sUserValue = $oJResp.StringOf("space.permissions[i].subjects.user.value")
$sGroupValue = $oJResp.StringOf("space.permissions[i].subjects.group.value")
$sOperation = $oJResp.StringOf("space.permissions[i].operation.operation")
$sTargetType = $oJResp.StringOf("space.permissions[i].operation.targetType")
$bAnonymousAccess = $oJResp.BoolOf("space.permissions[i].anonymousAccess")
$bUnlicensedAccess = $oJResp.BoolOf("space.permissions[i].unlicensedAccess")
$i = $i + 1
Wend
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": ""
}
]
}
