Streams

Save PDF

Last UpdatedMay 22, 2025
22 minute read

The API in this section interacts with streams.

`List Streams`

Returns a list of streams.

Request

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

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

[optional] string query
Parameter representing a string search.

[optional] string filter
Parameter representing a filter expression.

[optional] integer skip
Parameter representing the zero-based offset of the first SdsType to retrieve. If not specified, a default value of 0 is used.

[optional] integer count
Parameter representing the maximum number of SdsTypes to retrieve. If not specified, a default value of 100 is used.

[optional] string orderby
Parameter representing sorted order which SdsTypes will be returned. A field name is required. The sorting is based on the stored values for the 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 result.

Response

Status Code	Body Type	Description
200	SdsStream[]	Returns a list of `SdsStream` objects
400	ErrorResponseBody	Missing or invalid inputs
401	ErrorResponseBody	Unauthorized
403	ErrorResponseBody	Forbidden
404	ErrorResponseBody	One of the resources specified was not found
500	ErrorResponseBody	An error occurred while processing the request
503	ErrorResponseBody	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
      }
    ],
    "CreatedDate": "2019-08-24T14:15:22Z",
    "ModifiedDate": "2019-08-24T14:15:22Z"
  }
]

`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	SdsStream	Returns the `SdsStream`
400	ErrorResponseBody	Missing or invalid inputs
401	ErrorResponseBody	Unauthorized
403	ErrorResponseBody	Forbidden
404	ErrorResponseBody	One of the resources specified was not found
500	ErrorResponseBody	An error occurred while processing the request
503	ErrorResponseBody	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
    }
  ],
  "CreatedDate": "2019-08-24T14:15:22Z",
  "ModifiedDate": "2019-08-24T14:15:22Z"
}

`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	SdsStream	`SdsStream` was successfully returned
201	SdsStream	`SdsStream` was successfully created
400	ErrorResponseBody	Missing or invalid inputs
401	ErrorResponseBody	Unauthorized
403	ErrorResponseBody	Forbidden
404	ErrorResponseBody	One of the resources specified was not found
409	ErrorResponseBody	Conflict
500	ErrorResponseBody	An error occurred while processing the request
503	ErrorResponseBody	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
    }
  ],
  "CreatedDate": "2019-08-24T14:15:22Z",
  "ModifiedDate": "2019-08-24T14:15:22Z"
}

`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	SdsStream	`SdsStream` was successfully created
204	None	`SdsStream` was successfully updated
400	ErrorResponseBody	Missing or invalid inputs
401	ErrorResponseBody	Unauthorized
403	ErrorResponseBody	Forbidden
404	ErrorResponseBody	One of the resources specified was not found
409	ErrorResponseBody	Conflict
500	ErrorResponseBody	An error occurred while processing the request
503	ErrorResponseBody	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
    }
  ],
  "CreatedDate": "2019-08-24T14:15:22Z",
  "ModifiedDate": "2019-08-24T14:15:22Z"
}

`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	ErrorResponseBody	Missing or invalid inputs
401	ErrorResponseBody	Unauthorized
403	ErrorResponseBody	Forbidden
404	ErrorResponseBody	One of the resources specified was not found
500	ErrorResponseBody	An error occurred while processing the request
503	ErrorResponseBody	Service Unavailable

`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	SdsType	Returns the `SdsType`
400	ErrorResponseBody	Missing or invalid inputs
401	ErrorResponseBody	Unauthorized
403	ErrorResponseBody	Forbidden
404	ErrorResponseBody	One of the resources specified was not found
500	ErrorResponseBody	An error occurred while processing the request
503	ErrorResponseBody	Service Unavailable

Example response body

200 Response (SdsType)

{
  "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,
  "CreatedDate": "2019-08-24T14:15:22Z",
  "ModifiedDate": "2019-08-24T14:15:22Z"
}

`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
?streamViewId={streamViewId}

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

string streamId
Stream identifier.

