IBM Event Streams REST Producer v1.1.0

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

REST API for producing messages to IBM Event Streams.
Note: You must have IBM Event Streams version 2019.1.1 or later to use the REST API.

Getting started
For an introduction to the REST Producer, including authentication for the version of Event Streams you are using, see the producer API.
To retrieve the base url, run the following command: cloudctl es init

Notes
The total length of the URI must not exceed 10Kb.

Default

produceMessage

Code samples

# You can also use wget
curl -X POST /topics/{topic_name}/records \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

POST /topics/{topic_name}/records HTTP/1.1

Content-Type: application/json
Accept: application/json

var headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'

};

$.ajax({
  url: '/topics/{topic_name}/records',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');
const inputBody = '{}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'

};

fetch('/topics/{topic_name}/records',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post '/topics/{topic_name}/records',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('/topics/{topic_name}/records', params={

}, headers = headers)

print r.json()

URL obj = new URL("/topics/{topic_name}/records");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/topics/{topic_name}/records", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /topics/{topic_name}/records

Produce a message.

Produce the body of the request as a message in IBM Event Streams.

Body parameter

{}

{}

<?xml version="1.0" encoding="UTF-8" ?>

Parameters

Enumerated Values

Example responses

200 Response

{
  "metadata": {
    "topic": "string",
    "timestamp": "string",
    "partition": 0,
    "offset": 0
  },
  "Comment": "string"
}

Responses

Schemas

successresponse

{
  "metadata": {
    "topic": "string",
    "timestamp": "string",
    "partition": 0,
    "offset": 0
  },
  "Comment": "string"
}

Object returned on successful request.

Properties

metadata

{
  "topic": "string",
  "timestamp": "string",
  "partition": 0,
  "offset": 0
}

The RecordMetadata object returned from IBM Event Streams.

Properties

error_response

{
  "error_code": 0,
  "message": "string",
  "error": {
    "error_code": 0,
    "message": "string",
    "kafka_error_code": 0,
    "topic": "string",
    "incident": "string",
    "schema": "string"
  }
}

Error object representing the error that occured while producing the message.

Properties