Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

CONNECT data services developer documentation

TABLE OF CONTENTS

Resolved Asset

Save PDF
Save selected topicSave selected topic and subtopicsSave all topics
Share
Share to emailCopy topic URL
  • Last UpdatedJan 08, 2025
  • 9 minute read

Get Resolved Asset

Returns resolved view of specified asset.

Request

GET /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/Assets/{assetId}/Resolved

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

string assetId
Asset identifier.

Response

Status Code Body Type Description
200 ResolvedAsset Resolved asset with specified identifier.
400 ErrorTemplate Request is not valid. See the response body for additional details.
403 ErrorTemplate Forbidden.
404 ErrorTemplate Not found.
408 ErrorTemplate Request Timeout.
503 ErrorTemplate Service unavailable.

Example response body

200 Response

{
  "Id": "Heater-8911ee90-467b-4a3f-bc7b-3b3512c23dfc",
  "Name": "Heater Asset",
  "Resolved": true,
  "Description": "Heater Asset on the first floor.",
  "AssetTypeId": "Heater_AssetType-6f53c911-f5de-4b7f-981f-d6f0ec139d9f",
  "AssetTypeName": "Heater_AssetType",
  "Metadata": [
    {
      "Name": "ModelNumber",
      "SdsTypeCode": "Double",
      "Value": 0.01
    }
  ],
  "Streams": [
    {
      "Name": "ResolvedReferenceName1",
      "Type": {
        "Id": "SdsType-ffdf2227-50e8-4196-b828-f1bd2b3689c8",
        "SdsTypeCode": "Object",
        "Properties": [
          {
            "Id": "Timestamp",
            "IsKey": true,
            "SdsType": {
              "Id": "0573b425-368a-369b-95d9-71c863df45a5",
              "SdsTypeCode": "DateTime"
            },
            "InterpolationMode": "Continuous"
          },
          {
            "Id": "Pressure",
            "SdsType": {
              "Id": "9144b7d6-3d5f-3b29-8131-ff0db551e17c",
              "SdsTypeCode": "Double"
            },
            "Uom": "bar",
            "InterpolationMode": "Continuous"
          }
        ]
      },
      "StreamReferenceName": "ResolvedReferenceName1",
      "StreamId": "Stream-b3c7a344-ce8a-4578-b4cd-1a6d78ca0610",
      "PropertyMaps": [
        {
          "Id": "Timestamp",
          "SourcePropertyId": "Timestamp"
        },
        {
          "Id": "Pressure",
          "SourcePropertyId": "Pressure"
        }
      ]
    }
  ],
  "UnresolvedStreams": [],
  "UnresolvedMetadata": [],
  "StatusDefinitionType": "StreamPropertyMapping",
  "Status": {
    "StreamId": "SdsStream_id_1",
    "SourcePropertyId": "Count"
  },
  "Tags": [
    "Tag1",
    "Tag2"
  ]
}

400 Response (ErrorTemplate)

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

Resolved Asset

Bulk Get Resolved Assets

Returns multiple resolved assets.

Request

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

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

Request Body

Asset identifiers

[
  "Equipment1",
  "Equipment2"
]

Response

Status Code Body Type Description
200 MultiStatusResultOfResolvedAssetAndChildErrorTemplate Returns the resolved view of multiple assets.
207 MultiStatusResultOfStringAndChildErrorTemplate Partial success. Not all assets were able to be resolved. See response body for additional details.
400 ErrorTemplate Request is not valid. See the response body for additional details.
408 ErrorTemplate Request Timeout.
503 ErrorTemplate Service unavailable.

Example response body

200 Response

