Export Logo Image
Exports the corporate logo used in an Account Reconciliation business process to a JPG file so that you can import it into another environment.
The exported file can be download using the Download REST API. This is an asynchronous API.
REST Resource
POST /arm/rest/fcmapi/{api_version}/rc/export/logo
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-49 EXPORT LOGO 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 logo 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 Logo Image. |
Yes | None |
Example of request body
{
"fileName":"logo.jpg"
}
Response
Supported Media Types: application/json
Parameters:
Table 17-50 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 get the status of the
import operation.
|
Example of Response Body
The following is an example of the response body in JSON format.
{
"links": [
{
"rel": "self",
"href": "https://<SERVICE_NAME>-
<TENANT_NAME>.<SERVICE_TYPE>.<dcX>.oraclecloud.com/arm/rest/fcmapi/v1/RC/export/logo",
"action": "POST"
},
{
"rel": "export-content",
"href": "<SERVICE_NAME>-
<TENANT_NAME>.<SERVICE_TYPE>.<dcX>.oraclecloud.com/interop/rest/11.1.2.3.600/applicationsnapshots/logo.jpg/contents",
"action": "GET"
}
],
"details": "Logo image exported successfully.",
"type": "RC",
"status": 0,
"link": {},
"error": null,
"items": []
}