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

Data Views Resolved

Save PDF
Save selected topicSave selected topic and subtopicsSave all topics
Share
Share to emailCopy topic URL
  • Last UpdatedMar 28, 2023
  • 21 minute read

This portion of the overall data views API is the resources that resolve per-user for each data view. For a description of what this information is, and how to use it, see the documentation for resolved data views.

Get Data Items by Query

Returns the paged collection of data items that are the results of an individual query, and which are eligible for use in the current data view. A data view has a collection of zero or more queries. Each query has an identifier. Those identifiers are used here as part of the request path.

Request

GET /api/v1/tenants/{tenantId}/namespaces/{namespaceId}/dataviews/{id}/resolved/dataitems/{queryid}
?cache={cache}&skip={skip}&count={count}

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

string id
Data view identifier.

string queryId
Query identifier.

[optional] string cache
"Refresh" to force the resource to re-resolve.
"Preserve" to use cached information, if available. This is the default value.

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

[optional] integer count
An optional parameter representing the maximum number of data items to retrieve. If not specified, a default value of 100 is used.

Response

Status Code Body Type Description
200 ResolvedItemsOfDataItem An object with a "TimeOfResolution" and a collection of "Items", the DataItems that resolved.
403 ErrorResponse You are not authorized for this operation.
404 ErrorResponse The data view or query does not exist.
500 ErrorResponse An error occurred while processing the request. See the response body for details.

Response Headers

Status Header Type Description
200 Total-Count integer The total count of data items visible to the current user.
200 Link string Hyperlinks to the first page and next page of results as applicable.
200 Next-Page string Hyperlink to the next page of results.
200 First-Page string Hyperlink to the first page of results.

Example response body

200 Response

HTTP 200 OK
Content-Type: application/json  
{
  "TimeOfResolution": "2019-12-13T01:23:45Z",
  "Items": [
    {
      "Id": "WS_BILT",
      "Name": "WS_BILT",
      "TypeId": "quickstart-omf-weather-gen1",
      "ResourceType": "Stream",
      "TenantId": "fb3ee10e-91f0-4473-98b9-0353daeaa9e7",
      "NamespaceId": "development",
      "CommunityId": "",
      "Tags": [
        "Weather",
        "High Resolution",
        "Gen1"
       ],
       "Metadata": [
         {
           "Name": "Site",
           "Value": "Biltmore",
           "TypeCode": "String"
         }
       ],
       "DataItemFields": [
         {
           "Id": "Timestamp",
           "Name": "Timestamp",
           "TypeCode": "DateTime",
           "IsKey": true
         },
         {
           "Id": "SolarRadiation",
           "Name": "SolarRadiation",
           "TypeCode": "Int32",
           "IsKey": false
         },
         {
           "Id": "Temperature",
           "Name": "Temperature",
           "TypeCode": "Double",
           "IsKey": false
         }
      ],
      "IneligibleDataItemFields": []
    }
  ]
}

403 Response (ErrorResponse)

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

Get Ineligible Data Items by Query

Returns the paged collection of data items that are the results of an individual query, but which are not eligible for use in the current data view. A common reason for ineligibility is that the item's index property is of a different type than the data view expects. A data view has a collection of zero or more queries. Each query has an identifier. Those identifiers are used here as part of the request path.

Request

GET /api/v1/tenants/{tenantId}/namespaces/{namespaceId}/dataviews/{id}/resolved/ineligibledataitems/{queryid}
?cache={cache}&skip={skip}&count={count}

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

string id
Data view identifier.

string queryId
Query identifier.

[optional] string cache
"Refresh" to force the resource to re-resolve.
"Preserve" to use cached information, if available. This is the default value.

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

[optional] integer count
An optional parameter representing the maximum number of data items to retrieve. If not specified, a default value of 100 is used.

Response

Status Code Body Type Description
200 ResolvedItemsOfDataItem An object with a "TimeOfResolution" and a collection of "Items", the DataItems that resolved.
403 ErrorResponse You are not authorized for this operation.
404 ErrorResponse The data view or query does not exist.
500 ErrorResponse An error occurred while processing the request. See the response body for details.

Response Headers

Status Header Type Description
200 Total-Count integer The total count of data items visible to the current user.
200 Link string Hyperlinks to the first page and next page of results as applicable.
200 Next-Page string Hyperlink to the next page of results.
200 First-Page string Hyperlink to the first page of results.

Example response body

200 Response

HTTP 200 OK
Content-Type: application/json
{
  "TimeOfResolution": "2019-12-13T01:23:45Z",
  "Items": [
    {
      "Id": "SOME_INELIGIBLE_STREAM",
      "Name": "Some Ineligible Stream",
      "TypeId": "type-with-different-index",
      "ResourceType": "Stream",
      "TenantId": "fb3ee10e-91f0-4473-98b9-0353daeaa9e7",
      "NamespaceId": "development",
      "CommunityId": "",
      "Tags": [],
      "Metadata": [],
      "DataItemFields": [],
      "IneligibleDataItemFields": [
         {
           "Id": "Depth",
           "Name": "Depth",
           "TypeCode": "Double",
           "IsKey": true
         },
         {
           "Id": "Density",
           "Name": "Density",
           "TypeCode": "Double",
           "IsKey": false
         }
      ]
    }
  ]
}

