Skip to content

Return safe build-toolchain, runtime-contract, and optional artifact compatibility.

GET
/api/workspace/admin/ui-project/compatibility
curl --request GET \
--url https://example.com/api/workspace/admin/ui-project/compatibility
  • None
artifactId
string
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

Safe Workspace UI build-toolchain and runtime compatibility status.

object
IsBuildToolchainReady

Whether checks and builds can use the packaged offline toolchain.

boolean
IsRuntimeContractReady

Whether publication can validate the packaged browser runtime contract.

boolean
RuntimeIdentifier

Packaged toolchain runtime identifier.

string
nullable
NodeVersion

Packaged Node version.

string
nullable
HostContractVersion

Current Workspace UI host contract version.

integer format: int32
nullable
HostContractFingerprint

Current Workspace UI host contract fingerprint.

string
nullable
ToolchainFingerprint

Current offline toolchain fingerprint.

string
nullable
DependencyVersions

Current immutable dependency versions.

object
key
additional properties
string
Artifact

Compatibility and lifecycle readiness for one stored artifact.

object
ArtifactId

Artifact identifier.

string
nullable
IsCompatible

Whether the artifact matches the current browser runtime contract.

boolean
CanActivate

Whether the artifact can be activated now.

boolean
CanRollback

Whether the artifact can be restored now.

boolean
DiagnosticCode

Stable compatibility result code.

string
nullable
Diagnostics

Safe localized diagnostics.

Array<object>
nullable

One safe Workspace UI compatibility diagnostic.

object
Code

Stable diagnostic code without deployment details.

string
nullable
Message

Localized operator-facing message.

string
nullable
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
{
"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"
}

Not Found

Media typeapplication/json
object
Data

Safe Workspace UI build-toolchain and runtime compatibility status.

object
IsBuildToolchainReady

Whether checks and builds can use the packaged offline toolchain.

boolean
IsRuntimeContractReady

Whether publication can validate the packaged browser runtime contract.

boolean
RuntimeIdentifier

Packaged toolchain runtime identifier.

string
nullable
NodeVersion

Packaged Node version.

string
nullable
HostContractVersion

Current Workspace UI host contract version.

integer format: int32
nullable
HostContractFingerprint

Current Workspace UI host contract fingerprint.

string
nullable
ToolchainFingerprint

Current offline toolchain fingerprint.

string
nullable
DependencyVersions

Current immutable dependency versions.

object
key
additional properties
string
Artifact

Compatibility and lifecycle readiness for one stored artifact.

object
ArtifactId

Artifact identifier.

string
nullable
IsCompatible

Whether the artifact matches the current browser runtime contract.

boolean
CanActivate

Whether the artifact can be activated now.

boolean
CanRollback

Whether the artifact can be restored now.

boolean
DiagnosticCode

Stable compatibility result code.

string
nullable
Diagnostics

Safe localized diagnostics.

Array<object>
nullable

One safe Workspace UI compatibility diagnostic.

object
Code

Stable diagnostic code without deployment details.

string
nullable
Message

Localized operator-facing message.

string
nullable
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
{
"Errors": [
{
"Type": 0,
"Severity": 0
}
],
"Warnings": [
{
"Type": 0,
"Severity": 0
}
]
}