[
  {
    "Id": "Equipment1",
    "Name": "Equipment1",
    "Resolved": true,
    "Description": "An example asset",
    "AssetTypeId": "Equipment",
    "AssetTypeName": "Equipment",
    "Metadata": [
      {
        "Name": "site",
        "Id": "site",
        "SdsTypeCode": "String",
        "Value": "PHYL"
      }
    ],
    "Streams": [
      {
        "Name": "Reader1",
        "Type": {
          "Id": "TimeIndexedDouble",
          "SdsTypeCode": "Object",
          "Properties": [
            {
              "Id": "Timestamp",
              "IsKey": true,
              "SdsType": {
                "Id": "TimeIndexedDouble.Timestamp",
                "SdsTypeCode": "DateTime"
              },
              "InterpolationMode": "Default"
            },
            {
              "Id": "Value",
              "SdsType": {
                "Id": "TimeIndexedDouble.Value",
                "SdsTypeCode": "Double"
              },
              "InterpolationMode": "Default"
            }
          ]
        },
        "StreamReferenceName": "Reader1",
        "Id": "Reader1",
        "StreamId": "Equipment1-Reader1",
        "PropertyMaps": [
          {
            "Id": "Timestamp",
            "SourcePropertyId": "Timestamp"
          },
          {
            "Id": "Value",
            "SourcePropertyId": "Value"
          }
        ]
      }
    ],
    "UnresolvedStreams": [],
    "UnresolvedMetadata": [],
    "StatusDefinitionType": "StreamPropertyMapping",
    "Tags": []
  },
  {
    "Id": "Equipment2",
    "Name": "Equipment2",
    "Resolved": true,
    "Description": "Setup Script Asset Type",
    "AssetTypeId": "Equipment",
    "AssetTypeName": "Equipment",
    "Metadata": [
      {
        "Name": "site",
        "Id": "site",
        "SdsTypeCode": "String",
        "Value": "SLTC"
      }
    ],
    "Streams": [
      {
        "Name": "Reader1",
        "Type": {
          "Id": "TimeIndexedDouble",
          "SdsTypeCode": "Object",
          "Properties": [
            {
              "Id": "Timestamp",
              "IsKey": true,
              "SdsType": {
                "Id": "TimeIndexedDouble.Timestamp",
                "SdsTypeCode": "DateTime"
              },
              "InterpolationMode": "Default"
            },
            {
              "Id": "Value",
              "SdsType": {
                "Id": "TimeIndexedDouble.Value",
                "SdsTypeCode": "Double"
              },
              "InterpolationMode": "Default"
            }
          ]
        },
        "StreamReferenceName": "Reader1",
        "Id": "Reader1",
        "StreamId": "Equipment2-Reader1",
        "PropertyMaps": [
          {
            "Id": "Timestamp",
            "SourcePropertyId": "Timestamp"
          },
          {
            "Id": "Value",
            "SourcePropertyId": "Value"
          }
        ]
      }
    ],
    "UnresolvedStreams": [],
    "UnresolvedMetadata": [],
    "StatusDefinitionType": "StreamPropertyMapping",
    "Tags": []
  }
]

207 Response (MultiStatusResultOfStringAndChildErrorTemplate)

{
  "Reason": "string",
  "Error": "string",
  "OperationId": "string",
  "Data": [
    "string"
  ],
  "ChildErrors": [
    {
      "OperationId": "string",
      "Error": "string",
      "Resolution": "string",
      "Reason": "string",
      "StatusCode": 0,
      "property1": null,
      "property2": null
    }
  ]
}

Definitions

ResolvedAsset

The resolved asset describes the consumption-oriented aspects of a resource rather than describing how the resource is configured. The resolved asset corresponds to its metadata and referenced stream which define how the data is interpreted (that is, SdsTypeCode, InterpolationMode, and Uom).

Properties

