Create a Connection

Use this REST API to create a connection that will be saved in an application.

REST Resource

POST /arm/rest/fcmapi/{api_version}/{module}/connections

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-54 Parameters

Name	Description	Type	Required	Default
api_version	Version of the API you are developing with (must be v1)	Path	Yes	None
module	The name of the module for which to create a connection. For Account Reconciliation, set this value to RC.	Path	Yes	None
url	The URL of the connection, such as https://<BASE-URL>	Payload	Yes	None
username	A username with the Service Administrator predefined role	Payload	Yes	None
password	The encrypted password for the user For security reasons, only an encrypted password is allowed. Use the EPM Automate encrypt command to generate the encrypted password. See encrypt .	Payload	Yes	None
type	The type of connection. Valid values include the following: ENTERPRISE_JOURNALS - for Enterprise Journals connections OBJECT_STORAGE - for Object Storage connections	Payload	Yes	None

Example URL

https://<BASE-URL>/arm/rest/fcmapi/v1/rc/connections

Example of Request Body

{
    "url": "https://<BASE-URL>",
    "username": "<NEW_USERNAME>",
    "password": "<NEW_PASSWORD>",
    "type" : "ENTERPRISE_JOURNALS"
}

Response

Supported Media Type: application/json

Table 17-55 Parameters

Parameters	Description
details	In case of errors, details are published with the error string.

Example of Response Body

{
  "details": "Connection created successfully."
}