API

System APIs

GET system/context-menu-items/{contextMenuItemId}

Context menu item details for provided identifier

HTTP method GET
URI https://api.rambase.net/system/context-menu-items/{contextMenuItemId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {contextMenuItemId} Context menu item id
Integer, minimum 100000
Successful HTTP status code 200
API resource identifier 2176, version 4

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
1

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.

$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]
$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
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$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.
$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.
$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.

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. 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:
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
     <TranslatedTitle
TranslatedTitle

This is the translated version of the Title field.

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

>{String}</TranslatedTitle>
6
     <SortingPriority
SortingPriority

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

>{Integer}</SortingPriority>
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}</ConfirmationDialogText>
8
     <TranslatedConfirmationDialogText
TranslatedConfirmationDialogText

The translated version of the ConfirmationDialogText field

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

>{String}</TranslatedConfirmationDialogText>
9
     <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>
10
     <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>
11
     <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.

>
12
          <ContextMenuItemId
ContextMenuItemId

Context menu item id

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

Context menu item reference

>{String}</ContextMenuItemLink>
14
     </ParentContextMenuItem>
15
     <ContextMenuCollection>
16
          <ContextMenuCollectionId
ContextMenuCollectionId

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

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

Context menu collection reference

>{String}</ContextMenuCollectionLink>
18
     </ContextMenuCollection>
19
     <TargetApplication
TargetApplication

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

>
20
          <ApplicationMatch
ApplicationMatch

Matching Keyword

>{String}</ApplicationMatch>
21
     </TargetApplication>
22
     <ApiOperation
ApiOperation

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

>
23
          <ApiOperationId
ApiOperationId

Api operation identifiers

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

Api operation reference

>{String}</ApiOperationLink>
25
     </ApiOperation>
26
     <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.

>
27
          <AccessRuleId
AccessRuleId

Access Rule identifier

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

Reference to access rule details

>{String}</AccessRuleLink>
29
     </AccessRule>
30
     <Repository
Repository

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

>
31
          <IsChanged
IsChanged

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

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

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

Scope of the DOV (LOCAL/GLOBAL)

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

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

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

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

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

EmployeeId of the employee making the change

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

>
35
               <UserId
UserId

User identifier

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

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

User reference

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

>{String}</UserLink>
37
          </ChangedBy>
38
     </Repository>
39
</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
          "translatedTitle
TranslatedTitle

This is the translated version of the Title field.

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

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

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

": "{Integer}",
8
          "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}",
9
          "translatedConfirmationDialogText
TranslatedConfirmationDialogText

The translated version of the ConfirmationDialogText field

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

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

": {
13
               "contextMenuItemId
ContextMenuItemId

Context menu item id

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

Context menu item reference

": "{String}"
15
          },
16
          "contextMenuCollection": {
17
               "contextMenuCollectionId
ContextMenuCollectionId

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

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

Context menu collection reference

": "{String}"
19
          },
20
          "targetApplication
TargetApplication

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

": {
21
               "applicationMatch
ApplicationMatch

Matching Keyword

": "{String}"
22
          },
23
          "apiOperation
ApiOperation

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

": {
24
               "apiOperationId
ApiOperationId

Api operation identifiers

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

Api operation reference

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

": {
28
               "accessRuleId
AccessRuleId

Access Rule identifier

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

Reference to access rule details

": "{String}"
30
          },
31
          "repository
Repository

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

": {
32
               "isChanged
IsChanged

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

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

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

Scope of the DOV (LOCAL/GLOBAL)

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

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

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

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

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

EmployeeId of the employee making the change

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

": {
36
                    "userId
UserId

User identifier

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

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

User reference

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

": "{String}"
38
               }
39
          }
40
     }
41
}

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 101863 HTTP 404 Context menu item not found