Update a Connection

Use this REST API to update a specific connection that is saved in an application.

Using this REST API requires prerequisites, such as understanding how to use jobs. See Prerequisites. Be sure that you understand how to use jobs as described in Managing Jobs

Note:

If optionName is password, consumerSecret, or tokenSecret, then optionValue must be an encrypted value. Plain (unencrypted) values are not accepted.

REST Resource

/aif/rest/{api_version}/jobs

Required Roles

Service Administrator, Power User

Request

Supported Media Types: application/json

Method:

PUT

Parameters:

The following table summarizes the client request.

Table 16-6 Parameters

Name	Description	Type	Required	Default
sourceSystemID	Identifier of the source system connection to update.	Payload	Yes	None
sourceSystemName	The name of the source system connection.	Payload	Yes	None
sourceSystemType	Type of the source system (for example, Oracle HCM Cloud).	Payload	Yes	None
sourceSystemOptions	List of options to configure the connection. If optionName is password, consumerSecret, or tokenSecret, then optionValue must be an encrypted value. Plain (unencrypted) values are not accepted.	Payload	Yes	None
username	A username with 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
serviceURL	The base URL of the target source system.	Payload	Yes	None
consumerSecret	Specify the consumer secret that authorizes the client making the request. For security reasons, consumerSecret parameter must be encrypted.	Payload	Yes	None
tokenSecret	The token secret that generates the signature for the request. For security reasons, tokenSecret parameter must be encrypted.	Payload	Yes	None

Example URL

https://<BASE-URL>/aif/rest/V1/objects/connections/

Example of Request Body

{
  "sourceSystemId": 10,
  "sourceSystemName": "<SOURCE_SYSTEM_NAME>",
  "sourceSystemType": "<SOURCE_SYSTEM_TYPE>",
  "sourceSystemOptions": [
    {
      "optionValue": "<USERNAME>",
      "optionName": "userName"
    },
    {
      "optionValue": "https://<SERVICE_URL>",
      "optionName": "serviceURL"
    },
    {
      "optionValue": "<******>",
      "optionName": "password"
    }
  ]
}

Response

Supported Media Type: application/json

Table 16-7 Parameters

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

Example of Response Body

{
"status": 0,
"details": null,
"response": "Updated source connection object Test6 successfully"
}