Skip to content

List registered built-in module pages for user-menu configuration.

GET
/api/workspace/admin/runtime-menus/module-pages
curl --request GET \
--url https://example.com/api/workspace/admin/runtime-menus/module-pages

Known pages remain in the catalog while their owning module is disabled. Such pages may be saved but are unavailable at runtime until the module is enabled.

  • None
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
Array<object>
nullable

One built-in module page available for Runtime Menu configuration.

object
PageCode

Stable page code stored by Runtime Menu configuration.

string
nullable
DisplayName

Localized page display name.

string
nullable
Icon

MDI icon name.

string
nullable
SortOrder

Display order inside the owning module.

integer format: int32
ModuleKey

Owning module key.

string
nullable
RouteName

WebApp named-route contract returned by runtime resolution.

string
nullable
IsModuleEnabled

Whether the owning module is enabled.

boolean
IsAvailable

Whether the page can currently resolve at runtime.

boolean
RequiredPermissions

Static workspace permission prerequisites.

Array<string>
nullable
IsDeprecated

Whether this stable page code is deprecated.

boolean
ReplacementPageCode

Optional stable replacement page code.

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