Create a function-backed UI action.
using System.Net.Http.Headers;var client = new HttpClient();var request = new HttpRequestMessage{ Method = HttpMethod.Post, RequestUri = new Uri("https://example.com/api/workspace/admin/entity-definitions/example/ui/actions"), 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\", \"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';const options = { method: 'POST', 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","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 POST \ --url https://example.com/api/workspace/admin/entity-definitions/example/ui/actions \ --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", "ToolbarPresentation": 0, "Color": "example", "Variant": "example" }'Authorizations
Section titled “Authorizations”- None
Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Query Parameters
Section titled “Query Parameters”Optional access token for clients that cannot set Authorization headers. Prefer Authorization: Bearer <token> when possible.
Request Body
Section titled “Request Body”Request payload to create a function-backed UI action.
object
Business function identifier.
Entity definition identifier for entity-scoped action targets.
Entity UI surface model identifier when binding to a concrete surface.
Action order within the placement.
Whether the binding is enabled.
Optional label override.
Optional icon override.
Optional action-specific permission gate.
Vuetify color token.
Vuetify variant token.
Request payload to create a function-backed UI action.
object
Business function identifier.
Entity definition identifier for entity-scoped action targets.
Entity UI surface model identifier when binding to a concrete surface.
Action order within the placement.
Whether the binding is enabled.
Optional label override.
Optional icon override.
Optional action-specific permission gate.
Vuetify color token.
Vuetify variant token.
Request payload to create a function-backed UI action.
object
Business function identifier.
Entity definition identifier for entity-scoped action targets.
Entity UI surface model identifier when binding to a concrete surface.
Action order within the placement.
Whether the binding is enabled.
Optional label override.
Optional icon override.
Optional action-specific permission gate.
Vuetify color token.
Vuetify variant token.
Responses
Section titled “Responses”OK
object
Designer-owned action connecting a business function to a compatible UI surface context.
object
Action identifier.
Bound business function identifier.
Entity definition identifier for entity-scoped action targets.
Entity UI surface model identifier when bound to a concrete surface.
Action order within the placement.
Whether the binding is enabled.
Optional label override.
Optional icon override.
Vuetify color token.
Vuetify variant token.
Optional action-specific permission gate.
Concurrency token.
object
object
object
object
Example
{ "Data": { "Surface": 0, "ActionTargetScope": 0, "Placement": 0, "ToolbarPresentation": 0 }, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}Bad Request
object
Designer-owned action connecting a business function to a compatible UI surface context.
object
Action identifier.
Bound business function identifier.
Entity definition identifier for entity-scoped action targets.
Entity UI surface model identifier when bound to a concrete surface.
Action order within the placement.
Whether the binding is enabled.
Optional label override.
Optional icon override.
Vuetify color token.
Vuetify variant token.
Optional action-specific permission gate.
Concurrency token.
object
object
object
object
Example
{ "Data": { "Surface": 0, "ActionTargetScope": 0, "Placement": 0, "ToolbarPresentation": 0 }, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}Forbidden
object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}