Update system settings

post

/epm/rest/v1/systemSettings

Update system settings accessed by service admins only.

Request

Supported Media Types
Body ()
Specifies the parameters to update the system settings
Root Schema : Parameters to update the System Settings
Type: object
Show Source
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
Back to Top

Response

Supported Media Types

200 Response

OK
Body ()
Root Schema : SystemPreferences
Type: object
System Settings
Show Source
Nested Schema : preventReqActionByOrigin
Type: array
Show Source
Nested Schema : preventRequestActions
Type: array
Show Source

400 Response

Error in body

403 Response

Forbidden

404 Response

Not Found

500 Response

Invalid file stream
Back to Top

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"
	]
}
Back to Top