Skip to content

List the module-owned records a target-bound module page can open, such as Boards for the one-Board page.

GET
/api/workspace/admin/runtime-menus/module-pages/{pageCode}/targets
curl --request GET \
--url https://example.com/api/workspace/admin/runtime-menus/module-pages/example/targets \
--header 'Authorization: Bearer <token>'

The list is for configuration and is not filtered by the configuring user’s access; runtime resolution hides targets the viewer cannot open.

pageCode
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
Array<object>
nullable

One module-owned record that a target-bound module page can open, such as one Board.

object
Id

Stable record identifier stored as the menu item page target.

string
nullable
DisplayName

Record display name.

string
nullable
Icon

Optional MDI icon suggested for the menu item.

string
nullable
IsAvailable

Whether viewers can open the record now, such as an active Board; items of an unavailable record stay hidden.

boolean
Key

Workspace-independent name of the record, such as a Board key; installation packages refer to the target by it.

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

Not Found

Media typeapplication/json
object
Data
Array<object>
nullable

One module-owned record that a target-bound module page can open, such as one Board.

object
Id

Stable record identifier stored as the menu item page target.

string
nullable
DisplayName

Record display name.

string
nullable
Icon

Optional MDI icon suggested for the menu item.

string
nullable
IsAvailable

Whether viewers can open the record now, such as an active Board; items of an unavailable record stay hidden.

boolean
Key

Workspace-independent name of the record, such as a Board key; installation packages refer to the target by it.

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