Bulk Streams

Defines the API endpoint for bulk stream data access.

Join Bulk Stream Values

Returns all values between a given start and end date, joined according to a given join mode for all stream IDs in a comma-separated list. If no value exists for a stream at a timestamp that is required by the join mode, null is returned.

Request

GET /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/Bulk/Streams/Data/Joins?streams={streamIds}&joinMode={joinMode}&startIndex={startIndex}&endIndex={endIndex}

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

string streamIds
Stream IDs, comma seperated.

integer joinMode
join mode for the query
|Join Mode|Join Type|Description| |---|---|---| |0|Inner|Returns one row for each unique timestamp that occurs in all streams in the data set| |1|Outer|Returns one row for every unique timestamp in the data set, returns null when a stream does not have a value for the timestamp| |2|Outer Interpolated|Returns one row for every unique timestamp in the data set, returns an interpolated value when a stream does not have a value for the timestamp| |3|Outer Left|Returns one row for every unique timestamp in the data set with one column of values corresponding to the first non-null value starting from the left-most streamId| |4|Outer Right|Returns one row for every unique timestamp in the data set with one column of values corresponding to the first non-null value starting from the right-most streamId|

string startIndex
Index identifying the beginning of the request window

string endIndex
Index identifying the end of the request window

Response

Definitions

ErrorResponseBody

The error response contains details on the cause of the error.

Properties

{
  "Message": "string"
}