Workspace

A workspace [Workspace] is a collection of documents, discussions and links.

XML

SOAP

REST

Database table

Object

Workspace

oaWorkspace

workspace

Supported Commands

Add, Read, Modify, Delete

add(), read(), modify(), upsert(), delete()

The Workspace object has the following standard properties:

Note:

Workspace object properties may also include custom fields. The object type supports the custom equal to read method and the enable_custom read attribute.

XML / SOAP

Database

Description

allow_guests

allow_guests

A 1/0 field indicating whether guests can be subscribed to this.

created

created

[Read-only] Time the record was created. See Date Fields.

date

date

[Required] The date of the workspace. See Date Fields.

description

description

The description of the workspace.

global

global

A 1/0 field indicating if this is a global workspace (available to all users). Must be set to 1 if global_access is not empty.

global_access

global_access

The access permissions for all users. Required if global is set to 1.

  • 'R' - Read-only

  • 'W' - Read/write

  • 'A' - Administrator

id

id

[Read-only] Unique ID. Automatically assigned by OpenAir.

name

name

[Required] The workspace name.

notes

notes

Notes.

open

open

A “1/0” field indicating whether this workspace is open.

updated

updated

[Read-only] Time the record was last updated or modified. See Date Fields.

userid

user_id

[Required] The user ID of the workspace owner. The user must exist, must not be marked as deleted, must be active and must not be a generic user.