Property Name Data Type Required Nullable Description
Id string false true Asset identifier
Name string false true Asset name
Resolved boolean false false Always true. Reserved for future use
Description string false true Resolved description. If description is null on the asset and the asset has an asset type, then the resolved description comes from the asset type.
AssetTypeId string false true Asset type identifier of the resolved asset. This field will be null if the asset does not have an asset type.
AssetTypeName string false true Asset type name of the resolved asset. This field will be null if the asset does not have an asset type.
ShapeId string false true Reserved for future use
ShapeName string false true Reserved for future use
Metadata [ResolvedMetadataItem] false true Resolved metadata. The metadata is the union of the metadata from the asset and asset type.
Streams [ResolvedStream] false true Resolved asset stream references
UnresolvedStreams [UnresolvedStream] false true Resolved asset unresolved streams
UnresolvedMetadata [UnresolvedMetadata] false true Unresolved metadata will always be empty. Reserved for future use.
StatusDefinitionType StatusDefinitionType false false Resolved asset status definition
Status any false true Resolved asset status
UnresolvedStatus UnresolvedStatus false true Resolved asset unresolved status
Tags string[] false true Resolved asset tags 
{
  "Id": "Heater-8911ee90-467b-4a3f-bc7b-3b3512c23dfc",
  "Name": "Heater Asset",
  "Resolved": true,
  "Description": "Heater Asset on the first floor.",
  "AssetTypeId": "Heater_AssetType-6f53c911-f5de-4b7f-981f-d6f0ec139d9f",
  "AssetTypeName": "Heater_AssetType",
  "Metadata": [
    {
      "Name": "ModelNumber",
      "SdsTypeCode": "Double",
      "Value": 0.01
    }
  ],
  "Streams": [
    {
      "Name": "ResolvedReferenceName1",
      "Type": {
        "Id": "SdsType-ffdf2227-50e8-4196-b828-f1bd2b3689c8",
        "SdsTypeCode": "Object",
        "Properties": [
          {
            "Id": "Timestamp",
            "IsKey": true,
            "SdsType": {
              "Id": "0573b425-368a-369b-95d9-71c863df45a5",
              "SdsTypeCode": "DateTime"
            },
            "InterpolationMode": "Continuous"
          },
          {
            "Id": "Pressure",
            "SdsType": {
              "Id": "9144b7d6-3d5f-3b29-8131-ff0db551e17c",
              "SdsTypeCode": "Double"
            },
            "Uom": "bar",
            "InterpolationMode": "Continuous"
          }
        ]
      },
      "StreamReferenceName": "ResolvedReferenceName1",
      "StreamId": "Stream-b3c7a344-ce8a-4578-b4cd-1a6d78ca0610",
      "PropertyMaps": [
        {
          "Id": "Timestamp",
          "SourcePropertyId": "Timestamp"
        },
        {
          "Id": "Pressure",
          "SourcePropertyId": "Pressure"
        }
      ]
    }
  ],
  "UnresolvedStreams": [],
  "UnresolvedMetadata": [],
  "StatusDefinitionType": "StreamPropertyMapping",
  "Status": {
    "StreamId": "SdsStream_id_1",
    "SourcePropertyId": "Count"
  },
  "Tags": [
    "Tag1",
    "Tag2"
  ]
}

ResolvedMetadataItem

Resolved metadata is a property of a resolved asset.

Properties

Property Name Data Type Required Nullable Description
Name string false true Metadata name
Id string false true Metadata Id
SdsTypeCode SdsTypeCode false false Metadata data type represented as an SdsTypeCode
Value any false true Metadata static value
Uom string false true Metadata unit of measurement 
{
  "Name": "ModelNumber",
  "Id": "Id-abcde",
  "SdsTypeCode": "Double",
  "Value": 0.01
}

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

ResolvedStream

Resolved stream is a property of the resolved asset.

Properties

Property Name Data Type Required Nullable Description
Name string false true Resolved stream name. The resolved stream name corresponds to the stream reference name as defined in the stream reference on the asset.
Type SdsType false true SdsType of the referenced stream
StreamReferenceName string false true Stream reference name used in the asset
Id string false true Stream reference id used in the asset
StreamId string false true SDS stream identifier of the referenced stream
PropertyMaps [PropertyMap] false true SDS stream property maps 
{
  "Name": "string",
  "Type": {
    "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"
  },
  "StreamReferenceName": "string",
  "Id": "string",
  "StreamId": "string",
  "PropertyMaps": [
    {
      "Id": "Timestamp",
      "SourcePropertyId": "Timestamp"
    }
  ]
}

