SdsStreamView API

The REST APIs provide programmatic access to read and write Sequential Data Store (SDS) data. The APIs in this section interact with SdsStreamViews. For general SdsStreamView information, see Stream views.

List Stream Views

Returns a list of SdsStreamView

Request

GET /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/StreamViews?query={query}&skip={skip}&count={count}&orderby={orderby}

Parameters

string tenantId Tenant identifier

string namespaceId Namespace identifier

[Optional] string query
Query identifier. See Search in SDS for information about specifying the search parameter.

[Optional] int skip
Parameter representing the zero-based offset of the first object to retrieve. If unspecified, a default value of 0 is used.

[Optional] int count
Parameter representing the maximum number of objects to retrieve. If unspecified, a default value of 100 is used.

[Optional] string orderby
Parameter representing sorted order. A field name is required. The sorting is based on the stored values for a given field (of type string). For example, orderby=name would sort the returned results by the name values (ascending by default). Additionally, a value can be provided along with the field name to identify whether to sort ascending or descending, by using values asc or desc, respectively. For example, orderby=name desc sorts the returned results by descending name values. If you do not specify a value, the results are not sorted.

Response

Example response body

200 Response

HTTP/1.1 200

Content-Type: application/json

[

{

"Id":"StreamView",

"Name":"StreamView",

"SourceTypeId":"Simple",

"TargetTypeId":"Simple3"

},

{

"Id":"StreamViewWithProperties",

"Name":"StreamViewWithProperties",

"SourceTypeId":"Simple",

"TargetTypeId":"Simple3",

"Properties":[

{

"SourceId":"Time",

"TargetId":"Time"

},

{

"SourceId":"State",

"TargetId":"State"

},

{

"SourceId":"Measurement",

"TargetId":"Value"

}

]

}

]

400 Response (ErrorResponseBody)

{

"OperationId": "string",

"Error": "string",

"Reason": "string",

"Resolution": "string",

"Parameters": {

"property1": "string",

"property2": "string"

}

}

Get Stream View

Returns the SdsStreamView

Request

GET /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/StreamViews/{streamViewId}

Parameters

string tenantId Tenant identifier

string namespaceId Namespace identifier

string streamViewId Stream view identifier

Response

Example response body

200 Response

HTTP/1.1 200

Content-Type: application/json

{

"Id":"StreamView",

"Name":"StreamView",

"SourceTypeId":"Simple",

"TargetTypeId":"Simple3",

"Properties":[

{

"SourceId":"Time",

"TargetId":"Time"

},

{

"SourceId":"State",

"TargetId":"State"

},

{

"SourceId":"Measurement",

"TargetId":"Value"

}

]

}

400 Response (ErrorResponseBody)

{

"OperationId": "string",

"Error": "string",

"Reason": "string",

"Resolution": "string",

"Parameters": {

"property1": "string",

"property2": "string"

}

}

Get Or Create Stream View

If an SdsStreamView with a matching identifier already exists, the stream view passed in is compared with the existing stream view. If the stream views are identical, a Found (302) status is returned. If the stream views are different, the Conflict (409) error is returned. If no matching identifier is found, the specified stream view is created.

Request

POST /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/StreamViews/{streamViewId}

Parameters

string tenantId Tenant identifier

string namespaceId Namespace identifier

string streamViewId Stream view identifier

Response

Example response body

200 Response (SdsStreamView)

{

"Id": "string",

"Name": "string",

"Description": "string",

"SourceTypeId": "string",

"TargetTypeId": "string",

"Properties": [

{

"SourceId": "string",

"TargetId": "string",

"SdsStreamView": {

"Id": "string",

"Name": "string",

"Description": "string",

"SourceTypeId": "string",

"TargetTypeId": "string",

"Properties": [

null

]

}

}

]

}

Create Or Update Stream View

Creates or updates the definition of a SdsStreamView

Request

PUT /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/StreamViews/{streamViewId}

Parameters

