Developer Guide

2.5.0
- 2.4.0
- 2.3.2
- 2.3.1
- 2.3.0

Back Next

Get Target Services by ID

Use the GET method to retrieve target services based on ID in EDS.

GET Request in JSON Format

Generate a GET request. For example, the following GET request retrieves a target service based on the ID:

GET /api/dataflows/{dataflow-id}/targets/{target-entity-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": {target-entity-id},
    "name": "TestUMTarget",
    "type": "TARGET",
    "self": {
        "rel": "self",
        "href": "api/dataflows/{dataflow-id}/targets/{target-entity-id}",
        "title": "TestUMTarget",
        "id": {target-entity-id}
    },
    "dataflow": {
        "rel": "dataflow",
        "href": "api/dataflows/{dataflow-id}",
        "title": "Data flow",
        "id": {dataflow-id}
    },
    "success": true,
    "valid": true,
    "createDate": "2015-07-07T03:21:39-07:00",
    "createdBy": "Administrator",
    "predefined": false,
    "deployable": true,
    "deploymentState": "DRAFT",
    "force": false,
    "pluginId": "_VDS_TGT_UM",
    "schedulable": false,
    "config": {},
    "stats": []
}

The following are sample responses for the 404 Not Found code:

{
    "success": false,
    "errors": 
        [
            {
            "code": DATAFLOW_NOT_FOUND,
            "parameters": [{dataflow-id}],
            "errorMessage": "Dataflow with Id: {dataflow-id} not found"
            }
        ]
}

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

Rename Saved Search

Table of Contents

Developer Guide

Developer Guide

Get Target Services by ID

Get Target Services by ID

GET Request in JSON Format

GET Response in JSON Format