SdsType

Properties

Property Name Data Type Required Nullable Description
Id string false true None
Name string false true None
Description string false true None
SdsTypeCode SdsTypeCode false false None
IsGenericType boolean false false None
IsReferenceType boolean false false None
GenericArguments [SdsType] false true None
Properties [SdsTypeProperty] false true None
BaseType SdsType false true None
DerivedTypes [SdsType] false true None
InterpolationMode SdsInterpolationMode false false None
ExtrapolationMode SdsExtrapolationMode false false None
CreatedDate date-time false false None
ModifiedDate date-time false false None 
{
  "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"
}

SdsTypeProperty

Properties

Property Name Data Type Required Nullable Description
Id string false true None
Name string false true None
Description string false true None
Order int32 false false None
IsKey boolean false false None
FixedSize int32 false false None
SdsType SdsType false true None
Value any false true None
Uom string false true None
InterpolationMode SdsInterpolationMode false true None
IsQuality boolean false false None 
{
  "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
}

SdsInterpolationMode

Enumerated Values

Property Value
Continuous 0
Default 0
StepwiseContinuousLeading 1
StepwiseContinuousTrailing 2
Discrete 3
ContinuousNullableLeading 4
ContinuousNullableTrailing 5

SdsExtrapolationMode

Enumerated Values

Property Value
All 0
None 1
Forward 2
Backward 3

PropertyMap

Property map

Properties

Property Name Data Type Required Nullable Description
Id string false true Renamed Stream property identifier. Currently, Id and SourcePropertyId will always be the same. This field mapping is reserved for future use.
SourcePropertyId string false true The original name of the Stream Property Id as defined in the Sequential Data Store (SDS). 
{
  "Id": "Timestamp",
  "SourcePropertyId": "Timestamp"
}

UnresolvedStream

Unresolved stream, a property of the resolved asset, is a stream that could not be resolved.

Properties

Property Name Data Type Required Nullable Description
Name string false true Name of the stream reference that could not be resolved
Id string false true Stream reference id that could not be resolved
Reason string false true Reason why the stream reference could not be resolved 
"{\n    \"Name\": \"InputTemperature\",\n    \"Id\": \"5345e98d-dc43-4f9d-a666-158a3baaf244\",\n    \"Reason\": \"SDS Stream 'temperature' not found\"\"\n}"

UnresolvedMetadata

Reserved for future use. In the current implementation, the UnresolvedMetadata will always be an empty list.

Properties

Property Name Data Type Required Nullable Description
Name string false true Name of the metadata which could not be resolved.
Reason string false true Reason why the metadata could not be resolved. 
{
  "Name": "string",
  "Reason": "string"
}

StatusDefinitionType

Status definition type. Currently, only StreamPropertyMapping is supported.

Enumerated Values

Property Value Description
Unspecified 0
StreamPropertyMapping 1

UnresolvedStatus

Unresolved status, a property of the resolved asset, means asset status could not be resolved.

Properties

Property Name Data Type Required Nullable Description
Reason string false true Reason why the status could not be resolved. 
{
  "Reason": "Reason why status could not be resolved."
}

ErrorTemplate

Properties

Property Name Data Type Required Nullable Description
OperationId string false true Operation identifier
Error string false true Error string
Resolution string false true Resolution string
Reason string false true Error reason string 
{
  "OperationId": "string",
  "Error": "string",
  "Resolution": "string",
  "Reason": "string",
  "property1": null,
  "property2": null
}

MultiStatusResultOfResolvedAssetAndChildErrorTemplate

A multi status result is returned to indicate a partial success.

Properties

