Space Fields


To fetch metadata of Space object send a GET request to:

https://api.assembla.com/v1/meta/spaces.(json|xml)

example. request json with curl utility:

curl -H "authorization: bearer _token" https://api.assembla.com/v1/meta/spaces.json

example. request xml with curl utility:

curl -H "authorization: bearer _token" https://api.assembla.com/v1/meta/spaces.xml

table below is the list of fields contained in the response, this list will be properly formatted to json or xml as requested.

Fields

Param Data type Access Description
id string read Space identifier
name string read/write Space name
description string read/write Space description
wiki_name string read/write Wiki name of the space, it can be also used as space identifier, this field is required. If name is set it can be skipped wiki_name is calculated from space name.
Note: If a repository tool is installed on space a validation error will be thrown on wiki name update.
public_permissions integer read/write Public permissions for space, possible values are:
  • 0, non space members have no access to space(available for commercial spaces only)
  • 1, non space members have access to view the space
team_permissions integer read/write Permissions for space members, possible values are:
  • 1, space members have access to view the space
  • 2, space members have access to edit the space
  • 3, space members have all permissions
watcher_permissions integer read/write Permissions for watchers, possible values are:
  • 1, watchers have access to view the space
Only one option is available and it is the default.
share_permissions boolean read/write Permissions to share space team with another spaces, default is true
team_tab_role integer read/write permissions to team tab, possible values are:
  • 0, team tab is available to anyone, even non space members
  • 10, team tab is available to watchers and users with heigher permissions
  • 50, team tab is available to space members and users with heigher permissions
  • 90, team tab is available to owners only
created_at datetime read Date and time when space was created
updated_at datetime read Date and time when space was updated last time
default_showpage string read/write Tab name value, when accessing the space this is default page users will be redirected to
tabs_order array(on write)/text(on read) read/write An array of ordered space tools names, modify this field to change the order
parent_id string read Id of portfolio space is attached to
restricted boolean read Available to commercial spaces, if commercial plan expires, this flag will be set to true and restricted the space
restricted_date date read Date when space was restricted
commercial_from datetime read Date and time when space became commercial
banner string read/write URL to image for space custom banner
banner_height integer read/write Height of image banner in pixels
banner_text string read/write If no image banner is used a text alternative is displayed, this text is not show otherwise
banner_link string read/write Add a link to the banner and make it clickable
style text read/write Space custom css styles, read more about custom styling here
status integer read/write Space status in a portfolio, available values are:
  • 0, Proposed
  • 1, Active
  • 2, Archived
  • 3, Proposed
  • 4, Shared
approved boolean read/write If true, space can be used as a copy template
is_manager boolean read If true, space has a manager subscription
is_volunteer boolean read If true, space is marked as volunteer
is_commercial boolean read If true, space is marked as commercial
can_join boolean write If true, any user can join and any member can invite new members.
last_payer_changed_at date read Date when last payer was changed

Validations

Field Validator Description
wiki_name format validator Validates the format of wiki name on space creation or update, for a regexp and details request spaces meta information.
wiki_name uniqueness validator Wiki name should be unique, case insensitive.
name format validator Validates the format of name on space creation or update, for a regexp and details request spaces meta information.
name presence validator Name should be present.
description length validator Description must be less than 200 characters, blank description is allowed.
public_permissions inclusion validator Value should be in range 0 to 2.
team_permissions inclusion validator Value should be in range 0 to 3.