Import Background Image
Imports the background image from an export file into an Account Reconciliation environment and then sets it as the current background image.
The image will be available for import after you upload the file using the Upload REST API. This is a synchronous API.
REST Resource
POST /arm/rest/fcmapi/{api_version}/rc/import/backgroundImage
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-47 IMPORT BACKGROUND IMAGE
Name | Description | Required | Default |
---|---|---|---|
api_version |
The current REST API version for the API. For example, v1 for this API. | Yes | v1 |
fileName |
The name of the background image file that was exported from another environment. Supported formats include JPG, JPEG, GIF, and PNG. | Yes | None |
Example of request body
{
"fileName":"backgroundImage.jpg"
}
Response
Supported Media Types: application/json
Parameters:
Table 17-48 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. Possible values: self .
|
Example of Response Body
The following is an example of the response body in JSON format.
{
"details": "Background image imported successfully.",
"links": [
{
"rel": "self",
"href": "https://<SERVICE_NAME>-
<TENANT_NAME>.<SERVICE_TYPE>.<dcX>.oraclecloud.com/arm/rest/fcmapi/v1/rc/import/backgroundImage",
"action": "POST"
}
],
"status": 0,
"type": "RC",
"link": {},
"error": null,
"items": []
}