API

System APIs

POST system/context-menu-items

Creates a new context menu item

HTTP method POST
URI https://api.rambase.net/system/context-menu-items
Supported formats Xml, Html, Json (ex. $format=json)
Successful HTTP status code 201
API resource identifier 2185, 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
<ContextMenuItem>
2
     <Title
Title

Required/mandatory field

The title of the context menu item. This is the text that will be visible in the context menu.

>{String}</Title>
3
     <SortingPriority
SortingPriority

A nuber that will be used for sorting the menu on screen.

This field is optional.

>{Integer}</SortingPriority>
4
     <ConfirmationDialogText
ConfirmationDialogText

If you want a confirmation from the user before running this menu item, this will be the text shown in the confirmation dialog box.

This field is optional.

>{String}</ConfirmationDialogText>
5
     <ActionType
ActionType

The type of action that should happen when a user click this menu item.
Possible values:
0: Operation
1: Popup
2: Legacy Popup
3: Code
4: Navigate

Applicable domain values can be found here

This field is optional.

>{Integer}</ActionType>
6
     <ActionConfigurations
ActionConfigurations

Keeps configurations like what application this menu item should navigate to, what popup it should open, how wide and heigh the popup should be, parameter mapping between components and the collection and so on. Stored as JSON

This field is optional.

>{String}</ActionConfigurations>
7
     <ParentContextMenuItem
ParentContextMenuItem

If this field has a value it indicates that this menu item is a child of another menu item. The value of the field will tell what menu item this menu item is a child of.

This field is optional.

>
8
          <ContextMenuItemId
ContextMenuItemId

Context menu item id

This field is optional.

>{Integer}</ContextMenuItemId>
9
     </ParentContextMenuItem>
10
     <ContextMenuCollection>
11
          <ContextMenuCollectionId
ContextMenuCollectionId

Required/mandatory field

Context menu collection id. A unique Id representing a single context menu collection.

>{Integer}</ContextMenuCollectionId>
12
     </ContextMenuCollection>
13
     <TargetApplication
TargetApplication

Specifies APPMATCH of the application the menu item will navigate to.

This field is optional.

>
14
          <ApplicationMatch
ApplicationMatch

Matching Keyword

This field is optional.

>{String}</ApplicationMatch>
15
     </TargetApplication>
16
     <ApiOperation
ApiOperation

If the actiontype is Operation this field will contain the AOP number to execute when clicking this menu item.

This field is optional.

>
17
          <ApiOperationId
ApiOperationId

Api operation identifiers

This field is optional.

>{Integer}</ApiOperationId>
18
     </ApiOperation>
19
     <AccessRule
AccessRule

Fill this field with a valid ARU (Access rule) number if you want an access rule to be evaluated before showing/executing this menu item.

This field is optional.

>
20
          <AccessRuleId
AccessRuleId

Access Rule identifier

This field is optional.

>{Integer}</AccessRuleId>
21
     </AccessRule>
22
     <Repository
Repository

This field is optional.

>
23
          <Scope
Scope

Scope of the Context menu item (LOCAL/GLOBAL)

Applicable domain values can be found here

This field is optional.

>{String}</Scope>
24
     </Repository>
25
</ContextMenuItem>
1
{
2
     "contextMenuItem": {
3
          "title
Title

Required/mandatory field

The title of the context menu item. This is the text that will be visible in the context menu.

": "{String}",
4
          "sortingPriority
SortingPriority

A nuber that will be used for sorting the menu on screen.

This field is optional.

": "{Integer}",
5
          "confirmationDialogText
ConfirmationDialogText

If you want a confirmation from the user before running this menu item, this will be the text shown in the confirmation dialog box.

This field is optional.

": "{String}",
6
          "actionType
ActionType

The type of action that should happen when a user click this menu item.
Possible values:
0: Operation
1: Popup
2: Legacy Popup
3: Code
4: Navigate

Applicable domain values can be found here

This field is optional.

": "{Integer}",
7
          "actionConfigurations
ActionConfigurations

Keeps configurations like what application this menu item should navigate to, what popup it should open, how wide and heigh the popup should be, parameter mapping between components and the collection and so on. Stored as JSON

This field is optional.

": "{String}",
8
          "parentContextMenuItem
ParentContextMenuItem

If this field has a value it indicates that this menu item is a child of another menu item. The value of the field will tell what menu item this menu item is a child of.

This field is optional.

": {
9
               "contextMenuItemId
ContextMenuItemId

Context menu item id

This field is optional.

": "{Integer}"
10
          },
11
          "contextMenuCollection": {
12
               "contextMenuCollectionId
ContextMenuCollectionId

Required/mandatory field

Context menu collection id. A unique Id representing a single context menu collection.

": "{Integer}"
13
          },
14
          "targetApplication
TargetApplication

Specifies APPMATCH of the application the menu item will navigate to.

This field is optional.

": {
15
               "applicationMatch
ApplicationMatch

Matching Keyword

This field is optional.

": "{String}"
16
          },
