Workspace

A workspace is a symbolic link to a directory.

The Public Documents directory, Data360 Nodes directory, and each user’s My Documents directory have workspace references. In addition each user’s temporary directory has a workspace reference. The temporary directory stores temporal data such as unsaved edit sessions. See user preferences for details about identifying a user’s workspaces.

In addition, system-generated workspaces are used to store core data such as Lavastorm nodes.

Get a list of workspaces

GET request returns the list of workspaces.

Path Parameters

None

Request Parameters

Parameter Description

Parameter	Description
`container`	The container locator of the requested workspaces.
`fields`	Specifies the fields to return in the response. One or more of `objects` or `metadata`. Defaults to `objects`
`filter`	An optional FIQL filter expression. Supports searching by the 'name' attribute. For example `filter=name=='Object Name'`
`ltk`	The authentication token.

container

The container locator of the requested workspaces.

fields

Specifies the fields to return in the response. One or more of objects or metadata. Defaults to objects

filter

An optional FIQL filter expression. Supports searching by the 'name' attribute. For example filter=name=='Object Name'

ltk

The authentication token.

Response Fields

Path Type Description

Path	Type	Description
`data.objects[].locator`	`String`	The object resource locator of the requested workspace.
`status`	`String`	Status of the response. One of: `OK`, `ERROR`, `SKIPPED` or `ASYNC`
`data.objects[].object.id`	`String`	The identity of the workspace. It must be unique and will be allocated if not specified at creation.
`data.objects[].object.name`	`String`	The name of the workspace.
`data.objects[].object.directory`	`String`	The directory that the workspace references.

data.objects[].locator

String

The object resource locator of the requested workspace.

status

String

Status of the response. One of: OK, ERROR, SKIPPED or ASYNC

data.objects[].object.id

String

The identity of the workspace. It must be unique and will be allocated if not specified at creation.

data.objects[].object.name

String

The name of the workspace.

data.objects[].object.directory

String

The directory that the workspace references.

Example request

GET /api/v3/workspaces?container=object:!tenant:defaultTenant~directory:workspace-id&fields=object&filter=name%3D%3D'Workspace%20Name'&ltk=AUTHENTICATION_TOKEN HTTP/1.1
Host: localhost:8080

Example response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 761

{
  "status" : "OK",
  "data" : {
    "objects" : [ {
      "locator" : "object:!tenant:defaultTenant~directory:workspace-id~workspace:workspace-id-001",
      "object" : {
        "id" : "workspace-id-001",
        "name" : "First Workspace",
        "directory" : "object:!tenant:defaultTenant~directory:__Root__~directory:lavastorm~directory:directoryid",
        "description" : null
      }
    }, {
      "locator" : "object:!tenant:defaultTenant~directory:workspace-id~workspace:workspace-id-002",
      "object" : {
        "id" : "workspace-id-002",
        "name" : "Second Workspace",
        "directory" : "object:!tenant:defaultTenant~directory:__Root__~directory:lavastorm~directory:directoryid",
        "description" : null
      }
    } ]
  }
}