Skip to content
MoltaroMoltaroMoltaro Docs

List function-backed UI actions for an entity definition.

GET
/api/workspace/admin/entity-definitions/{entityDefinitionId}/ui/actions
curl --request GET \
  --url https://example.com/api/workspace/admin/entity-definitions/example/ui/actions

Authorizations

Section titled “Authorizations”
  • None

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
entityDefinitionId
required
string

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

Designer-owned action connecting a business function to a compatible UI surface context.

object
Id

Action identifier.

string
nullable
BusinessFunctionId

Bound business function identifier.

string
nullable
EntityDefinitionId

Entity definition identifier for entity-scoped action targets.

string
nullable
EntityUiSurfaceModelId

Entity UI surface model identifier when bound to a concrete surface.

string
nullable
Surface
integer format: int32
Allowed values: 0 1 2 3 4 5
ActionTargetScope
integer format: int32
Allowed values: 0 1 2 3
Placement
integer format: int32
Allowed values: 0 1 2
ToolbarPresentation
integer format: int32
Allowed values: 0 1
SortOrder

Action order within the placement.

integer format: int32
IsEnabled

Whether the binding is enabled.

boolean
Label

Optional label override.

string
nullable
Icon

Optional icon override.

string
nullable
Color

Vuetify color token.

string
nullable
Variant

Vuetify variant token.

string
nullable
PermissionKey

Optional action-specific permission gate.

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": [
    {
      "Surface": 0,
      "ActionTargetScope": 0,
      "Placement": 0,
      "ToolbarPresentation": 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"
}