Time Series Instances - List

Reference

Service:: Time Series Insights

API Version:: 2020-07-31

Gets time series instances in pages.

GET https://{environmentFqdn}/timeseries/instances?api-version=2020-07-31

URI Parameters

Name	In	Required	Type	Description
environmentFqdn	path	True	string	Per environment FQDN, for example 10000000-0000-0000-0000-100000000109.env.timeseries.azure.com. You can obtain this domain name from the response of the Get Environments API, Azure portal, or Azure Resource Manager.
api-version	query	True	string	Version of the API to be used with the client request. Currently supported version is "2020-07-31".

Request Header

Name	Type	Description
x-ms-continuation	string	Continuation token from previous page of results to retrieve the next page of the results in calls that support pagination. To get the first page results, specify null continuation token as parameter value. Returned continuation token is null if all results have been returned, and there is no next page of results.
x-ms-client-request-id	string	Optional client request ID. Service records this value. Allows the service to trace operation across services, and allows the customer to contact support regarding a particular request.
x-ms-client-session-id	string	Optional client session ID. Service records this value. Allows the service to trace a group of related operations across services, and allows the customer to contact support regarding a particular group of requests.

Responses

Name	Type	Description
200 OK	GetInstancesPage	Successful operation. Headers x-ms-request-id: string
Other Status Codes	TsiError	Unexpected error. Headers x-ms-request-id: string

Name

Type

Description

200 OK

GetInstancesPage

Successful operation.

Headers

x-ms-request-id: string

Other Status Codes

TsiError

Unexpected error.

Headers

x-ms-request-id: string

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

InstancesListPage1

InstancesListPage2

InstancesListPage3

InstancesListPage1

Sample Request

HTTP

GET https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/instances?api-version=2020-07-31

Sample Response

Status code:: 200

{
  "instances": [
    {
      "typeId": "9b84e946-7b36-4aa0-9d26-71bf48cb2aff",
      "name": "F1W7.GS1",
      "timeSeriesId": [
        "006dfc2d-0324-4937-998c-d16f3b4f1952",
        "T1"
      ],
      "description": "ContosoFarm1W7_GenSpeed1",
      "hierarchyIds": [
        "33d72529-dd73-4c31-93d8-ae4e6cb5605d"
      ],
      "instanceFields": {
        "Name": "GeneratorSpeed",
        "Plant": "Contoso Plant 1",
        "Unit": "W7",
        "System": "Generator System",
        "Status": false,
        "Version": 1.3,
        "Code": 28
      }
    }
  ],
  "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrZSI6MTAwMH0="
}

InstancesListPage2

Sample Request

HTTP

GET https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/instances?api-version=2020-07-31

Sample Response

Status code:: 200

{
  "instances": [
    {
      "typeId": "9b84e946-7b36-4aa0-9d26-71bf48cb2aff",
      "timeSeriesId": [
        "fe984fd0-f632-49ab-990e-3ded259e29b8",
        "T1"
      ],
      "description": "ContosoFarm1W6_GridVoltage3",
      "hierarchyIds": [
        "33d72529-dd73-4c31-93d8-ae4e6cb5605d"
      ],
      "instanceFields": {
        "Name": "GridVoltagePhase3",
        "Plant": "Contoso Plant 1",
        "Unit": "W6",
        "System": "Generator System",
        "Status": false,
        "Version": 1.3,
        "Code": 28
      }
    }
  ],
  "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrASI6MTAwMH0="
}

InstancesListPage3

Sample Request

HTTP

GET https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/instances?api-version=2020-07-31

Sample Response

Status code:: 200

{
  "instances": []
}

Definitions

Name	Description
GetInstancesPage	Partial list of time series instances returned in a single request.
TimeSeriesInstance	Time series instances are the time series themselves. In most cases, the deviceId or assetId is the unique identifier of the asset in the environment. Instances have descriptive information associated with them called instance fields. At a minimum, instance fields include hierarchy information. They can also include useful, descriptive data like the manufacturer, operator, or the last service date.
TsiError	Information about an API error.
TsiErrorBody	A particular API error with an error code and a message.
TsiErrorDetails	Additional error information.

GetInstancesPage

Partial list of time series instances returned in a single request.

Name	Type	Description
continuationToken	string	If returned, this means that current results represent a partial result. Continuation token allows to get the next page of results. To get the next page of query results, send the same request with continuation token parameter in "x-ms-continuation" HTTP header.
instances	TimeSeriesInstance[]	Partial list of time series instances returned in a single request. Can be empty if server was unable to fill the page in this request, or there is no more objects when continuation token is null.

TimeSeriesInstance

Time series instances are the time series themselves. In most cases, the deviceId or assetId is the unique identifier of the asset in the environment. Instances have descriptive information associated with them called instance fields. At a minimum, instance fields include hierarchy information. They can also include useful, descriptive data like the manufacturer, operator, or the last service date.

Name	Type	Description
description	string	This optional field contains description about the instance.
hierarchyIds	string[]	Set of time series hierarchy IDs that the instance belong to. May be null.
instanceFields		Set of key-value pairs that contain user-defined instance properties. It may be null. Supported property value types are: bool, string, long, double and it cannot be nested or null.
name	string	Optional name of the instance which is unique in an environment. Names acts as a mutable alias or display name of the time series instance. Mutable, may be null.
timeSeriesId	TimeSeriesId[]	Time Series ID that uniquely identifies the instance. It matches Time Series ID properties in an environment. Immutable, never null.
typeId	string	This represents the type that this instance belongs to. Never null.

TsiError

Information about an API error.

Name	Type	Description
error	TsiErrorBody	A particular API error with an error code and a message.

TsiErrorBody

A particular API error with an error code and a message.

Name	Type	Description
code	string	Language-independent, human-readable string that defines a service-specific error code. This code serves as a more specific indicator for the HTTP error code specified in the response. Can be used to programmatically handle specific error cases.
details	TsiErrorDetails[]	Contains additional error information. May be null.
innerError	TsiErrorBody	Contains more specific error that narrows down the cause. May be null.
message	string	Human-readable, language-independent representation of the error. It is intended as an aid to developers and is not suitable for exposure to end users.
target	string	Target of the particular error (for example, the name of the property in error). May be null.

TsiErrorDetails

Additional error information.

Name	Type	Description
code	string	Language-independent, human-readable string that defines a service-specific error code. This code serves as a more specific indicator for the HTTP error code specified in the response. Can be used to programmatically handle specific error cases.
message	string	Human-readable, language-independent representation of the error. It is intended as an aid to developers and is not suitable for exposure to end users.

Time Series Instances - List

URI Parameters

Request Header

Responses

Security

azure_auth

Scopes

Examples

InstancesListPage1

Sample Request

Sample Response

InstancesListPage2

Sample Request

Sample Response

InstancesListPage3

Sample Request

Sample Response

Definitions

GetInstancesPage

TimeSeriesInstance

TsiError

TsiErrorBody

TsiErrorDetails

Additional resources