Create one user menu.
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/runtime-menus"), Headers = { { "Authorization", "Bearer <token>" }, }, Content = new StringContent("{ \"Name\": \"example\", \"Description\": \"example\", \"Priority\": 1, \"RoleIds\": [ \"example\" ], \"Items\": [ { \"Kind\": 0, \"SortOrder\": 1, \"Label\": \"example\", \"Icon\": \"example\", \"LeafType\": 0, \"EntityDefinitionId\": \"example\", \"Children\": [], \"Href\": \"example\", \"PageCode\": \"example\", \"WorkspaceUiPageKey\": \"example\", \"CatalogDefinitionId\": \"example\", \"EntityListPageSurfaceKey\": \"example\", \"RoleIds\": [ \"example\" ], \"LabelTranslations\": { \"additionalProperty\": \"example\" }, \"PageTargetId\": \"example\", \"Id\": \"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/runtime-menus';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"Name":"example","Description":"example","Priority":1,"RoleIds":["example"],"Items":[{"Kind":0,"SortOrder":1,"Label":"example","Icon":"example","LeafType":0,"EntityDefinitionId":"example","Children":[],"Href":"example","PageCode":"example","WorkspaceUiPageKey":"example","CatalogDefinitionId":"example","EntityListPageSurfaceKey":"example","RoleIds":["example"],"LabelTranslations":{"additionalProperty":"example"},"PageTargetId":"example","Id":"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/runtime-menus \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "Name": "example", "Description": "example", "Priority": 1, "RoleIds": [ "example" ], "Items": [ { "Kind": 0, "SortOrder": 1, "Label": "example", "Icon": "example", "LeafType": 0, "EntityDefinitionId": "example", "Children": [], "Href": "example", "PageCode": "example", "WorkspaceUiPageKey": "example", "CatalogDefinitionId": "example", "EntityListPageSurfaceKey": "example", "RoleIds": [ "example" ], "LabelTranslations": { "additionalProperty": "example" }, "PageTargetId": "example", "Id": "example" } ] }'Authorizations
Section titled “Authorizations”Parameters
Section titled “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”Create one user menu.
object
Menu display name.
Optional free-form description.
Resolution priority.
Optional role scope; empty means all users.
Whole menu tree.
One runtime-menu node submitted by the admin UI.
object
Sibling sort order.
Default display label, shown when no translation exists for the viewer’s language.
MDI icon name.
Target entity definition identifier; required for Data Explorer leaves.
Absolute HTTP(S) URL or app-relative path beginning with a single slash; required for external-link leaves. Backslashes, control characters, protocol-relative paths, and surrounding whitespace are rejected.
Registered stable module page code; required for module-page leaves. Known pages of disabled modules remain valid configuration and become available when the module is enabled.
Workspace UI page key; required for workspace-page leaves.
Runtime Catalog Definition identifier; required for Catalog leaves.
Optional explicit entity-list page key for Data Explorer leaves; null resolves the current default.
Optional role identifiers that add a visibility restriction to this node and its descendants.
Optional label per supported language code (en, uk, de, pl, es). Blank values are ignored.
object
Module-owned record opened by a target-bound module page, such as one Board; required only for such pages.
Existing node identifier of this menu, sent on update to keep the node identity; omit for a new node. Menu creation and item appends reject ids.
Create one user menu.
object
Menu display name.
Optional free-form description.
Resolution priority.
Optional role scope; empty means all users.
Whole menu tree.
One runtime-menu node submitted by the admin UI.
object
Sibling sort order.
Default display label, shown when no translation exists for the viewer’s language.
MDI icon name.
Target entity definition identifier; required for Data Explorer leaves.
Absolute HTTP(S) URL or app-relative path beginning with a single slash; required for external-link leaves. Backslashes, control characters, protocol-relative paths, and surrounding whitespace are rejected.
Registered stable module page code; required for module-page leaves. Known pages of disabled modules remain valid configuration and become available when the module is enabled.
Workspace UI page key; required for workspace-page leaves.
Runtime Catalog Definition identifier; required for Catalog leaves.
Optional explicit entity-list page key for Data Explorer leaves; null resolves the current default.
Optional role identifiers that add a visibility restriction to this node and its descendants.
Optional label per supported language code (en, uk, de, pl, es). Blank values are ignored.
object
Module-owned record opened by a target-bound module page, such as one Board; required only for such pages.
Existing node identifier of this menu, sent on update to keep the node identity; omit for a new node. Menu creation and item appends reject ids.
Create one user menu.
object
Menu display name.
Optional free-form description.
Resolution priority.
Optional role scope; empty means all users.
Whole menu tree.
One runtime-menu node submitted by the admin UI.
object
Sibling sort order.
Default display label, shown when no translation exists for the viewer’s language.
MDI icon name.
Target entity definition identifier; required for Data Explorer leaves.
Absolute HTTP(S) URL or app-relative path beginning with a single slash; required for external-link leaves. Backslashes, control characters, protocol-relative paths, and surrounding whitespace are rejected.
Registered stable module page code; required for module-page leaves. Known pages of disabled modules remain valid configuration and become available when the module is enabled.
Workspace UI page key; required for workspace-page leaves.
Runtime Catalog Definition identifier; required for Catalog leaves.
Optional explicit entity-list page key for Data Explorer leaves; null resolves the current default.
Optional role identifiers that add a visibility restriction to this node and its descendants.
Optional label per supported language code (en, uk, de, pl, es). Blank values are ignored.
object
Module-owned record opened by a target-bound module page, such as one Board; required only for such pages.
Existing node identifier of this menu, sent on update to keep the node identity; omit for a new node. Menu creation and item appends reject ids.
Responses
Section titled “Responses”OK
object
Full runtime-menu detail for admin editing.
object
Menu identifier.
Menu display name.
Optional free-form description.
Resolution priority.
Assigned role identifiers.
Whole menu tree.
One runtime-menu node for admin read models.
object
Stable node identifier; send it back on update to keep the node identity.
Sibling sort order.
Default display label.
MDI icon name.
Target entity definition identifier.
Absolute URL for external-link leaves.
Frontend-owned page code for module-page leaves.
Workspace UI page key for workspace-page leaves.
Runtime Catalog Definition identifier for Catalog leaves.
Role identifiers that restrict visibility of this node and its descendants.
Concurrency token.
Explicit entity-list page key, or null for the default page.
Label per language code; empty when only the default label exists.
object
Module-owned record opened by a target-bound module page.
Concurrency token.
object
object
object
object
Example
{ "Data": { "Items": [ { "Kind": 0, "LeafType": 0 } ] }, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}Bad Request
object
Full runtime-menu detail for admin editing.
object
Menu identifier.
Menu display name.
Optional free-form description.
Resolution priority.
Assigned role identifiers.
Whole menu tree.
One runtime-menu node for admin read models.
object
Stable node identifier; send it back on update to keep the node identity.
Sibling sort order.
Default display label.
MDI icon name.
Target entity definition identifier.
Absolute URL for external-link leaves.
Frontend-owned page code for module-page leaves.
Workspace UI page key for workspace-page leaves.
Runtime Catalog Definition identifier for Catalog leaves.
Role identifiers that restrict visibility of this node and its descendants.
Concurrency token.
Explicit entity-list page key, or null for the default page.
Label per language code; empty when only the default label exists.
object
Module-owned record opened by a target-bound module page.
Concurrency token.
object
object
object
object
Example
{ "Data": { "Items": [ { "Kind": 0, "LeafType": 0 } ] }, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}Forbidden
object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}Conflict
object
Full runtime-menu detail for admin editing.
object
Menu identifier.
Menu display name.
Optional free-form description.
Resolution priority.
Assigned role identifiers.
Whole menu tree.
One runtime-menu node for admin read models.
object
Stable node identifier; send it back on update to keep the node identity.
Sibling sort order.
Default display label.
MDI icon name.
Target entity definition identifier.
Absolute URL for external-link leaves.
Frontend-owned page code for module-page leaves.
Workspace UI page key for workspace-page leaves.
Runtime Catalog Definition identifier for Catalog leaves.
Role identifiers that restrict visibility of this node and its descendants.
Concurrency token.
Explicit entity-list page key, or null for the default page.
Label per language code; empty when only the default label exists.
object
Module-owned record opened by a target-bound module page.
Concurrency token.
object
object
object
object
Example
{ "Data": { "Items": [ { "Kind": 0, "LeafType": 0 } ] }, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}