Produce Service
Overview
The produce service can be used to produce individual messages to a stream. The Rest Proxy supports multiple datatypes for key and value. Producing custom headers is not supported
API Specification
Endpoint |
<baseurl>/stream/{environment}/{stream} |
|
HTTP Method |
|
|
Path Variable |
|
The environment short name as specified in the Self Service definition |
Path Variable |
|
The stream name as specified in the Self Service definition |
Request |
||
HTTP Header |
|
|
HTTP Header |
|
(required) The unique producer instance id (example, 5 parallel producers would use different producer uuid) |
HTTP Header |
|
(required) The application id of the the producer application as specified in the Self Service |
HTTP Header |
|
(optional) The version of the the producer application |
HTTP Header |
|
(optional) The acknowledgement waiting strategy to be used, NONE doesn’t wait, SINGLE waits for the target acknowledgement, ALL waits for the replication acknowledgement. Defaults to SINGLE |
HTTP Header |
|
(optional) The strategy for ordering, KEEPING will ensure delivery or the message in order. With LOSING messages can overtake other messages. Defaults to LOSING |
HTTP Header |
|
(optional) How long does the call wait for delivery in milliseconds. Valid Range 50 - 60000, defaults to 30000 |
HTTP Header |
|
(optional) How long does sending engine wait for extra messages in the batch. Valid range 0-2000 defaults to 50 |
HTTP Body |
JSON Object |
|
Response |
||
HTTP Status Code |
200 |
|
HTTP Header |
|
|
HTTP Body |
JSON Object |
|
Error responses |
||
HTTP Status Code |
403 |
Not authorized to access the stream |
HTTP Status Code |
404 |
Stream and environment combination not found |
HTTP Status Code |
500 |
Generic Internal Error |
HTTP Header |
|
|
HTTP Body |
JSON Object |