Skip to content

Return one configured user menu.

GET
/api/workspace/admin/runtime-menus/{runtimeMenuId}
curl --request GET \
--url https://example.com/api/workspace/admin/runtime-menus/example
  • None
runtimeMenuId
required
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

Full runtime-menu detail for admin editing.

object
Id

Menu identifier.

string
nullable
Name

Menu display name.

string
nullable
Description

Optional free-form description.

string
nullable
Priority

Resolution priority.

integer format: int32
RoleIds

Assigned role identifiers.

Array<string>
nullable
Items

Whole menu tree.

Array<object>
nullable

One runtime-menu node for admin read models.

object
Id

Node identifier.

string
nullable
Kind
integer format: int32
Allowed values: 0 1 2
SortOrder

Sibling sort order.

integer format: int32
Label

Display label.

string
nullable
Icon

MDI icon name.

string
nullable
LeafType
integer format: int32
Allowed values: 0 1 2 3 4 5
EntityDefinitionId

Target entity definition identifier.

string
nullable
Href

Absolute URL for external-link leaves.

string
nullable
PageCode

Frontend-owned page code for module-page leaves.

string
nullable
WorkspaceUiPageKey

Workspace UI page key for workspace-page leaves.

string
nullable
CatalogDefinitionId

Runtime Catalog Definition identifier for Catalog leaves.

string
nullable
RoleIds

Role identifiers that restrict visibility of this node and its descendants.

Array<string>
nullable
Children
Array<object> recursive
RowVersion

Concurrency token.

string format: uuid
EntityListPageSurfaceKey

Explicit entity-list page key, or null for the default page.

string
nullable
RowVersion

Concurrency token.

string format: uuid
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": {
"Items": [
{
"Kind": 0,
"LeafType": 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"
}

Not Found

Media typeapplication/json
object
Data

Full runtime-menu detail for admin editing.

object
Id

Menu identifier.

string
nullable
Name

Menu display name.

string
nullable
Description

Optional free-form description.

string
nullable
Priority

Resolution priority.

integer format: int32
RoleIds

Assigned role identifiers.

Array<string>
nullable
Items

Whole menu tree.

Array<object>
nullable

One runtime-menu node for admin read models.

object
Id

Node identifier.

string
nullable
Kind
integer format: int32
Allowed values: 0 1 2
SortOrder

Sibling sort order.

integer format: int32
Label

Display label.

string
nullable
Icon

MDI icon name.

string
nullable
LeafType
integer format: int32
Allowed values: 0 1 2 3 4 5
EntityDefinitionId

Target entity definition identifier.

string
nullable
Href

Absolute URL for external-link leaves.

string
nullable
PageCode

Frontend-owned page code for module-page leaves.

string
nullable
WorkspaceUiPageKey

Workspace UI page key for workspace-page leaves.

string
nullable
CatalogDefinitionId

Runtime Catalog Definition identifier for Catalog leaves.

string
nullable
RoleIds

Role identifiers that restrict visibility of this node and its descendants.

Array<string>
nullable
Children
Array<object> recursive
RowVersion

Concurrency token.

string format: uuid
EntityListPageSurfaceKey

Explicit entity-list page key, or null for the default page.

string
nullable
RowVersion

Concurrency token.

string format: uuid
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": {
"Items": [
{
"Kind": 0,
"LeafType": 0
}
]
},
"Errors": [
{
"Type": 0,
"Severity": 0
}
],
"Warnings": [
{
"Type": 0,
"Severity": 0
}
]
}