Update a Target - Teradata Listener

Teradata® Listener™ User Guide

Product
Teradata Listener
Release Number
2.03
Published
September 2018
Language
English (United States)
Last Update
2018-10-01
dita:mapPath
kum1525897006440.ditamap
dita:ditavalPath
ft:empty
dita:id
B035-2910
lifecycle
previous
Product Category
Analytical Ecosystem

To update a target, send a JSON object with updated values for one or more of the writable target properties. Read-only properties are ignored. All property values from the previous version of this target are carried over by default if not included in the hash.

Definition

PATCH https://listener-app-services.teradata.com/v1/targets/{target_id} HTTP/1.1

Example Request

curl \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer TOKEN" \
  -X PATCH \
  -d '{
    "production": true
  }' \
  -i \
  https://listener-app-services.teradata.com/v1/targets/758fbda4-accc-4f90-8f09-cc0a164c8c28

Example Responses

HTTP/1.1 200 OK
Content-Type: application/json
{
  "target_id": "758fbda4-accc-4f90-8f09-cc0a164c8c28",
  "source_id": "84757abc-ba43-5736-0ba3-1bdac4748290",
  "system_id": "9dda5570-70e0-45be-8449-83f33320cd08",
  "owner": ["jd123456"],
  "created_at": "2015-07-04T10:20:00Z",
  "created_by": "av012345",
  "updated_at": "2015-12-20T10:20:00Z",
  "updated_by": "jd123456",
  "name": "My Data Target",
  "description": "A superb data target",
  "target_type": "teradata",
  "data_path": {
    "schema": "schema",
    "table": "table"
  },
  "system_info": {
    "username": "ip112233",
    "password": "password"
  },
  "state": 1,
  "production": true,
  "batch": true,
  "bundle_type": "records",
  "bundle_interval": 500
}

Response Codes

Code Description
200 Target successfully updated.
400 Required property missing from request.
401 Authorization header not found.
404 Resource not found.