Developer Guide

2.5.0
- 2.4.0
- 2.3.2
- 2.3.1
- 2.3.0

Back Next

Update Target Services

Use the POST method to update a target service in EDS.

POST Request in JSON Format

Generate a POST request. For example, the following POST request updates a target service:

POST /api/dataflows/{dataflow-id}/targets/{target-entity-id}

Content-Type: application/json
Accept: application/json
x-http-method-override: PUT

POST Body in JSON Format

The following a sample POST body in JSON format:

{
    "config": {},
    "stats": [],
    "name": "TestUMTargetUpdated",
    "type":"target",
    "pluginId": "_VDS_TGT_UM"
}

POST Response in JSON Format

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

{
    "id": {target-entity-id},
    "name": "TestUMTargetUpdated",
    "type": "TARGET",
    "self": {
        "rel": "self",
        "href": "api/dataflows/{dataflow-id}/targets/{target-entity-id}",
        "title": "TestUMTargetUpdatedAgain",
        "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 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 sample response for the 400 Bad Request code:

{
    "success": false,
    "errors": 
        [
            {
            "code": NAME_FIELD_MISSING,
            "parameters": null,
            "errorMessage": "'name' field is missing in request"
            }
        ]
}

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

Rename Saved Search

Table of Contents

Developer Guide

Developer Guide

Update Target Services

Update Target Services

POST Request in JSON Format

POST Body in JSON Format

POST Response in JSON Format