System APIs

GET system/rambase-menu-items

This resource will list all available RamBase menu items within the current RamBase system. If you want to list all menus available you should use the level query parameter and specify level=0. By specifing a level other than 0 you will get all menu items at that level regardless of which menu they belong to.

HTTP method	GET
URI	https://api.rambase.net/system/rambase-menu-items
Supported formats	Xml, Html, Json (ex. $format=json)
Maximum page size ($top)	80
Successful HTTP status code	200
API resource identifier	1787, version 13

The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.

Format:

The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.

$lang String, optional	Specifies the language used in the response, following the 3-letter ISO-639-1 [lll]
$access_token String, optional	After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time.
$db String, optional	Set the database/company for the request
$expand String, optional	Use to include output fields that are not returned by default in the response. Accepts a comma-separated list of expandable field names. See the Expand and Select page for more information.
$select String, optional	Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select page for more information.
$useMinimumVersion Integer, optional	Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information.
$format String, optional	Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$top String, optional	Specifies number of rows to return in each page. Maximum limit is specific for each API resource. Default value is 10.
$pageKey String, optional	Use to navigate to first, previous, next or last page in list. Add $expand=PagingDetails to add the different keys to the response.
$filter String, optional	Use to filter the result list, see the Filtering and sorting page for more information.
$orderby String, optional	Use to order the result list, see the Filtering and sorting page for more information.
$inlinecount String, optional	Set to "allpages" to include total number of rows in the response. Possible values are: "allpages", "none"

Read more about filters and sorting on how to use filter parameters and named filters.

Active items only() Named filter	Will list only active menu items
List root menu items() Named filter	By providing this filter you will get a list of all the menus available in RamBase.
IconName String	Each RamBase Menu Item can have an icon associated with it. If your RamBase Menu Item should have an icon this field must contain the name of an icon that exists in the RamBase icon set.
ObjectStatus String	The status of the RamBase Menu Item. The following values will be legal: 1 - Edit state, 4 - Active State, 9 - Discontinued state. For a menu item to show up in a menu it has to be in status 4.
OrderIndex Integer	The order of menu items is controlled by this index field. A lower number will mean a higher rank in the menu. Index 0 will be on the top of the menu.
ParentMenuItem. ParentMenuItemId Integer	A reference to the parent menu item id. Will contain the RamBaseMenuItemId of the parent menu item.
Path String	The sub-menu items path.
Permission String	RamBase cotain a Role and Permission concept that can restrict what a user can see and do. To restrict users from accessing a menu item that he shouldn't have access to you can require a named permission by specifing an existing permission in this field.
RamBaseMenuItemId Integer	A unique identifier for a RamBase Menu Item.
RootMenuItem. RootMenuItemId Integer	A reference to the root menu item (the root of the tree). Will contain the RamBaseMenuItemId of the RamBase menu item at the root of the tree.
Title String	The title of the RamBase Menu Item. This is the title/text that will be displayed in the menu tree.
TreeLevel Integer	The level at which this menu item exist in the tree. Level 0 will mean that it is a root level node.
Url String	The URL we will navigate to when clicking a menu item. This can be either a relative or an absolute URL.

Read more about filters and sorting on how to use sortable parameters

IconName String	Each RamBase Menu Item can have an icon associated with it. If your RamBase Menu Item should have an icon this field must contain the name of an icon that exists in the RamBase icon set.
ObjectStatus String	The status of the RamBase Menu Item. The following values will be legal: 1 - Edit state, 4 - Active State, 9 - Discontinued state. For a menu item to show up in a menu it has to be in status 4.
OrderIndex Integer	The order of menu items is controlled by this index field. A lower number will mean a higher rank in the menu. Index 0 will be on the top of the menu.
ParentMenuItem. ParentMenuItemId Integer	A reference to the parent menu item id. Will contain the RamBaseMenuItemId of the parent menu item.
Path String	The sub-menu items path
Permission String	RamBase cotain a Role and Permission concept that can restrict what a user can see and do. To restrict users from accessing a menu item that he shouldn't have access to you can require a named permission by specifing an existing permission in this field.
RamBaseMenuItemId Integer	A unique identifier for a RamBase Menu Item
RootMenuItem. RootMenuItemId Integer	A reference to the root menu item (the root of the tree). Will contain the RamBaseMenuItemId of the RamBase menu item at the root of the tree.
Title String	The title of the RamBase Menu Item. This is the title/text that will be displayed in the menu tree.
TreeLevel Integer	The level at which this menu item exist in the tree. Level 0 will mean that it is a root level node.
Url String	The URL we will navigate to when clicking a menu item. This can be either a relative or an absolute URL.

Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields. Fields colored in grey is expandable fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:

                                        <RamBaseMenuItems>
                                    

                                             <RamBaseMenuItem>
                                    

