Skip to main content

Menu

A menu item.

type Menu {
  children: [Menu!]
  createdAt: DateTime!
  deletedAt: DateTime
  deletedBy: String
  description: String
  enteredBy: String!
  icon: String
  id: ID!
  isActive: Boolean!
  isMainMenu: Boolean!
  label: String!
  menuType: MenuType!
  name: String!
  order: Int!
  organizationId: String!
  parent: Menu
  parentId: String
  path: String
  requiredPermissions: [String!]
  updatedAt: DateTime!
  updatedBy: String!
}

Fields​

Menu.children ● [Menu!] list object​

The child menu items.

Menu.createdAt ● DateTime! non-null scalar​

When the record was created.

Menu.deletedAt ● DateTime scalar​

When the record was deleted. Empty while the record is live.

Menu.deletedBy ● String scalar​

The ID of the user who deleted the record.

Menu.description ● String scalar​

What the menu item is for.

Menu.enteredBy ● String! non-null scalar​

The ID of the user who created the record.

Menu.icon ● String scalar​

The icon of the menu item.

Menu.id ● ID! non-null scalar​

The unique ID of this record.

Menu.isActive ● Boolean! non-null scalar​

Whether the record is active.

Menu.isMainMenu ● Boolean! non-null scalar​

True when the item is a main menu entry.

Menu.label ● String! non-null scalar​

The text shown for the menu item.

MAIN or SUB.

Menu.name ● String! non-null scalar​

The internal name of the menu item.

Menu.order ● Int! non-null scalar​

The position among its siblings, lowest first.

Menu.organizationId ● String! non-null scalar​

The ID of the organization the record belongs to.

Menu.parent ● Menu object​

The parent menu item.

Menu.parentId ● String scalar​

The ID of the parent menu item.

Menu.path ● String scalar​

The address the menu item opens.

Menu.requiredPermissions ● [String!] list scalar​

The permissions needed to see the item.

Menu.updatedAt ● DateTime! non-null scalar​

When the record was last changed.

Menu.updatedBy ● String! non-null scalar​

The ID of the user who last changed the record.

Returned By​

createMenu mutation ● mainMenus query ● menu query ● menuChildren query ● menus query ● reorderMenus mutation ● updateMenu mutation

Member Of​

Menu object