GuidesAPI Reference
API Reference

Consumes data from a layer

get
https://use.apilookup.for.a.base.url/stream/v2/layers//partitions

Consumes data from a layer. Returns messages from a stream layer formatted similar to a Partition object. If the data size is less than 1 MB, the data field will be populated. If the data size is greater than 1 MB, a data handle will be returned pointing to the object stored in the Blob store. The base path to be used is the value of 'nodeBaseURL' returned from /subscribe POST request.

Path Params
string
required

The ID of the stream layers.

Query Params
string

The subscriptionId received in the response of the /subscribe request (required if mode=parallel).

string
enum
Defaults to serial

The subscription mode of this subscriptionId (as provided in /subscribe POST API).

Allowed:
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated last month

Language
Credentials
Bearer
JWT
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
*/*
Updated last month