access control responses

403 Response (ErrorResponse)

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

Get Groups

Returns the collection of Groups that resolved for the data view.

Request

GET /api/v1/tenants/{tenantId}/namespaces/{namespaceId}/dataviews/{id}/resolved/groups
?cache={cache}&skip={skip}&count={count}

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

string id
Data view identifier.

[optional] string cache
"Refresh" to force the resource to re-resolve.
"Preserve" to use cached information, if available. This is the default value.

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

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

Response

Status Code Body Type Description
200 ResolvedItemsOfGroup An object with a "TimeOfResolution" and a collection of "Items", the Groups that resolved.
403 ErrorResponse You are not authorized for this operation.
404 ErrorResponse The requested data view was not found.
500 ErrorResponse An error occurred while processing the request. See the response body for details.

Response Headers

Status Header Type Description
200 Total-Count integer The total count of groups.
200 Link string Hyperlinks to the first page and next page of results as applicable.
200 Next-Page string Hyperlink to the next page of results.
200 First-Page string Hyperlink to the first page of results.

Example response body

200 Response

HTTP 200 OK
Content-Type: application/json
{
  "TimeOfResolution": "2019-12-13T01:23:45Z",
  "Items": [
    {
      "GroupingValues": [ 
        {
          "Value": "Biltmore",
          "TypeCode": "String"
        }
      ],
      "DataItems": {
        "Query1": [
          {
            "Id": "WS_BILT",
            "Name": "WS_BILT",
            "TypeId": "quickstart-omf-weather-gen1",
            "ResourceType": "Stream",
            "TenantId": "fb3ee10e-91f0-4473-98b9-0353daeaa9e7",
            "NamespaceId": "development",
            "CommunityId": "",
            "Tags": [
                "Weather",
                "High Resolution",
                "Gen1"
            ],
            "Metadata": [
              {
                "Name": "Site",
                "Value": "Biltmore",
                "TypeCode": "String"
              }
            ],
            "DataItemFields": [
                {
                    "Id": "Timestamp",
                    "Name": "Timestamp",
                    "TypeCode": "DateTime",
                    "IsKey": true
                },
                {
                    "Id": "SolarRadiation",
                    "Name": "SolarRadiation",
                    "TypeCode": "Int32",
                    "IsKey": false
                },
                {
                    "Id": "Temperature",
                    "Name": "Temperature",
                    "TypeCode": "Double",
                    "IsKey": false
                }
            ],
            "IneligibleDataItemFields": []
          }
        ]
      }
    }
  ]
}

403 Response (ErrorResponse)

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

Get Field Mappings

Returns the collection of field mappings resolved for the data view. These show the exact data behind every field, for each data item, for each group.

Request

GET /api/v1/tenants/{tenantId}/namespaces/{namespaceId}/dataviews/{id}/resolved/fieldmappings
?cache={cache}&skip={skip}&count={count}

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

string id
Data view identifier.

[optional] string cache
"Refresh" to force the resource to re-resolve.
"Preserve" to use cached information, if available. This is the default value.

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

[optional] integer count
An optional parameter representing the maximum number of field mappings to retrieve. If not specified, a default value of 100 is used.

Response

Status Code Body Type Description
200 ResolvedItemsOfFieldMapping An object with a "TimeOfResolution" and a collection of "Items", the FieldMappings that resolved.
403 ErrorResponse You are not authorized for this operation.
404 ErrorResponse The data view or query does not exist.
500 ErrorResponse An error occurred while processing the request. See the response body for details.

Response Headers

Status Header Type Description
200 Total-Count integer The total count of field mappings.
200 Link string Hyperlinks to the first page and next page of results as applicable.
200 Next-Page string Hyperlink to the next page of results.
200 First-Page string Hyperlink to the first page of results.

Example response body

200 Response

HTTP 200 OK
{
    "TimeOfResolution": "2019-12-13T01:23:45Z",
    "Items": [
      {
        "Id": "Timestamp",
        "Label": "Timestamp",
        "FieldKind": "IndexField",
        "TypeCode": "DateTime",
        "DataMappings": [
          {
            "TypeCode": "DateTime"
          },
          {
            "TypeCode": "DateTime"
          },
          {
            "TypeCode": "DateTime"
          }
        ]
      },
      {
        "Id": "Temperature",
        "Label": "Temperature",
        "FieldKind": "DataField",
        "TypeCode": "Double",
        "DataMappings": [
          {
            "TargetId": "WS_BILT",
            "TargetTenantId": "fb3ee10e-91f0-4473-98b9-0353daeaa9e7",
            "TargetNamespaceId": "development",
            "TargetCommunityId": "",
            "TargetFieldKey": "Temperature",
            "TypeCode": "Double",
            "FieldSetIndex": 1,
            "FieldIndex": 0
          },
          {
            "TargetId": "WS_ROSE",
            "TargetTenantId": "fb3ee10e-91f0-4473-98b9-0353daeaa9e7",
            "TargetNamespaceId": "development",
            "TargetCommunityId": "",
            "TargetFieldKey": "Temperature",
            "TypeCode": "Double",
            "FieldSetIndex": 1,
            "FieldIndex": 0
          },
          {
            "TargetId": "WS_WINT",
            "TargetTenantId": "fb3ee10e-91f0-4473-98b9-0353daeaa9e7",
            "TargetNamespaceId": "development",
            "TargetCommunityId": "",
            "TargetFieldKey": "AmbientTemperature",
            "TypeCode": "Double",
            "FieldSetIndex": 1,
            "FieldIndex": 0
          }
        ]
      },
    ]
}