Property Name Data Type Required Nullable Description
Reason string false true Failure reason.
Error string false true Error string
OperationId string false true Operational identifier of the call. Used for support.
Data [ResolvedAsset] false true Requested information from call.
ChildErrors [ChildErrorTemplate] false true Child error pertaining to specific resources. 
{
  "Reason": "string",
  "Error": "string",
  "OperationId": "string",
  "Data": [
    {
      "Id": "Heater-8911ee90-467b-4a3f-bc7b-3b3512c23dfc",
      "Name": "Heater Asset",
      "Resolved": true,
      "Description": "Heater Asset on the first floor.",
      "AssetTypeId": "Heater_AssetType-6f53c911-f5de-4b7f-981f-d6f0ec139d9f",
      "AssetTypeName": "Heater_AssetType",
      "Metadata": [
        {
          "Name": "ModelNumber",
          "SdsTypeCode": "Double",
          "Value": 0.01
        }
      ],
      "Streams": [
        {
          "Name": "ResolvedReferenceName1",
          "Type": {
            "Id": "SdsType-ffdf2227-50e8-4196-b828-f1bd2b3689c8",
            "SdsTypeCode": "Object",
            "Properties": [
              {
                "Id": "Timestamp",
                "IsKey": true,
                "SdsType": {
                  "Id": "0573b425-368a-369b-95d9-71c863df45a5",
                  "SdsTypeCode": "DateTime"
                },
                "InterpolationMode": "Continuous"
              },
              {
                "Id": "Pressure",
                "SdsType": {
                  "Id": "9144b7d6-3d5f-3b29-8131-ff0db551e17c",
                  "SdsTypeCode": "Double"
                },
                "Uom": "bar",
                "InterpolationMode": "Continuous"
              }
            ]
          },
          "StreamReferenceName": "ResolvedReferenceName1",
          "StreamId": "Stream-b3c7a344-ce8a-4578-b4cd-1a6d78ca0610",
          "PropertyMaps": [
            {
              "Id": "Timestamp",
              "SourcePropertyId": "Timestamp"
            },
            {
              "Id": "Pressure",
              "SourcePropertyId": "Pressure"
            }
          ]
        }
      ],
      "UnresolvedStreams": [],
      "UnresolvedMetadata": [],
      "StatusDefinitionType": "StreamPropertyMapping",
      "Status": {
        "StreamId": "SdsStream_id_1",
        "SourcePropertyId": "Count"
      },
      "Tags": [
        "Tag1",
        "Tag2"
      ]
    }
  ],
  "ChildErrors": [
    {
      "OperationId": "string",
      "Error": "string",
      "Resolution": "string",
      "Reason": "string",
      "StatusCode": 0,
      "property1": null,
      "property2": null
    }
  ]
}

ChildErrorTemplate

Properties

Property Name Data Type Required Nullable Description
OperationId string false true Operation identifier
Error string false true Error string
Resolution string false true Resolution string
Reason string false true Error reason string
StatusCode int32 false false None 
{
  "OperationId": "string",
  "Error": "string",
  "Resolution": "string",
  "Reason": "string",
  "StatusCode": 0,
  "property1": null,
  "property2": null
}

MultiStatusResultOfStringAndChildErrorTemplate

A multi status result is returned to indicate a partial success.

Properties

Property Name Data Type Required Nullable Description
Reason string false true Failure reason.
Error string false true Error string
OperationId string false true Operational identifier of the call. Used for support.
Data string[] false true Requested information from call.
ChildErrors [ChildErrorTemplate] false true Child error pertaining to specific resources. 
{
  "Reason": "string",
  "Error": "string",
  "OperationId": "string",
  "Data": [
    "string"
  ],
  "ChildErrors": [
    {
      "OperationId": "string",
      "Error": "string",
      "Resolution": "string",
      "Reason": "string",
      "StatusCode": 0,
      "property1": null,
      "property2": null
    }
  ]
}
In This Topic
Related Links
TitleResults for “How to create a CRG?”Also Available in