System APIs
For easier access to creating new sub menu items you can use this resource.
| HTTP method | POST |
| URI | https://api.rambase.net/system/rambase-menu-items/{RamBaseMenuItemId}/sub-menu-items |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {RamBaseMenuItemId} |
A unique identifier for a RamBase Menu Item
Integer |
| Successful HTTP status code | 201 |
| API resource identifier | 1793, version 2 |
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.
Title
Required/mandatory field
The title of the RamBase Menu Item. This is the title/text that will be displayed in the menu tree.
>{String}</Title>Url
The URL we will navigate to when clicking a menu item. This can be either a relative or an absolute URL.
This field is optional.
>{String}</Url>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.
This field is optional.
>{String}</IconName>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.
This field is optional.
>{String}</Permission>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.
This field is optional.
>{Integer}</OrderIndex>Title
Required/mandatory field
The title of the RamBase Menu Item. This is the title/text that will be displayed in the menu tree.
": "{String}",Url
The URL we will navigate to when clicking a menu item. This can be either a relative or an absolute URL.
This field is optional.
": "{String}",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.
This field is optional.
": "{String}",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.
This field is optional.
": "{String}",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.
This field is optional.
": "{Integer}"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.
| $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 |
| $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. |
| $lang String, optional | Specifies the language used in the response, following the 3-letter ISO-639-1 [lll] |
Read more about filters and sorting on how to use filter parameters and named filters.
Read more about filters and sorting on how to use sortable parameters
Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields.
Please note that some fields may be removed from the response, based on user roles/duties/permissions.
RamBaseMenuItemId
A unique identifier for a RamBase Menu Item
>{String}</RamBaseMenuItemId>RamBaseMenuItemId
A unique identifier for a RamBase Menu Item
": "{String}"
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 101015 HTTP 404 | Permission not found |
| Error 101420 HTTP 404 | Setting definition not found |