Skip to content

Reads lifecycle and readiness without creating configuration.

GET
/api/workspace/admin/workflow
curl --request GET \
--url https://example.com/api/workspace/admin/workflow \
--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

Installed Workflow foundation and current lifecycle.

object
Summary

Persisted lifecycle information and permitted state transitions.

object
ModuleKey
string
nullable
IsEnabled
boolean
ConfigurationState
integer format: int32
Allowed values: 0 1 2 3 4 5
EnabledAtUtc
string format: date-time
nullable
DisabledAtUtc
string format: date-time
nullable
DisabledReason
string
nullable
RowVersion
string format: uuid
AllowedActions

Actions supported by the current lifecycle state.

object
CanEnable
boolean
CanDisable
boolean
CanReconcileSecurity
boolean
Readiness

Readiness of the installed foundation, not process execution capability.

object
IsFullyReady
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": {
"Summary": {
"ConfigurationState": 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"
}