<RamBaseMenuItemId

RamBaseMenuItemId

A unique identifier for a RamBase Menu Item

>{Integer}</RamBaseMenuItemId>

<ObjectStatus

ObjectStatus

The status of the RamBase Menu Item. The following values will be legal: 1 - Edit state, 4 - Active State, 9 - Discontinued state. For a menu item to show up in a menu it has to be in status 4.

>{String}</ObjectStatus>

<Title

Title

The title of the RamBase Menu Item. This is the title/text that will be displayed in the menu tree.

>{String}</Title>

<TranslatedTitle

TranslatedTitle

This is the same as the title field, except from the title being translated into the current user preffered language. If a translation in that language does not exist, the english title will be returned.

This field is greyed out because it is an expandable field. You have to add $expand=RamBaseMenuItem.TranslatedTitle in your request URI to get this field

>{String}</TranslatedTitle>

<Url

Url

The URL we will navigate to when clicking a menu item. This can be either a relative or an absolute URL.

>{String}</Url>

<Path

Path

The sub-menu items path

>{String}</Path>

<IconName

IconName

Each RamBase Menu Item can have an icon associated with it. If your RamBase Menu Item should have an icon this field must contain the name of an icon that exists in the RamBase icon set.

>{String}</IconName>

<Permission

Permission

RamBase cotain a Role and Permission concept that can restrict what a user can see and do. To restrict users from accessing a menu item that he shouldn't have access to you can require a named permission by specifing an existing permission in this field.

>{String}</Permission>

<OrderIndex

OrderIndex

The order of menu items is controlled by this index field. A lower number will mean a higher rank in the menu. Index 0 will be on the top of the menu.

>{Integer}</OrderIndex>

<TreeLevel

TreeLevel

The level at which this menu item exist in the tree. Level 0 will mean that it is a root level node.

>{Integer}</TreeLevel>

<IsVisibleToCurrentUser

IsVisibleToCurrentUser

If a RamBase user doesn't have permission to run an application, that application should not be visible in the menu either. This boolean field will tell you if this menu item should be shown to the end user or not.

This field is greyed out because it is an expandable field. You have to add $expand=RamBaseMenuItem.IsVisibleToCurrentUser in your request URI to get this field

>{Boolean}</IsVisibleToCurrentUser>

<HasSubmenuItems

HasSubmenuItems

Indicates if this menu items has any sub menu items connected to it.

>{Boolean}</HasSubmenuItems>

                                                  <ParentMenuItem>
                                    

<ParentMenuItemId

ParentMenuItemId

A reference to the parent menu item id. Will contain the RamBaseMenuItemId of the parent menu item.

>{Integer}</ParentMenuItemId>

<ParentMenuLink

ParentMenuLink

An parent object reference. Will link to the parent menu item

>{String}</ParentMenuLink>

                                                  </ParentMenuItem>
                                    

                                                  <RootMenuItem>
                                    

<RootMenuItemId

RootMenuItemId

A reference to the root menu item (the root of the tree). Will contain the RamBaseMenuItemId of the RamBase menu item at the root of the tree.

>{Integer}</RootMenuItemId>

<RootMenuLink

RootMenuLink

A root object reference. Will link to the menu item at the root of the tree.

>{String}</RootMenuLink>

                                                  </RootMenuItem>
                                    

<RamBaseMenuItemLink

RamBaseMenuItemLink

RamBase Menu Item reference

>{String}</RamBaseMenuItemLink>

                                             </RamBaseMenuItem>
                                    

<Paging

Paging

Detailed paging information for this list.

<PageSize

PageSize

Number of elements in the list, as defined in $top. Default is 10.

>{Integer}</PageSize>

<Position

Position

Position of the first element in the list

>{Integer}</Position>

<Page

Page

Page index

>{Integer}</Page>

<FirstPageKey

FirstPageKey

