Update system settings
post
/epm/rest/v1/systemSettings
Update system settings accessed by service admins only.
Request
Supported Media Types
- application/json
Specifies the parameters to update the system settings
Root Schema : Parameters to update the System Settings
Type:
Show Source
object
-
attachRequestFile:
boolean
Include the request file as attachment for approver/committer notification email.
-
attachSubscriptionRequestFile:
boolean
Include the request file as attachment for subscription notification email.
-
backgroundImageName:
string
Name of the background image file. It can only be used with Custom Dark and Custom Light themes. Allowed file types are JPG, PNG and GIF. The image file must be first uploaded to the staging area.
-
brandColor:
string
Brand color code. It can only be used with the Custom Dark and Custom Light themes. Allowed values are #FFFFFF, #EDF6F6, #F8F1FC, #FAF2F4, #FFEBE8, #FDF3E4, #FDF4DF, #EEF5FF, #F5F4F2, #CBE9D6, #D7E5E5, #EADDF4, #F6DAE1, #FCD0CA, #F5DEBD, #F7E0A1, #DAE2EF, #E4E1DD, #99C2A6, #A9BBBC, #C4B0D1, #D9ABB6, #EEA59C, #ECCB98, #D5B364, #B0B8C4, #BCB6B1, #74A683, #8B9D9E, #A890B6, #C28897, #DE7A6D, #C58C52, #B39554, #9299A6, #9E9892, #4C825C, #697778, #846A92, #A36472, #CA4D3C, #AA643B, #89723F, #6F757E, #7A736E, #3F6B4B, #586363, #6F577B, #86505C, #AC3E2E, #8D4F2E, #715E34, #5C6169, #665F5B, #33553C, #464F4F, #594564, #6C3F49, #863125, #713F25, #5B4A29, #494D53, #514C47, #253D2C, #323939, #3F3048, #4F2B33, #60231A, #512C1B, #40361D, #34363B, #3A3632
-
emailSubjectPrefix:
string
Configure prefix to apply at the subject of the email.
-
enableNotifications:
boolean
Notifications to the user enabled.
-
fiscalYearEndMonth(required):
string
Allowed Values:
[ "JANUARY", "FEBRUARY", "MARCH", "APRIL", "MAY", "JUNE", "JULY", "AUGUST", "SEPTEMBER", "OCTOBER", "NOVEMBER", "DECEMBER" ]
Specify the last month of the fiscal year. -
logoImageName:
string
Name of the logo image file in the staging area. Valid file types are JPG, PNG and GIF. The image file must be first uploaded to the staging area.
-
oglApplicationId:
string
Application Id of Oracle Guided Learning.
-
oglServerURL:
string
Server Url for Oracle Guided Learning.
-
preventReqActionByOrigin:
array preventReqActionByOrigin
Unique Items Required:
true
Prevent for these request types. Allowed values are INTERACTIVE, SUBSCRIPTION, CONSOLIDATION, IMPORT, LOAD. -
preventRequestActions:
array preventRequestActions
Unique Items Required:
true
Actions to prevent. Allowed values are REJECT, PUSHBACK, RECALL. -
preventSubmittedRequestDeletion:
boolean
Prevent a submitted request from being deleted.
-
requestActionPurgePeriod:
integer(int32)
Defines the number of months before actions are purged from completed requests. Allowed value ranges between 6 and 18.
-
showBusinessProcessName:
boolean
Display business process name.
-
substituteRecipientName:
string
User name of the substitute recipient.
-
theme(required):
string
Allowed Values:
[ "ORACLE", "CUSTOM_LIGHT", "CUSTOM_DARK" ]
Specify the theme for application.
Nested Schema : preventReqActionByOrigin
Type:
array
Unique Items Required:
true
Prevent for these request types. Allowed values are INTERACTIVE, SUBSCRIPTION, CONSOLIDATION, IMPORT, LOAD.
Show Source
Nested Schema : preventRequestActions
Type:
array
Unique Items Required:
true
Actions to prevent. Allowed values are REJECT, PUSHBACK, RECALL.
Show Source
Response
Supported Media Types
- application/json
200 Response
OK
Root Schema : SystemPreferences
Type:
object
System Settings
Show Source
-
attachRequestFile:
boolean
-
attachSubscriptionRequestFile:
boolean
-
backgroundImageName:
string
-
brandColor:
string
-
emailSubjectPrefix:
string
-
enableNotifications:
boolean
-
fiscalYearEndMonth:
string
Allowed Values:
[ "JANUARY", "FEBRUARY", "MARCH", "APRIL", "MAY", "JUNE", "JULY", "AUGUST", "SEPTEMBER", "OCTOBER", "NOVEMBER", "DECEMBER" ]
-
links:
array links
-
logoImageName:
string
-
oglApplicationId:
string
-
oglServerURL:
string
-
preventReqActionByOrigin:
array preventReqActionByOrigin
-
preventRequestActions:
array preventRequestActions
-
preventSubmittedRequestDeletion:
boolean
-
requestActionPurgePeriod:
integer(int32)
-
showBusinessProcessName:
boolean
-
substituteRecipient:
string(uuid)
-
substituteRecipientName:
string
-
theme:
string
Allowed Values:
[ "ORACLE", "CUSTOM_LIGHT", "CUSTOM_DARK" ]
400 Response
Error in body
403 Response
Forbidden
404 Response
Not Found
500 Response
Invalid file stream
Examples
The following example shows how to update system settings by submitting a POST request on the REST resource using cURL.
cURL Command
curl --user epm_cloud_user -X POST -H 'Content-Type: application/json' -d
@example_request_payload.json https://servername.fa.us2.oraclecloud.com/epm/rest/v1/systemSettings
Example of Request Body
The following shows an example of the request body in JSON format.
{ "logoImageName": "2.gif", "backgroundImageName": "1.png", "theme": "CUSTOM_DARK", "showBusinessProcessName": true, "enableNotifications": true, "emailSubjectPrefix": "Demo:", "substituteRecipientName": "barry", "oglApplicationId": "abc@xyz", "oglServerURL": "https://guidedlearning.oracle.com", "preventSubmittedRequestDeletion": true, "requestActionPurgePeriod": 6, "fiscalYearEndMonth": "DECEMBER", "attachSubscriptionRequestFile": true, "brandColor": "#CBE9D6", "preventReqActionByOrigin": [ "LOAD", "INTERACTIVE" ], "preventRequestActions": [ "REJECT", "PUSHBACK" ] }
Example of Response Body
The following shows an example of the response body in JSON format.
{ "logoImageName":"2.gif", "backgroundImageName":"1.png", "theme":"CUSTOM_DARK", "showBusinessProcessName":true, "enableNotifications":true, "emailSubjectPrefix":"Demo:", "substituteRecipientName":"barry", "oglApplicationId":"abc@xyz", "oglServerURL":"https://guidedlearning.oracle.com", "preventSubmittedRequestDeletion":true, "requestActionPurgePeriod":6, "fiscalYearEndMonth":"DECEMBER", "attachSubscriptionRequestFile":true, "brandColor":"#CBE9D6", "preventReqActionByOrigin":[ "INTERACTIVE", "LOAD" ], "preventRequestActions":[ "REJECT", "PUSHBACK" ] }