List actions available for a supported runtime surface.

GET

/api/workspace/entity/{entityIdOrKey}/ui/actions

curl --request GET \
  --url https://example.com/api/workspace/entity/example/ui/actions

Authorizations

• None

Parameters

Path Parameters

entityIdOrKey

required

string

Query Parameters

Surface

string

access_token

string

Optional access token for clients that cannot set Authorization headers. Prefer Authorization: Bearer <token> when possible.

Responses

200

OK

Media typeapplication/json

object

Data

Array<object>

nullable

Runtime action exposed on one supported entity UI surface. Input schema payloads include versioned nullability and typed Boolean or Select defaults when authored by the current Package SDK.

object

ActionId

string

nullable

BusinessFunctionId

string

nullable

BusinessFunctionVersionId

string

nullable

OperationKey

string

nullable

EntityDefinitionId

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

integer format: int32

Label

string

nullable

Icon

string

nullable

Color

string

nullable

Variant

string

nullable

PermissionKey

string

nullable

HasInput

boolean

InputSchemaPayload

string

nullable

InputFormPayload

string

nullable

InputCardPayload

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

{
  "Data": [
    {
      "Surface": 0,
      "ActionTargetScope": 0,
      "Placement": 0,
      "ToolbarPresentation": 0
    }
  ],
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

400

Bad Request

Media typeapplication/json

object

Data

Array<object>

nullable

Runtime action exposed on one supported entity UI surface. Input schema payloads include versioned nullability and typed Boolean or Select defaults when authored by the current Package SDK.

object

ActionId

string

nullable

BusinessFunctionId

string

nullable

BusinessFunctionVersionId

string

nullable

OperationKey

string

nullable

EntityDefinitionId

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

integer format: int32

Label

string

nullable

Icon

string

nullable

Color

string

nullable

Variant

string

nullable

PermissionKey

string

nullable

HasInput

boolean

InputSchemaPayload

string

nullable

InputFormPayload

string

nullable

InputCardPayload

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

{
  "Data": [
    {
      "Surface": 0,
      "ActionTargetScope": 0,
      "Placement": 0,
      "ToolbarPresentation": 0
    }
  ],
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

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

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

404

Not Found

Media typeapplication/json

object

Data

Array<object>

nullable

Runtime action exposed on one supported entity UI surface. Input schema payloads include versioned nullability and typed Boolean or Select defaults when authored by the current Package SDK.

object

ActionId

string

nullable

BusinessFunctionId

string

nullable

BusinessFunctionVersionId

string

nullable

OperationKey

string

nullable

EntityDefinitionId

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

integer format: int32

Label

string

nullable

Icon

string

nullable

Color

string

nullable

Variant

string

nullable

PermissionKey

string

nullable

HasInput

boolean

InputSchemaPayload

string

nullable

InputFormPayload

string

nullable

InputCardPayload

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

{
  "Data": [
    {
      "Surface": 0,
      "ActionTargetScope": 0,
      "Placement": 0,
      "ToolbarPresentation": 0
    }
  ],
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}