403 Response (ErrorResponse)

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

Get Available Field Sets

Returns the collection of field sets that are available for use in the data view, and which are not already included in the data view.

Request

GET /api/v1/tenants/{tenantId}/namespaces/{namespaceId}/dataviews/{id}/resolved/availablefieldsets
?cache={cache}

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

string id
Data view identifier.

[optional] string cache
"Refresh" to force the resource to re-resolve.
"Preserve" to use cached information, if available. This is the default value.

Response

Status Code Body Type Description
200 ResolvedItemsOfFieldSet An object with a "TimeOfResolution" and a collection of "Items", the FieldSets that resolved and which are still available.
403 ErrorResponse You are not authorized for this operation.
404 ErrorResponse The requested data view was not found.
500 ErrorResponse An error occurred while processing the request. See the response body for details.

Example response body

200 Response

HTTP 200 OK
{
    "TimeOfResolution": "2019-12-13T01:23:45Z",
    "Items": [
        {
            "QueryId": "weather",
            "DataFields": [
                {
                    "Source": "Id",
                    "Keys": [],
                    "Label": "{IdentifyingValue} Id"
                },
                {
                    "Source": "PropertyId",
                    "Keys": [
                        "SolarRadiation"
                    ],
                    "Label": "{IdentifyingValue} SolarRadiation {Uom} {SummaryType}"
                },
                {
                    "Source": "Metadata",
                    "Keys": [
                        "Site"
                    ],
                    "Label": "{IdentifyingValue} Site {Uom}"
                },
                {
                    "Source": "Tags",
                    "Keys": [
                        "Weather",
                        "Low Resolution",
                        "High Resolution",
                        "Gen1",
                        "Gen2",
                    ],
                    "Label": "{IdentifyingValue} Tags"
                }
            ]
        }
    ]
}

403 Response (ErrorResponse)

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

Get All Field Sets

Returns the collection of all field sets eligible for use in the data view, including fields which are currently included in the data view.

Request

GET /api/v1/tenants/{tenantId}/namespaces/{namespaceId}/dataviews/{id}/resolved/allfieldsets
?cache={cache}

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

string id
Data view identifier.

[optional] string cache
"Refresh" to force the resource to re-resolve.
"Preserve" to use cached information, if available. This is the default value.

Response

Status Code Body Type Description
200 ResolvedItemsOfFieldSet An object with a "TimeOfResolution" and a collection of "Items", the FieldSets that resolved and which are still available.
403 ErrorResponse You are not authorized for this operation.
404 ErrorResponse The requested data view was not found.
500 ErrorResponse An error occurred while processing the request. See the response body for details.

Example response body

200 Response

HTTP 200 OK
{
    "TimeOfResolution": "2019-12-13T01:23:45Z",
    "Items": [
        {
            "QueryId": "weather",
            "DataFields": [
                {
                    "Source": "Id",
                    "Keys": [],
                    "Label": "{IdentifyingValue} Id"
                },
                {
                    "Source": "PropertyId",
                    "Keys": [
                        "SolarRadiation"
                    ],
                    "Label": "{IdentifyingValue} SolarRadiation {Uom} {SummaryType}"
                },
                {
                    "Source": "PropertyId",
                    "Keys": [
                        "Temperature"
                    ],
                    "Label": "{IdentifyingValue} Temperature {Uom} {SummaryType}"
                },
                {
                    "Source": "Metadata",
                    "Keys": [
                        "Site"
                    ],
                    "Label": "{IdentifyingValue} Site {Uom}"
                },
                {
                    "Source": "Tags",
                    "Keys": [
                        "Weather",
                        "Low Resolution",
                        "High Resolution",
                        "Gen1",
                        "Gen2",
                    ],
                    "Label": "{IdentifyingValue} Tags"
                }
            ]
        }
    ]
}

403 Response (ErrorResponse)

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

Get Statistics

Returns the statistics about the size and shape on how the data view resolved.

Request

GET /api/v1/tenants/{tenantId}/namespaces/{namespaceId}/dataviews/{id}/resolved/statistics
?cache={cache}

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

string id
Data view identifier.

[optional] string cache
"Refresh" to force the resource to re-resolve.
"Preserve" to use cached information, if available. This is the default value.

Response

Status Code Body Type Description
200 ResolvedItemOfStatistics Successfully retrieved data.
403 ErrorResponse You are not authorized for this operation.
404 ErrorResponse The specified data view identifier is not found.
500 ErrorResponse An error occurred while processing the request. See the response body for details.

Example response body

