Developer Guide

2.5.0
- 2.4.0
- 2.3.2
- 2.3.1
- 2.3.0

Back Next

Retrieve Data Flows

Use the GET method to retrieve data flows in EDS.

GET Request in JSON Format

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

GET /api/dataflows/{dataflow-id}

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

GET Response in JSON Format

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

{ 
    "success": true,
    "id": {dataflow-id},
    "name": "Dataflow 1",
    "deploymentState": "DRAFT",
    "entities": {
        "count": 3,
        "total": 3,
        "items": [
            {
                "id": 1,
                "name": "TCP",
                "type": "SOURCE",
                "pluginId": "_VDS_SRC_TCP",
                "deploymentState": "DRAFT"
            }, {
                "id": 2,
                "name": "Ultra Messaging",
                "type": "TARGET",
                "pluginId": "_VDS_TGT_UM",
                "deploymentState": "DRAFT"
            }, {
                "id": 3,
                "name": "um",
                "type": "connection",
                "pluginId": "_VDS_UM_TRANSPORT",
                "deploymentState": "DRAFT"
            }
        ]
    }
}

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

{ 
    "success": false,
    "errors":
        [
            { 
            "code": DATAFLOW_NOT_FOUND,
            "parameters": [{dataflow-id}],
            "errorMessage": "Dataflow with Id: {dataflow-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 dataflow. Exception: {error-message}"
            }
        ]
}

Rename Saved Search

Table of Contents

Developer Guide

Developer Guide

Retrieve Data Flows

Retrieve Data Flows

GET Request in JSON Format

GET Response in JSON Format