REST API - GET Navigation

This operation returns the Command Center navigation preferences.

Request

Syntax

GET webservice/NavigationSettings HTTP/1.1
Host: host name
Accept: application/xml
Authtoken: authentication token

where <webservice> is the root path used to route the API requests to the Web Server.

For more information, see Available Web Services for REST API.

Request Headers

Name	Description
Host	The host name of the Web Server or the Command Center used in the API request.
Accept	The format of the response. Valid values are: application/xml or application/json.
Authtoken	The authentication token received after successfully logging on. For details on receiving an authentication token, see Authentication.

Response

Response Parameters

Parameter	Description	Element
deniedNavItems	CommCell level: The left pane navigation nodes that the user role (persona) cannot access. For a list of valid values, see Navigation Codes and Titles.	globalSettings
defaultLandingPage	CommCell level: The landing page set for the user role (persona).	globalSettings
userRole	CommCell level: The user role (persona) that the navigation preferences apply to. Valid values are: 0, the CommCell administrator role 1, the tenant administrator role 2, the tenant user role 3, the CommCell user role 4, the restricted user role	globalSettings
deniedNavItems	Company level: The left pane navigation nodes that the user role (persona) cannot access. For a list of valid values, see Navigation Codes and Titles.	companySettings
defaultLandingPage	Company level: The landing page set for the user role (persona).	companySettings
userRole	Company level: The user role (persona) that the navigation preferences apply to. Valid values are: 0, the CommCell administrator role 1, the tenant administrator role 2, the tenant user role 3, the CommCell user role 4, the restricted user role	companySettings

Examples

Sample Request

GET webservice/NavigationSettings HTTP/1.1
Host: client.mydomain.com
Accept: application/json
 Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc60f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef768fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f3233d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8

Sample Response

This is the response when the navigation options have not changed from the default options.

<Api_GenericResp errorCode="0" errorMessage="" />

This is the response when the navigation options are changed through a POST API or through the Command Center.

{ "navSettings": { "globalSettings": [ { "deniedNavItems": "", "defaultLandingPage": "", "userRole": 0 }, { "deniedNavItems": "gettingStarted,replicationGroups,commCell,license,operationWindow,metricsReporting,snmp,plugin,accessControl,globalExceptions,maintenance,dataOptions,certificate,storagePool,storage,snapArray,mediaAgent", "defaultLandingPage": "", "userRole": 1 }, { "deniedNavItems": "gettingStarted,dashboard,sharepoint,profile,subscriptions,replicationGroups,replicationMonitor,triggeredAlerts,commCell,license,customization,navigationPreferences,emailTemplates,operationWindow,metricsReporting,snmp,plugin,accessControl,globalExceptions,maintenance,dataOptions,certificate,storagePool,storage,snapArray,mediaAgent,users,userGroups,roles,identityServers,nameServers", "defaultLandingPage": "", "userRole": 2 }, { "deniedNavItems": "commCell,license,customization,navigationPreferences,emailTemplates,operationWindow,metricsReporting,snmp,plugin,accessControl,globalExceptions,maintenance,dataOptions,certificate,identityServers", "defaultLandingPage": "", "userRole": 3 }, { "deniedNavItems": "gettingStarted,dashboard,profile,subscriptions,replicationGroups,replicationMonitor,triggeredAlerts,commCell,clientGroupDetails,serverGroups,license,customization,navigationPreferences,emailTemplates,operationWindow,metricsReporting,snmp,plugin,accessControl,globalExceptions,maintenance,dataOptions,certificate,storagePool,storage,snapArray,mediaAgent,users,userGroups,roles,identityServers,nameServers", "defaultLandingPage": "", "userRole": 4 } ] }, "error": { "errorMessage": "", "errorCode": 0 }
}