200 Response

HTTP 200 OK
{
    "TimeOfResolution": "2019-12-13T01:23:45Z",
    "DataItemCount": 24,
    "GroupCount": 2,
    "FieldMappingCount": 10,
    "DataFieldSets": [
        {
            "DataItemCount": 18,
            "UnmappedDataItemCount": 3,
            "DataFields": [
                {
                    "FieldMappingCount": 3,
                    "DataMappingCount": 6,
                    "EmptyDataMappingCount": 0,
                    "UnmappedGroupCount": 0
                },
                {
                    "FieldMappingCount": 3,
                    "DataMappingCount": 6,
                    "EmptyDataMappingCount": 2,
                    "UnmappedGroupCount": 1
                }
            ]
        },
        {
            "DataItemCount": 6,
            "UnmappedDataItemCount": 0,
            "DataFields": [
                {
                    "FieldMappingCount": 2,
                    "DataMappingCount": 4,
                    "EmptyDataMappingCount": 2,
                    "UnmappedGroupCount": 1
                }
            ]
        }
    ]
}

403 Response (ErrorResponse)

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

Definitions

ResolvedItemsOfDataItem

Holds a collection of items that were resolved at a specific time.

Properties

Property Name Data Type Required Nullable Description
TimeOfResolution date-time false false The time the Items were resolved
Items [DataItem] false true The collection of items that were resolved 
{
  "TimeOfResolution": "2019-08-24T14:15:22Z",
  "Items": [
    {
      "Id": "string",
      "Name": "string",
      "ClusterEndpoint": "string",
      "Description": "string",
      "TypeId": "string",
      "ResourceType": 1,
      "TenantId": "string",
      "NamespaceId": "string",
      "CommunityId": "string",
      "Tags": [
        "string"
      ],
      "Metadata": [
        {
          "Name": "string",
          "Value": null,
          "Description": "string",
          "TypeCode": 0,
          "Uom": "string"
        }
      ],
      "DataItemFields": [
        {
          "Id": "string",
          "Name": "string",
          "StreamReferenceName": "string",
          "StreamId": "string",
          "TypeCode": 0,
          "Uom": "string",
          "IsKey": true
        }
      ],
      "IneligibleDataItemFields": [
        {
          "Id": "string",
          "Name": "string",
          "StreamReferenceName": "string",
          "StreamId": "string",
          "TypeCode": 0,
          "Uom": "string",
          "IsKey": true
        }
      ]
    }
  ]
}

DataItem

A data item resolved by the data view. Can represent various DataItemResourceTypes

Properties

Property Name Data Type Required Nullable Description
Id string false true The data item's unique identifier
Name string false true The data item's friendly name
ClusterEndpoint string false true The data item's cluster endpoint
Description string false true The data item's description
TypeId string false true The identifier of the data item's type
ResourceType DataItemResourceType false false The type of resource this data item comes from
TenantId string false true The tenant identifier this data item originates from
NamespaceId string false true The namespace identifier this data item originates from
CommunityId string false true The community identifier this data item originates from
Tags string[] false true The collection of tags specified on this data item
Metadata [MetadataValueOfObject] false true The list of metadata value objects specified on this data item
DataItemFields [DataItemField] false true The collection of data fields this data item exposes
IneligibleDataItemFields [DataItemField] false true The collection of ineligible data fields this data item exposes These fields are not supported by data views and will not be included in the available field sets These fields can be manually added to a data view but the data result will show null values 
{
  "Id": "string",
  "Name": "string",
  "ClusterEndpoint": "string",
  "Description": "string",
  "TypeId": "string",
  "ResourceType": 1,
  "TenantId": "string",
  "NamespaceId": "string",
  "CommunityId": "string",
  "Tags": [
    "string"
  ],
  "Metadata": [
    {
      "Name": "string",
      "Value": null,
      "Description": "string",
      "TypeCode": 0,
      "Uom": "string"
    }
  ],
  "DataItemFields": [
    {
      "Id": "string",
      "Name": "string",
      "StreamReferenceName": "string",
      "StreamId": "string",
      "TypeCode": 0,
      "Uom": "string",
      "IsKey": true
    }
  ],
  "IneligibleDataItemFields": [
    {
      "Id": "string",
      "Name": "string",
      "StreamReferenceName": "string",
      "StreamId": "string",
      "TypeCode": 0,
      "Uom": "string",
      "IsKey": true
    }
  ]
}

DataItemResourceType

The type of resource that a data item represents

Enumerated Values

Property Value
Stream 1
Asset 2

MetadataValueOfObject

Individual metadata value from the metadata list of a DataItem

Properties

Property Name Data Type Required Nullable Description
Name string false true Name of the metadata value
Value any false true Value of the metadata value
Description string false true Description of the metadata value
TypeCode SdsTypeCode false false SDS type of the metadata value
Uom string false true Unit of measurement of the metadata value 
{
  "Name": "string",
  "Value": null,
  "Description": "string",
  "TypeCode": 0,
  "Uom": "string"
}

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

DataItemField

A field exposed by some DataItem

Properties

