System Configuration API
JSON Example
There is no symmetry between the administrator CUPI URI's for configuration values and the end user access to configuration values. Anything that an end user needs to have read access to has its own URI that an end user can get to. End users cannot get to configuration values directly; for example, they cannot use the /vmrest/configurationvalue URI. If they attempt to use it, they get access denied. A client using an end user's credentials may need to know some information about the system. Currently the information involves two configuration values that an administrator can set:
-
System.Messaging.CumiAccessSecureMessageAttachments
-
System.Messaging.CumiAllowSecureMessageHeaders
Both settings need to be exposed to end users, but end users cannot access configuration values directly. To resolve this issue, we created a way to expose some system values an end user client may need to see using the following URI. Listing System Configuration
GET http://<connection-server>/vmrest/systemconfiguration
The following is the response from the *GET* request and the actual response will depend upon the information given by you:
<SystemConfiguration>
<SecureMessageHeaders>true</SecureMessageHeaders>
<SecureMessageAttachmentDownload>false</SecureMessageAttachmentDownload>
<RecordingMaxLength>1200000</RecordingMaxLength>
<DisableCopyVoiceMessage>false</DisableCopyVoiceMessage>
<ConfirmDeleteMessage>1</ConfirmDeleteMessage>
</SystemConfiguration>
Response Code: 200
GET https://<connection-server>/vmrest/systemconfiguration
Accept: application/json
Content-type: application/json
Connection: keep-alive
The following is the response from the *GET* request and the actual response will depend upon the information given by you:
{
"SecureMessageHeaders": "true",
"SecureMessageAttachmentDownload": "false",
"RecordingMaxLength": "1200000",
"DisableCopyVoiceMessage": "false",
"ConfirmDeleteMessage": "1"
}
This URI can be accessed by any authenticated user, including an end user.