Return designer data for configuring function-backed UI actions.
using System.Net.Http.Headers;var client = new HttpClient();var request = new HttpRequestMessage{ Method = HttpMethod.Get, RequestUri = new Uri("https://example.com/api/workspace/admin/entity-definitions/example/ui/actions/designer-model?Surface=0"),};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/designer-model?Surface=0';const options = {method: 'GET'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url 'https://example.com/api/workspace/admin/entity-definitions/example/ui/actions/designer-model?Surface=0'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.
Responses
Section titled “Responses”OK
object
Designer payload for configuring function-backed UI actions on one entity definition.
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.
Administrative business function summary.
object
Function identifier.
Stable function key.
User-facing function name.
Optional description.
Owning entity definition for entity functions.
Whether the function can be invoked by future runtime slices.
Current published version identifier.
Creation timestamp.
Last metadata modification timestamp.
Last modifying user identifier.
Number of stored immutable versions.
Latest stored version number.
Publication timestamp for the latest stored version.
Current published version number.
Publication timestamp for the current published version.
Most recent persisted run start timestamp.
Concurrency token.
object
object
object
object
Example
{ "Data": { "Surface": 0, "Actions": [ { "Surface": 0, "ActionTargetScope": 0, "Placement": 0, "ToolbarPresentation": 0 } ], "AvailableFunctions": [ { "Kind": 0, "CurrentPublishedContract": 0, "LastRunStatus": 0 } ], "SupportedSurfaces": [ 0 ], "SupportedTargetScopes": [ 0 ], "SupportedPlacements": [ 0 ], "SupportedToolbarPresentations": [ 0 ] }, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}Bad Request
object
Designer payload for configuring function-backed UI actions on one entity definition.
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.
Administrative business function summary.
object
Function identifier.
Stable function key.
User-facing function name.
Optional description.
Owning entity definition for entity functions.
Whether the function can be invoked by future runtime slices.
Current published version identifier.
Creation timestamp.
Last metadata modification timestamp.
Last modifying user identifier.
Number of stored immutable versions.
Latest stored version number.
Publication timestamp for the latest stored version.
Current published version number.
Publication timestamp for the current published version.
Most recent persisted run start timestamp.
Concurrency token.
object
object
object
object
Example
{ "Data": { "Surface": 0, "Actions": [ { "Surface": 0, "ActionTargetScope": 0, "Placement": 0, "ToolbarPresentation": 0 } ], "AvailableFunctions": [ { "Kind": 0, "CurrentPublishedContract": 0, "LastRunStatus": 0 } ], "SupportedSurfaces": [ 0 ], "SupportedTargetScopes": [ 0 ], "SupportedPlacements": [ 0 ], "SupportedToolbarPresentations": [ 0 ] }, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}Forbidden
object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}