Import Application Properties

Imports Account Reconciliation application settings (related to Redwood Experience, theme, email notification, and business process name), background image, and logo image from an export file into an Account Reconciliation environment. The export file is available for import after the file is uploaded using the Upload REST API.

This a synchronous API.

REST Resource

POST       /arm/rest/fcmapi/{api_version}/rc/import/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 12-35 IMPORT APPLICATION PROPERTIES

Name Description Required Default
api_version The REST API version for the API. This release is v1. Yes v1
fileName

The name of the JSON file that contains exported property values from another environment.

This file, exported from another environment as described in Export Application Properties, must be available in the environment where you are restoring application settings.

Yes None

Example of request body

{
    "fileName":"applicationProperties.json"
}

Response

Supported Media Types: application/json

Parameters:

Table 12-36 Parameters

Name Description
details In case of errors, details are published with the error string
status

Status of the job:

  • -1 = In Progress
  • 0 = Success
  • 1 = Fail
links Detailed information about the link
href Links to API call or status API
action The HTTP call type
rel Relationship type. Possible values: self.

Example of Response Body

The following is an example of the response body in JSON format.

{
    "details": "Application properties imported successfully",
    "links": [
        {
            "rel": "self",
            "href": "https://<SERVICE_NAME>-
<TENANT_NAME>.<SERVICE_TYPE>.<dcX>.oraclecloud.com/arm/rest/fcmapi/v1/rc/import/applicationproperties",
            "action": "POST"
    ],
    "status": 0,
    "type": "RC",
    "link": {},
    "error": null,
    "items": []
}