Developer Guide

2.5.0
- 2.4.0
- 2.3.2
- 2.3.1
- 2.3.0

Back Next

Retrieve All Transformations

Use the GET method to retrieve all transformations in EDS.

GET Request in JSON Format

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

GET /api/dataflows/{dataflow-id}/transforms

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

GET Response in JSON Format

The following is the sample response for the 200 OK code when there are no transformations in the data flow:

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

The following is the sample response for when there is a transformation in the data flow:

{
    "total": 1,
    "count": 1,
    "success": true,
    "items": [
        {
            "id": {transform-entity-id},
            "name": "TestInsertTransform",
            "type": "TRANSFORM",
            "pluginId": "_VDS_TRX_INSERT_STR",
            "runMode": "WITH_PREVIOUS",
            "self": {
                "rel": "self",
                "href": "api/dataflows/{dataflow-id}/transforms/{transform-entity-id}",
                "title": "TestInsertTransform",
                "id": {transform-entity-id}
            },
            "dataflow": {
                "rel": "dataflow",
                "href": "api/dataflows/{dataflow-id}",
                "title": "TestDataflow",
                "id": {dataflow-id}
            },
            "valid": true,
            "createDate": "2015-07-07T15:38:48+05:30",
            "createdBy": "Administrator",
            "predefined": false,
            "deployable": true,
            "deploymentState": "DRAFT",
            "force": false,
            "schedulable": false,
            "config": 
            {
                "stringExpression": "#HOSTNAME#DATA"
            },
            "stats": 
            [
                {"name": "Events Received", "value": 10301, "type": 102}, {"name": "Bytes Received", "value": 10300, "type": 102 }, {"name": "Events Generated", "value": 10303, "type": 102 }, 
                {"name": "Bytes Sent", "value": 10302, "type": 102 }, {"name": "Time Taken for Transformation (Milli Sec)", "value": 10304, "type": 102} 
            ]
        }
    ]
}

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

Rename Saved Search

Table of Contents

Developer Guide

Developer Guide

Retrieve All Transformations

Retrieve All Transformations

GET Request in JSON Format

GET Response in JSON Format