Test Connection

POST 
/ECM/testConnection

This API is used to save and test a connection.

The Authorization must have Bearer followed by Token.

Mandatory params:

connectiontype, connectionName OR connectionkey(if both are passed connectionkey is considered)

Additional connection parameters can also be passed -

For example, for SAP Import, provide paramters - JCO_ASHOST, JCO_SYSNR, JCO_CLIENT, JCO_USER, PASSWORD,

This API is enhanced to update vaultconnection, and vaultconfiguration connection details.

From Release v23.10, if you specify the key value for header response as standard,a detailed error message is displayed in the Response that enables you to troubleshoot errors.

Request

multipart/form-data

Body

PASSWORD string
URL string
USERNAME string
connectionName string
connectiontype string
saveconnection string

Responses

200

Test Connection-non standard response / Test Connection-non standard failure / Test Connection-standard response success / Test Connection-standard response failure

Response Headers

• Access-Control-Allow-Credentials

  string

• Access-Control-Allow-Origin

  string

• CF-Cache-Status

  string

• CF-RAY

  string

• Cache-Control

  string

• Connection

  string

• Content-Encoding

  string

• Content-Security-Policy

  string

• Date

  string

• Expires

  string

• Permissions-Policy

  string

• Pragma

  string

• Referrer-Policy

  string

• Server

  string

• Set-Cookie

  string

• Strict-Transport-Security

  string

• Transfer-Encoding

  string

• X-Content-Type-Options

  string

• X-Frame-Options

  string

application/json

Schema

Schema

connectionKey number
connectionName string

connectionResult

object

errors

object[]

Array [

errorMessage string

]

connectionStatus string
connectionType string
errorCode string
msg string

Example (from schema)

{
  "connectionKey": 1909,
  "connectionName": "Active Directory_Doc",
  "connectionResult": {
    "errors": [
      {
        "errorMessage": "The connection to the [LDAP://3.19.17.34:386] server was denied. Target Error Message: [javax.naming.CommunicationException: 3.19.17.34:386 [Root exception is java.net.ConnectException: Connection refused (Connection refused)]\n\t]"
      }
    ]
  },
  "connectionStatus": "SUCCESS",
  "connectionType": "AD",
  "errorCode": "0",
  "msg": "Connection Successful"
}

Test Connection-non standard failure

{
  "connectionKey": 1909,
  "errorCode": "0",
  "msg": "Connection Failed"
}

Test Connection-non standard response

{
  "connectionKey": 1909,
  "errorCode": "0",
  "msg": "Connection Successful"
}

Test Connection-standard response failure

{
  "connectionKey": 1909,
  "connectionName": "Active Directory_Doc",
  "connectionResult": {
    "errors": [
      {
        "errorMessage": "The connection to the [LDAP://3.19.17.34:386] server was denied. Target Error Message: [javax.naming.CommunicationException: 3.19.17.34:386 [Root exception is java.net.ConnectException: Connection refused (Connection refused)]\n\t]"
      }
    ]
  },
  "connectionStatus": "FAILURE",
  "connectionType": "AD",
  "errorCode": "0",
  "msg": "Connection Failed"
}

Test Connection-standard response success

{
  "connectionKey": 1909,
  "connectionName": "Active Directory_Doc",
  "connectionStatus": "SUCCESS",
  "connectionType": "AD",
  "errorCode": "0",
  "msg": "Connection Successful"
}

Loading...