Update a function-backed UI action.

PUT

/api/workspace/admin/entity-definitions/{entityDefinitionId}/ui/actions/{actionId}

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Put,
    RequestUri = new Uri("https://example.com/api/workspace/admin/entity-definitions/example/ui/actions/example"),
    Content = new StringContent("{ \"BusinessFunctionId\": \"example\", \"EntityDefinitionId\": \"example\", \"EntityUiSurfaceModelId\": \"example\", \"Surface\": 0, \"ActionTargetScope\": 0, \"Placement\": 0, \"SortOrder\": 1, \"IsEnabled\": true, \"Label\": \"example\", \"Icon\": \"example\", \"PermissionKey\": \"example\", \"RowVersion\": \"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0\", \"ToolbarPresentation\": 0, \"Color\": \"example\", \"Variant\": \"example\" }")
    {
        Headers =
        {
            ContentType = new MediaTypeHeaderValue("application/json")
        }
    }
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

const url = 'https://example.com/api/workspace/admin/entity-definitions/example/ui/actions/example';
const options = {
  method: 'PUT',
  headers: {'Content-Type': 'application/json'},
  body: '{"BusinessFunctionId":"example","EntityDefinitionId":"example","EntityUiSurfaceModelId":"example","Surface":0,"ActionTargetScope":0,"Placement":0,"SortOrder":1,"IsEnabled":true,"Label":"example","Icon":"example","PermissionKey":"example","RowVersion":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","ToolbarPresentation":0,"Color":"example","Variant":"example"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request PUT \
  --url https://example.com/api/workspace/admin/entity-definitions/example/ui/actions/example \
  --header 'Content-Type: application/json' \
  --data '{ "BusinessFunctionId": "example", "EntityDefinitionId": "example", "EntityUiSurfaceModelId": "example", "Surface": 0, "ActionTargetScope": 0, "Placement": 0, "SortOrder": 1, "IsEnabled": true, "Label": "example", "Icon": "example", "PermissionKey": "example", "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "ToolbarPresentation": 0, "Color": "example", "Variant": "example" }'

Authorizations

None

Parameters

Path Parameters

entityDefinitionId

required

string

actionId

required

string

Query Parameters

access_token

string

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

Request Body

Request payload to update a function-backed UI action.

object

BusinessFunctionId

Business function identifier.

string

nullable

EntityDefinitionId

Entity definition identifier for entity-scoped action targets.

string

nullable

EntityUiSurfaceModelId

Entity UI surface model identifier when binding 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

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

PermissionKey

Optional action-specific permission gate.

string

nullable

RowVersion

Expected concurrency token.

string format: uuid

ToolbarPresentation

integer format: int32

Allowed values: 0 1

Color

Vuetify color token.

string

nullable

Variant

Vuetify variant token.

string

nullable

Responses

200

application/json

object

Data

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

object

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

400

Bad Request

application/json

object

Data

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

object

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

Forbidden

application/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

application/json

object

Data

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

object

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

409

Conflict

application/json

object

Data

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

object

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

Update a function-backed UI action.

Authorizations

Parameters

Path Parameters

Query Parameters

Request Body

Responses

200

Example

400

Example

403

Examplegenerated

404

Example

409

Example

Example^generated