SdsStream API
- Last UpdatedSep 25, 2025
- 26 minute read
The REST APIs provide programmatic access to read and write Sequential Data Store (SDS) data. The APIs in this section interact with SdsStreams. For general SdsStream information, see Streams.
List Streams
Returns a list of streams
Request
GET /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/Streams?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 would sort the returned results by the name values, descending. If no value is specified, there is no sorting of results.
Response
|
Status Code |
Body Type |
Description |
|---|---|---|
|
200 |
Returns a list of SdsStream objects |
|
|
400 |
Missing or invalid inputs |
|
|
401 |
Unauthorized |
|
|
403 |
Forbidden |
|
|
404 |
One of the resources specified was not found. |
|
|
500 |
An error occurred while processing the request. |
|
|
503 |
Service Unavailable |
Example response body
200 Response (SdsStream[])
[
{
"Id": "string",
"Name": "string",
"Description": "string",
"TypeId": "string",
"Indexes": [
{
"SdsTypePropertyId": "string"
}
],
"InterpolationMode": 0,
"ExtrapolationMode": 0,
"PropertyOverrides": [
{
"SdsTypePropertyId": "string",
"Uom": "string",
"InterpolationMode": 0
}
]
}
]
Get Stream
Returns the specified stream
Request
GET /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/Streams/{streamId}
Parameters
string tenantId Tenant identifier
string namespaceId Namespace identifier
string streamId Stream identifier
Response
|
Status Code |
Body Type |
Description |
|---|---|---|
|
200 |
Returns the SdsStream |
|
|
400 |
Missing or invalid inputs |
|
|
401 |
Unauthorized |
|
|
403 |
Forbidden |
|
|
404 |
One of the resources specified was not found. |
|
|
500 |
An error occurred while processing the request. |
|
|
503 |
Service Unavailable |
Example response body
200 Response (SdsStream)
{
"Id": "string",
"Name": "string",
"Description": "string",
"TypeId": "string",
"Indexes": [
{
"SdsTypePropertyId": "string"
}
],
"InterpolationMode": 0,
"ExtrapolationMode": 0,
"PropertyOverrides": [
{
"SdsTypePropertyId": "string",
"Uom": "string",
"InterpolationMode": 0
}
]
}
Get Or Create Stream
Creates the specified stream. If a stream with a matching identifier already exists, SDS compares the existing stream with the stream that was sent.
Request
POST /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/Streams/{streamId}
Parameters
string tenantId Tenant identifier
string namespaceId Namespace identifier
string streamId Stream identifier
Response
|
Status Code |
Body Type |
Description |
|---|---|---|
|
200 |
Returns the SdsStream |
|
|
201 |
Returns the SdsStream |
|
|
400 |
Missing or invalid inputs |
|
|
401 |
Unauthorized |
|
|
403 |
Forbidden |
|
|
404 |
One of the resources specified was not found. |
|
|
409 |
Conflict |
|
|
500 |
An error occurred while processing the request. |
|
|
503 |
Service Unavailable |
Example response body
200 Response (SdsStream)
{
"Id": "string",
"Name": "string",
"Description": "string",
"TypeId": "string",
"Indexes": [
{
"SdsTypePropertyId": "string"
}
],
"InterpolationMode": 0,
"ExtrapolationMode": 0,
"PropertyOverrides": [
{
"SdsTypePropertyId": "string",
"Uom": "string",
"InterpolationMode": 0
}
]
}
Create Or Update Stream
Creates the specified stream. If a stream with the same Id already exists, the definition of the stream is updated.
Request
PUT /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/Streams/{streamId}
Parameters
string tenantId Tenant identifier
string namespaceId Namespace identifier
string streamId Stream identifier
Response
|
Status Code |
Body Type |
Description |
|---|---|---|
|
201 |
Returns the SdsStream |
|
|
204 |
None |
Returns the SdsStream |
|
400 |
Missing or invalid inputs |
|
|
401 |
Unauthorized |
|
|
403 |
Forbidden |
|
|
404 |
One of the resources specified was not found. |
|
|
409 |
Conflict |
|
|
500 |
An error occurred while processing the request. |
|
|
503 |
Service Unavailable |
Example response body
201 Response (SdsStream)
{
"Id": "string",
"Name": "string",
"Description": "string",
"TypeId": "string",
"Indexes": [
{
"SdsTypePropertyId": "string"
}
],
"InterpolationMode": 0,
"ExtrapolationMode": 0,
"PropertyOverrides": [
{
"SdsTypePropertyId": "string",
"Uom": "string",
"InterpolationMode": 0
}
]
}
Delete Stream
Deletes a stream from the specified tenant and namespace
Request
DELETE /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/Streams/{streamId}
Parameters
string tenantId Tenant identifier
string namespaceId Namespace identifier
string streamId Stream identifier
Response
|
Status Code |
Body Type |
Description |
|---|---|---|
|
204 |
None |
SdsStream was successfully deleted |
|
400 |
Missing or invalid inputs |
|
|
401 |
Unauthorized |
|
|
403 |
Forbidden |
|
|
404 |
One of the resources specified was not found. |
|
|
500 |
An error occurred while processing the request. |
|
|
503 |
Service Unavailable |
Example response body
400 Response (ErrorResponseBody)
{
"OperationId": "string",
"Error": "string",
"Reason": "string",
"Resolution": "string",
"Parameters": {
"property1": "string",
"property2": "string"
}
}
Get Stream Type
Returns the type definition that is associated with a given stream
Request
GET /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/Streams/{streamId}/Type
Parameters
string tenantId Tenant identifier
string namespaceId Namespace identifier
string streamId Stream identifier
Response
|
Status Code |
Body Type |
Description |
|---|---|---|
|
200 |
Returns the SdsType |
|
|
400 |
Missing or invalid inputs |
|
|
401 |
Unauthorized |
|
|
403 |
Forbidden |
|
|
404 |
One of the resources specified was not found. |
|
|
500 |
An error occurred while processing the request. |
|
|
503 |
Service Unavailable |
Example response body
200 Response (SdsType)
{
"Id": "string",
"Name": "string",
"Description": "string",
"SdsTypeCode": 0,
"IsGenericType": true,
"IsReferenceType": true,
"GenericArguments": [
{
"Id": "string",
"Name": "string",
"Description": "string",
"SdsTypeCode": 0,
"IsGenericType": true,
"IsReferenceType": true,
"GenericArguments": [
{
"Id": "string",
"Name": "string",
"Description": "string",
"SdsTypeCode": null,
"IsGenericType": true,
"IsReferenceType": true,
"GenericArguments": [
{}
],
"Properties": [
{}
],
"BaseType": null,
"DerivedTypes": [
{}
],
"InterpolationMode": null,
"ExtrapolationMode": null
}
],
"Properties": [
{
"Id": "string",
"Name": "string",
"Description": "string",
"Order": 0,
"IsKey": true,
"FixedSize": 0,
"SdsType": null,
"Value": null,
"Uom": "string",
"InterpolationMode": null,
"IsQuality": true
}
],
"BaseType": {
"Id": "string",
"Name": "string",
"Description": "string",
"SdsTypeCode": null,
"IsGenericType": true,
"IsReferenceType": true,
"GenericArguments": [
null
],
"Properties": [
null
],
"BaseType": null,
"DerivedTypes": [
null
],
"InterpolationMode": null,
"ExtrapolationMode": null
},
"DerivedTypes": [
{
"Id": "string",
"Name": "string",
"Description": "string",
"SdsTypeCode": null,
"IsGenericType": true,
"IsReferenceType": true,
"GenericArguments": [
{}
],
"Properties": [
{}
],
"BaseType": null,
"DerivedTypes": [
{}
],
"InterpolationMode": null,
"ExtrapolationMode": null
}
],
"InterpolationMode": 0,
"ExtrapolationMode": 0
}
],
"Properties": [
{
"Id": "string",
"Name": "string",
"Description": "string",
"Order": 0,
"IsKey": true,
"FixedSize": 0,
"SdsType": {
"Id": "string",
"Name": "string",
"Description": "string",
"SdsTypeCode": null,
"IsGenericType": true,
"IsReferenceType": true,
"GenericArguments": [
null
],
"Properties": [
null
],
"BaseType": null,
"DerivedTypes": [
null
],
"InterpolationMode": null,
"ExtrapolationMode": null
},
"Value": null,
"Uom": "string",
"InterpolationMode": 0,
"IsQuality": true
}
],
"BaseType": {
"Id": "string",
"Name": "string",
"Description": "string",
"SdsTypeCode": 0,
"IsGenericType": true,
"IsReferenceType": true,
"GenericArguments": [
{
"Id": "string",
"Name": "string",
"Description": "string",
"SdsTypeCode": null,
"IsGenericType": true,
"IsReferenceType": true,
"GenericArguments": [
null
],
"Properties": [
null
],
"BaseType": null,
"DerivedTypes": [
null
],
"InterpolationMode": null,
"ExtrapolationMode": null
}
],
"Properties": [
{
"Id": "string",
"Name": "string",
"Description": "string",
"Order": 0,
"IsKey": true,
"FixedSize": 0,
"SdsType": null,
"Value": null,
"Uom": "string",
"InterpolationMode": null,
"IsQuality": true
}
],
"BaseType": {
"Id": null,
"Name": null,
"Description": null,
"SdsTypeCode": null,
"IsGenericType": null,
"IsReferenceType": null,
"GenericArguments": null,
"Properties": null,
"BaseType": null,
"DerivedTypes": null,
"InterpolationMode": null,
"ExtrapolationMode": null
},
"DerivedTypes": [
{
"Id": "string",
"Name": "string",
"Description": "string",
"SdsTypeCode": null,
"IsGenericType": true,
"IsReferenceType": true,
"GenericArguments": [
null
],
"Properties": [
null
],
"BaseType": null,
"DerivedTypes": [
null
],
"InterpolationMode": null,
"ExtrapolationMode": null
}
],
"InterpolationMode": 0,
"ExtrapolationMode": 0
},
"DerivedTypes": [
{
"Id": "string",
"Name": "string",
"Description": "string",
"SdsTypeCode": 0,
"IsGenericType": true,
"IsReferenceType": true,
"GenericArguments": [
{
"Id": "string",
"Name": "string",
"Description": "string",
"SdsTypeCode": null,
"IsGenericType": true,
"IsReferenceType": true,
"GenericArguments": [
{}
],
"Properties": [
{}
],
"BaseType": null,
"DerivedTypes": [
{}
],
"InterpolationMode": null,
"ExtrapolationMode": null
}
],
"Properties": [
{
"Id": "string",
"Name": "string",
"Description": "string",
"Order": 0,
"IsKey": true,
"FixedSize": 0,
"SdsType": null,
"Value": null,
"Uom": "string",
"InterpolationMode": null,
"IsQuality": true
}
],
"BaseType": {
"Id": "string",
"Name": "string",
"Description": "string",
"SdsTypeCode": null,
"IsGenericType": true,
"IsReferenceType": true,
"GenericArguments": [
null
],
"Properties": [
null
],
"BaseType": null,
"DerivedTypes": [
null
],
"InterpolationMode": null,
"ExtrapolationMode": null
},
"DerivedTypes": [
{
"Id": "string",
"Name": "string",
"Description": "string",
"SdsTypeCode": null,
"IsGenericType": true,
"IsReferenceType": true,
"GenericArguments": [
{}
],
"Properties": [
{}
],
"BaseType": null,
"DerivedTypes": [
{}
],
"InterpolationMode": null,
"ExtrapolationMode": null
}
],
"InterpolationMode": 0,
"ExtrapolationMode": 0
}
],
"InterpolationMode": 0,
"ExtrapolationMode": 0
}
Update Stream Type
Returns the type definition that is associated with a given stream
Request
PUT /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/Streams/{streamId}/Type
Parameters
string tenantId Tenant identifier
string namespaceId Namespace identifier
string streamId Stream identifier
Response
|
Status Code |
Body Type |
Description |
|---|---|---|
|
204 |
None |
SdsType was successfully updated |
|
400 |
Missing or invalid inputs |
|
|
401 |
Unauthorized |
|
|
403 |
Forbidden |
|
|
404 |
One of the resources specified was not found. |
|
|
409 |
Conflict |
|
|
500 |
An error occurred while processing the request. |
|
|
503 |
Service Unavailable |
Example response body
400 Response (ErrorResponseBody)
{
"OperationId": "string",
"Error": "string",
"Reason": "string",
"Resolution": "string",
"Parameters": {
"property1": "string",
"property2": "string"
}
}
Get Resolved Stream
Request
GET /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/Streams/{streamId}/Resolved
Parameters
string tenantId string namespaceId string streamId
Response
|
Status Code |
Body Type |
Description |
|---|---|---|
|
200 |
None |
|
|
400 |
None |
|
|
401 |
None |
|
|
403 |
None |
|
|
404 |
None |
|
|
500 |
None |
|
|
503 |
None |
Example response body
200 Response (SdsResolvedStream)
{
"Id": "string",
"Name": "string",
"Description": "string",
"TypeId": "string",
"Indexes": [
{
"SdsTypePropertyId": "string"
}
],
"InterpolationMode": 0,
"ExtrapolationMode": 0,
"PropertyOverrides": [
{
"SdsTypePropertyId": "string",
"Uom": "string",
"InterpolationMode": 0
}
],
"Resolved": true,
"Type": {
"Id": "string",
"Name": "string",
"Description": "string",
"SdsTypeCode": "Empty",
"IsGenericType": true,
"IsReferenceType": true,
"GenericArguments": [
{
"Id": "string",
"Name": "string",
"Description": "string",
"SdsTypeCode": 0,
"IsGenericType": true,
"IsReferenceType": true,
"GenericArguments": "[<SdsType>]",
"Properties": [
{
"Id": "string",
"Name": "string",
"Description": "string",
"Order": 0,
"IsKey": true,
"FixedSize": 0,
"SdsType": "<SdsType>",
"Value": null,
"Uom": "string",
"InterpolationMode": 0,
"IsQuality": true
}
],
"BaseType": "<SdsType>",
"DerivedTypes": "[<SdsType>]",
"InterpolationMode": 0,
"ExtrapolationMode": 0
}
],
"Properties": [
{
"Id": "string",
"Name": "string",
"Description": "string",
"Order": 0,
"IsKey": true,
"FixedSize": 0,
"SdsType": "<SdsResolvedType>",
"Value": null,
"Uom": "string",
"InterpolationMode": "Continuous",
"IsQuality": true
}
],
"BaseType": {
"Id": "string",
"Name": "string",
"Description": "string",
"SdsTypeCode": 0,
"IsGenericType": true,
"IsReferenceType": true,
"GenericArguments": "[<SdsType>]",
"Properties": [
{
"Id": "string",
"Name": "string",
"Description": "string",
"Order": 0,
"IsKey": true,
"FixedSize": 0,
"SdsType": "<SdsType>",
"Value": null,
"Uom": "string",
"InterpolationMode": 0,
"IsQuality": true
}
],
"BaseType": "<SdsType>",
"DerivedTypes": "[<SdsType>]",
"InterpolationMode": 0,
"ExtrapolationMode": 0
},
"DerivedTypes": [
{
"Id": "string",
"Name": "string",
"Description": "string",
"SdsTypeCode": 0,
"IsGenericType": true,
"IsReferenceType": true,
"GenericArguments": "[<SdsType>]",
"Properties": [
{
"Id": "string",
"Name": "string",
"Description": "string",
"Order": 0,
"IsKey": true,
"FixedSize": 0,
"SdsType": "<SdsType>",
"Value": null,
"Uom": "string",
"InterpolationMode": 0,
"IsQuality": true
}
],
"BaseType": "<SdsType>",
"DerivedTypes": "[<SdsType>]",
"InterpolationMode": 0,
"ExtrapolationMode": 0
}
],
"InterpolationMode": "Continuous",
"ExtrapolationMode": "All"
}
}
Get Resolved Streams
Request
POST /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/Streams/Bulk/Streams/Resolved
Parameters
string tenantId string namespaceId
Response
|
Status Code |
Body Type |
Description |
|---|---|---|
|
207 |
None |
|
|
400 |
None |
|
|
500 |
None |
|
|
503 |
None |
Example response body
207 Response (SdsResolvedStreamsResponse)
{
"Data": [
{
"Id": "string",
"Name": "string",
"Description": "string",
"TypeId": "string",
"Indexes": [
{
"SdsTypePropertyId": "string"
}
],
"InterpolationMode": 0,
"ExtrapolationMode": 0,
"PropertyOverrides": [
{
"SdsTypePropertyId": "string",
"Uom": "string",
"InterpolationMode": 0
}
],
"Resolved": true,
"Type": {
"Id": "string",
"Name": "string",
"Description": "string",
"SdsTypeCode": "Empty",
"IsGenericType": true,
"IsReferenceType": true,
"GenericArguments": [
{
"Id": "string",
"Name": "string",
"Description": "string",
"SdsTypeCode": 0,
"IsGenericType": true,
"IsReferenceType": true,
"GenericArguments": "[<SdsType>]",
"Properties": [
{
"Id": "string",
"Name": "string",
"Description": "string",
"Order": 0,
"IsKey": true,
"FixedSize": 0,
"SdsType": "<SdsType>",
"Value": null,
"Uom": "string",
"InterpolationMode": "[",
"IsQuality": true
}
],
"BaseType": "<SdsType>",
"DerivedTypes": "[<SdsType>]",
"InterpolationMode": 0,
"ExtrapolationMode": 0
}
],
"Properties": [
{
"Id": "string",
"Name": "string",
"Description": "string",
"Order": 0,
"IsKey": true,
"FixedSize": 0,
"SdsType": "<SdsResolvedType>",
"Value": null,
"Uom": "string",
"InterpolationMode": "Continuous",
"IsQuality": true
}
],
"BaseType": {
"Id": "string",
"Name": "string",
"Description": "string",
"SdsTypeCode": 0,
"IsGenericType": true,
"IsReferenceType": true,
"GenericArguments": "[<SdsType>]",
"Properties": [
{
"Id": "string",
"Name": "string",
"Description": "string",
"Order": 0,
"IsKey": true,
"FixedSize": 0,
"SdsType": null,
"Value": null,
"Uom": "string",
"InterpolationMode": null,
"IsQuality": true
}
],
"BaseType": "<SdsType>",
"DerivedTypes": "[<SdsType>]",
"InterpolationMode": 0,
"ExtrapolationMode": 0
},
"DerivedTypes": [
{
"Id": "string",
"Name": "string",
"Description": "string",
"SdsTypeCode": 0,
"IsGenericType": true,
"IsReferenceType": true,
"GenericArguments": "[<SdsType>]",
"Properties": [
{
"Id": "string",
"Name": "string",
"Description": "string",
"Order": 0,
"IsKey": true,
"FixedSize": 0,
"SdsType": "<SdsType>",
"Value": null,
"Uom": "string",
"InterpolationMode": "[",
"IsQuality": true
}
],
"BaseType": "<SdsType>",
"DerivedTypes": "[<SdsType>]",
"InterpolationMode": 0,
"ExtrapolationMode": 0
}
],
"InterpolationMode": "Continuous",
"ExtrapolationMode": "All"
}
}
],
"ChildErrors": [
{
"OperationId": "string",
"Error": "string",
"Reason": "string",
"Resolution": "string",
"Parameters": {
"property1": "string",
"property2": "string"
},
"StreamId": "string",
"StatusCode": 100
}
]
}
Definitions
SdsStream
Properties
|
Property Name |
Data Type |
Required |
Nullable |
Description |
|---|---|---|---|---|
|
Id |
string |
false |
true |
An unique identifier for the SdsStream object |
|
Name |
string |
false |
true |
An optional user-friendly name for the SdsStream object |
|
Description |
string |
false |
true |
A brief description of the SdsStream object |
|
TypeId |
string |
false |
true |
An unique identifier for the SdsType of the SdsStream object |
|
Indexes |
false |
true |
List of SdsStreamIndexs to define secondary indexes for the SdsStream |
|
|
InterpolationMode |
false |
true |
Defines the SdsInterpolationMode of the SdsStream. Default is null. |
|
|
ExtrapolationMode |
false |
true |
Defines the SdsExtrapolationMode of the SdsStream. Default is null. |
|
|
PropertyOverrides |
false |
true |
List of SdsStreamPropertyOverrides to define unit of measure and interpolation mode overrides for the SdsStream |
{
"Id": "string",
"Name": "string",
"Description": "string",
"TypeId": "string",
"Indexes": [
{
"SdsTypePropertyId": "string"
}
],
"InterpolationMode": 0,
"ExtrapolationMode": 0,
"PropertyOverrides": [
{
"SdsTypePropertyId": "string",
"Uom": "string",
"InterpolationMode": 0
}
]
}
SdsStreamIndex
Indexes speed up and order the results of stream data filtering. SdsStreamIndex or secondary indexes is defined on the stream and is applied to a single property. You can define several secondary indexes. Secondary index values need not be unique.
Properties
|
Property Name |
Data Type |
Required |
Nullable |
Description |
|---|---|---|---|---|
|
SdsTypePropertyId |
string |
false |
true |
An unique identifier for the SdsTypeProperty |
{
"SdsTypePropertyId": "string"
}
SdsInterpolationMode
Interpolation modes that can be applied to SdsType, SdsTypeProperty, SdsStream, and SdsStreamPropertyOverride objects
Enumerated Values
|
Property |
Value |
Description |
|---|---|---|
|
Default |
0 |
Interpolation modes that can be applied to SdsType, SdsTypeProperty, SdsStream, and SdsStreamPropertyOverride objects |
|
Continuous |
0 |
Interpolation modes that can be applied to SdsType, SdsTypeProperty, SdsStream, and SdsStreamPropertyOverride objects |
|
StepwiseContinuousLeading |
1 |
Interpolation modes that can be applied to SdsType, SdsTypeProperty, SdsStream, and SdsStreamPropertyOverride objects |
|
StepwiseContinuousTrailing |
2 |
Interpolation modes that can be applied to SdsType, SdsTypeProperty, SdsStream, and SdsStreamPropertyOverride objects |
|
Discrete |
3 |
Interpolation modes that can be applied to SdsType, SdsTypeProperty, SdsStream, and SdsStreamPropertyOverride objects |
|
ContinuousNullableLeading |
4 |
Interpolation modes that can be applied to SdsType, SdsTypeProperty, SdsStream, and SdsStreamPropertyOverride objects |
|
ContinuousNullableTrailing |
5 |
Interpolation modes that can be applied to SdsType, SdsTypeProperty, SdsStream, and SdsStreamPropertyOverride objects |
SdsExtrapolationMode
Defines how a stream responds to requests with indexes that precede or follow all data in the stream. Behavior also depends on the SdsInterpolationMode for a stream. If SdsInterpolationMode is set to Discrete, extrapolation will not occur. If SdsInterpolationMode is set to ContinuousNullableLeading or ContinuousNullableTrailing, default values will be returned instead of actual data.
Enumerated Values
|
Property |
Value |
Description |
|---|---|---|
|
All |
0 |
Defines how a stream responds to requests with indexes that precede or follow all data in the stream. Behavior also depends on the SdsInterpolationMode for a stream. If SdsInterpolationMode is set to Discrete, extrapolation will not occur. If SdsInterpolationMode is set to ContinuousNullableLeading or ContinuousNullableTrailing, default values are returned instead of actual data. |
|
None |
1 |
Defines how a stream responds to requests with indexes that precede or follow all data in the stream. Behavior also depends on the SdsInterpolationMode for a stream. If SdsInterpolationMode is set to Discrete, extrapolation will not occur. If SdsInterpolationMode is set to ContinuousNullableLeading or ContinuousNullableTrailing, default values are returned instead of actual data. |
|
Forward |
2 |
Defines how a stream responds to requests with indexes that precede or follow all data in the stream. Behavior also depends on the SdsInterpolationMode for a stream. If SdsInterpolationMode is set to Discrete, extrapolation will not occur. If SdsInterpolationMode is set to ContinuousNullableLeading or ContinuousNullableTrailing, default values are returned instead of actual data. |
|
Backward |
3 |
Defines how a stream responds to requests with indexes that precede or follow all data in the stream. Behavior also depends on the SdsInterpolationMode for a stream. If SdsInterpolationMode is set to Discrete, extrapolation will not occur. If SdsInterpolationMode is set to ContinuousNullableLeading or ContinuousNullableTrailing, default values are returned instead of actual data. |
SdsStreamPropertyOverride
Properties
|
Property Name |
Data Type |
Required |
Nullable |
Description |
|---|---|---|---|---|
|
SdsTypePropertyId |
string |
false |
true |
An unique identifier for the SdsTypeProperty object that needs to be overridden |
|
Uom |
string |
false |
true |
The Id, name, or abbreviation of the unit of measure to be applied to the SdsTypeProperty |
|
InterpolationMode |
false |
true |
Defines the InterpolationMode of the SdsTypeProperty |
{
"SdsTypePropertyId": "string",
"Uom": "string",
"InterpolationMode": 0
}
ErrorResponseBody
Contains the error message format that follows the CONNECT data services error standards
Properties
|
Property Name |
Data Type |
Required |
Nullable |
Description |
|---|---|---|---|---|
|
OperationId |
string |
false |
true |
Operation unique identifier of action that caused the error |
|
Error |
string |
false |
true |
Error description |
|
Reason |
string |
false |
true |
Reason for the error |
|
Resolution |
string |
false |
true |
Resolution to resolve the error |
|
Parameters |
object |
false |
true |
Ids or values that are creating or are affected by the error |
{
"OperationId": "string",
"Error": "string",
"Reason": "string",
"Resolution": "string",
"Parameters": {
"property1": "string",
"property2": "string"
}
}
SdsType
A contract defining the type of data to read or write in a SdsStream
Properties
|
Property Name |
Data Type |
Required |
Nullable |
Description |
|---|---|---|---|---|
|
Id |
string |
false |
true |
A unique identifier for the SdsType object |
|
Name |
string |
false |
true |
An optional user-friendly name for the SdsType object |
|
Description |
string |
false |
true |
A brief description of the SdsType object |
|
SdsTypeCode |
false |
false |
The SdsTypeCode of the SdsType object |
|
|
IsGenericType |
boolean |
false |
false |
A boolean value indicating whether the current SdsType is a generic type This property is only used when using templates or generics. It will be automatically set if the SdsType is generated using SdsTypeBuilder. For further information on generics, please refer, |
|
IsReferenceType |
boolean |
false |
false |
Enabling this property preserves objects as references during serialization/de-serialization of the SdsType data while using the SdsFormatter. This property behaves similar to the IsReference property for DataContractSerializer and is only valid for serialization if SdsFormatter is used. |
|
GenericArguments |
[SdsType] |
false |
true |
Contains the parameterized SdsTypes of the current generic SdsType. This property is only used when using templates or generics. It will be automatically set if the SdsType is generated using SdsTypeBuilder. For further information on generics, please refer to |
|
Properties |
false |
true |
List of SdsTypePropertys of the SdsType |
|
|
BaseType |
false |
true |
Defines the base type of the SdsType. Commonly used by SdsTypeBuilder to generate an SdsType from contracts not explicitly defined and maintained by the user. |
|
|
DerivedTypes |
[SdsType] |
false |
true |
List of SdsTypes that should be recognized by SdsFormatter during serialization/de-serialization. This property behaves similar to KnownTypeAttribute attribute for DataContractSerializer and only valid for serialization if SdsFormatter is used. |
|
InterpolationMode |
false |
false |
Defines the SdsInterpolationMode of the SdsType. This property is only valid for the root SdsType and invalid for SdsTypes of SdsTypePropertys. |
|
|
ExtrapolationMode |
false |
false |
Defines the SdsExtrapolationMode of the SdsType. This property is only valid for the root SdsType and invalid for SdsTypes of SdsTypePropertys. |
{
"Id": "string",
"Name": "string",
"Description": "string",
"SdsTypeCode": 0,
"IsGenericType": true,
"IsReferenceType": true,
"GenericArguments": [
{
"Id": "string",
"Name": "string",
"Description": "string",
"SdsTypeCode": 0,
"IsGenericType": true,
"IsReferenceType": true,
"GenericArguments": [
{
"Id": "string",
"Name": "string",
"Description": "string",
"SdsTypeCode": null,
"IsGenericType": true,
"IsReferenceType": true,
"GenericArguments": [
{}
],
"Properties": [
{}
],
"BaseType": null,
"DerivedTypes": [
{}
],
"InterpolationMode": null,
"ExtrapolationMode": null
}
],
"Properties": [
{
"Id": "string",
"Name": "string",
"Description": "string",
"Order": 0,
"IsKey": true,
"FixedSize": 0,
"SdsType": null,
"Value": null,
"Uom": "string",
"InterpolationMode": null,
"IsQuality": true
}
],
"BaseType": {
"Id": "string",
"Name": "string",
"Description": "string",
"SdsTypeCode": null,
"IsGenericType": true,
"IsReferenceType": true,
"GenericArguments": [
null
],
"Properties": [
null
],
"BaseType": null,
"DerivedTypes": [
null
],
"InterpolationMode": null,
"ExtrapolationMode": null
},
"DerivedTypes": [
{
"Id": "string",
"Name": "string",
"Description": "string",
"SdsTypeCode": null,
"IsGenericType": true,
"IsReferenceType": true,
"GenericArguments": [
{}
],
"Properties": [
{}
],
"BaseType": null,
"DerivedTypes": [
{}
],
"InterpolationMode": null,
"ExtrapolationMode": null
}
],
"InterpolationMode": 0,
"ExtrapolationMode": 0
}
],
"Properties": [
{
"Id": "string",
"Name": "string",
"Description": "string",
"Order": 0,
"IsKey": true,
"FixedSize": 0,
"SdsType": {
"Id": "string",
"Name": "string",
"Description": "string",
"SdsTypeCode": null,
"IsGenericType": true,
"IsReferenceType": true,
"GenericArguments": [
null
],
"Properties": [
null
],
"BaseType": null,
"DerivedTypes": [
null
],
"InterpolationMode": null,
"ExtrapolationMode": null
},
"Value": null,
"Uom": "string",
"InterpolationMode": 0,
"IsQuality": true
}
],
"BaseType": {
"Id": "string",
"Name": "string",
"Description": "string",
"SdsTypeCode": 0,
"IsGenericType": true,
"IsReferenceType": true,
"GenericArguments": [
{
"Id": "string",
"Name": "string",
"Description": "string",
"SdsTypeCode": null,
"IsGenericType": true,
"IsReferenceType": true,
"GenericArguments": [
null
],
"Properties": [
null
],
"BaseType": null,
"DerivedTypes": [
null
],
"InterpolationMode": null,
"ExtrapolationMode": null
}
],
"Properties": [
{
"Id": "string",
"Name": "string",
"Description": "string",
"Order": 0,
"IsKey": true,
"FixedSize": 0,
"SdsType": null,
"Value": null,
"Uom": "string",
"InterpolationMode": null,
"IsQuality": true
}
],
"BaseType": {
"Id": null,
"Name": null,
"Description": null,
"SdsTypeCode": null,
"IsGenericType": null,
"IsReferenceType": null,
"GenericArguments": null,
"Properties": null,
"BaseType": null,
"DerivedTypes": null,
"InterpolationMode": null,
"ExtrapolationMode": null
},
"DerivedTypes": [
{
"Id": "string",
"Name": "string",
"Description": "string",
"SdsTypeCode": null,
"IsGenericType": true,
"IsReferenceType": true,
"GenericArguments": [
null
],
"Properties": [
null
],
"BaseType": null,
"DerivedTypes": [
null
],
"InterpolationMode": null,
"ExtrapolationMode": null
}
],
"InterpolationMode": 0,
"ExtrapolationMode": 0
},
"DerivedTypes": [
{
"Id": "string",
"Name": "string",
"Description": "string",
"SdsTypeCode": 0,
"IsGenericType": true,
"IsReferenceType": true,
"GenericArguments": [
{
"Id": "string",
"Name": "string",
"Description": "string",
"SdsTypeCode": null,
"IsGenericType": true,
"IsReferenceType": true,
"GenericArguments": [
{}
],
"Properties": [
{}
],
"BaseType": null,
"DerivedTypes": [
{}
],
"InterpolationMode": null,
"ExtrapolationMode": null
}
],
"Properties": [
{
"Id": "string",
"Name": "string",
"Description": "string",
"Order": 0,
"IsKey": true,
"FixedSize": 0,
"SdsType": null,
"Value": null,
"Uom": "string",
"InterpolationMode": null,
"IsQuality": true
}
],
"BaseType": {
"Id": "string",
"Name": "string",
"Description": "string",
"SdsTypeCode": null,
"IsGenericType": true,
"IsReferenceType": true,
"GenericArguments": [
null
],
"Properties": [
null
],
"BaseType": null,
"DerivedTypes": [
null
],
"InterpolationMode": null,
"ExtrapolationMode": null
},
"DerivedTypes": [
{
"Id": "string",
"Name": "string",
"Description": "string",
"SdsTypeCode": null,
"IsGenericType": true,
"IsReferenceType": true,
"GenericArguments": [
{}
],
"Properties": [
{}
],
"BaseType": null,
"DerivedTypes": [
{}
],
"InterpolationMode": null,
"ExtrapolationMode": null
}
],
"InterpolationMode": 0,
"ExtrapolationMode": 0
}
],
"InterpolationMode": 0,
"ExtrapolationMode": 0
}
SdsTypeCode
Enumerated Values
|
Property |
Value |
|---|---|
|
Empty |
0 |
|
Object |
1 |
|
Boolean |
3 |
|
Char |
4 |
|
SByte |
5 |
|
Byte |
6 |
|
Int16 |
7 |
|
UInt16 |
8 |
|
Int32 |
9 |
|
UInt32 |
10 |
|
Int64 |
11 |
|
UInt64 |
12 |
|
Single |
13 |
|
Double |
14 |
|
Decimal |
15 |
|
DateTime |
16 |
|
String |
18 |
|
Guid |
19 |
|
DateTimeOffset |
20 |
|
TimeSpan |
21 |
|
Version |
22 |
|
NullableBoolean |
103 |
|
NullableChar |
104 |
|
NullableSByte |
105 |
|
NullableByte |
106 |
|
NullableInt16 |
107 |
|
NullableUInt16 |
108 |
|
NullableInt32 |
109 |
|
NullableUInt32 |
110 |
|
NullableInt64 |
111 |
|
NullableUInt64 |
112 |
|
NullableSingle |
113 |
|
NullableDouble |
114 |
|
NullableDecimal |
115 |
|
NullableDateTime |
116 |
|
NullableGuid |
119 |
|
NullableDateTimeOffset |
120 |
|
NullableTimeSpan |
121 |
|
BooleanArray |
203 |
|
CharArray |
204 |
|
SByteArray |
205 |
|
ByteArray |
206 |
|
Int16Array |
207 |
|
UInt16Array |
208 |
|
Int32Array |
209 |
|
UInt32Array |
210 |
|
Int64Array |
211 |
|
UInt64Array |
212 |
|
SingleArray |
213 |
|
DoubleArray |
214 |
|
DecimalArray |
215 |
|
DateTimeArray |
216 |
|
StringArray |
218 |
|
GuidArray |
219 |
|
DateTimeOffsetArray |
220 |
|
TimeSpanArray |
221 |
|
VersionArray |
222 |
|
Array |
400 |
|
IList |
401 |
|
IDictionary |
402 |
|
IEnumerable |
403 |
|
SdsType |
501 |
|
SdsTypeProperty |
502 |
|
SdsStreamView |
503 |
|
SdsStreamViewProperty |
504 |
|
SdsStreamViewMap |
505 |
|
SdsStreamViewMapProperty |
506 |
|
SdsStream |
507 |
|
SdsStreamIndex |
508 |
|
SdsTable |
509 |
|
SdsColumn |
510 |
|
SdsValues |
511 |
|
SdsObject |
512 |
|
SByteEnum |
605 |
|
ByteEnum |
606 |
|
Int16Enum |
607 |
|
UInt16Enum |
608 |
|
Int32Enum |
609 |
|
UInt32Enum |
610 |
|
Int64Enum |
611 |
|
UInt64Enum |
612 |
|
NullableSByteEnum |
705 |
|
NullableByteEnum |
706 |
|
NullableInt16Enum |
707 |
|
NullableUInt16Enum |
708 |
|
NullableInt32Enum |
709 |
|
NullableUInt32Enum |
710 |
|
NullableInt64Enum |
711 |
|
NullableUInt64Enum |
712 |
SdsTypeProperty
A contract defining a property of a SdsType
Properties
|
Property Name |
Data Type |
Required |
Nullable |
Description |
|---|---|---|---|---|
|
Id |
string |
false |
true |
An unique identifier for the SdsTypeProperty object |
|
Name |
string |
false |
true |
An optional user-friendly name for the SdsTypeProperty object |
|
Description |
string |
false |
true |
A brief description of the SdsTypeProperty object |
|
Order |
int32 |
false |
false |
The order used for comparison among SdsTypePropertys if a compound index is specified for SdsType |
|
IsKey |
boolean |
false |
false |
A boolean value indicating whether the current SdsTypeProperty must be used for indexing Used in combination with property to enable compound indexing |
|
FixedSize |
int32 |
false |
false |
An optional property specifying the length of string. |
|
SdsType |
false |
true |
SdsType of the current SdsTypeProperty |
|
|
Value |
any |
false |
true |
An enum value of the current SdsTypeProperty. |
|
Uom |
string |
false |
true |
Indicates the Unit of Measure of the current SdsTypeProperty |
|
InterpolationMode |
false |
true |
An InterpolationMode that overrides the root SdsType's InterpolationMode for this SdsTypeProperty |
|
|
IsQuality |
boolean |
false |
false |
Indicates whether this property marks data quality |
{
"Id": "string",
"Name": "string",
"Description": "string",
"Order": 0,
"IsKey": true,
"FixedSize": 0,
"SdsType": {
"Id": "string",
"Name": "string",
"Description": "string",
"SdsTypeCode": 0,
"IsGenericType": true,
"IsReferenceType": true,
"GenericArguments": [
{
"Id": "string",
"Name": "string",
"Description": "string",
"SdsTypeCode": null,
"IsGenericType": true,
"IsReferenceType": true,
"GenericArguments": [
null
],
"Properties": [
null
],
"BaseType": null,
"DerivedTypes": [
null
],
"InterpolationMode": null,
"ExtrapolationMode": null
}
],
"Properties": [
{
"Id": "string",
"Name": "string",
"Description": "string",
"Order": 0,
"IsKey": true,
"FixedSize": 0,
"SdsType": null,
"Value": null,
"Uom": "string",
"InterpolationMode": null,
"IsQuality": true
}
],
"BaseType": {
"Id": null,
"Name": null,
"Description": null,
"SdsTypeCode": null,
"IsGenericType": null,
"IsReferenceType": null,
"GenericArguments": null,
"Properties": null,
"BaseType": null,
"DerivedTypes": null,
"InterpolationMode": null,
"ExtrapolationMode": null
},
"DerivedTypes": [
{
"Id": "string",
"Name": "string",
"Description": "string",
"SdsTypeCode": null,
"IsGenericType": true,
"IsReferenceType": true,
"GenericArguments": [
null
],
"Properties": [
null
],
"BaseType": null,
"DerivedTypes": [
null
],
"InterpolationMode": null,
"ExtrapolationMode": null
}
],
"InterpolationMode": 0,
"ExtrapolationMode": 0
},
"Value": null,
"Uom": "string",
"InterpolationMode": 0,
"IsQuality": true
}
SdsResolvedStream
A contract defining resolution of SdsStream
Properties
|
Property Name |
Data Type |
Required |
Nullable |
Description |
|---|---|---|---|---|
|
Id |
string |
false |
true |
A unique identifier for the SdsStream object |
|
Name |
string |
false |
true |
An optional user-friendly name for the SdsStream object |
|
Description |
string |
false |
true |
A brief description of the SdsStream object |
|
TypeId |
string |
false |
true |
A unique identifier for the SdsType of the SdsStream object |
|
Indexes |
false |
true |
List of SdsStreamIndexs to define secondary indexes for the SdsStream |
|
|
InterpolationMode |
false |
true |
Defines the SdsInterpolationMode of the SdsStream. Default is null. |
|
|
ExtrapolationMode |
false |
true |
Defines the SdsExtrapolationMode of the SdsStream. Default is null. |
|
|
PropertyOverrides |
false |
true |
List of SdsStreamPropertyOverrides to define unit of measure and interpolation mode overrides for the SdsStream |
|
|
Resolved |
boolean |
false |
false |
None |
|
Type |
false |
true |
A contract defining the type of data to read or write in a SdsResolvedStream |
{
"Id": "string",
"Name": "string",
"Description": "string",
"TypeId": "string",
"Indexes": [
{
"SdsTypePropertyId": "string"
}
],
"InterpolationMode": 0,
"ExtrapolationMode": 0,
"PropertyOverrides": [
{
"SdsTypePropertyId": "string",
"Uom": "string",
"InterpolationMode": 0
}
],
"Resolved": true,
"Type": {
"Id": "string",
"Name": "string",
"Description": "string",
"SdsTypeCode": "Empty",
"IsGenericType": true,
"IsReferenceType": true,
"GenericArguments": [
{
"Id": "string",
"Name": "string",
"Description": "string",
"SdsTypeCode": 0,
"IsGenericType": true,
"IsReferenceType": true,
"GenericArguments": "[<SdsType>]",
"Properties": [
{
"Id": "string",
"Name": "string",
"Description": "string",
"Order": 0,
"IsKey": true,
"FixedSize": 0,
"SdsType": "<SdsType>",
"Value": null,
"Uom": "string",
"InterpolationMode": 0,
"IsQuality": true
}
],
"BaseType": "<SdsType>",
"DerivedTypes": "[<SdsType>]",
"InterpolationMode": 0,
"ExtrapolationMode": 0
}
],
"Properties": [
{
"Id": "string",
"Name": "string",
"Description": "string",
"Order": 0,
"IsKey": true,
"FixedSize": 0,
"SdsType": "<SdsResolvedType>",
"Value": null,
"Uom": "string",
"InterpolationMode": "Continuous",
"IsQuality": true
}
],
"BaseType": {
"Id": "string",
"Name": "string",
"Description": "string",
"SdsTypeCode": 0,
"IsGenericType": true,
"IsReferenceType": true,
"GenericArguments": "[<SdsType>]",
"Properties": [
{
"Id": "string",
"Name": "string",
"Description": "string",
"Order": 0,
"IsKey": true,
"FixedSize": 0,
"SdsType": "<SdsType>",
"Value": null,
"Uom": "string",
"InterpolationMode": 0,
"IsQuality": true
}
],
"BaseType": "<SdsType>",
"DerivedTypes": "[<SdsType>]",
"InterpolationMode": 0,
"ExtrapolationMode": 0
},
"DerivedTypes": [
{
"Id": "string",
"Name": "string",
"Description": "string",
"SdsTypeCode": 0,
"IsGenericType": true,
"IsReferenceType": true,
"GenericArguments": "[<SdsType>]",
"Properties": [
{
"Id": "string",
"Name": "string",
"Description": "string",
"Order": 0,
"IsKey": true,
"FixedSize": 0,
"SdsType": "<SdsType>",
"Value": null,
"Uom": "string",
"InterpolationMode": 0,
"IsQuality": true
}
],
"BaseType": "<SdsType>",
"DerivedTypes": "[<SdsType>]",
"InterpolationMode": 0,
"ExtrapolationMode": 0
}
],
"InterpolationMode": "Continuous",
"ExtrapolationMode": "All"
}
}
SdsResolvedType
A contract defining the type of data to read or write in a SdsResolvedStream
Properties
|
Property Name |
Data Type |
Required |
Nullable |
Description |
|---|---|---|---|---|
|
Id |
string |
false |
true |
A unique identifier for the SdsType object |
|
Name |
string |
false |
true |
An optional user-friendly name for the SdsType object |
|
Description |
string |
false |
true |
A brief description of the SdsType object |
|
SdsTypeCode |
false |
false |
None |
|
|
IsGenericType |
boolean |
false |
false |
A boolean value indicating whether the current SdsType is a generic type This property is only used when using templates or generics. It will be automatically set if the SdsType is generated using SdsTypeBuilder. For more information on generics, refer to Generic classes and methods |
|
IsReferenceType |
boolean |
false |
false |
Enabling this property preserves objects as references during serialization/de-serialization of the SdsType data while using the SdsFormatter This property behaves similar to IsReference property for DataContractSerializer and is only valid for serialization if SdsFormatter is used. |
|
GenericArguments |
[SdsType] |
false |
true |
Contains the parameterized SdsTypes of the current generic SdsType This property is only used when using templates or generics. It will be automatically set if the SdsType is generated using SdsTypeBuilder. For more information on generics, refer to Generic classes and methods |
|
Properties |
false |
true |
[A contract defining the type of data to read or write in a SdsResolvedType] |
|
|
BaseType |
false |
true |
Defines the base type of the SdsType Commonly used by SdsTypeBuilder to generate SdsType from contracts not explicitly defined and maintained by the user. |
|
|
DerivedTypes |
[SdsType] |
false |
true |
List of SdsTypes that should be recognized by SdsFormatter during serialization/de-serialization. This property behaves similar to KnownTypeAttribute attribute for DataContractSerializer and only valid for serialization if SdsFormatter is used. |
|
InterpolationMode |
false |
false |
Interpolation modes that can be applied to SdsType, SdsTypeProperty, SdsStream, and SdsStreamPropertyOverride objects |
|
|
ExtrapolationMode |
false |
false |
Defines how a stream responds to requests with indexes that precede or follow all data in the stream. Behavior also depends on the SdsInterpolationMode for a stream. If SdsInterpolationMode is set to Discrete, extrapolation will not occur. If SdsInterpolationMode is set to ContinuousNullableLeading or ContinuousNullableTrailing, default values will be returned instead of actual data. |
{
"Id": "string",
"Name": "string",
"Description": "string",
"SdsTypeCode": "Empty",
"IsGenericType": true,
"IsReferenceType": true,
"GenericArguments": [
{
"Id": "string",
"Name": "string",
"Description": "string",
"SdsTypeCode": 0,
"IsGenericType": true,
"IsReferenceType": true,
"GenericArguments": "[<SdsType>]",
"Properties": [
{
"Id": "string",
"Name": "string",
"Description": "string",
"Order": 0,
"IsKey": true,
"FixedSize": 0,
"SdsType": "<SdsType>",
"Value": null,
"Uom": "string",
"InterpolationMode": 0,
"IsQuality": true
}
],
"BaseType": "<SdsType>",
"DerivedTypes": "[<SdsType>]",
"InterpolationMode": 0,
"ExtrapolationMode": 0
}
],
"Properties": [
{
"Id": "string",
"Name": "string",
"Description": "string",
"Order": 0,
"IsKey": true,
"FixedSize": 0,
"SdsType": "<SdsResolvedType>",
"Value": null,
"Uom": "string",
"InterpolationMode": "Continuous",
"IsQuality": true
}
],
"BaseType": {
"Id": "string",
"Name": "string",
"Description": "string",
"SdsTypeCode": 0,
"IsGenericType": true,
"IsReferenceType": true,
"GenericArguments": "[<SdsType>]",
"Properties": [
{
"Id": "string",
"Name": "string",
"Description": "string",
"Order": 0,
"IsKey": true,
"FixedSize": 0,
"SdsType": "<SdsType>",
"Value": null,
"Uom": "string",
"InterpolationMode": 0,
"IsQuality": true
}
],
"BaseType": "<SdsType>",
"DerivedTypes": "[<SdsType>]",
"InterpolationMode": 0,
"ExtrapolationMode": 0
},
"DerivedTypes": [
{
"Id": "string",
"Name": "string",
"Description": "string",
"SdsTypeCode": 0,
"IsGenericType": true,
"IsReferenceType": true,
"GenericArguments": "[<SdsType>]",
"Properties": [
{
"Id": "string",
"Name": "string",
"Description": "string",
"Order": 0,
"IsKey": true,
"FixedSize": 0,
"SdsType": "<SdsType>",
"Value": null,
"Uom": "string",
"InterpolationMode": 0,
"IsQuality": true
}
],
"BaseType": "<SdsType>",
"DerivedTypes": "[<SdsType>]",
"InterpolationMode": 0,
"ExtrapolationMode": 0
}
],
"InterpolationMode": "Continuous",
"ExtrapolationMode": "All"
}
SdsResolvedTypeProperty
A contract defining the type of data to read or write in a SdsResolvedType
Properties
|
Property Name |
Data Type |
Required |
Nullable |
Description |
|---|---|---|---|---|
|
Id |
string |
false |
true |
A unique identifier for the SdsTypeProperty object |
|
Name |
string |
false |
true |
An optional user-friendly name for the SdsTypeProperty object |
|
Description |
string |
false |
true |
A brief description of the SdsTypeProperty object |
|
Order |
int32 |
false |
false |
The order used for comparison among SdsTypePropertys if a compound index is specified for SdsType |
|
IsKey |
boolean |
false |
false |
A boolean value indicating whether the current SdsTypeProperty must be used for indexing. Used in combination with property to enable compound indexing. |
|
FixedSize |
int32 |
false |
false |
An optional property specifying the length of string. |
|
SdsType |
false |
true |
A contract defining the type of data to read or write in a SdsResolvedStream |
|
|
Value |
any |
false |
true |
An enum value of the current SdsTypeProperty. |
|
Uom |
string |
false |
true |
Indicates the Unit of Measure of the current SdsTypeProperty |
|
InterpolationMode |
false |
true |
Interpolation modes that can be applied to SdsType, SdsTypeProperty, SdsStream, and SdsStreamPropertyOverride objects |
|
|
IsQuality |
boolean |
false |
false |
Indicates whether this property marks data quality |
{
"Id": "string",
"Name": "string",
"Description": "string",
"Order": 0,
"IsKey": true,
"FixedSize": 0,
"SdsType": {
"Id": "string",
"Name": "string",
"Description": "string",
"SdsTypeCode": "Empty",
"IsGenericType": true,
"IsReferenceType": true,
"GenericArguments": [
{
"Id": "string",
"Name": "string",
"Description": "string",
"SdsTypeCode": 0,
"IsGenericType": true,
"IsReferenceType": true,
"GenericArguments": "[<SdsType>]",
"Properties": [
{
"Id": "string",
"Name": "string",
"Description": "string",
"Order": 0,
"IsKey": true,
"FixedSize": 0,
"SdsType": "<SdsType>",
"Value": null,
"Uom": "string",
"InterpolationMode": 0,
"IsQuality": true
}
],
"BaseType": "<SdsType>",
"DerivedTypes": "[<SdsType>]",
"InterpolationMode": 0,
"ExtrapolationMode": 0
}
],
"Properties": "[<SdsResolvedTypeProperty>]",
"BaseType": {
"Id": "string",
"Name": "string",
"Description": "string",
"SdsTypeCode": 0,
"IsGenericType": true,
"IsReferenceType": true,
"GenericArguments": "[<SdsType>]",
"Properties": [
{
"Id": "string",
"Name": "string",
"Description": "string",
"Order": 0,
"IsKey": true,
"FixedSize": 0,
"SdsType": "<SdsType>",
"Value": null,
"Uom": "string",
"InterpolationMode": 0,
"IsQuality": true
}
],
"BaseType": "<SdsType>",
"DerivedTypes": "[<SdsType>]",
"InterpolationMode": 0,
"ExtrapolationMode": 0
},
"DerivedTypes": [
{
"Id": "string",
"Name": "string",
"Description": "string",
"SdsTypeCode": 0,
"IsGenericType": true,
"IsReferenceType": true,
"GenericArguments": "[<SdsType>]",
"Properties": [
{
"Id": "string",
"Name": "string",
"Description": "string",
"Order": 0,
"IsKey": true,
"FixedSize": 0,
"SdsType": "<SdsType>",
"Value": null,
"Uom": "string",
"InterpolationMode": 0,
"IsQuality": true
}
],
"BaseType": "<SdsType>",
"DerivedTypes": "[<SdsType>]",
"InterpolationMode": 0,
"ExtrapolationMode": 0
}
],
"InterpolationMode": "Continuous",
"ExtrapolationMode": "All"
},
"Value": null,
"Uom": "string",
"InterpolationMode": "Continuous",
"IsQuality": true
}
SdsInterpolationMode2
Interpolation modes that can be applied to SdsType, SdsTypeProperty, SdsStream, and SdsStreamPropertyOverride objects
Enumerated Values
|
Property |
Value |
|---|---|
|
Default |
Continuous |
|
Continuous |
Continuous |
|
StepwiseContinuousLeading |
StepwiseContinuousLeading |
|
StepwiseContinuousTrailing |
StepwiseContinuousTrailing |
|
Discrete |
Discrete |
|
ContinuousNullableLeading |
ContinuousNullableLeading |
|
ContinuousNullableTrailing |
ContinuousNullableTrailing |
SdsTypeCode2
Enumerated Values
|
Property |
Value |
|---|---|
|
Empty |
Empty |
|
Object |
Object |
|
Boolean |
Boolean |
|
Char |
Char |
|
SByte |
SByte |
|
Byte |
Byte |
|
Int16 |
Int16 |
|
UInt16 |
UInt16 |
|
Int32 |
Int32 |
|
UInt32 |
UInt32 |
|
Int64 |
Int64 |
|
UInt64 |
UInt64 |
|
Single |
Single |
|
Double |
Double |
|
Decimal |
Decimal |
|
DateTime |
DateTime |
|
String |
String |
|
Guid |
Guid |
|
DateTimeOffset |
DateTimeOffset |
|
TimeSpan |
TimeSpan |
|
Version |
Version |
|
NullableBoolean |
NullableBoolean |
|
NullableChar |
NullableChar |
|
NullableSByte |
NullableSByte |
|
NullableByte |
NullableByte |
|
NullableInt16 |
NullableInt16 |
|
NullableUInt16 |
NullableUInt16 |
|
NullableInt32 |
NullableInt32 |
|
NullableUInt32 |
NullableUInt32 |
|
NullableInt64 |
NullableInt64 |
|
NullableUInt64 |
NullableUInt64 |
|
NullableSingle |
NullableSingle |
|
NullableDouble |
NullableDouble |
|
NullableDecimal |
NullableDecimal |
|
NullableDateTime |
NullableDateTime |
|
NullableGuid |
NullableGuid |
|
NullableDateTimeOffset |
NullableDateTimeOffset |
|
NullableTimeSpan |
NullableTimeSpan |
|
BooleanArray |
BooleanArray |
|
CharArray |
CharArray |
|
SByteArray |
SByteArray |
|
ByteArray |
ByteArray |
|
Int16Array |
Int16Array |
|
UInt16Array |
UInt16Array |
|
Int32Array |
Int32Array |
|
UInt32Array |
UInt32Array |
|
Int64Array |
Int64Array |
|
UInt64Array |
UInt64Array |
|
SingleArray |
SingleArray |
|
DoubleArray |
DoubleArray |
|
DecimalArray |
DecimalArray |
|
DateTimeArray |
DateTimeArray |
|
StringArray |
StringArray |
|
GuidArray |
GuidArray |
|
DateTimeOffsetArray |
DateTimeOffsetArray |
|
TimeSpanArray |
TimeSpanArray |
|
VersionArray |
VersionArray |
|
Array |
Array |
|
IList |
IList |
|
IDictionary |
IDictionary |
|
IEnumerable |
IEnumerable |
|
SdsType |
SdsType |
|
SdsTypeProperty |
SdsTypeProperty |
|
SdsStreamView |
SdsStreamView |
|
SdsStreamViewProperty |
SdsStreamViewProperty |
|
SdsStreamViewMap |
SdsStreamViewMap |
|
SdsStreamViewMapProperty |
SdsStreamViewMapProperty |
|
SdsStream |
SdsStream |
|
SdsStreamIndex |
SdsStreamIndex |
|
SdsTable |
SdsTable |
|
SdsColumn |
SdsColumn |
|
SdsValues |
SdsValues |
|
SdsObject |
SdsObject |
|
SByteEnum |
SByteEnum |
|
ByteEnum |
ByteEnum |
|
Int16Enum |
Int16Enum |
|
UInt16Enum |
UInt16Enum |
|
Int32Enum |
Int32Enum |
|
UInt32Enum |
UInt32Enum |
|
Int64Enum |
Int64Enum |
|
UInt64Enum |
UInt64Enum |
|
NullableSByteEnum |
NullableSByteEnum |
|
NullableByteEnum |
NullableByteEnum |
|
NullableInt16Enum |
NullableInt16Enum |
|
NullableUInt16Enum |
NullableUInt16Enum |
|
NullableInt32Enum |
NullableInt32Enum |
|
NullableUInt32Enum |
NullableUInt32Enum |
|
NullableInt64Enum |
NullableInt64Enum |
|
NullableUInt64Enum |
NullableUInt64Enum |
SdsExtrapolationMode2
Defines how a stream responds to requests with indexes that precede or follow all data in the stream. Behavior also depends on the SdsInterpolationMode for a stream. If SdsInterpolationMode is set to Discrete, extrapolation will not occur. If SdsInterpolationMode is set to ContinuousNullableLeading or ContinuousNullableTrailing, default values will be returned instead of actual data.
Enumerated Values
|
Property |
Value |
|---|---|
|
All |
All |
|
None |
None |
|
Forward |
Forward |
|
Backward |
Backward |
SdsResolvedStreamsResponse
A contract defining bulk response of SdsResolvedStream
Properties
|
Property Name |
Data Type |
Required |
Nullable |
Description |
|---|---|---|---|---|
|
Data |
false |
true |
[A contract defining resolution of SdsStream] |
|
|
ChildErrors |
false |
true |
[The error response contains details on the cause of stream resolution failure and resolution of the error.] |
{
"Data": [
{
"Id": "string",
"Name": "string",
"Description": "string",
"TypeId": "string",
"Indexes": [
{
"SdsTypePropertyId": "string"
}
],
"InterpolationMode": 0,
"ExtrapolationMode": 0,
"PropertyOverrides": [
{
"SdsTypePropertyId": "string",
"Uom": "string",
"InterpolationMode": 0
}
],
"Resolved": true,
"Type": {
"Id": "string",
"Name": "string",
"Description": "string",
"SdsTypeCode": "Empty",
"IsGenericType": true,
"IsReferenceType": true,
"GenericArguments": [
{
"Id": "string",
"Name": "string",
"Description": "string",
"SdsTypeCode": 0,
"IsGenericType": true,
"IsReferenceType": true,
"GenericArguments": "[<SdsType>]",
"Properties": [
{
"Id": "string",
"Name": "string",
"Description": "string",
"Order": 0,
"IsKey": true,
"FixedSize": 0,
"SdsType": "<SdsType>",
"Value": null,
"Uom": "string",
"InterpolationMode": "[",
"IsQuality": true
}
],
"BaseType": "<SdsType>",
"DerivedTypes": "[<SdsType>]",
"InterpolationMode": 0,
"ExtrapolationMode": 0
}
],
"Properties": [
{
"Id": "string",
"Name": "string",
"Description": "string",
"Order": 0,
"IsKey": true,
"FixedSize": 0,
"SdsType": "<SdsResolvedType>",
"Value": null,
"Uom": "string",
"InterpolationMode": "Continuous",
"IsQuality": true
}
],
"BaseType": {
"Id": "string",
"Name": "string",
"Description": "string",
"SdsTypeCode": 0,
"IsGenericType": true,
"IsReferenceType": true,
"GenericArguments": "[<SdsType>]",
"Properties": [
{
"Id": "string",
"Name": "string",
"Description": "string",
"Order": 0,
"IsKey": true,
"FixedSize": 0,
"SdsType": null,
"Value": null,
"Uom": "string",
"InterpolationMode": null,
"IsQuality": true
}
],
"BaseType": "<SdsType>",
"DerivedTypes": "[<SdsType>]",
"InterpolationMode": 0,
"ExtrapolationMode": 0
},
"DerivedTypes": [
{
"Id": "string",
"Name": "string",
"Description": "string",
"SdsTypeCode": 0,
"IsGenericType": true,
"IsReferenceType": true,
"GenericArguments": "[<SdsType>]",
"Properties": [
{
"Id": "string",
"Name": "string",
"Description": "string",
"Order": 0,
"IsKey": true,
"FixedSize": 0,
"SdsType": "<SdsType>",
"Value": null,
"Uom": "string",
"InterpolationMode": "[",
"IsQuality": true
}
],
"BaseType": "<SdsType>",
"DerivedTypes": "[<SdsType>]",
"InterpolationMode": 0,
"ExtrapolationMode": 0
}
],
"InterpolationMode": "Continuous",
"ExtrapolationMode": "All"
}
}
],
"ChildErrors": [
{
"OperationId": "string",
"Error": "string",
"Reason": "string",
"Resolution": "string",
"Parameters": {
"property1": "string",
"property2": "string"
},
"StreamId": "string",
"StatusCode": 100
}
]
}
SdsResolvedStreamErrorResponseBody
The error response contains details on the cause of stream resolution failure and resolution of the error.
Properties
|
Property Name |
Data Type |
Required |
Nullable |
Description |
|---|---|---|---|---|
|
OperationId |
string |
false |
true |
Operation unique identifier of action that caused the error |
|
Error |
string |
false |
true |
Error description |
|
Reason |
string |
false |
true |
Reason for the error |
|
Resolution |
string |
false |
true |
Resolution to resolve the error |
|
Parameters |
object |
false |
true |
Ids or values that are creating or are affected by the error |
|
StreamId |
string |
false |
true |
None |
|
StatusCode |
false |
false |
None |
{
"OperationId": "string",
"Error": "string",
"Reason": "string",
"Resolution": "string",
"Parameters": {
"property1": "string",
"property2": "string"
},
"StreamId": "string",
"StatusCode": 100
}
List Summaries
Returns summary intervals between a specified start and end index. Index types that cannot be interpolated do not support summary requests. Strings are an example of indexes that cannot be interpolated. Summaries are not supported for streams with compound indexes. Interpolating between two indexes that consist of multiple properties is not defined and results in non-determinant behavior.
Request
GET /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/Streams/{streamId}/Data/Summaries
Parameters
string tenantId
Tenant identifier.
string namespaceId
Namespace identifier.
string streamId
Stream identifier.
Response
|
Status Code |
Body Type |
Description |
|---|---|---|
|
200 |
Inline |
Returns a serialized collection of SdsIntervals. Each SdsInterval has a start, end, and collection of summary values. |
|
400 |
Missing or invalid inputs |
|
|
401 |
Unauthorized |
|
|
403 |
Forbidden |
|
|
404 |
One of the resources specified was not found |
|
|
500 |
An error occurred while processing the request |
|
|
503 |
Service Unavailable |
Example response body
400 Response (SdsStream API)
{
"OperationId": "string",
"Error": "string",
"Reason": "string",
"Resolution": "string",
"Parameters": {
"property1": "string",
"property2": "string"
}
}
List Sampled Values
Returns representative data sampled by intervals between a specified start and end index. Sampling is driven by a specified property or properties of the stream's Sds Type. Property types that cannot be interpolated do not support sampling requests. Strings are an example of a property that cannot be interpolated.
Request
GET /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/Streams/{streamId}/Data/Sampled
Parameters
string tenantId
Tenant identifier.
string namespaceId
Namespace identifier.
string streamId
Stream identifier.
Response
|
Status Code |
Body Type |
Description |
|---|---|---|
|
200 |
Inline |
Returns a serialized collection of events |
|
400 |
Missing or invalid inputs |
|
|
401 |
Unauthorized |
|
|
403 |
Forbidden |
|
|
404 |
One of the resources specified was not found |
|
|
500 |
An error occurred while processing the request |
|
|
503 |
Service Unavailable |
Example response body
400 Response (SdsStream API)
{
"OperationId": "string",
"Error": "string",
"Reason": "string",
"Resolution": "string",
"Parameters": {
"property1": "string",
"property2": "string"
}
}
Properties
|
Property Name |
Data Type |
Required |
Nullable |
Description |
|---|---|---|---|---|
|
OperationId |
string |
false |
true |
Operation unique identifier of action that caused the error |
|
Error |
string |
false |
true |
Error description |
|
Reason |
string |
false |
true |
Reason for the error |
|
Resolution |
string |
false |
true |
Resolution to resolve the error |
|
Parameters |
object |
false |
true |
IDs or values that are creating or are affected by the error |
{
"OperationId": "string",
"Error": "string",
"Reason": "string",
"Resolution": "string",
"Parameters": {
"property1": "string",
"property2": "string"
}
}
HttpStatusCode
Enumerated Values
|
Property |
Value |
|---|---|
|
Continue |
100 |
|
SwitchingProtocols |
101 |
|
Processing |
102 |
|
EarlyHints |
103 |
|
OK |
200 |
|
Created |
201 |
|
Accepted |
202 |
|
NonAuthoritativeInformation |
203 |
|
NoContent |
204 |
|
ResetContent |
205 |
|
PartialContent |
206 |
|
MultiStatus |
207 |
|
AlreadyReported |
208 |
|
IMUsed |
226 |
|
MultipleChoices |
300 |
|
Ambiguous |
300 |
|
MovedPermanently |
301 |
|
Moved |
301 |
|
Found |
302 |
|
Redirect |
302 |
|
SeeOther |
303 |
|
RedirectMethod |
303 |
|
NotModified |
304 |
|
UseProxy |
305 |
|
Unused |
306 |
|
TemporaryRedirect |
307 |
|
RedirectKeepVerb |
307 |
|
PermanentRedirect |
308 |
|
BadRequest |
400 |
|
Unauthorized |
401 |
|
PaymentRequired |
402 |
|
Forbidden |
403 |
|
NotFound |
404 |
|
MethodNotAllowed |
405 |
|
NotAcceptable |
406 |
|
ProxyAuthenticationRequired |
407 |
|
RequestTimeout |
408 |
|
Conflict |
409 |
|
Gone |
410 |
|
LengthRequired |
411 |
|
PreconditionFailed |
412 |
|
RequestEntityTooLarge |
413 |
|
RequestUriTooLong |
414 |
|
UnsupportedMediaType |
415 |
|
RequestedRangeNotSatisfiable |
416 |
|
ExpectationFailed |
417 |
|
MisdirectedRequest |
421 |
|
UnprocessableEntity |
422 |
|
Locked |
423 |
|
FailedDependency |
424 |
|
UpgradeRequired |
426 |
|
PreconditionRequired |
428 |
|
TooManyRequests |
429 |
|
RequestHeaderFieldsTooLarge |
431 |
|
UnavailableForLegalReasons |
451 |
|
InternalServerError |
500 |
|
NotImplemented |
501 |
|
BadGateway |
502 |
|
ServiceUnavailable |
503 |
|
GatewayTimeout |
504 |
|
HttpVersionNotSupported |
505 |
|
VariantAlsoNegotiates |
506 |
|
InsufficientStorage |
507 |
|
LoopDetected |
508 |
|
NotExtended |
510 |
|
NetworkAuthenticationRequired |
511 |