Resource
workspace_version
One immutable version of a workspace's definition. Versions form the authoring history; listWorkspaceVersions returns them newest first.
Configuration
workspaceIdWorkspaceID!RequiredTypeID of the workspace to add a version to (prefix wks).
References workspace
forces replacement
sourceStringRequiredWorkspace source, including its document and server Lua.
/sourceXML: workspace_document fields
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.
childrenOptional- Minimum items
0- Maximum items
9223372036854776000
List items
All of these apply
domainsOptionalSpace-separated business domains the workspace relates to. They are hints and grant no permissions.
idRequiredUnique identifier: lowercase letters, digits and hyphens, starting with a letter.
- Minimum length
1
roleRequiredThe audience the workspace is for, such as Sales or Operations.
- Minimum length
1
titleRequiredHeading shown to users.
- Minimum length
1
Only the fields listed here are accepted.
forces replacement
Read-only values
Show values
idWorkspaceVersionID!Read onlyTypeID of this immutable version record (prefix wsv, e.g. "wsv_01K…").
computed by the platform
versionInt!Read onlySequential version number within the workspace, starting at 1 and incrementing per authored draft.
computed by the platform
statusWorkspaceStatus!Read onlyDRAFT 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 onlyInternal compiled rendering contract.
computed by the platform
createdAtISO8601!Read onlyISO-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.