Chilkat Online Tools

PureBasic / Atlassian Confluence Cloud / Get space properties

Back to Collection Items

IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"

Procedure ChilkatExample()

    ; This example assumes the Chilkat API to have been previously unlocked.
    ; See Global Unlock Sample for sample code.

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i

    queryParams.i = CkJsonObject::ckCreate()
    If queryParams.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckUpdateString(queryParams,"expand","<string>")
    CkJsonObject::ckUpdateString(queryParams,"expand","<string>")
    CkJsonObject::ckUpdateInt(queryParams,"start",0)
    CkJsonObject::ckUpdateInt(queryParams,"limit",10)

    ; Adds the "Authorization: Bearer <access_token>" header.
    CkHttp::setCkAuthToken(http, "<access_token>")

    resp.i = CkHttp::ckQuickRequestParams(http,"GET","https://your-domain.atlassian.net/wiki/rest/api/space/:spaceKey/property",queryParams)
    If CkHttp::ckLastMethodSuccess(http) = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(queryParams)
        ProcedureReturn
    EndIf

    sbResponseBody.i = CkStringBuilder::ckCreate()
    If sbResponseBody.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkHttpResponse::ckGetBodySb(resp,sbResponseBody)

    jResp.i = CkJsonObject::ckCreate()
    If jResp.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckLoadSb(jResp,sbResponseBody)
    CkJsonObject::setCkEmitCompact(jResp, 0)

    Debug "Response Body:"
    Debug CkJsonObject::ckEmit(jResp)

    respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
    Debug "Response Status Code = " + Str(respStatusCode)
    If respStatusCode >= 400
        Debug "Response Header:"
        Debug CkHttpResponse::ckHeader(resp)
        Debug "Failed."
        CkHttpResponse::ckDispose(resp)

        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(queryParams)
        CkStringBuilder::ckDispose(sbResponseBody)
        CkJsonObject::ckDispose(jResp)
        ProcedureReturn
    EndIf

    CkHttpResponse::ckDispose(resp)

    ; Sample JSON response:
    ; (Sample code for parsing the JSON response is shown below)

    ; {
    ;   "results": [
    ;     {
    ;       "id": 19427264,
    ;       "key": "id non",
    ;       "value": {},
    ;       "_expandable": {
    ;         "version": "aute culpa",
    ;         "space": "sit fugiat"
    ;       },
    ;       "version": {
    ;         "when": "1988-02-08T03:27:37.011Z",
    ;         "message": "velit aliqua labore incididunt",
    ;         "number": -41582376,
    ;         "minorEdit": false
    ;       },
    ;       "space": {
    ;         "id": 20731255,
    ;         "key": "ut",
    ;         "name": "do aliqua laboris eiusmod",
    ;         "type": "exercitation id",
    ;         "status": "consectetur ullamco",
    ;         "_expandable": {
    ;           "settings": "sint",
    ;           "metadata": "quis non",
    ;           "operations": "dolor in cillum",
    ;           "lookAndFeel": "tempor qui",
    ;           "permissions": "Duis veniam mollit nisi",
    ;           "icon": "culpa est",
    ;           "description": "ex sunt labore id",
    ;           "theme": "id minim",
    ;           "history": "inci",
    ;           "homepage": "occaecat in dolor quis"
    ;         },
    ;         "_links": {},
    ;         "icon": {
    ;           "path": "nisi non esse culpa",
    ;           "width": 99533791,
    ;           "height": -28134599,
    ;           "isDefault": true
    ;         },
    ;         "description": {
    ;           "plain": {
    ;             "value": "dolor proident ut 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": "consequat",
    ;             "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": -59083965,
    ;             "limit": 75849140,
    ;             "size": 92184684,
    ;             "_links": {}
    ;           }
    ;         },
    ;         "operations": [
    ;           {
    ;             "operation": "restore",
    ;             "targetType": "attachment"
    ;           },
    ;           {
    ;             "operation": "export",
    ;             "targetType": "application"
    ;           }
    ;         ],
    ;         "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": "create",
    ;               "targetType": "space"
    ;             },
    ;             "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": "delete",
    ;               "targetType": "space"
    ;             },
    ;             "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": "2003-06-18T11:28:40.383Z"
    ;         }
    ;       }
    ;     },
    ;     {
    ;       "id": 50590702,
    ;       "key": "minim adipisicing mollit ut",
    ;       "value": {},
    ;       "_expandable": {
    ;         "version": "sed ad el",
    ;         "space": "pariatur deserunt in labore aliquip"
    ;       },
    ;       "version": {
    ;         "when": "1970-01-13T15:48:59.108Z",
    ;         "message": "in mollit pariatur",
    ;         "number": -34696343,
    ;         "minorEdit": false
    ;       },
    ;       "space": {
    ;         "id": 2257956,
    ;         "key": "deserunt ",
    ;         "name": "pariatur",
    ;         "type": "mollit dolore",
    ;         "status": "voluptate o",
    ;         "_expandable": {
    ;           "settings": "dolor officia",
    ;           "metadata": "nostrud proident qui",
    ;           "operations": "dolore",
    ;           "lookAndFeel": "ex",
    ;           "permissions": "et ea ad do",
    ;           "icon": "ea anim laborum",
    ;           "description": "nostrud n",
    ;           "theme": "est irure proident",
    ;           "history": "aute magna",
    ;           "homepage": "voluptate labore"
    ;         },
    ;         "_links": {},
    ;         "icon": {
    ;           "path": "ex consectetur",
    ;           "width": -6687916,
    ;           "height": 6284709,
    ;           "isDefault": false
    ;         },
    ;         "description": {
    ;           "plain": {
    ;             "value": "magna",
    ;             "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": "mollit",
    ;             "representation": "view",
    ;             "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": 31563568,
    ;             "limit": 7437848,
    ;             "size": -50600293,
    ;             "_links": {}
    ;           }
    ;         },
    ;         "operations": [
    ;           {
    ;             "operation": "export",
    ;             "targetType": "application"
    ;           },
    ;           {
    ;             "operation": "read",
    ;             "targetType": "blogpost"
    ;           }
    ;         ],
    ;         "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": "delete",
    ;               "targetType": "attachment"
    ;             },
    ;             "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": "purge",
    ;               "targetType": "space"
    ;             },
    ;             "anonymousAccess": false,
    ;             "unlicensedAccess": false
    ;           }
    ;         ],
    ;         "settings": {
    ;           "routeOverrideEnabled": true,
    ;           "_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": "1946-10-24T07:33:44.994Z"
    ;         }
    ;       }
    ;     }
    ;   ],
    ;   "start": -871862,
    ;   "limit": -29998484,
    ;   "size": 16090591,
    ;   "_links": {}
    ; }

    ; Sample code for parsing the JSON response...
    ; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

    id.i
    key.s
    Version.s
    Space.s
    When.s
    Message.s
    v_Number.i
    MinorEdit.i
    Id.i
    Key.s
    Name.s
    v_Type.s
    Status.s
    Settings.s
    Metadata.s
    Operations.s
    LookAndFeel.s
    Permissions.s
    Icon.s
    Description.s
    Theme.s
    History.s
    Homepage.s
    Path.s
    Width.i
    Height.i
    IsDefault.i
    Value.s
    Representation.s
    ViewValue.s
    ViewRepresentation.s
    HomepageValue.s
    Start.i
    Limit.i
    Size.i
    RouteOverrideEnabled.i
    Color.s
    LinksColor.s
    HoverOrFocusValue.s
    ColorValue.s
    BackgroundColorValue.s
    ButtonValue.s
    PrimaryNavigationValue.s
    SecondaryNavigationValue.s
    SearchValue.s
    ScreenValue.s
    ContainerValue.s
    HeaderValue.s
    BodyValue.s
    BordersAndDividersColor.s
    CreatedDate.s
    j.i
    count_j.i
    value.s
    operation.s
    targetType.s
    v_expandableValue.s
    UserValue.s
    GroupValue.s
    Operation.s
    TargetType.s
    anonymousAccess.i
    unlicensedAccess.i

    start.i = CkJsonObject::ckIntOf(jResp,"start")
    limit.i = CkJsonObject::ckIntOf(jResp,"limit")
    size.i = CkJsonObject::ckIntOf(jResp,"size")
    i.i = 0
    count_i.i = CkJsonObject::ckSizeOfArray(jResp,"results")
    While i < count_i
        CkJsonObject::setCkI(jResp, i)
        id = CkJsonObject::ckIntOf(jResp,"results[i].id")
        key = CkJsonObject::ckStringOf(jResp,"results[i].key")
        Version = CkJsonObject::ckStringOf(jResp,"results[i]._expandable.version")
        Space = CkJsonObject::ckStringOf(jResp,"results[i]._expandable.space")
        When = CkJsonObject::ckStringOf(jResp,"results[i].version.when")
        Message = CkJsonObject::ckStringOf(jResp,"results[i].version.message")
        v_Number = CkJsonObject::ckIntOf(jResp,"results[i].version.number")
        MinorEdit = CkJsonObject::ckBoolOf(jResp,"results[i].version.minorEdit")
        Id = CkJsonObject::ckIntOf(jResp,"results[i].space.id")
        Key = CkJsonObject::ckStringOf(jResp,"results[i].space.key")
        Name = CkJsonObject::ckStringOf(jResp,"results[i].space.name")
        v_Type = CkJsonObject::ckStringOf(jResp,"results[i].space.type")
        Status = CkJsonObject::ckStringOf(jResp,"results[i].space.status")
        Settings = CkJsonObject::ckStringOf(jResp,"results[i].space._expandable.settings")
        Metadata = CkJsonObject::ckStringOf(jResp,"results[i].space._expandable.metadata")
        Operations = CkJsonObject::ckStringOf(jResp,"results[i].space._expandable.operations")
        LookAndFeel = CkJsonObject::ckStringOf(jResp,"results[i].space._expandable.lookAndFeel")
        Permissions = CkJsonObject::ckStringOf(jResp,"results[i].space._expandable.permissions")
        Icon = CkJsonObject::ckStringOf(jResp,"results[i].space._expandable.icon")
        Description = CkJsonObject::ckStringOf(jResp,"results[i].space._expandable.description")
        Theme = CkJsonObject::ckStringOf(jResp,"results[i].space._expandable.theme")
        History = CkJsonObject::ckStringOf(jResp,"results[i].space._expandable.history")
        Homepage = CkJsonObject::ckStringOf(jResp,"results[i].space._expandable.homepage")
        Path = CkJsonObject::ckStringOf(jResp,"results[i].space.icon.path")
        Width = CkJsonObject::ckIntOf(jResp,"results[i].space.icon.width")
        Height = CkJsonObject::ckIntOf(jResp,"results[i].space.icon.height")
        IsDefault = CkJsonObject::ckBoolOf(jResp,"results[i].space.icon.isDefault")
        Value = CkJsonObject::ckStringOf(jResp,"results[i].space.description.plain.value")
        Representation = CkJsonObject::ckStringOf(jResp,"results[i].space.description.plain.representation")
        ViewValue = CkJsonObject::ckStringOf(jResp,"results[i].space.description.view.value")
        ViewRepresentation = CkJsonObject::ckStringOf(jResp,"results[i].space.description.view.representation")
        HomepageValue = CkJsonObject::ckStringOf(jResp,"results[i].space.homepage.value")
        Start = CkJsonObject::ckIntOf(jResp,"results[i].space.metadata.labels.start")
        Limit = CkJsonObject::ckIntOf(jResp,"results[i].space.metadata.labels.limit")
        Size = CkJsonObject::ckIntOf(jResp,"results[i].space.metadata.labels.size")
        RouteOverrideEnabled = CkJsonObject::ckBoolOf(jResp,"results[i].space.settings.routeOverrideEnabled")
        Color = CkJsonObject::ckStringOf(jResp,"results[i].space.lookAndFeel.headings.color")
        LinksColor = CkJsonObject::ckStringOf(jResp,"results[i].space.lookAndFeel.links.color")
        HoverOrFocusValue = CkJsonObject::ckStringOf(jResp,"results[i].space.lookAndFeel.menus.hoverOrFocus.value")
        ColorValue = CkJsonObject::ckStringOf(jResp,"results[i].space.lookAndFeel.menus.color.value")
        BackgroundColorValue = CkJsonObject::ckStringOf(jResp,"results[i].space.lookAndFeel.header.backgroundColor.value")
        ButtonValue = CkJsonObject::ckStringOf(jResp,"results[i].space.lookAndFeel.header.button.value")
        PrimaryNavigationValue = CkJsonObject::ckStringOf(jResp,"results[i].space.lookAndFeel.header.primaryNavigation.value")
        SecondaryNavigationValue = CkJsonObject::ckStringOf(jResp,"results[i].space.lookAndFeel.header.secondaryNavigation.value")
        SearchValue = CkJsonObject::ckStringOf(jResp,"results[i].space.lookAndFeel.header.search.value")
        ScreenValue = CkJsonObject::ckStringOf(jResp,"results[i].space.lookAndFeel.content.screen.value")
        ContainerValue = CkJsonObject::ckStringOf(jResp,"results[i].space.lookAndFeel.content.container.value")
        HeaderValue = CkJsonObject::ckStringOf(jResp,"results[i].space.lookAndFeel.content.header.value")
        BodyValue = CkJsonObject::ckStringOf(jResp,"results[i].space.lookAndFeel.content.body.value")
        BordersAndDividersColor = CkJsonObject::ckStringOf(jResp,"results[i].space.lookAndFeel.bordersAndDividers.color")
        CreatedDate = CkJsonObject::ckStringOf(jResp,"results[i].space.history.createdDate")
        j = 0
        count_j = CkJsonObject::ckSizeOfArray(jResp,"results[i].space.description.plain.embeddedContent")
        While j < count_j
            CkJsonObject::setCkJ(jResp, j)
            value = CkJsonObject::ckStringOf(jResp,"results[i].space.description.plain.embeddedContent[j].value")
            j = j + 1
        Wend
        j = 0
        count_j = CkJsonObject::ckSizeOfArray(jResp,"results[i].space.description.view.embeddedContent")
        While j < count_j
            CkJsonObject::setCkJ(jResp, j)
            value = CkJsonObject::ckStringOf(jResp,"results[i].space.description.view.embeddedContent[j].value")
            j = j + 1
        Wend
        j = 0
        count_j = CkJsonObject::ckSizeOfArray(jResp,"results[i].space.metadata.labels.results")
        While j < count_j
            CkJsonObject::setCkJ(jResp, j)
            value = CkJsonObject::ckStringOf(jResp,"results[i].space.metadata.labels.results[j].value")
            j = j + 1
        Wend
        j = 0
        count_j = CkJsonObject::ckSizeOfArray(jResp,"results[i].space.operations")
        While j < count_j
            CkJsonObject::setCkJ(jResp, j)
            operation = CkJsonObject::ckStringOf(jResp,"results[i].space.operations[j].operation")
            targetType = CkJsonObject::ckStringOf(jResp,"results[i].space.operations[j].targetType")
            j = j + 1
        Wend
        j = 0
        count_j = CkJsonObject::ckSizeOfArray(jResp,"results[i].space.permissions")
        While j < count_j
            CkJsonObject::setCkJ(jResp, j)
            v_expandableValue = CkJsonObject::ckStringOf(jResp,"results[i].space.permissions[j].subjects._expandable.value")
            UserValue = CkJsonObject::ckStringOf(jResp,"results[i].space.permissions[j].subjects.user.value")
            GroupValue = CkJsonObject::ckStringOf(jResp,"results[i].space.permissions[j].subjects.group.value")
            Operation = CkJsonObject::ckStringOf(jResp,"results[i].space.permissions[j].operation.operation")
            TargetType = CkJsonObject::ckStringOf(jResp,"results[i].space.permissions[j].operation.targetType")
            anonymousAccess = CkJsonObject::ckBoolOf(jResp,"results[i].space.permissions[j].anonymousAccess")
            unlicensedAccess = CkJsonObject::ckBoolOf(jResp,"results[i].space.permissions[j].unlicensedAccess")
            j = j + 1
        Wend
        i = i + 1
    Wend


    CkHttp::ckDispose(http)
    CkJsonObject::ckDispose(queryParams)
    CkStringBuilder::ckDispose(sbResponseBody)
    CkJsonObject::ckDispose(jResp)


    ProcedureReturn
EndProcedure

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": ""
    }
  ]
}