[optional] string streamViewId
Stream view identifier.

Response

Status Code	Body Type	Description
204	None	`SdsType` was successfully updated
400	ErrorResponseBody	Missing or invalid inputs
401	ErrorResponseBody	Unauthorized
403	ErrorResponseBody	Forbidden
404	ErrorResponseBody	One of the resources specified was not found
409	ErrorResponseBody	Conflict
500	ErrorResponseBody	An error occurred while processing the request
503	ErrorResponseBody	Service Unavailable

`Get Resolved Stream`

Returns the resolved stream and type representation that is associated with a given stream.

Request

GET /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/Streams/{streamId}/Resolved

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

string streamId
Stream identifier.

Response

Status Code	Body Type	Description
200	SdsResolvedStream	`SdsResolvedStream` was successfully retrieved
400	ErrorResponseBody	Missing or invalid inputs
401	ErrorResponseBody	Unauthorized
403	ErrorResponseBody	Forbidden
404	ErrorResponseBody	One of the resources specified was not found
500	ErrorResponseBody	An error occurred while processing the request
503	ErrorResponseBody	Service Unavailable

Example response body

200 Response

{
    "Id": "string",
    "Name": "string",
    "Description": "string",
    "Indexes": [
        {
        "SdsTypePropertyId": "string"
        }
    ],
    "CreatedDate": "2019-08-24T14:15:22Z",
    "ModifiedDate": "2019-08-24T14:15:22Z",
    "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
            }
            ],
            "InterpolationMode": 0,
            "ExtrapolationMode": 0,
            "CreatedDate": "2019-08-24T14:15:22Z",
            "ModifiedDate": "2019-08-24T14:15:22Z"
        }
        ],
        "Properties": [
        {
            "Id": "string",
            "Name": "string",
            "Description": "string",
            "Order": 0,
            "IsKey": true,
            "FixedSize": 0,
            "SdsType": "<SdsResolvedType>",
            "Value": null,
            "Uom": "string",
            "InterpolationMode": "Default",
            "IsQuality": true
        }
        ],
        "InterpolationMode": "Default",
        "ExtrapolationMode": "All",
        "CreatedDate": "2019-08-24T14:15:22Z",
        "ModifiedDate": "2019-08-24T14:15:22Z"
    }
}

400 Response (ErrorResponseBody)

{
  "OperationId": "string",
  "Error": "string",
  "Reason": "string",
  "Resolution": "string",
  "Parameters": {
    "property1": "string",
    "property2": "string"
  }
}

`Get Resolved Streams`

Returns bulk resolved stream and type representations that are associated with provided streams. The list of stream identifiers to be resolved should be supplied as a list of stream IDs in the request body. HTTP 207 is returned regardless of partial or complete success of stream resolution. Any stream that cannot be resolved with be included in the ChildErrors property of the SdsResolvedStreamsResponse.

Request

POST /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/Bulk/Streams/Resolved

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

Response

Status Code	Body Type	Description
207	SdsResolvedStreamsResponse	`SdsResolvedStreamsResponse` was successfully retrieved
400	ErrorResponseBody	Missing or invalid inputs
500	ErrorResponseBody	An error occurred while processing the request
503	ErrorResponseBody	Service Unavailable

Example response body

207 Response