Property Name Data Type Required Nullable Description
Id string false true The field's unique identifier
Name string false true The field's friendly name
StreamReferenceName string false true Name of the corresponding asset stream reference, if applicable
StreamId string false true Stream id corresponding to the asset stream reference, if applicable
TypeCode SdsTypeCode false false The field's data type
Uom string false true The field's unit of measure unique identifier
IsKey boolean false false Whether or not this field is its data item's primary key/index True if the field is its data item's primary key/index; false otherwise. 
{
  "Id": "string",
  "Name": "string",
  "StreamReferenceName": "string",
  "StreamId": "string",
  "TypeCode": 0,
  "Uom": "string",
  "IsKey": true
}

ErrorResponse

Properties

Property Name Data Type Required Nullable Description
OperationId string false true None
Error string false true None
Reason string false true None
Resolution string false true None
Parameters object false true None
ChildErrors object false true None 
{
  "OperationId": "string",
  "Error": "string",
  "Reason": "string",
  "Resolution": "string",
  "Parameters": {
    "property1": "string",
    "property2": "string"
  },
  "ChildErrors": {
    "property1": null,
    "property2": null
  }
}

ResolvedItemsOfGroup

Holds a collection of items that were resolved at a specific time.

Properties

Property Name Data Type Required Nullable Description
TimeOfResolution date-time false false The time the Items were resolved
Items [Group] false true The collection of items that were resolved 
{
  "TimeOfResolution": "2019-08-24T14:15:22Z",
  "Items": [
    {
      "GroupingValues": [
        {
          "Value": null,
          "TypeCode": 0,
          "Uom": "string"
        }
      ],
      "DataItems": {
        "property1": [
          {
            "Id": "string",
            "Name": "string",
            "ClusterEndpoint": "string",
            "Description": "string",
            "TypeId": "string",
            "ResourceType": 1,
            "TenantId": "string",
            "NamespaceId": "string",
            "CommunityId": "string",
            "Tags": [
              "string"
            ],
            "Metadata": [
              {
                "Name": "string",
                "Value": null,
                "Description": "string",
                "TypeCode": 0,
                "Uom": "string"
              }
            ],
            "DataItemFields": [
              {
                "Id": "string",
                "Name": "string",
                "StreamReferenceName": "string",
                "StreamId": "string",
                "TypeCode": 0,
                "Uom": "string",
                "IsKey": true
              }
            ],
            "IneligibleDataItemFields": [
              {
                "Id": "string",
                "Name": "string",
                "StreamReferenceName": "string",
                "StreamId": "string",
                "TypeCode": 0,
                "Uom": "string",
                "IsKey": true
              }
            ]
          }
        ],
        "property2": [
          {
            "Id": "string",
            "Name": "string",
            "ClusterEndpoint": "string",
            "Description": "string",
            "TypeId": "string",
            "ResourceType": 1,
            "TenantId": "string",
            "NamespaceId": "string",
            "CommunityId": "string",
            "Tags": [
              "string"
            ],
            "Metadata": [
              {
                "Name": "string",
                "Value": null,
                "Description": "string",
                "TypeCode": 0,
                "Uom": "string"
              }
            ],
            "DataItemFields": [
              {
                "Id": "string",
                "Name": "string",
                "StreamReferenceName": "string",
                "StreamId": "string",
                "TypeCode": 0,
                "Uom": "string",
                "IsKey": true
              }
            ],
            "IneligibleDataItemFields": [
              {
                "Id": "string",
                "Name": "string",
                "StreamReferenceName": "string",
                "StreamId": "string",
                "TypeCode": 0,
                "Uom": "string",
                "IsKey": true
              }
            ]
          }
        ]
      }
    }
  ]
}

Group

A group resolved by a data view

Properties

Property Name Data Type Required Nullable Description
GroupingValues [GroupingValueOfObject] false true The collection of values resolved by the grouping fields defined in the data view
DataItems object false true The collections of data items in this group, keyed by query id 
{
  "GroupingValues": [
    {
      "Value": null,
      "TypeCode": 0,
      "Uom": "string"
    }
  ],
  "DataItems": {
    "property1": [
      {
        "Id": "string",
        "Name": "string",
        "ClusterEndpoint": "string",
        "Description": "string",
        "TypeId": "string",
        "ResourceType": 1,
        "TenantId": "string",
        "NamespaceId": "string",
        "CommunityId": "string",
        "Tags": [
          "string"
        ],
        "Metadata": [
          {
            "Name": "string",
            "Value": null,
            "Description": "string",
            "TypeCode": 0,
            "Uom": "string"
          }
        ],
        "DataItemFields": [
          {
            "Id": "string",
            "Name": "string",
            "StreamReferenceName": "string",
            "StreamId": "string",
            "TypeCode": 0,
            "Uom": "string",
            "IsKey": true
          }
        ],
        "IneligibleDataItemFields": [
          {
            "Id": "string",
            "Name": "string",
            "StreamReferenceName": "string",
            "StreamId": "string",
            "TypeCode": 0,
            "Uom": "string",
            "IsKey": true
          }
        ]
      }
    ],
    "property2": [
      {
        "Id": "string",
        "Name": "string",
        "ClusterEndpoint": "string",
        "Description": "string",
        "TypeId": "string",
        "ResourceType": 1,
        "TenantId": "string",
        "NamespaceId": "string",
        "CommunityId": "string",
        "Tags": [
          "string"
        ],
        "Metadata": [
          {
            "Name": "string",
            "Value": null,
            "Description": "string",
            "TypeCode": 0,
            "Uom": "string"
          }
        ],
        "DataItemFields": [
          {
            "Id": "string",
            "Name": "string",
            "StreamReferenceName": "string",
            "StreamId": "string",
            "TypeCode": 0,
            "Uom": "string",
            "IsKey": true
          }
        ],
        "IneligibleDataItemFields": [
          {
            "Id": "string",
            "Name": "string",
            "StreamReferenceName": "string",
            "StreamId": "string",
            "TypeCode": 0,
            "Uom": "string",
            "IsKey": true
          }
        ]
      }
    ]
  }
}

