System APIs

GET system/context-menu-items

List of all context menu items

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

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.

$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
$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.

AccessRuleId Integer	Access Rule identifier.
ActionType Integer	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.
ApiOperationId Integer	Api operation identifiers.
ContextMenuCollectionId Integer	Context menu collection id. A unique Id representing a single context menu collection.
ContextMenuItemId Integer	Context menu item id.
ParentContextMenuItemId Integer	Context menu item id.
SortingPriority Integer	A nuber that will be used for sorting the menu on screen..
Status Integer	The status of the context menu item.
TargetApplicationMatch String	Matching Keyword.
Title String	The title of the context menu item. This is the text that will be visible in the context menu.

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

AccessRuleId Integer	Access Rule identifier
ActionType Integer	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
ApiOperationId Integer	Api operation identifiers
ContextMenuCollectionId Integer	Context menu collection id. A unique Id representing a single context menu collection.
ContextMenuItemId Integer	Context menu item id
ParentContextMenuItemId Integer	Context menu item id
SortingPriority Integer	A nuber that will be used for sorting the menu on screen.
Status Integer	The status of the context menu item
TargetApplicationMatch String	Matching Keyword
Title String	The title of the context menu item. This is the text that will be visible in the context menu.

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:

                                        <ContextMenuItems>
                                    

                                             <ContextMenuItem>
                                    

<ContextMenuItemId

ContextMenuItemId

Context menu item id

>{Integer}</ContextMenuItemId>

<Status

Status

The status of the context menu item

>{Integer}</Status>

<Title

Title

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

>{String}</Title>

<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=ContextMenuItem.TranslatedTitle in your request URI to get this field

>{String}</TranslatedTitle>

<SortingPriority

SortingPriority

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

>{Integer}</SortingPriority>

<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>

<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=ContextMenuItem.TranslatedConfirmationDialogText in your request URI to get this field

>{String}</TranslatedConfirmationDialogText>

<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>

<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>

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

<ContextMenuItemId

ContextMenuItemId

Context menu item id

>{Integer}</ContextMenuItemId>

<ContextMenuItemLink

ContextMenuItemLink

Context menu item reference

>{String}</ContextMenuItemLink>

                                                  </ParentContextMenuItem>
                                    

                                                  <ContextMenuCollection>
                                    

<ContextMenuCollectionId

ContextMenuCollectionId

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

>{Integer}</ContextMenuCollectionId>

<ContextMenuCollectionLink

ContextMenuCollectionLink

Context menu collection reference

>{String}</ContextMenuCollectionLink>

                                                  </ContextMenuCollection>
                                    

<TargetApplication

TargetApplication

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

<ApplicationMatch

ApplicationMatch

Matching Keyword

>{String}</ApplicationMatch>

                                                  </TargetApplication>
                                    

<ApiOperation

ApiOperation

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

<ApiOperationId

ApiOperationId

Api operation identifiers

>{Integer}</ApiOperationId>

<ApiOperationLink

ApiOperationLink

Api operation reference

>{String}</ApiOperationLink>

                                                  </ApiOperation>
                                    

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

<AccessRuleId

AccessRuleId

Access Rule identifier

>{Integer}</AccessRuleId>

<AccessRuleLink

AccessRuleLink

Reference to access rule details

>{String}</AccessRuleLink>

                                                  </AccessRule>
                                    

<ContextMenuItemLink

ContextMenuItemLink

Context menu item reference

>{String}</ContextMenuItemLink>

                                             </ContextMenuItem>
                                    

<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>
                                    

                                        </ContextMenuItems>
                                    

{

                                             "contextMenuItems": [
                                    

{

"contextMenuItemId

ContextMenuItemId

Context menu item id

": "{Integer}",

"status

Status

The status of the context menu item

": "{Integer}",

"title

Title

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

": "{String}",

"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=ContextMenuItem.TranslatedTitle in your request URI to get this field

": "{String}",

"sortingPriority

SortingPriority

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

": "{Integer}",

"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}",

"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=ContextMenuItem.TranslatedConfirmationDialogText in your request URI to get this field

": "{String}",

"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}",

"actionConfigurations

ActionConfigurations

": "{String}",

"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.

": {

"contextMenuItemId

ContextMenuItemId

Context menu item id

": "{Integer}",

"contextMenuItemLink

ContextMenuItemLink

Context menu item reference

": "{String}"

},

                                                       "contextMenuCollection": {
                                    

"contextMenuCollectionId

ContextMenuCollectionId

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

": "{Integer}",

"contextMenuCollectionLink

ContextMenuCollectionLink

Context menu collection reference

": "{String}"

},

"targetApplication

TargetApplication

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

": {

"applicationMatch

ApplicationMatch

Matching Keyword

": "{String}"

},

"apiOperation

ApiOperation

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

": {

"apiOperationId

ApiOperationId

Api operation identifiers

": "{Integer}",

"apiOperationLink

ApiOperationLink

Api operation reference

": "{String}"

},

"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.

": {

"accessRuleId

AccessRuleId

Access Rule identifier

": "{Integer}",

"accessRuleLink

AccessRuleLink

Reference to access rule details

": "{String}"

},

"contextMenuItemLink

ContextMenuItemLink

Context 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: