Get a List of Sources - 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

Load a list of all sources in Listener.

Definition

GET https://listener-app-services.teradata.com/v1/sources?starred HTTP/1.1
Parameter Required Type Sample Purpose
starred Optional boolean true Filter the list of sources by the ones you sorted.

Example Request

curl \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer TOKEN" \
  -X  GET \
  -i \
  https://listener-app-services.teradata.com/v1/sources

Example 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"
  },
  {
    "source_id": "758fbda4-accc-4f90-8f09-cc0a164c8c29",
    "owner": ["jd123456"],
    "created_at": "2015-07-04T10:21:00Z",
    "created_by": "av012345",
    "updated_at": "2015-12-20T10:21:00Z",
    "updated_by": "jd123456",
    "secret": "f8a9f620-e0e6-470b-a6b8-1f16b003c035",
    "name": "My other source",
    "description": "Another superb source",
    "state": 1,
    "production": false,
    "source_type": "MQTT",
    "subscription_info": {
      "broker": "http://localhost:1234",
      "topic": "My MQTT topic",
      "state": "connected"
    }
  },
  {
    "source_id": "758fbda4-accc-4f90-8f09-cc0a164c8c30",
    "owner": ["jd123456"],
    "created_at": "2015-07-04T10:22:00Z",
    "created_by": "av012345",
    "updated_at": "2015-12-20T10:22:00Z",
    "updated_by": "jd123456",
    "secret": "f8a9f620-e0e6-470b-a6b8-1f16b003c036",
    "name": "My other source 2",
    "description": "Another superb source 2",
    "state": 1,
    "production": false,
    "source_type": "MQTT",
    "subscription_info": {
      "broker": "http://localhost:1235",
      "topic": "My MQTT topic 2",
      "state": "disconnected",
      "reason": "Error connecting to subscriber or no subscriptions found."
    }
  },
  ...
]

Response Codes

Code Description
200 Sources successfully returned.
401 Authorization header not found.