Update a Source

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

Definition

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

Example REST Source Request

curl \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer TOKEN" \
  -X PATCH \
  -d '{
    "owner": ["jd123456"],
    "created_at": "2015-07-04T10:20:00Z",
    "created_by": "av012345",
    "updated_at": "2015-12-20T10:20:00Z",
    "updated_by": "jd123456",
    "secret": "f8a9f620-e0e6-470b-a6b8-1f16b003c034",
    "name": "My source",
    "description": "A superb source",
    "state": 1,
    "production": false,
    "source_type": "REST"
  }' \
  -i \
  https://listener-app-services.teradata.com/v1/sources/758fbda4-accc-4f90-8f09-cc0a164c8c28

Example MQTT Source Request

curl \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer TOKEN" \
  -X PATCH \
  -d '{
    "owner": ["jd123456"],
    "created_at": "2015-07-04T10:20:00Z",
    "created_by": "av012345",
    "updated_at": "2015-12-20T10:20:00Z",
    "updated_by": "jd123456",
    "secret": "f8a9f620-e0e6-470b-a6b8-1f16b003c034",
    "name": "My source",
    "description": "A superb source",
    "state": 1,
    "production": false,
    "source_type": "MQTT",
    "subscription_info": {
      "broker": "http://localhost:1234",
      "topic": "My MQTT topic"
    }
  }' \
  -i \
  https://listener-app-services.teradata.com/v1/sources/758fbda4-accc-4f90-8f09-cc0a164c8c28

Example REST Source Response

HTTP/1.1 200 OK
Content-Type: application/json
{
  "source_id": "758fbda4-accc-4f90-8f09-cc0a164c8c28",
  "owner": ["jd123456"],
  "created_at": "2015-07-04T10:20:00Z",
  "created_by": "av012345",
  "updated_at": "2015-12-20T10:20:00Z",
  "updated_by": "jd123456",
  "secret": "f8a9f620-e0e6-470b-a6b8-1f16b003c034",
  "name": "My source",
  "description": "A superb source",
  "state": 1,
  "production": false,
  "source_type": "REST"
}

Example MQTT Source Response

HTTP/1.1 200 OK
Content-Type: application/json
{
  "source_id": "758fbda4-accc-4f90-8f09-cc0a164c8c28",
  "owner": ["jd123456"],
  "created_at": "2015-07-04T10:20:00Z",
  "created_by": "av012345",
  "updated_at": "2015-12-20T10:20:00Z",
  "updated_by": "jd123456",
  "secret": "f8a9f620-e0e6-470b-a6b8-1f16b003c034",
  "name": "My source",
  "description": "A superb source",
  "state": 1,
  "production": false,
  "source_type": "MQTT",
  "subscription_info": {
    "broker": "http://localhost:1234",
    "topic": "My MQTT topic"
  }
}

Response Codes

CodeDescription
201Source successfully updated.
400Required property missing from request.
401Authorization header not found.
404Resource not found.

results matching ""

    No results matching ""