Developer Guide

2.5.0
- 2.4.0
- 2.3.2
- 2.3.1
- 2.3.0

Back Next

Retrieve Data Connections

Use the GET method to retrieve data connections in EDS.

GET Request in JSON Format

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

GET /api/dataflows/{dataflow-id}/connections/{connection-id}

Content-Type: application/json
Accept: application/json

GET Response in JSON Format

The following is a sample response for the 200 OK code:

{
    "id": {connection-id},
    "name": "UM_transport_1",
    "type": "_VDS_UM_TRANSPORT",
    "resolution": "UNICAST",
    "address": "",
    "daemon": "127.0.0.1:15380",
    "umMode": "ULB",
    "umpStoreName": "",
    "resolverPort": "",
    "requestTcpPort": "",
    "transportTcpPort": "",
    "umConfig": ""
}

The following is a sample response for the 404 Not Found code:

{
    "success": false,
    "errors": 
        [
            {
            "code": CONNECTION_NOT_FOUND,
            "parameters": [{connection-id}],
            "errorMessage": "Connection with Id: {connection-id} not found"
            }
        ]
}

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 connection. Exception : {error-message}."
            }
        ]
}

Rename Saved Search

Table of Contents

Developer Guide

Developer Guide

Retrieve Data Connections

Retrieve Data Connections

GET Request in JSON Format

GET Response in JSON Format