17
          "apiOperation
ApiOperation

If the actiontype is Operation this field will contain the AOP number to execute when clicking this menu item.

This field is optional.

": {
18
               "apiOperationId
ApiOperationId

Api operation identifiers

This field is optional.

": "{Integer}"
19
          },
20
          "accessRule
AccessRule

Fill this field with a valid ARU (Access rule) number if you want an access rule to be evaluated before showing/executing this menu item.

This field is optional.

": {
21
               "accessRuleId
AccessRuleId

Access Rule identifier

This field is optional.

": "{Integer}"
22
          },
23
          "repository
Repository

This field is optional.

": {
24
               "scope
Scope

Scope of the Context menu item (LOCAL/GLOBAL)

Applicable domain values can be found here

This field is optional.

": "{String}"
25
          }
26
     }
27
}

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.
$showDomainDescriptions Boolean, optional Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false.
$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
<ContextMenuItem>
2
     <ContextMenuItemId
ContextMenuItemId

Context menu item id

>{Integer}</ContextMenuItemId>
3
     <Status
Status

The status of the context menu item

>{Integer}</Status>
4
     <Title
Title

The title of the context menu item. This is the text that will be visible in the context menu.

>{String}</Title>
5
     <SortingPriority
SortingPriority

A nuber that will be used for sorting the menu on screen.

>{Integer}</SortingPriority>
6
     <ConfirmationDialogText
ConfirmationDialogText

If you want a confirmation from the user before running this menu item, this will be the text shown in the confirmation dialog box.

>{String}</ConfirmationDialogText>
7
     <ActionType
ActionType

The type of action that should happen when a user click this menu item.
Possible values:
0: Operation
1: Popup
2: Legacy Popup
3: Code
4: Navigate

Possible domain values can be found here

>{Integer}</ActionType>
8
     <ActionConfigurations
ActionConfigurations

Keeps configurations like what application this menu item should navigate to, what popup it should open, how wide and heigh the popup should be, parameter mapping between components and the collection and so on. Stored as JSON

>{String}</ActionConfigurations>
9
     <ParentContextMenuItem
ParentContextMenuItem

If this field has a value it indicates that this menu item is a child of another menu item. The value of the field will tell what menu item this menu item is a child of.

>
10
          <ContextMenuItemId
ContextMenuItemId

Context menu item id

>{Integer}</ContextMenuItemId>
11
          <ContextMenuItemLink
ContextMenuItemLink

Context menu item reference

>{String}</ContextMenuItemLink>
12
     </ParentContextMenuItem>
13
     <ContextMenuCollection>
14
          <ContextMenuCollectionId
ContextMenuCollectionId

Context menu collection id. A unique Id representing a single context menu collection.

>{Integer}</ContextMenuCollectionId>
15
          <ContextMenuCollectionLink
ContextMenuCollectionLink

Context menu collection reference

>{String}</ContextMenuCollectionLink>
16
     </ContextMenuCollection>
17
     <TargetApplication
TargetApplication

Specifies APPMATCH of the application the menu item will navigate to.

>
18
          <ApplicationMatch
ApplicationMatch

Matching Keyword

>{String}</ApplicationMatch>
19
     </TargetApplication>
20
     <ApiOperation
ApiOperation

If the actiontype is Operation this field will contain the AOP number to execute when clicking this menu item.

>
21
          <ApiOperationId
ApiOperationId

Api operation identifiers

>{Integer}</ApiOperationId>
22
          <ApiOperationLink
ApiOperationLink

Api operation reference

>{String}</ApiOperationLink>
23
     </ApiOperation>
24
     <AccessRule
AccessRule

Fill this field with a valid ARU (Access rule) number if you want an access rule to be evaluated before showing/executing this menu item.

>
25
          <AccessRuleId
AccessRuleId

Access Rule identifier

>{Integer}</AccessRuleId>
26
          <AccessRuleLink
AccessRuleLink

Reference to access rule details

>{String}</AccessRuleLink>
27
          <IsChanged
IsChanged

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

>{Boolean}</IsChanged>
28
          <Scope
Scope