{
    "Data": [
      {
        "Id": "string",
        "Name": "string",
        "Description": "string",
        "Indexes": [{ "SdsTypePropertyId": "string" }],
        "CreatedDate": "2019-08-24T14:15:22Z",
        "ModifiedDate": "2019-08-24T14:15:22Z",
        "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
                }
              ],
              "InterpolationMode": 0,
              "ExtrapolationMode": 0,
              "CreatedDate": "2019-08-24T14:15:22Z",
              "ModifiedDate": "2019-08-24T14:15:22Z"
            }
          ],
          "Properties": [
            {
              "Id": "string",
              "Name": "string",
              "Description": "string",
              "Order": 0,
              "IsKey": true,
              "FixedSize": 0,
              "SdsType": "<SdsResolvedType>",
              "Value": null,
              "Uom": "string",
              "InterpolationMode": "Default",
              "IsQuality": true
            }
          ],
          "InterpolationMode": "Default",
          "ExtrapolationMode": "All",
          "CreatedDate": "2019-08-24T14:15:22Z",
          "ModifiedDate": "2019-08-24T14:15:22Z"
        }
      }
    ],
    "ChildErrors": [
      {
        "OperationId": "string",
        "Error": "string",
        "Reason": "string",
        "Resolution": "string",
        "Parameters": { "property1": "string", "property2": "string" },
        "StreamId": "string",
        "StatusCode": 100
      }
    ]
  }
```> 400 Response ([ErrorResponseBody](#schemaerrorresponsebody))

```json
{
  "OperationId": "string",
  "Error": "string",
  "Reason": "string",
  "Resolution": "string",
  "Parameters": {
    "property1": "string",
    "property2": "string"
  }
}

Definitions

SdsStream

A contract defining read and write operations on data of SdsType.

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	[SdsStreamIndex]	false	true	List of SdsStreamIndexs to define secondary indexes for the SdsStream.
InterpolationMode	SdsInterpolationMode	false	true	Defines the SdsInterpolationMode of the SdsStream. Default is null.
ExtrapolationMode	SdsExtrapolationMode	false	true	Defines the SdsExtrapolationMode of the SdsStream. Default is null.
PropertyOverrides	[SdsStreamPropertyOverride]	false	true	List of SdsStreamPropertyOverrides to define unit of measure and interpolation mode overrides for the SdsStream.
CreatedDate	date-time	false	false	The DateTime in ISO 8601 extended format and UTC time standard when the SdsStream was created. This value is set upon object creation and is immutable. The default value of the CreatedDate property of existing objects is DateTime.MinValue. This property cannot be modified by users.
ModifiedDate	date-time	false	false	The DateTime in ISO 8601 extended format and UTC time standard when the SdsStream was last modified. This value is initialized upon object creation and is updated each time an object's properties are successfully modified. The ModifiedDate property of an object will also update if the object's ACL or owner is modified. The default value of the ModifiedDate property of existing objects is DateTime.MinValue. This property cannot be modified by users.

{
  "Id": "string",
  "Name": "string",
  "Description": "string",
  "TypeId": "string",
  "Indexes": [
    {
      "SdsTypePropertyId": "string"
    }
  ],
  "InterpolationMode": 0,
  "ExtrapolationMode": 0,
  "PropertyOverrides": [
    {
      "SdsTypePropertyId": "string",
      "Uom": "string",
      "InterpolationMode": 0
    }
  ],
  "CreatedDate": "2019-08-24T14:15:22Z",
  "ModifiedDate": "2019-08-24T14:15:22Z"
}

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	A 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
Continuous	0	Interpolates the data using previous and next index values.
Default	0
StepwiseContinuousLeading	1	Returns the data from the previous index.
StepwiseContinuousTrailing	2	Returns the data from the next index.
Discrete	3	If set on an SdsStream, returns stored events only. If set on a property of an event, the default value of the property type will be returned.
ContinuousNullableLeading	4	For nullable data types only. If either the previous or next data value is null, returns the data from the previous index.
ContinuousNullableTrailing	5	For nullable data types only. If either the previous or next data value is null, returns the data from the next index.

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 won't 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	Returns the first data value if the index is before the first event in the stream, and returns the last data value if the index is after the last event in the stream
None	1	No extrapolation occurs
Forward	2	Returns the last data value if the index is after the last event in the stream
Backward	3	Returns the first data value if the index is before the first event in the stream

SdsStreamPropertyOverride

SdsStreamPropertyOverride object provides a way to override interpolation behavior and unit of measure for individual SdsType Properties for a specific SdsStream.

