Export Background Image

Exports the background image used in an Account Reconciliation environment to a JPG file so that you can import it into another environment.

You can download the image file using the Download REST API. This is a synchronous API.

REST Resource

POST       /arm/rest/fcmapi/{api_version}/rc/export/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-43 EXPORT BACKGROUND IMAGE

Name Description Required Default

api_version The current REST API version for the API. For example, v1 for this API. Yes v1

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 for the background image file in JPG, JPEG, GIF, or PNG format. Use the Upload API to upload the background image file to the target environment and then import it into the target environment, as described in Import Background Image.	Yes	None

fileName

The name for the background image file in JPG, JPEG, GIF, or PNG format.

Use the Upload API to upload the background image file to the target environment and then import it into the target environment, as described in Import Background Image.

Yes

None

Example of request body

{
    "fileName":"backgroundImage.jpg"
}

Response

Supported Media Types: application/json

Parameters:

Table 17-44 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. 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": "Background Image exported successfully",
    "links": [
        {
            "rel": "self",
            "href": "https://<SERVICE_NAME>-
<TENANT_NAME>.<SERVICE_TYPE>.<dcX>.oraclecloud.com/arm/rest/fcmapi/v1/rc/export/backgroundImage",
            "action": "POST"
        },
        {
            "rel": "export-content",
            "href": "https://<SERVICE_NAME>-
<TENANT_NAME>.<SERVICE_TYPE>.<dcX>.oraclecloud.com/interop/rest/11.1.2.3.600/applicationsnapshots/bgImage.jpg/contents",
            "action": "GET"
        }
    ],
    "status": 0,
    "type": "RC",
    "link": {},
    "error": null,
    "items": []
}