← All types
Ob Object

WorkspaceView

A published workspace as a renderer or menu reads it: no source, drafts or revision. Authoring uses the Workspace type.

Fields

id

WorkspaceID!Non-null

TypeID of the workspace (prefix wks).

handle

String!Non-null

The workspace's stable handle, unique within the tenant.

title

String!Non-null

Display title from the published definition, else the handle.

icon

StringNullable

Icon token from the published definition; null when it declares none.

Distribution scope: the caller's own PERSONAL workspace, a TEAM's, or the INSTANCE's.

Possible values (3)
PERSONAL

Owned by one user and visible only to them. Self-service: authoring it needs workspace:personal rather than workspace:write, and workspace:write is not a backdoor into someone else's personal workspace.

TEAM

Offered to the members of the teams it is assigned to; at least one team is required. Authoring it needs workspace:write.

INSTANCE

Offered to everyone in the tenant whose permissions cover its requiredDomains. The default scope when none is given; authoring it needs workspace:write.

TypeID of the published version served (prefix wsv); server handlers are invoked against it.

Compiled rendering contract of the published version; null when access.usable is false. Never submit it as authored source.

Whether the caller can open the workspace, and which domains are missing if not.

Referenced by (2)
Exact type SDL
"""
A published workspace as a renderer or menu reads it: no source, drafts or revision. Authoring uses the Workspace type.
"""
type WorkspaceView {
  """TypeID of the workspace (prefix `wks`)."""
  id: WorkspaceID!
  """The workspace's stable handle, unique within the tenant."""
  handle: String!
  """Display title from the published definition, else the handle."""
  title: String!
  """Icon token from the published definition; null when it declares none."""
  icon: String
  """
  Distribution scope: the caller's own PERSONAL workspace, a TEAM's, or the INSTANCE's.
  """
  scope: WorkspaceScope!
  """
  TypeID of the published version served (prefix `wsv`); server handlers are invoked against it.
  """
  versionId: WorkspaceVersionID!
  """
  Compiled rendering contract of the published version; null when access.usable is false. Never submit it as authored source.
  """
  definition: String
  """
  Whether the caller can open the workspace, and which domains are missing if not.
  """
  access: ViewAccess!
}