The REST API provides the following methods to manage the Management Console's general settings:
GET /api/managementconsole/settings
URI | GET /api/managementconsole/settings |
---|---|
Description | Retrieves the Management Console's general settings. |
Request Header | Accept: application/json |
Accept: application/vnd.orchestral.rhapsody.6_4+json |
|
Request Body | Empty. |
Response Status | 200 OK - operation successful. |
Response Body |
The response body has the following structure: { "data": { "maxSearchResults": 1000, "maxErrorHoldSearchResults": 1000, "maxPathNodes": 10000, "debatchThreshold": 20, "extraPathNodes": 50, "sessionTimeout": 60, "maxSessionsPerUser": 0, "maxSessionPolicy": "DENY_LOGIN" }, "error": null } |
Access Rights | 'Call REST API'. |
PUT /api/managementconsole/settings
URI | PUT /api/managementconsole/settings |
---|---|
Description | Modifies the Management Console's general settings. |
Request Header | Content-Type: application/json CSRF Protection Enabled |
Content-Type: application/vnd.orchestral.rhapsody.6_4+json CSRF Protection Enabled |
|
Request Body |
The request body has the following structure: { "maxSearchResults": 1000, "maxErrorHoldSearchResults": 1000, "maxPathNodes": 10000, "debatchThreshold": 20, "extraPathNodes": 50, "sessionTimeout": 60, "maxSessionsPerUser": 0, "maxSessionPolicy": "DENY_LOGIN" } |
Response Status | 204 No Content - operation successful. |
Response Body | No value is returned. |
Access Rights | 'Manage general settings REST API'. |