Get Last Asset Status Data

Returns status of an asset. Status of an asset is determined by an exact match of the Sds stream property value to the value of the ValueStatusMapping. If there are no exact matches, the status is a 0 (Unknown).

Request

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

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

string assetId
Asset identifier.

Response

Example response body

200 Response

{
  "AssetId": "AssetId-1",
  "Status": "Good",
  "Value": "85",
  "DisplayName": "AssetInGoodState",
  "DataRetrievalTime": "2020-05-04T16:55:26.3732693Z",
  "Index": "2019-01-02T00:00:00Z"
}

400 Response (ErrorTemplate)

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

Get Asset Status Range Summary Data

Returns status summary of an asset. Statistics are computed using 'StepwiseContinuousLeading' for interpolation and ‘Forward’ for extrapolation with regard to the status stream property, without regard to the actual interpolation or extrapolation modes configured in SDS for that property.

Request

GET /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/Assets/{assetId}/Status/Summary
?startIndex={startIndex}&endIndex={endIndex}&intervals={intervals}

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

string assetId
Asset identifier.

string startIndex
Start index.

string endIndex
End index.

integer intervals
Number of intervals.

Response

Example response body

200 Response

{
  "RangeValues": [
    {
      "Index": "2019-01-02T00:00:00Z",
      "Status": "Warning",
      "Value": 2,
      "DisplayName": "AssetInWarning"
    },
    {
      "Index": "2019-01-02T00:30:00Z",
      "Status": "Bad",
      "Value": 4,
      "DisplayName": "AssetInBadState"
    }
  ],
  "Statistics": [
    {
      "Status": "Warning",
      "TotalInterval": "00:30:00",
      "Values": [
        {
          "Value": 2,
          "Interval": "00:30:00"
        }
      ]
    },
    {
      "Status": "Bad",
      "TotalInterval": "1246.06:30:00",
      "Values": [
        {
          "Value": 4,
          "Interval": "1246.06:30:00"
        }
      ]
    }
  ]
}

400 Response (ErrorTemplate)

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

Asset Status

Get Bulk Last Status Data For Assets

Returns status of multiple assets.

Request

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

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

Request Body

Asset identifiers

[
  "AssetId-1",
  "AssetId-2",
  "AssetId-3"
]

Response

Example response body

200 Response

[
  {
    "AssetId": "AssetId-1",
    "Status": 1,
    "Value": "85",
    "DisplayName": "TemperatureSensorBuild1InF",
    "DataRetrievalTime": "2020-05-04T16:55:26.3732693Z"
  },
  {
    "AssetId": "AssetId-2",
    "Status": 2,
    "Value": "185",
    "DisplayName": "DeviceMeasurement",
    "DataRetrievalTime": "2020-05-04T16:55:26.3732693Z"
  }
]

207 Response (MultiStatusResultOfLastStatusDataAndChildErrorTemplate)

{
  "Reason": "string",
  "Error": "string",
  "OperationId": "string",
  "Data": [
    {
      "AssetId": "AssetId-1",
      "Status": "Good",
      "Value": "85",
      "DisplayName": "AssetInGoodState",
      "DataRetrievalTime": "2020-05-04T16:55:26.3732693Z",
      "Index": "2019-01-02T00:00:00Z"
    }
  ],
  "ChildErrors": [
    {
      "OperationId": "string",
      "Error": "string",
      "Resolution": "string",
      "Reason": "string",
      "StatusCode": 0,
      "property1": null,
      "property2": null
    }
  ]
}

Definitions

LastStatusData

Asset's last status

Properties

{
  "AssetId": "AssetId-1",
  "Status": "Good",
  "Value": "85",
  "DisplayName": "AssetInGoodState",
  "DataRetrievalTime": "2020-05-04T16:55:26.3732693Z",
  "Index": "2019-01-02T00:00:00Z"
}

StatusEnum

Pre-defined asset status values.

Enumerated Values

ErrorTemplate

Properties

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

StatusRangeSummary

Returns the status summary of an asset.

Properties

{
  "RangeValues": [
    {
      "Index": "2019-01-02T00:00:00Z",
      "Status": "Warning",
      "Value": 2,
      "DisplayName": "AssetInWarning"
    },
    {
      "Index": "2019-01-02T00:30:00Z",
      "Status": "Bad",
      "Value": 4,
      "DisplayName": "AssetInBadState"
    }
  ],
  "Statistics": [
    {
      "Status": "Warning",
      "TotalInterval": "00:30:00",
      "Values": [
        {
          "Value": 2,
          "Interval": "00:30:00"
        }
      ]
    },
    {
      "Status": "Bad",
      "TotalInterval": "1246.06:30:00",
      "Values": [
        {
          "Value": 4,
          "Interval": "1246.06:30:00"
        }
      ]
    }
  ]
}

StatusData

Status data that is assocated with asset.

Properties

{
  "Index": "2019-01-02T00:00:00Z",
  "Status": "Warning",
  "Value": 2,
  "DisplayName": "AssetInWarning"
}

StatusValueStatistics

Status value statistics returns asset status statistics

Properties

{
  "Status": 0,
  "TotalInterval": null,
  "Values": [
    {
      "Value": null,
      "Interval": null,
      "DisplayName": "string"
    }
  ]
}

UnderlyingValueStatistics

Underlying value statistics represents statistics for a single interval

Properties

{
  "Value": null,
  "Interval": null,
  "DisplayName": "string"
}

MultiStatusResultOfLastStatusDataAndChildErrorTemplate

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

Properties

{
  "Reason": "string",
  "Error": "string",
  "OperationId": "string",
  "Data": [
    {
      "AssetId": "AssetId-1",
      "Status": "Good",
      "Value": "85",
      "DisplayName": "AssetInGoodState",
      "DataRetrievalTime": "2020-05-04T16:55:26.3732693Z",
      "Index": "2019-01-02T00:00:00Z"
    }
  ],
  "ChildErrors": [
    {
      "OperationId": "string",
      "Error": "string",
      "Resolution": "string",
      "Reason": "string",
      "StatusCode": 0,
      "property1": null,
      "property2": null
    }
  ]
}

ChildErrorTemplate

Properties

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