API

System APIs

POST system/rambase-menu-items

Use this resource to create a new RamBase menu item at any level in the tree.

HTTP method POST
URI https://api.rambase.net/system/rambase-menu-items
Supported formats Xml, Html, Json (ex. $format=json)
Successful HTTP status code 201
API resource identifier 1790, version 3

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:
1
<RamBaseMenuItem>
2
     <Title
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>
3
     <Url
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>
4
     <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.

This field is optional.

>{String}</IconName>
5
     <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.

This field is optional.

>{String}</Permission>
6
     <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.

This field is optional.

>{Integer}</OrderIndex>
7
     <ParentMenuItem>
8
          <ParentMenuItemId
ParentMenuItemId

Required/mandatory field

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

>{Integer}</ParentMenuItemId>
9
     </ParentMenuItem>
10
</RamBaseMenuItem>
1
{
2
     "ramBaseMenuItem": {
3
          "title
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}",
4
          "url
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}",
5
          "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.

This field is optional.

": "{String}",
6
          "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.

This field is optional.

": "{String}",
7
          "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.

This field is optional.

": "{Integer}",
8
          "parentMenuItem": {
9
               "parentMenuItemId
ParentMenuItemId

Required/mandatory field

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

": "{Integer}"
10
          }
11
     }
12
}

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.

Format:
1
<RamBaseMenuItem>
2
     <RamBaseMenuItemId
RamBaseMenuItemId

A unique identifier for a RamBase Menu Item

>{Integer}</RamBaseMenuItemId>
3
     <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>
4
     <Title
Title

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

>{String}</Title>
5
     <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>
6
     <Path
Path

The sub-menu items path

>{String}</Path>
7
     <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>
8
     <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>
9
     <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>
10
     <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>
11
     <HasSubmenuItems
HasSubmenuItems

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

>{Boolean}</HasSubmenuItems>
12
     <ChangedBy
ChangedBy

Tells whether this object has been changed locally and are ready to be committed to the Repository

>{Integer}</ChangedBy>
13
     <ParentMenuItem>
14
          <ParentMenuItemId
ParentMenuItemId

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

>{Integer}</ParentMenuItemId>
15
          <ParentMenuLink
ParentMenuLink

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

>{String}</ParentMenuLink>
16
     </ParentMenuItem>
17
     <RootMenuItem>
18
          <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>
19
          <RootMenuLink
RootMenuLink

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

>{String}</RootMenuLink>
20
     </RootMenuItem>
21
</RamBaseMenuItem>
1
{
2
     "ramBaseMenuItem": {
3
          "ramBaseMenuItemId
RamBaseMenuItemId

A unique identifier for a RamBase Menu Item

": "{Integer}",
4
          "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}",
5
          "title
Title

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

": "{String}",
6
          "url
Url

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

": "{String}",
7
          "path
Path

The sub-menu items path

": "{String}",
8
          "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}",
9
          "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}",
10
          "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}",
11
          "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}",
12
          "hasSubmenuItems
HasSubmenuItems

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

": "{Boolean}",
13
          "changedBy
ChangedBy

Tells whether this object has been changed locally and are ready to be committed to the Repository

": "{Integer}",
14
          "parentMenuItem": {
15
               "parentMenuItemId
ParentMenuItemId

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

": "{Integer}",
16
               "parentMenuLink
ParentMenuLink

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

": "{String}"
17
          },
18
          "rootMenuItem": {
19
               "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}",
20
               "rootMenuLink
RootMenuLink

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

": "{String}"
21
          }
22
     }
23
}

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