Properties

Property Name	Data Type	Required	Nullable	Description
SdsTypePropertyId	string	false	true	A 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	SdsInterpolationMode	false	true	Defines the InterpolationMode of the SdsTypeProperty.

{
  "SdsTypePropertyId": "string",
  "Uom": "string",
  "InterpolationMode": 0
}

ErrorResponseBody

The error response contains standard details on the cause 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

{
  "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	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, https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/generics/index.\|
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 further information on generics, please refer to https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/generics/index.\|
Properties	[SdsTypeProperty]	false	true	List of SdsTypePropertys of the SdsType.
BaseType	SdsType	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	SdsInterpolationMode	false	false	Defines the SdsInterpolationMode of the SdsType. This property is only valid for the root SdsType and invalid for SdsTypes of SdsTypePropertys.
ExtrapolationMode	SdsExtrapolationMode	false	false	Defines the SdsExtrapolationMode of the SdsType. This property is only valid for the root SdsType and invalid for SdsTypes of SdsTypePropertys.
CreatedDate	date-time	false	false	The DateTime in ISO 8601 extended format and UTC time standard when the SdsType was created. This value is set upon object creation and is immutable. The default value of the CreatedDate property of existing objects is DateTime.MinValue. This property cannot be modified by users.
ModifiedDate	date-time	false	false	The DateTime in ISO 8601 extended format and UTC time standard when the SdsType was last modified. This value is initialized upon object creation and is updated each time an object's properties are successfully modified. The ModifiedDate property of an object will also update if the object's ACL or owner is modified. The default value of the ModifiedDate property of existing objects is DateTime.MinValue. This property cannot be modified by users.

{
  "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,
  "CreatedDate": "2019-08-24T14:15:22Z",
  "ModifiedDate": "2019-08-24T14:15:22Z"
}

SdsTypeCode

Enumerated Values

Property	Value	Description
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	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.
FixedSize	int32	false	false	An optional property specifying the length of string.
SdsType	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	SdsInterpolationMode	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": "[<SdsType>]",
    "Properties": "[<SdsTypeProperty>]",
    "BaseType": "<SdsType>",
    "DerivedTypes": "[<SdsType>]",
    "InterpolationMode": 0,
    "ExtrapolationMode": 0,
    "CreatedDate": "2019-08-24T14:15:22Z",
    "ModifiedDate": "2019-08-24T14:15:22Z"
  },
  "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	[SdsStreamIndex]	false	true	List of SdsStreamIndexs to define secondary indexes for the SdsStream.
