Jump to

• Request
• Response
• Examples

Get system settings

get

/epm/rest/v1/systemSettings

Returns all the system settings accessed by service admins only.

Request

There are no request parameters for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : SystemPreferences

Type: object

System Settings

Show Source

• 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" ]

{
    "type":"object",
    "properties":{
        "logoImageName":{
            "type":"string"
        },
        "backgroundImageName":{
            "type":"string"
        },
        "theme":{
            "type":"string",
            "enum":[
                "ORACLE",
                "CUSTOM_LIGHT",
                "CUSTOM_DARK"
            ]
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "showBusinessProcessName":{
            "type":"boolean"
        },
        "enableNotifications":{
            "type":"boolean"
        },
        "emailSubjectPrefix":{
            "type":"string"
        },
        "substituteRecipient":{
            "type":"string",
            "format":"uuid"
        },
        "substituteRecipientName":{
            "type":"string"
        },
        "oglApplicationId":{
            "type":"string"
        },
        "oglServerURL":{
            "type":"string"
        },
        "preventSubmittedRequestDeletion":{
            "type":"boolean"
        },
        "requestActionPurgePeriod":{
            "type":"integer",
            "format":"int32"
        },
        "fiscalYearEndMonth":{
            "type":"string",
            "enum":[
                "JANUARY",
                "FEBRUARY",
                "MARCH",
                "APRIL",
                "MAY",
                "JUNE",
                "JULY",
                "AUGUST",
                "SEPTEMBER",
                "OCTOBER",
                "NOVEMBER",
                "DECEMBER"
            ]
        },
        "attachSubscriptionRequestFile":{
            "type":"boolean"
        },
        "brandColor":{
            "type":"string"
        },
        "preventReqActionByOrigin":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "preventRequestActions":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    },
    "description":"System Settings"
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : preventReqActionByOrigin

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : preventRequestActions

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : Link

Type: object

Show Source

• href: string
• method: string
• rel: string
• templated: boolean

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "templated":{
            "type":"boolean"
        },
        "method":{
            "type":"string"
        }
    }
}

403 Response

Forbidden

Back to Top

Examples

The following example shows how to retrieve all the system settings by submitting a GET request on the REST resource using cURL.

curl --user edmcs_cloud_user -X GET https://servername.fa.us2.oraclecloud.com/epm/rest/v1/systemSettings

Example of the Response Body

The following example shows the contents of the response body in JSON format:

{
		"backgroundImageName":"1.png",
		"logoImageName": "2.gif",
		"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":"#FFFFFF",
		"preventReqActionByOrigin":[
			"INTERACTIVE",
			"LOAD"
		],
		"preventRequestActions":[
			"REJECT",
			"PUSHBACK"
		]
}

Back to Top