string tenantId Tenant identifier

string namespaceId Namespace identifier

string streamViewId Stream view identifier

Response

Example response body

200 Response (SdsStreamView API)

{

"Id": "string",

"Name": "string",

"Description": "string",

"SourceTypeId": "string",

"TargetTypeId": "string",

"Properties": [

{

"SourceId": "string",

"TargetId": "string",

"SdsStreamView": {

"Id": "string",

"Name": "string",

"Description": "string",

"SourceTypeId": "string",

"TargetTypeId": "string",

"Properties": [

null

]

}

}

]

}

Delete Stream View

Deletes a stream view from the specified tenant and namespace

Request

DELETE /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/StreamViews/{streamViewId}

Parameters

string tenantId Tenant identifier

string namespaceId Namespace identifier

string streamViewId Stream view identifier

Response

Example response body

400 Response (ErrorResponseBody)

{

"OperationId": "string",

"Error": "string",

"Reason": "string",

"Resolution": "string",

"Parameters": {

"property1": "string",

"property2": "string"

}

}

Get Stream View Map

Returns the SdsStreamViewMap corresponding to the specified streamViewId

Request

GET /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/StreamViews/{streamViewId}/Map

Parameters

string tenantId Tenant identifier

string namespaceId Namespace identifier

string streamViewId Stream view identifier

Response

Example response body

200 Response

HTTP/1.1 200

Content-Type: application/json

{

"SourceTypeId": "Simple",

"TargetTypeId": "Simple3",

"Properties": [

{

"SourceId": "Time",

"TargetId": "Time"

},

{

"SourceId": "Measurement",

"TargetId": "Value",

"Mode": 20

},

{

"SourceId": "State",

"Mode": 2

},

{

"TargetId": "State",

"Mode": 1

}

]

}

400 Response (ErrorResponseBody)

{

"OperationId": "string",

"Error": "string",

"Reason": "string",

"Resolution": "string",

"Parameters": {

"property1": "string",

"property2": "string"

}

}

Definitions

SdsStreamView

A contract defining the stream view

Properties

{

"Id": "string",

"Name": "string",

"Description": "string",

"SourceTypeId": "string",

"TargetTypeId": "string",

"Properties": [

{

"SourceId": "string",

"TargetId": "string",

"SdsStreamView": {

"Id": "string",

"Name": "string",

"Description": "string",

"SourceTypeId": "string",

"TargetTypeId": "string",

"Properties": [

null

]

}

}

]

}

SdsStreamViewProperty

A contract defining the stream view property

Properties

{

"SourceId": "string",

"TargetId": "string",

"SdsStreamView": {

"Id": "string",

"Name": "string",

"Description": "string",

"SourceTypeId": "string",

"TargetTypeId": "string",

"Properties": [

{

"SourceId": "string",

"TargetId": "string",

"SdsStreamView": null

}

]

}

}

ErrorResponseBody

Contains the error message format that follows the CONNECT data services error standards

Properties

{

"OperationId": "string",

"Error": "string",

"Reason": "string",

"Resolution": "string",

"Parameters": {

"property1": "string",

"property2": "string"

}

}

SdsStreamViewMap

A contract defining the stream view map

Properties

{

"SourceTypeId": "string",

"TargetTypeId": "string",

"Properties": [

{

"SourceId": "string",

"TargetId": "string",

"Mode": 0,

"StreamViewMap": {

"SourceTypeId": "string",

"TargetTypeId": "string",

"Properties": [

null

]

}

}

]

}

SdsStreamViewMapProperty

A contract defining stream view map property

Properties

{

"SourceId": "string",

"TargetId": "string",

"Mode": 0,

"StreamViewMap": {

"SourceTypeId": "string",

"TargetTypeId": "string",

"Properties": [

{

"SourceId": "string",

"TargetId": "string",

"Mode": null,

"StreamViewMap": null

}

]

}

}

SdsStreamViewMode

Enumerated Values