Get a Configuration Menu Section by ID
get
/vision/api/configMenus/{id}
Gets the specified configuration menu section.
Unified Assurance roles with the Admin Vision package permissions have access to this endpoint.
Unified Assurance roles with the Admin Vision package permissions have access to this endpoint.
Request
Path Parameters
-
id(required): string
The ID of the configuration menu resource to get. The default configuration menu resource IDs are single lowercase words.Example:
dashboards
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
OK
Root Schema : ResourceWrapper2
Type:
object
The response resource wrapper.
Show Source
-
columns: array
columns
Information about the columns used to display the requested or updated content.
-
content:
content
-
links: array
links
Links related to the requested or updated content.
Nested Schema : columns
Type:
array
Information about the columns used to display the requested or updated content.
Show Source
-
Array of:
object ColumnData
The details of columns to use to show data in a table.
Nested Schema : content
Match All
Show Source
-
object
ConfigMenu
The details of a Vision configuration menu section.
-
allOf
content-allOf[1]
Nested Schema : links
Type:
array
Links related to the requested or updated content.
Show Source
-
Array of:
object Link
The link details.
Nested Schema : ColumnData
Type:
object
The details of columns to use to show data in a table.
Show Source
-
cssClass: string
The CSS class for the column.Example:
slick-header-column
-
defaultSortAsc: boolean
Whether to sort the column in ascending order by default (true) or not (false).Example:
true
-
editor: string
The editor to use for the column.Example:
TaskEnabledEditor
-
entity: string
The name of the Vision resource that the column represents. This generally corresponds to one of the sections in the side menu of the Settings UI.Example:
Task
-
field: string
The field to use for data in the column cells.Example:
enabled
-
focusable: boolean
Whether the column is focusable (true) or not (false).Example:
true
-
formatter: string
The formatter to apply to the column. For example, CamelCaseFormatter formats strings to use camel case, transforming a value like true to True.Example:
CamelCaseFormatter
-
headerCssClass: string
The CSS class for the column header.Example:
slick-header-column
-
id: integer
(int64)
The column ID.Example:
130
-
maxWidth: integer
(int32)
The maximum width for the column.Example:
80
-
minWidth: integer
(int32)
The minimum width for the column.Example:
30
-
name: string
The column name, that appears in the header row.Example:
Enabled
-
options: string
Options for values in the column.Example:
true,false
-
rerenderOnResize: boolean
Whether the column should be rerendered when resized (true) or not (false).Example:
false
-
resizable: boolean
Whether the column can be resized (true) or not (false).Example:
true
-
selectable: boolean
Whether the column can be selected (true) or not (false).Example:
true
-
sortable: boolean
Whether the column can be used to sort the table (true) or not (false).Example:
true
-
tooltip: string
The tooltip to display for the column.Example:
Whether the task is enabled or disabled.
-
width: integer
(int32)
The default width, in pixels, of the column.Example:
50
Nested Schema : content-allOf[1]
Match All
The requested or updated content.
Show Source
-
object
ConfigMenu
The details of a Vision configuration menu section.
-
The requested or updated content.
Nested Schema : ConfigMenu
Type:
object
The details of a Vision configuration menu section.
Show Source
-
i18n: string
The internationalization string for the section.Example:
config_menu_dashboards
-
id: string
The section ID.Example:
27
-
name: string
The section name.Example:
Dashboards
-
order: integer
(int32)
The position of the section in the menu.Example:
9
-
privileges: array
privileges
The list of Unified Assurance roles who have permission to access the section.
-
tabs: array
tabs
The tabs for the section.
Nested Schema : privileges
Type:
array
The list of Unified Assurance roles who have permission to access the section.
Show Source
Example:
Admin, Operator, Viewer
Nested Schema : tabs
Type:
array
The tabs for the section.
Show Source
-
Array of:
object Tab
The tab details.
Nested Schema : Tab
Type:
object
The tab details.
Show Source
-
form: string
The form to load when the tab is selected.Example:
dashboards
-
i18n: string
The internationalization string for the tab.Example:
config_submenu_view
-
id: integer
(int64)
The tab ID.Example:
1
-
key: string
The key value for the tab.Example:
view
- menuKey: string
-
name: string
The tab name to display.Example:
View
-
order: integer
(int32)
The position of the tab on the tab bar. The tab with order set to 0 is farthest left, or first.Example:
0
-
privileges: array
privileges
The Unified Assurance roles that have access to the tab.
Nested Schema : privileges
Type:
array
The Unified Assurance roles that have access to the tab.
Show Source
Example:
[ Admin, Operator ]
Nested Schema : Link
Type:
object
The link details.
Show Source
-
expects: object
expects
Additional Properties Allowed: additionalPropertiesAny input expected by the link.
-
href: string
The link reference.Example:
https://example.com/layers
-
method: string
The HTTP method used by the linked object.Example:
GET
-
rel: string
The relationship between the linked object and the current object.Example:
self
Nested Schema : expects
Type:
object
Additional Properties Allowed
Show Source
Any input expected by the link.
Example:
text
Nested Schema : additionalProperties
Type:
object
401 Response
Unauthorized Access
Root Schema : schema
Type:
object
The error response details.
Show Source
-
message: string
The error message.Example:
An internal server error occurred.
-
reason: string
The reason phrase for the response.Example:
INTERNAL SERVER ERROR
-
status: integer
(int32)
The response status code.Example:
500
404 Response
Resource not Found
Root Schema : schema
Type:
object
The error response details.
Show Source
-
message: string
The error message.Example:
An internal server error occurred.
-
reason: string
The reason phrase for the response.Example:
INTERNAL SERVER ERROR
-
status: integer
(int32)
The response status code.Example:
500
500 Response
An internal server error occurred while accessing the database or performing a database operation.
Root Schema : schema
Type:
object
The error response details.
Show Source
-
message: string
The error message.Example:
An internal server error occurred.
-
reason: string
The reason phrase for the response.Example:
INTERNAL SERVER ERROR
-
status: integer
(int32)
The response status code.Example:
500