Export Application Properties
Exports Account Reconciliation application settings (related to Redwood Experience, theme, email notification, and business process name), background image, and logo image to a JSON file so that you can import them into the same or another environment.
This command is useful when you import an application from prod to test environments. If your application settings are different in prod and test environments, you can export them from the test environment before importing the application from the prod environment, and then import the settings in to the test environment to maintain the original settings.
You can download the export file using the Download REST API. This is a synchronous API.
REST Resource
POST /arm/rest/fcmapi/{api_version}/rc/export/applicationproperties
Required Roles
Service Administrator
Request
Supported Media Types: application/json
Parameters
The following table summarizes the client request parameters specific to this job.
Table 17-41 EXPORT APPLICATION PROPERTIES
Name | Description | Required | Default |
---|---|---|---|
fileName |
The name of the JSON file that stores the exported property values. Use the Upload API to upload the file to the target environment and then restore these settings in the target environment, as described in Import Application Properties. |
Yes | None |
properties |
The comma-separated list of properties to be exported. Valid values include the following:
|
No | All valid properties are exported. |
Examples of request body
Example 1: Exporting all exportable application properties
{
"fileName": "ApplicationProperties.json"
}
Example 2: Exporting specific application properties
{
"fileName": "ApplicationProperties.json",
"properties":["Theme", "EmailNotification", "DisplayBusinessProcessName", "RedwoodExperience"]
}
Response
Supported Media Types: application/json
Parameters:
Table 17-42 Parameters
Name | Description |
---|---|
details |
In case of errors, details are published with the error string. |
status |
Status of the job:
|
links |
Detailed information about the link |
href |
Links to API call or status API |
action |
The HTTP call type |
rel |
Relationship type. It can be self or export-content . If the
export succeeds, you can use the href to download the exported
file.
|
Example of Response Body
The following is an example of the response body in JSON format.
{
"details": "Application properties exported successfully",
"links": [
{
"rel": "self",
"href": "https://<SERVICE_NAME>-
<TENANT_NAME>.<SERVICE_TYPE>.<dcX>.oraclecloud.com/arm/rest/fcmapi/v1/rc/export/applicationproperties",
"action": "POST"
},
{
"rel": "export-content",
"href": "https://<SERVICE_NAME>-
<TENANT_NAME>.<SERVICE_TYPE>.<dcX>.oraclecloud.com/armARCS/rest/v1/ApplicationProperties.json/contents",
"action": "GET"
}
],
"status": 0,
"type": "RC",
"link": {},
"error": null,
"items": []
}