Developer Guide

2.5.0
- 2.4.0
- 2.3.2
- 2.3.1
- 2.3.0

Back Next

Retrieve All Data Connections

Use the GET method to retrieve all data connections in EDS.

GET Request in JSON Format

Generate a GET request. For example, the following GET request retrieves all data connections:

GET /api/dataflows/{dataflow-id}/connections
Content-Type: application/json
Accept: application/json

GET Response in JSON Format

The following are sample responses for the 200 OK code when there are no data flows:

{
    "success": true,
    "total": 0,
    "count": 0,
    "items": []
}

{
    "total": 2,
    "count": 2,
    "success": true,
    "items": [
        {
            "id": {connection-id-1},
            "name": "UM_transport_1",
            "type": "_VDS_UM_TRANSPORT",
            "resolution": "UNICAST",
            "address": "",
            "daemon": "127.0.0.1:15380",
            "umMode": "UMS",
            "umpStoreName": "",
            "resolverPort": "",
            "requestTcpPort": "",
            "transportTcpPort": "",
            "umConfig": ""
        },
        {
            "id": {connection-id-2},,
            "name": "WS_transport_1",
            "type": "_VDS_WS_TRANSPORT",
            "wsMode": "ACKNOWLEDGEMENT",
            "secure": false,
            "keystorePath": "",
            "keystore_password": "",
            "truststorePath": "",
            "truststorePassword": "",
            "port": "1234",
            "healthCheckUrl": "status",
            "server": "",
            "advancedConfig": ""
       }
    ]
}

The following is a sample response for the 500 Internal Server Error code:

{
    "success": false,
    "errors": 
        [
            {
            "code": INTERNAL_SERVER_ERROR,
            "parameters": [{error-message}],
            "errorMessage": "Failed to get all connections. Exception : {error-message}."
            }
        ]
}

Rename Saved Search

Table of Contents

Developer Guide

Developer Guide

Retrieve All Data Connections

Retrieve All Data Connections

GET Request in JSON Format

GET Response in JSON Format