GroupingValueOfObject

The value resolved by a grouping field defined in the data view

Properties

Property Name Data Type Required Nullable Description
Value any false true The grouping value
TypeCode SdsTypeCode false false SDS type of the grouping value
Uom string false true Unit of measurement of the grouping value 
{
  "Value": null,
  "TypeCode": 0,
  "Uom": "string"
}

DataItemOfObject

A data item resolved by the data view. Can represent various DataItemResourceTypes

Properties

Property Name Data Type Required Nullable Description
Id string false true The data item's unique identifier
Name string false true The data item's friendly name
ClusterEndpoint string false true The data item's cluster endpoint
Description string false true The data item's description
TypeId string false true The identifier of the data item's type
ResourceType DataItemResourceType false false The type of resource this data item comes from
TenantId string false true The tenant identifier this data item originates from
NamespaceId string false true The namespace identifier this data item originates from
CommunityId string false true The community identifier this data item originates from
Tags string[] false true The collection of tags specified on this data item
Metadata [MetadataValueOfObject] false true The list of metadata value objects specified on this data item
DataItemFields [DataItemField] false true The collection of data fields this data item exposes
IneligibleDataItemFields [DataItemField] false true The collection of ineligible data fields this data item exposes These fields are not supported by data views and will not be included in the available field sets These fields can be manually added to a data view but the data result will show null values 
{
  "Id": "string",
  "Name": "string",
  "ClusterEndpoint": "string",
  "Description": "string",
  "TypeId": "string",
  "ResourceType": 1,
  "TenantId": "string",
  "NamespaceId": "string",
  "CommunityId": "string",
  "Tags": [
    "string"
  ],
  "Metadata": [
    {
      "Name": "string",
      "Value": null,
      "Description": "string",
      "TypeCode": 0,
      "Uom": "string"
    }
  ],
  "DataItemFields": [
    {
      "Id": "string",
      "Name": "string",
      "StreamReferenceName": "string",
      "StreamId": "string",
      "TypeCode": 0,
      "Uom": "string",
      "IsKey": true
    }
  ],
  "IneligibleDataItemFields": [
    {
      "Id": "string",
      "Name": "string",
      "StreamReferenceName": "string",
      "StreamId": "string",
      "TypeCode": 0,
      "Uom": "string",
      "IsKey": true
    }
  ]
}

ResolvedItemsOfFieldMapping

Holds a collection of items that were resolved at a specific time.

Properties

Property Name Data Type Required Nullable Description
TimeOfResolution date-time false false The time the Items were resolved
Items [FieldMapping] false true The collection of items that were resolved 
{
  "TimeOfResolution": "2019-08-24T14:15:22Z",
  "Items": [
    {
      "Id": "string",
      "Label": "string",
      "FieldKind": 1,
      "TypeCode": 0,
      "Uom": "string",
      "SummaryType": 0,
      "SummaryDirection": 1,
      "DataMappings": [
        {
          "TargetId": "string",
          "TargetTenantId": "string",
          "TargetNamespaceId": "string",
          "TargetCommunityId": "string",
          "TargetStreamReferenceName": "string",
          "TargetFieldKey": "string",
          "TypeCode": 0,
          "Uom": "string",
          "SummaryType": 0,
          "SummaryDirection": 1,
          "FieldSetIndex": 0,
          "FieldIndex": 0
        }
      ]
    }
  ]
}

FieldMapping

A resolved field of the data view, identifying its data source for each group.

Properties

Property Name Data Type Required Nullable Description
Id string false true The unique identifier
Label string false true The friendly name
FieldKind FieldKind false false The kind of the field
TypeCode SdsTypeCode false false The primary data type of this FieldMapping. This value comes from the field mapping's first non-empty DataMapping.
Uom string false true The unit of measure unique identifier of this FieldMapping. Unit of measure is null unless all DataMapping unit of measures within the FieldMapping are equal.
SummaryType SdsSummaryType false true The SummaryType when all DataMapping SummaryType values for this field are consistent, otherwise null.
SummaryDirection SummaryDirection false true The SummaryDirection when all DataMapping SummaryDirection values for this field are consistent, otherwise null.
DataMappings [DataMapping] false true The collection of mappings corresponding indexwise to each Group resolved by the data view. 
{
  "Id": "string",
  "Label": "string",
  "FieldKind": 1,
  "TypeCode": 0,
  "Uom": "string",
  "SummaryType": 0,
  "SummaryDirection": 1,
  "DataMappings": [
    {
      "TargetId": "string",
      "TargetTenantId": "string",
      "TargetNamespaceId": "string",
      "TargetCommunityId": "string",
      "TargetStreamReferenceName": "string",
      "TargetFieldKey": "string",
      "TypeCode": 0,
      "Uom": "string",
      "SummaryType": 0,
      "SummaryDirection": 1,
      "FieldSetIndex": 0,
      "FieldIndex": 0
    }
  ]
}