Scope of the DOV (LOCAL/GLOBAL)

>{String}</Scope>
29
          <OverriddenStatus
OverriddenStatus

Contains the global overridden object status if object status has been changed locally.

>{String}</OverriddenStatus>
30
          <ChangedBy
ChangedBy

EmployeeId of the employee making the change

>
31
               <UserId
UserId

User identifier

>{Integer}</UserId>
32
               <UserLink
UserLink

User reference

>{String}</UserLink>
33
          </ChangedBy>
34
     </AccessRule>
35
</ContextMenuItem>
1
{
2
     "contextMenuItem": {
3
          "contextMenuItemId
ContextMenuItemId

Context menu item id

": "{Integer}",
4
          "status
Status

The status of the context menu item

": "{Integer}",
5
          "title
Title

The title of the context menu item. This is the text that will be visible in the context menu.

": "{String}",
6
          "sortingPriority
SortingPriority

A nuber that will be used for sorting the menu on screen.

": "{Integer}",
7
          "confirmationDialogText
ConfirmationDialogText

If you want a confirmation from the user before running this menu item, this will be the text shown in the confirmation dialog box.

": "{String}",
8
          "actionType
ActionType

The type of action that should happen when a user click this menu item.
Possible values:
0: Operation
1: Popup
2: Legacy Popup
3: Code
4: Navigate

Possible domain values can be found here

": "{Integer}",
9
          "actionConfigurations
ActionConfigurations

Keeps configurations like what application this menu item should navigate to, what popup it should open, how wide and heigh the popup should be, parameter mapping between components and the collection and so on. Stored as JSON

": "{String}",
10
          "parentContextMenuItem
ParentContextMenuItem

If this field has a value it indicates that this menu item is a child of another menu item. The value of the field will tell what menu item this menu item is a child of.

": {
11
               "contextMenuItemId
ContextMenuItemId

Context menu item id

": "{Integer}",
12
               "contextMenuItemLink
ContextMenuItemLink

Context menu item reference

": "{String}"
13
          },
14
          "contextMenuCollection": {
15
               "contextMenuCollectionId
ContextMenuCollectionId

Context menu collection id. A unique Id representing a single context menu collection.

": "{Integer}",
16
               "contextMenuCollectionLink
ContextMenuCollectionLink

Context menu collection reference

": "{String}"
17
          },
18
          "targetApplication
TargetApplication

Specifies APPMATCH of the application the menu item will navigate to.

": {
19
               "applicationMatch
ApplicationMatch

Matching Keyword

": "{String}"
20
          },
21
          "apiOperation
ApiOperation

If the actiontype is Operation this field will contain the AOP number to execute when clicking this menu item.

": {
22
               "apiOperationId
ApiOperationId

Api operation identifiers

": "{Integer}",
23
               "apiOperationLink
ApiOperationLink

Api operation reference

": "{String}"
24
          },
25
          "accessRule
AccessRule

Fill this field with a valid ARU (Access rule) number if you want an access rule to be evaluated before showing/executing this menu item.

": {
26
               "accessRuleId
AccessRuleId

Access Rule identifier

": "{Integer}",
27
               "accessRuleLink
AccessRuleLink

Reference to access rule details

": "{String}",
28
               "isChanged
IsChanged

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

": "{Boolean}",
29
               "scope
Scope

Scope of the DOV (LOCAL/GLOBAL)

": "{String}",
30
               "overriddenStatus
OverriddenStatus

Contains the global overridden object status if object status has been changed locally.

": "{String}",
31
               "changedBy
ChangedBy

EmployeeId of the employee making the change

": {
32
                    "userId
UserId

User identifier

": "{Integer}",
33
                    "userLink
UserLink

User reference

": "{String}"
34
               }
35
          }
36
     }
37
}

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 100444 HTTP 404 API Operation not found
Error 101902 HTTP 400 Access rule can not be added to this type of action
Error 101905 HTTP 404 Target application match can not be set for this type of action
Error 101904 HTTP 400 API operation can not be set for this type of action
Error 101906 HTTP 400 Target app match is required for this type of action
Error 101903 HTTP 400 API operation is required when type of action is 'Execute API Operation'
Error 101864 HTTP 404 Context menu collection not found, or it is not in an active status.
Error 101865 HTTP 404 Access rule not found, or it is not in an active status.
Error 101866 HTTP 404 API operation not found, or it is not in an active status.
Error 101867 HTTP 404 Context menu item not found, or it is in not in an active status.
Error 101899 HTTP 400 Context menu items cannot be added to context menu items with action