This operation updates the Command Center navigation preferences.
Request
Syntax
Send the request using either XML or JSON:
-
XML
POST <webservice>/NavigationSettings?Organization=0 HTTP/1.1 Host: <host name> Accept: {application/xml | application/json} Authtoken: <authentication token> Content-type: application/xml <update_navigation_template.xml>
-
JSON
POST <webservice>/NavigationSettings?Organization=0 HTTP/1.1 Host: <host name> Accept: {application/xml | application/json} Authtoken: <authentication token> Content-type: application/json <update_navigation_template.json>
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 Parameters
Name |
Description |
Required |
---|---|---|
Organization |
|
Yes |
Request Headers
Name |
Description |
---|---|
Host |
The host name of the Web Server or Web Console 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. |
Content-type |
The media type contained in the request body. |
Request Body
Download the XML or JSON file required for this request: update_navigation_template.xml or update_navigation_template.json. The following table displays the parameters for the request body.
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:
|
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:
|
companySettings |
Response
Response Parameters
Parameter |
Description |
Element |
---|---|---|
errorCode |
The possible error codes. Valid values are:
|
Api_GenericResp |
errorMessage |
The description of the error code. Not all error codes have an error message. |
Api_GenericResp |
Examples
Sample Request
XML
This request updates the company-level navigation preferences.
POST <webservice>/NavigationSettings?Organization=15 HTTP/1.1
Host: client.mydomain.com
Accept: application/xml
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8
Content-type: application/xml
<Api_UpdateNavItemsReq> <navSettings> <companySettings userRole="2" deniedNavItems="gettingStarted, vmGroups" /> <companySettings userRole="1" deniedNavItems="gettingStarted, servers" /> </navSettings>
</Api_UpdateNavItemsReq>
JSON
This request updates the CommCell-level navigation preferences.
POST <webservice>/NavigationSettings?Organization=0 HTTP/1.1
Host: client.mydomain.com
Accept: application/json
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8
Content-type: application/json
{ "navSettings": { "globalSettings": [{ "deniedNavItems": "gettingStarted, servers, servers, blrReplicationGroups, commCell, license", "userRole": 2 }, { "deniedNavItems": "replicationGroups,failover,lifeCyclePolicy, commCell, replicationTargets, gettingStarted,servers", "userRole": 4 }, { "deniedNavItems": "replicationTargets, replicationGroups,failover,lifeCyclePolicy", "userRole": 1 }, { "deniedNavItems": "replicationGroups,failover,lifeCyclePolicy, commCell, replicationTargets", "userRole": 3 }] }
}
Sample Response
<Api_GenericResp errorCode="0" errorMessage="" />