confl_space {conflr}R Documentation

REST Wrapper for the SpaceService

Description

REST Wrapper for the SpaceService

Usage

confl_list_spaces(
  spaceKey = NULL,
  type = c("global", "personal"),
  status = c("current", "archived"),
  label = NULL,
  favourite = NULL,
  expand = NULL,
  start = NULL,
  limit = 25
)

confl_get_space(spaceKey, expand = NULL)

Arguments

spaceKey

The space key to find content under.

type

Filter the list of spaces returned by type (global, personal).

status

Filter the list of spaces returned by status (current, archived).

label

Filter the list of spaces returned by label.

favourite

Filter the list of spaces returned by favourites.

expand

A comma separated list of properties to expand. To refer the nested contents, use periods. (e.g. ⁠body.storage,history⁠).

start

The start point of the collection to return.

limit

The limit of the number of items to return, this may be restricted by fixed system limits.

Value

The API response as a list.

Examples

## Not run: 
# Get the information of a space named "space1"
confl_get_space("space1")

## End(Not run)


[Package conflr version 0.1.1 Index]