InterpolationMode	SdsInterpolationMode	false	true	Defines the SdsInterpolationMode of the SdsStream. Default is null.
ExtrapolationMode	SdsExtrapolationMode	false	true	Defines the SdsExtrapolationMode of the SdsStream. Default is null.
PropertyOverrides	[SdsStreamPropertyOverride]	false	true	List of SdsStreamPropertyOverrides to define unit of measure and interpolation mode overrides for the SdsStream
CreatedDate	date-time	false	false	The DateTime in ISO 8601 extended format and UTC time standard when the SdsStream was created. This value is set upon object creation and is immutable. The default value of the CreatedDate property of existing objects is DateTime.MinValue. This property cannot be modified by users.
ModifiedDate	date-time	false	false	The DateTime in ISO 8601 extended format and UTC time standard when the SdsStream was last modified. This value is initialized upon object creation and is updated each time an object's properties are successfully modified. The ModifiedDate property of an object will also update if the object's ACL or owner is modified. The default value of the ModifiedDate property of existing objects is DateTime.MinValue. This property cannot be modified by users.
Resolved	boolean	false	false	None
Type	SdsResolvedType	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
    }
  ],
  "CreatedDate": "2019-08-24T14:15:22Z",
  "ModifiedDate": "2019-08-24T14:15:22Z",
  "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,
        "CreatedDate": "2019-08-24T14:15:22Z",
        "ModifiedDate": "2019-08-24T14:15:22Z"
      }
    ],
    "Properties": [
      {
        "Id": "string",
        "Name": "string",
        "Description": "string",
        "Order": 0,
        "IsKey": true,
        "FixedSize": 0,
        "SdsType": "<SdsResolvedType>",
        "Value": null,
        "Uom": "string",
        "InterpolationMode": "Default",
        "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,
      "CreatedDate": "2019-08-24T14:15:22Z",
      "ModifiedDate": "2019-08-24T14:15:22Z"
    },
    "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,
        "CreatedDate": "2019-08-24T14:15:22Z",
        "ModifiedDate": "2019-08-24T14:15:22Z"
      }
    ],
    "InterpolationMode": "Default",
    "ExtrapolationMode": "All",
    "CreatedDate": "2019-08-24T14:15:22Z",
    "ModifiedDate": "2019-08-24T14:15:22Z"
  }
}

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	SdsTypeCode2	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 further information on generics, please refer, https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/generics/index.\|
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 further information on generics, please refer to https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/generics/index.\|
Properties	[SdsResolvedTypeProperty]	false	true	[A contract defining the type of data to read or write in a SdsResolvedType.]
BaseType	SdsType	false	true	A contract defining the type of data to read or write in a SdsStream.
DerivedTypes	[SdsType]	false	true	[A contract defining the type of data to read or write in a SdsStream.]
InterpolationMode	SdsInterpolationMode2	false	false	Interpolation modes that can be applied to SdsType, SdsTypeProperty, SdsStream, and SdsStreamPropertyOverride objects.
ExtrapolationMode	SdsExtrapolationMode2	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 won't occur. If SdsInterpolationMode is set to ContinuousNullableLeading or ContinuousNullableTrailing, default values will be returned instead of actual data.
CreatedDate	date-time	false	false	The DateTime in ISO 8601 extended format and UTC time standard when the SdsType was created. This value is set upon object creation and is immutable. The default value of the CreatedDate property of existing objects is DateTime.MinValue. This property cannot be modified by users.
ModifiedDate	date-time	false	false	The DateTime in ISO 8601 extended format and UTC time standard when the SdsType was last modified. This value is initialized upon object creation and is updated each time an object's properties are successfully modified. The ModifiedDate property of an object will also update if the object's ACL or owner is modified. The default value of the ModifiedDate property of existing objects is DateTime.MinValue. This property cannot be modified by users.

{
  "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,
      "CreatedDate": "2019-08-24T14:15:22Z",
      "ModifiedDate": "2019-08-24T14:15:22Z"
    }
  ],
  "Properties": [
    {
      "Id": "string",
      "Name": "string",
      "Description": "string",
      "Order": 0,
      "IsKey": true,
      "FixedSize": 0,
      "SdsType": "<SdsResolvedType>",
      "Value": null,
      "Uom": "string",
      "InterpolationMode": "Default",
      "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,
    "CreatedDate": "2019-08-24T14:15:22Z",
    "ModifiedDate": "2019-08-24T14:15:22Z"
  },
  "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,
      "CreatedDate": "2019-08-24T14:15:22Z",
      "ModifiedDate": "2019-08-24T14:15:22Z"
    }
  ],
  "InterpolationMode": "Default",
  "ExtrapolationMode": "All",
  "CreatedDate": "2019-08-24T14:15:22Z",
  "ModifiedDate": "2019-08-24T14:15:22Z"
}

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.
FixedSize	int32	false	false	An optional property specifying the length of string.
SdsType	SdsResolvedType	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	SdsInterpolationMode2	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,
        "CreatedDate": "2019-08-24T14:15:22Z",
        "ModifiedDate": "2019-08-24T14:15:22Z"
      }
    ],
    "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,
      "CreatedDate": "2019-08-24T14:15:22Z",
      "ModifiedDate": "2019-08-24T14:15:22Z"
    },
    "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,
        "CreatedDate": "2019-08-24T14:15:22Z",
        "ModifiedDate": "2019-08-24T14:15:22Z"
      }
    ],
    "InterpolationMode": "Default",
    "ExtrapolationMode": "All",
    "CreatedDate": "2019-08-24T14:15:22Z",
    "ModifiedDate": "2019-08-24T14:15:22Z"
  },
  "Value": null,
  "Uom": "string",
  "InterpolationMode": "Default",
  "IsQuality": true
}

