Workspace - Huddle/huddle-apis GitHub Wiki

Summary

Note: This document uses the /workspace API prefix. A newer /membership equivalent is also available — see Membership workspace.

Workspaces always contains a DocumentLibrary folder that is the root folder from which you can create new documents or folders.

Operations

Retrieving a Workspace

When accessing the User resource, the response will contain the list of workspaces of which the user is member of. Each workspace will advertise a self link, which you can use to GET the workspace. The workspace resource also contains links to the document library, workspace changes and workspace members (see membership).

Example

Request

GET /workspaces/27 HTTP/1.1
Accept: application/vnd.huddle.data+xml
Authorization: Bearer frootymcnooty/vonbootycherooty

Response

HTTP/1.1 200 OK
Content-Type: application/vnd.huddle.data+xml
<workspace xmlns="http://schema.huddle.net/2011/02/"
           title="Infinite improbability drive"
           description="Projects for stealing the infinite improbability drive"
           type="shared">

  <link rel="self" href="..." />
  <link rel="documentLibrary" href="..." />
  <link rel="changes" href="..." />
  <link rel="workspaceMembers" href="..." />
  <link rel="permissions" href="..." />
  <link rel="assignee-approvals" href="..." />

  <settings>
    <setting name="CanSync" value="true" />
    <setting name="IsManager" value="true" />
    <setting name="Status" value="Active" />
  </settings>

</workspace>

Retrieving a workspace calendar

IN PROGRESS

Syntax

Example

<workspace xmlns="http://schema.huddle.net/2011/02/"
           title="Title is mandatory"
           description="Description is optional"
           type="shared">

  <link rel="self" href="..." />
  <link rel="documentLibrary" href="..." />

  <settings>
    <setting name="CanSync" value="true" />
    <setting name="IsManager" value="true" />
    <setting name="Status" value="Active" />
  </settings>

</workspace>

Properties

Name Description
title Workspace title
description Longer description
type shared is the documented value
settings Workspace configuration settings

Workspace settings

Name Type Description
CanSync boolean Sync workspace content locally
IsManager boolean Current user is a workspace manager
Status string e.g. Active, Locked, Deleted, Archived

Link relations

Name Description Methods
self This workspace GET
documentLibrary Root document folder GET
permissions Workspace teams / permissions GET
assignee-approvals Assignee approvals in the workspace — Approvals by workspace GET

Schema

start = workspace

workspace = element h:workspace {
  attribute title {xsd:string},
  attribute description {xsd:string}?,
  link+,
  settings
}

settings = element h:settings {
  setting+
}

setting = element h:setting {
  attribute name { xsd:string },
  attribute value { xsd:string }
}

Related

⚠️ **GitHub.com Fallback** ⚠️