Skip to content

Return the controlled state and active immutable artifact descriptor.

GET
/api/workspace/ui-project/runtime
curl --request GET \
--url https://example.com/api/workspace/ui-project/runtime \
--header 'Authorization: Bearer <token>'
access_token
string

Optional access token for clients that cannot set Authorization headers. Prefer Authorization: Bearer <token> when possible.

OK

Media typeapplication/json
object
Data

Authenticated Workspace UI runtime descriptor.

object
FormatVersion

Descriptor format version.

integer format: int32
Status
integer format: int32
Allowed values: 0 1 2 3 4
DiagnosticCode

Optional safe machine-readable diagnostic code.

string
nullable
Artifact

Identity and compatibility metadata of the active Workspace UI artifact.

object
Id

Artifact identifier.

string
nullable
ArtifactHash

Combined JavaScript and CSS hash.

string
nullable
CompilationId

Content-derived compilation identifier.

string
nullable
SourceChecksum

Source revision checksum.

string
nullable
WebAppVersion

Moltaro release identity that produced the artifact.

string
nullable
HostContractVersion

Workspace UI host contract version.

integer format: int32
HostContractFingerprint

Workspace UI host contract fingerprint.

string
nullable
DependencyVersions

Pinned runtime dependency versions.

object
key
additional properties
string
JavaScript

One immutable Workspace UI browser asset.

object
Path

Root-relative content-addressed asset path.

string
nullable
ContentHash

Lowercase SHA-256 content hash.

string
nullable
Integrity

SHA-256 subresource integrity value.

string
nullable
SizeBytes

Asset size in bytes.

integer format: int64
Css

One immutable Workspace UI browser asset.

object
Path

Root-relative content-addressed asset path.

string
nullable
ContentHash

Lowercase SHA-256 content hash.

string
nullable
Integrity

SHA-256 subresource integrity value.

string
nullable
SizeBytes

Asset size in bytes.

integer format: int64
Pages

Pages exposed by the active artifact.

Array<object>
nullable

One page exposed by the active Workspace UI artifact.

object
Key

Stable page key.

string
nullable
TitleKey

Artifact-local title localization key.

string
nullable
Icon

MDI icon name.

string
nullable
Layout
integer format: int32
Allowed values: 0 1
RequiredPermissions

Permission keys required to render the page.

Array<string>
nullable
ScopeId

Deterministic page and overlay CSS scope.

string
nullable
Route

Runtime route metadata for one Workspace UI page.

object
Path

Normalized relative route pattern.

string
nullable
ParameterNames

Named required parameters in route order.

Array<string>
nullable
Locales

Locales embedded in the active artifact.

Array<object>
nullable

One locale embedded in the active Workspace UI artifact.

object
Locale

Supported locale code.

string
nullable
ContentHash

Locale source SHA-256 hash.

string
nullable
KeyCount

Flattened message key count.

integer format: int32
Components

Embeddable components exposed by the active artifact; empty when none are registered.

Array<object>
nullable

One embeddable component exposed by the active Workspace UI artifact.

object
Key

Stable component key.

string
nullable
TitleKey

Artifact-local title localization key.

string
nullable
Icon

MDI icon name.

string
nullable
Placements

Native placements the component supports.

Array<integer>
nullable
Allowed values: 0 1 2 3
RequiredPermissions

Permission keys required to render the component.

Array<string>
nullable
ScopeId

Deterministic component and overlay CSS scope.

string
nullable
FormBindings

Declared form bindings of a FormItem component; empty for other placements.

Array<object>
nullable

One form binding declared by an embeddable component for the FormItem placement.

object
Name

Binding name used as the key of the component’s form context; lowercase kebab-case.

string
nullable
FieldTypes

Entity field types Constructor may map to this binding.

Array<integer>
nullable
Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
Access
integer format: int32
Allowed values: 0 1
Optional

Whether Constructor may leave the binding unmapped.

boolean
Errors
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Warnings
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Success
boolean
Example
{
"Data": {
"Status": 0,
"Pages": [
{
"Layout": 0
}
],
"Components": [
{
"Placements": [
0
],
"FormBindings": [
{
"FieldTypes": [
0
],
"Access": 0
}
]
}
]
},
"Errors": [
{
"Type": 0,
"Severity": 0
}
],
"Warnings": [
{
"Type": 0,
"Severity": 0
}
]
}

Forbidden

Media typeapplication/json
object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
key
additional properties
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"instance": "example"
}