← All resources

Resource

workspace_version

One immutable version of a workspace's definition. Versions form the authoring history; listWorkspaceVersions returns them newest first.

GraphQL reference →

Configuration

workspaceIdWorkspaceID!Required

TypeID of the workspace to add a version to (prefix wks).

References workspace

forces replacement

sourceStringRequired

Workspace source, including its document and server Lua.

/sourceXML: workspace_document fields

Open model reference →

The root element of a Workspace: a screen of panels that read and edit business data. It declares shared state, server Lua handlers, data sources and the layout.

object
childrenOptional
domainsOptional

Space-separated business domains the workspace relates to. They are hints and grant no permissions.

string
idRequired

Unique identifier: lowercase letters, digits and hyphens, starting with a letter.

string
Minimum length
1
roleRequired

The audience the workspace is for, such as Sales or Operations.

string
Minimum length
1
titleRequired

Heading shown to users.

string
Minimum length
1

Only the fields listed here are accepted.

forces replacement

Read-only values

Show values
idWorkspaceVersionID!Read only

TypeID of this immutable version record (prefix wsv, e.g. "wsv_01K…").

computed by the platform

versionInt!Read only

Sequential version number within the workspace, starting at 1 and incrementing per authored draft.

computed by the platform

statusWorkspaceStatus!Read only

DRAFT while this version is still being authored; PUBLISHED once publishWorkspace promotes it. Several DRAFT versions may be open at once — editing a workspace amends the newest, while createWorkspaceVersion always mints another — and publishing promotes the one it names, leaving the rest open.

Allowed values

DRAFT — An unpublished version; ordinary drafts are editable while IaC source snapshots are fixed. Never served to runners. On the workspace record it means no published version exists yet.

PUBLISHED — An immutable, live version — the only status runners fetch. On the workspace record it means a live published version exists, even when a newer draft is open beside it.

computed by the platform

definitionString!Read only

Internal compiled rendering contract.

computed by the platform

createdAtISO8601!Read only

ISO-8601 timestamp when this version was authored (not when it was published).

computed by the platform

Lifecycle

The CLI can create this resource. The platform assigns its id.

When replacement is needed, the replacement is created before the existing resource is removed.