Page key to use for navigating to the first page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</FirstPageKey>

<FirstPage

FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

>{String}</FirstPage>

<PreviousPageKey

PreviousPageKey

Page key to use for navigating to previous page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</PreviousPageKey>

<PreviousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

>{String}</PreviousPage>

<NextPageKey

NextPageKey

Page key to use for navigating to next page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</NextPageKey>

<NextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

>{String}</NextPage>

<LastPageKey

LastPageKey

Page key to use for navigating to last page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</LastPageKey>

<LastPage

LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

>{String}</LastPage>

<Size

Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

>{Integer}</Size>

                                             </Paging>
                                    

                                        </RamBaseMenuItems>
                                    

{

                                             "ramBaseMenuItems": [
                                    

{

"ramBaseMenuItemId

RamBaseMenuItemId

A unique identifier for a RamBase Menu Item

": "{Integer}",

"objectStatus

ObjectStatus

The status of the RamBase Menu Item. The following values will be legal: 1 - Edit state, 4 - Active State, 9 - Discontinued state. For a menu item to show up in a menu it has to be in status 4.

": "{String}",

"title

Title

The title of the RamBase Menu Item. This is the title/text that will be displayed in the menu tree.

": "{String}",

"translatedTitle

TranslatedTitle

This field is greyed out because it is an expandable field. You have to add $expand=RamBaseMenuItem.TranslatedTitle in your request URI to get this field

": "{String}",

"url

Url

The URL we will navigate to when clicking a menu item. This can be either a relative or an absolute URL.

": "{String}",

"path

Path

The sub-menu items path

": "{String}",

"iconName

IconName

Each RamBase Menu Item can have an icon associated with it. If your RamBase Menu Item should have an icon this field must contain the name of an icon that exists in the RamBase icon set.

": "{String}",

"permission

Permission

": "{String}",

"orderIndex

OrderIndex

The order of menu items is controlled by this index field. A lower number will mean a higher rank in the menu. Index 0 will be on the top of the menu.

": "{Integer}",

"treeLevel

TreeLevel

The level at which this menu item exist in the tree. Level 0 will mean that it is a root level node.

": "{Integer}",

"isVisibleToCurrentUser

IsVisibleToCurrentUser

This field is greyed out because it is an expandable field. You have to add $expand=RamBaseMenuItem.IsVisibleToCurrentUser in your request URI to get this field

": "{Boolean}",

"hasSubmenuItems

HasSubmenuItems

Indicates if this menu items has any sub menu items connected to it.

": "{Boolean}",

                                                       "parentMenuItem": {
                                    

"parentMenuItemId

ParentMenuItemId

A reference to the parent menu item id. Will contain the RamBaseMenuItemId of the parent menu item.

": "{Integer}",

"parentMenuLink

ParentMenuLink

An parent object reference. Will link to the parent menu item

": "{String}"

},

                                                       "rootMenuItem": {
                                    

"rootMenuItemId

RootMenuItemId

A reference to the root menu item (the root of the tree). Will contain the RamBaseMenuItemId of the RamBase menu item at the root of the tree.

": "{Integer}",

"rootMenuLink

RootMenuLink

A root object reference. Will link to the menu item at the root of the tree.

": "{String}"

},

"ramBaseMenuItemLink

RamBaseMenuItemLink

RamBase Menu Item reference

": "{String}"

}

],

"paging

Paging

Detailed paging information for this list.

": {

"pageSize

PageSize

Number of elements in the list, as defined in $top. Default is 10.

": "{Integer}",

"position

Position

Position of the first element in the list

": "{Integer}",

"page

Page

Page index

": "{Integer}",

"firstPageKey

FirstPageKey

Page key to use for navigating to the first page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",

"firstPage

FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

": "{String}",

"previousPageKey

PreviousPageKey

Page key to use for navigating to previous page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",

"previousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

": "{String}",

"nextPageKey

NextPageKey

Page key to use for navigating to next page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",

"nextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

": "{String}",

"lastPageKey

LastPageKey

Page key to use for navigating to last page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",

"lastPage

LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

": "{String}",

"size

Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

": "{Integer}"

}

}

List of available operations/actions for this resource.
See the operations documentation for more information about API operations.

Possible error codes the response might return:

Error 101013 HTTP 404	Sub-module not found
Error 102018 HTTP 403	You need permission {0}. Duties with this permission: {1}