Skip to content
MoltaroMoltaroMoltaro Docs

Returns Work Schedule lifecycle and readiness.

GET
/api/workspace/admin/work-schedule
curl --request GET \
  --url https://example.com/api/workspace/admin/work-schedule \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
access_token
string

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

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
Data

Work Schedule module administration detail.

object
Summary

Work Schedule lifecycle summary.

object
ModuleKey
string
nullable
DisplayName
string
nullable
Description
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
nullable
AllowedActions

Allowed lifecycle actions for the current module state.

object
CanEnable
boolean
CanReconcileSecurity
boolean
CanDisable
boolean
Readiness

Capability-specific Work Schedule readiness.

object
IsOperationallyHealthy
boolean
IsFullyReady
boolean
Capabilities
Array<object>
nullable

Availability of one Work Schedule capability.

object
Key
string
nullable
IsAvailable
boolean
BlockerKeys
Array<string>
nullable
Prerequisites
Array<object>
nullable

State of one operational catalog or calendar prerequisite.

object
Key
string
nullable
State
string
nullable
EntityDefinitionId
string
nullable
SuggestedAction
string
nullable
Diagnostics
Array<object>
nullable

One machine-readable setup or drift diagnostic.

object
Code
string
nullable
FieldKey
string
nullable
Surface
string
nullable
OpenTarget

Safe named-route navigation target.

object
RouteName
string
nullable
Params
object
key
additional properties
string
Query
object
key
additional properties
string
AccessTarget

Safe named-route navigation target.

object
RouteName
string
nullable
Params
object
key
additional properties
string
Query
object
key
additional properties
string
HealthIssues
Array<object>
nullable

Operational Work Schedule health issue.

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

403

Section titled “403”

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"
}