Connection Services

OvalEdge supports two types of connections:

• Managed Connection: It is used for crawling and profiling of data performed via OvalEdge.
• Manual Connection: It is used to load catalogs into OvalEdge where a direct connection to the client system is not supported. The connection will be set up by the Admin via the application interface. This API will just expose all the connections that were defined in the application. We restrict the ability to add new connections into OvalEdge via API.

The following are the operational APIs associated with the connection service.

1. Get Connection

The Get Connection method requires a {connectionId} as a parameter, which returns a Connection Object as response.

Mandatory Fields: connectionId.

Response

{

"status": true,

"statusCode": "",

"statusMsg": "",

"response": {

"connection": {

"connectionId": 191,

"connectionName": "postgres",

"serverType": "postgres",

"crawlerSettings": [

        {

"crawlerSettingId": 159,

"connectionInfoId": 191,

"setOrder": 1,

"threadCount": 1,

"dayOfWeek": 0,

"startTime": null,

"endTime": null,

"lastUpdateUser": "pavan.nikhilesh@ovaledge.com",

"lastUpdateDate": 1565170468000,

"rowcountcheck": true,

"rowcountlimit": 100000,

"profiletype": 0

        }

      ]

    }

  }

}

2. Get All Connections

Get All Connection method returns a list of the connection object

Response

{

"status": true,

"statusCode": "",

"statusMsg": "",

"response": {

"connections": [

      {

"connectionId": 191,

"connectionName": "name",

"serverType": "type",

"crawlerSettings": [

          {

"crawlerSettingId": 159,

"connectionInfoId": 191,

"setOrder": 1,

"threadCount": 1,

"dayOfWeek": 0,

"startTime": null,

"endTime": null,

"lastUpdateUser": "user",

"lastUpdateDate": 1565170468000,

"rowcountcheck": true,

"rowcountlimit": 100000,

"profiletype": 0

          }

        ]

      }

    ]

  }

}