API Reference

Publish Binary Record To Stream

POST/api/v2/highScale/streams/datasets/{datasetRid}/streams/{streamBranchName}/publishBinaryRecord

Warning

This endpoint is in preview and may be modified or removed at any time. To use this endpoint, add preview=true to the request query parameters.

Publish a single binary record to the stream. The stream's schema must be a single binary field.

Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:streams-write.

Path parameters

datasetRid

string

The Resource Identifier (RID) of a Dataset.

streamBranchName

string

The name of a Branch.

Query parameters

viewRid

string

optional

If provided, this operation will only write to the stream corresponding to the specified view rid. If not provided, this operation will write to the latest stream on the branch.

Providing this value is an advanced configuration, to be used when additional control over the underlying streaming data structures is needed.

preview

boolean

optional

Enables the use of preview functionality.

Request body

body

string

The binary record to publish to the stream

Examples

Request

Copied!

curl -X POST \
	-H "Content-type: application/octet-stream" \
	-H "Authorization: Bearer $TOKEN" \
	"https://$HOSTNAME/api/v2/highScale/streams/datasets/ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da/streams/master/publishBinaryRecord?viewRid=ri.foundry-streaming.main.view.ecd4f0f6-8526-4468-9eda-14939449ad79&preview=true" \
	-d '@/path/to/file'