FieldKind

Identifies the type of field

Enumerated Values

Property Value
IndexField 1
GroupingField 2
DataField 3
FieldId 4
FieldUom 5

SdsSummaryType

Enumerated Values

Property Value
None 0
Count 1
Minimum 2
Maximum 4
Range 8
Mean 16
StandardDeviation 32
PopulationStandardDeviation 64
Total 128
Skewness 256
Kurtosis 512
WeightedMean 1024
WeightedStandardDeviation 2048
WeightedPopulationStandardDeviation 4096

SummaryDirection

Specifies summary direction for a Field

Enumerated Values

Property Value
Forward 1
Backward 2

DataMapping

Information about the data source resolved for an individual Field for a specific Group

Properties

Property Name Data Type Required Nullable Description
TargetId string false true The identifier of the target data source
TargetTenantId string false true The identifier of the target’s tenant
TargetNamespaceId string false true The identifier of the target’s namespace
TargetCommunityId string false true The identifier of the target’s community
TargetStreamReferenceName string false true The name of the target stream reference
TargetFieldKey string false true The subpath within the target data source Null in case of non-"keyed" mapping (e.g. stream id, as opposed to a specific Stream property)
TypeCode SdsTypeCode false false The field's data type
Uom string false true The DataMapping's unit of measure unique identifier
SummaryType SdsSummaryType false false The DataMapping's summary operation
SummaryDirection SummaryDirection false true The direction of the DataMapping's summary operation
FieldSetIndex int32 false true The field set this DataMapping comes from, identified by its index in the data view's collection of FieldSets The FieldSet object is easily retrieved from the DataView's FieldSets using this index value. This only applies to FieldKind.DataField and FieldKind.FieldId.
FieldIndex int32 false true The field corresponding to this DataMapping, identified by its index in the FieldSet's collection of Fields The Field object is easily retrieved from the FieldSet's Fields using this index value. This applies to FieldKind.GroupingField, FieldKind.DataField, and FieldKind.FieldId. 
{
  "TargetId": "string",
  "TargetTenantId": "string",
  "TargetNamespaceId": "string",
  "TargetCommunityId": "string",
  "TargetStreamReferenceName": "string",
  "TargetFieldKey": "string",
  "TypeCode": 0,
  "Uom": "string",
  "SummaryType": 0,
  "SummaryDirection": 1,
  "FieldSetIndex": 0,
  "FieldIndex": 0
}

ResolvedItemsOfFieldSet

Holds a collection of items that were resolved at a specific time.

Properties

Property Name Data Type Required Nullable Description
TimeOfResolution date-time false false The time the Items were resolved
Items [FieldSet] false true The collection of items that were resolved 
{
  "TimeOfResolution": "2019-08-24T14:15:22Z",
  "Items": [
    {
      "QueryId": "string",
      "DataFields": [
        {
          "Source": 0,
          "Keys": [
            "string"
          ],
          "StreamReferenceNames": [
            "string"
          ],
          "Label": "string",
          "SummaryType": 0,
          "SummaryDirection": 1,
          "IncludeUom": true
        }
      ],
      "IdentifyingField": {
        "Source": 0,
        "Keys": [
          "string"
        ],
        "StreamReferenceNames": [
          "string"
        ],
        "Label": "string",
        "SummaryType": 0,
        "SummaryDirection": 1,
        "IncludeUom": true
      }
    }
  ]
}

FieldSet

A set of fields defined for a particular source of data.

Properties

Property Name Data Type Required Nullable Description
QueryId string false true The identifier of the Query this field set uses.
DataFields [Field] false true The collection of Data Fields defined in this field set.
IdentifyingField Field false true The field used to identify each data item resolved by this field set. 
{
  "QueryId": "string",
  "DataFields": [
    {
      "Source": 0,
      "Keys": [
        "string"
      ],
      "StreamReferenceNames": [
        "string"
      ],
      "Label": "string",
      "SummaryType": 0,
      "SummaryDirection": 1,
      "IncludeUom": true
    }
  ],
  "IdentifyingField": {
    "Source": 0,
    "Keys": [
      "string"
    ],
    "StreamReferenceNames": [
      "string"
    ],
    "Label": "string",
    "SummaryType": 0,
    "SummaryDirection": 1,
    "IncludeUom": true
  }
}

Field

A data field that targets information resolved within its FieldSet

Properties

