Skip to content
MoltaroMoltaroMoltaro Docs

Resolve the first visible user menu for the current caller or null.

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

Resolved user menu block to prepend in the runtime navigation.

object
Id

Menu identifier.

string
nullable
Name

Menu display name.

string
nullable
Priority

Resolution priority.

integer format: int32
Items

Resolved visible nodes.

Array<object>
nullable

One resolved runtime-menu node for the runtime navigation.

object
Id

Stable node identifier.

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

Sibling sort order.

integer format: int32
Label

Default display label.

string
nullable
LabelTranslations

Label per language code; the client shows the viewer’s language and falls back to Label.

object
key
additional properties
string
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 HTTP(S) URL or app-relative path for external-link leaves.

string
nullable
PageCode

Registered stable 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
Children
Array<object> recursive
ModulePageRouteName

Backend-owned WebApp named route for an available module-page leaf.

string
nullable
ModulePageRouteParams

Route parameters of a target-bound module page, such as the opened Board.

object
key
additional properties
string
EntityListPageSurfaceKey

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

string
nullable
ModulePageRouteQuery

Query values of a target-bound module page, such as the selected report or dashboard.

object
key
additional properties
string
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
    }
  ]
}

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