SdsInterpolationMode2

Interpolation modes that can be applied to SdsType, SdsTypeProperty, SdsStream, and SdsStreamPropertyOverride objects.

Enumerated Values

Property	Value
Continuous	Default
Default	Default
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

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	[SdsResolvedStream]	false	true	[A contract defining resolution of SdsStream.]
ChildErrors	[SdsResolvedStreamErrorResponseBody]	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
        }
      ],
      "CreatedDate": "2019-08-24T14:15:22Z",
      "ModifiedDate": "2019-08-24T14:15:22Z",
      "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,
            "CreatedDate": "2019-08-24T14:15:22Z",
            "ModifiedDate": "2019-08-24T14:15:22Z"
          }
        ],
        "Properties": [
          {
            "Id": "string",
            "Name": "string",
            "Description": "string",
            "Order": 0,
            "IsKey": true,
            "FixedSize": 0,
            "SdsType": "<SdsResolvedType>",
            "Value": null,
            "Uom": "string",
            "InterpolationMode": "Default",
            "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,
          "CreatedDate": "2019-08-24T14:15:22Z",
          "ModifiedDate": "2019-08-24T14:15:22Z"
        },
        "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,
            "CreatedDate": "2019-08-24T14:15:22Z",
            "ModifiedDate": "2019-08-24T14:15:22Z"
          }
        ],
        "InterpolationMode": "Default",
        "ExtrapolationMode": "All",
        "CreatedDate": "2019-08-24T14:15:22Z",
        "ModifiedDate": "2019-08-24T14:15:22Z"
      }
    }
  ],
  "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	HttpStatusCode	false	false	None

{
  "OperationId": "string",
  "Error": "string",
  "Reason": "string",
  "Resolution": "string",
  "Parameters": {
    "property1": "string",
    "property2": "string"
  },
  "StreamId": "string",
  "StatusCode": 100
}

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
UnprocessableContent	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

CONNECT data services developer documentation

Streams

List Streams

Request

Parameters

Response

Example response body

Get Stream

Request

Parameters

Response

Example response body

Get Or Create Stream

Request

Parameters

Response

Example response body

Create Or Update Stream

Request

Parameters

Response

Example response body

Delete Stream

Request

Parameters

Response

Get Stream Type

Request

Parameters

Response

Example response body

Update Stream Type

Request

Parameters

Response

Get Resolved Stream

Request

Parameters

Response

Example response body

Get Resolved Streams

Request

Parameters

Response

Example response body

Definitions

SdsStream

Properties

SdsStreamIndex

Properties

SdsInterpolationMode

Enumerated Values

SdsExtrapolationMode

Enumerated Values

SdsStreamPropertyOverride

Properties

ErrorResponseBody

Properties

SdsType

Properties

SdsTypeCode

Enumerated Values

SdsTypeProperty

Properties

SdsResolvedStream

Properties

SdsResolvedType

Properties

SdsResolvedTypeProperty

Properties

SdsInterpolationMode2

Enumerated Values

SdsTypeCode2

Enumerated Values

SdsExtrapolationMode2

Enumerated Values

SdsResolvedStreamsResponse

Properties

SdsResolvedStreamErrorResponseBody

Properties

`List Streams`

`Get Stream`

`Get Or Create Stream`

`Create Or Update Stream`

`Delete Stream`

`Get Stream Type`

`Update Stream Type`

`Get Resolved Stream`

`Get Resolved Streams`