Property Name Data Type Required Nullable Description
Source FieldSource false false The target part of a data item, if this Field targets a data item. NotApplicable otherwise.
Keys string[] false true The collection of keys this field can match on its target data source Can be used to account for differences across target data types, e.g. matching either "Temperature" or "temperature_val"
StreamReferenceNames string[] false true The collection of possible stream reference names
Label string false true A friendly label
SummaryType SdsSummaryType false false Specifies summary operation
SummaryDirection SummaryDirection false true Specifies summary direction
IncludeUom boolean false false Specifies whether to include this field's unit of measure as an additional field mapping in the resolved data view 
{
  "Source": 0,
  "Keys": [
    "string"
  ],
  "StreamReferenceNames": [
    "string"
  ],
  "Label": "string",
  "SummaryType": 0,
  "SummaryDirection": 1,
  "IncludeUom": true
}

FieldSource

The targeted part of a DataItem

Enumerated Values

Property Value
NotApplicable 0
Id 1
Name 2
PropertyId 3
PropertyName 4
Metadata 5
Tags 6
TenantId 7
TenantName 8
NamespaceId 9
NamespaceName 10
CommunityId 11
CommunityName 12

ResolvedItemOfStatistics

Holds an item that was resolved at a specific time.

Properties

Property Name Data Type Required Nullable Description
TimeOfResolution date-time false false The time the Item was resolved
Item Statistics false true The item that was resolved 
{
  "TimeOfResolution": "2019-08-24T14:15:22Z",
  "Item": {
    "DataItemCount": 0,
    "GroupCount": 0,
    "FieldMappingCount": 0,
    "Queries": [
      {
        "QueryId": "string",
        "DataItemCount": 0,
        "DataItemWithIneligibleFieldsCount": 0,
        "IneligibleDataItemCount": 0
      }
    ],
    "DataFieldSets": [
      {
        "DataItemCount": 0,
        "UnmappedDataItemCount": 0,
        "DataFields": [
          {
            "FieldMappingCount": 0,
            "DataMappingCount": 0,
            "EmptyDataMappingCount": 0,
            "UnmappedGroupCount": 0
          }
        ]
      }
    ]
  }
}

Statistics

Statistics about how a data view resolved

Properties

Property Name Data Type Required Nullable Description
DataItemCount int32 false false The total count of data items resolved by the data view
GroupCount int32 false false The total count of groups resolved by the data view
FieldMappingCount int32 false false The total count of field mappings resolved by the data view
Queries [QueryStatistics] false true Statistics about the data items resolved (or not resolved) for each query
DataFieldSets [DataFieldSetStatistics] false true Statistics about how the data view data field sets resolved 
{
  "DataItemCount": 0,
  "GroupCount": 0,
  "FieldMappingCount": 0,
  "Queries": [
    {
      "QueryId": "string",
      "DataItemCount": 0,
      "DataItemWithIneligibleFieldsCount": 0,
      "IneligibleDataItemCount": 0
    }
  ],
  "DataFieldSets": [
    {
      "DataItemCount": 0,
      "UnmappedDataItemCount": 0,
      "DataFields": [
        {
          "FieldMappingCount": 0,
          "DataMappingCount": 0,
          "EmptyDataMappingCount": 0,
          "UnmappedGroupCount": 0
        }
      ]
    }
  ]
}

QueryStatistics

Statistics about the data items associated with a particular query

Properties

Property Name Data Type Required Nullable Description
QueryId string false true The id of the query these statistics come from
DataItemCount int32 false false The total count of eligible data items
DataItemWithIneligibleFieldsCount int32 false false The total count of eligible data items that have ineligible fields
IneligibleDataItemCount int32 false false The total count of data items that are completely ineligible 
{
  "QueryId": "string",
  "DataItemCount": 0,
  "DataItemWithIneligibleFieldsCount": 0,
  "IneligibleDataItemCount": 0
}

DataFieldSetStatistics

Statistics about how a data field set resolved

Properties

Property Name Data Type Required Nullable Description
DataItemCount int32 false false The total count of data items resolved for the data field set
UnmappedDataItemCount int32 false false The total count of data items not referenced by a field mapping resolved for the data field set
DataFields [DataFieldStatistics] false true Statistics about how the data field set data fields resolved 
{
  "DataItemCount": 0,
  "UnmappedDataItemCount": 0,
  "DataFields": [
    {
      "FieldMappingCount": 0,
      "DataMappingCount": 0,
      "EmptyDataMappingCount": 0,
      "UnmappedGroupCount": 0
    }
  ]
}

DataFieldStatistics

Statistics about how a data field resolved

Properties

Property Name Data Type Required Nullable Description
FieldMappingCount int32 false false The total count of field mappings associated with the data field
DataMappingCount int32 false false The total count of data mappings associated with the data field
EmptyDataMappingCount int32 false false The total count of data mappings associated with the data field that do not map to any data
UnmappedGroupCount int32 false false The total count of groups that do not map to any field mappings in the data field 
{
  "FieldMappingCount": 0,
  "DataMappingCount": 0,
  "EmptyDataMappingCount": 0,
  "UnmappedGroupCount": 0
}
In This Topic
Related Links
TitleResults for “How to create a CRG?”Also Available in