Developer Guide

2.5.0
- 2.4.0
- 2.3.2
- 2.3.1
- 2.3.0

Back Next

Retrieve All Target Services

Use the GET method to retrieve all target services in EDS.

GET Request in JSON Format

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

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

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 targets:

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

The following is a sample response when there is one UM target in the data flow:

{
    "total": 1,
    "count": 1,
    "success": true,
    "items": [
        {
            "id": {target-entity-id},
            "name": "um-target",
            "type": "TARGET",
            "pluginId": "_VDS_TGT_UM",
            "self": {
                "rel": "self",
                "href": "api/dataflows/{dataflow-id}/targets/{target-entity-id}",
                "title": "um-target",
                "id": {target-entity-id}
            },
            "dataflow": {
                "rel": "dataflow",
                "href": "api/dataflows/{dataflow-id}",
                "title": "Data flow",
                "id": {dataflow-id}
            },
            "valid": true,
            "createDate": "2015-07-07T02:31:41-07:00",
            "createdBy": "Administrator",
            "predefined": false,
            "deployable": true,
            "deploymentState": "DRAFT",
            "force": false,
            "schedulable": false,
            "config": {},
            "stats": []
        }
    ]
}

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

Rename Saved Search

Table of Contents

Developer Guide

Developer Guide

Retrieve All Target Services

Retrieve All Target Services

GET Request in JSON Format

GET Response in JSON Format