Time Series Instances - Get

Gets time series instances in pages.

GET https://{environmentFqdn}/timeseries/instances?api-version=2018-11-01-preview

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 "2018-11-01-preview".

Request Header

Name Required 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

Successful operation.

Headers

  • x-ms-request-id: string
Other Status Codes

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

InstancesGetPage1
InstancesGetPage2
InstancesGetPage3

InstancesGetPage1

Sample Request

GET https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/instances?api-version=2018-11-01-preview

Sample Response

{
  "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"
      }
    }
  ],
  "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrZSI6MTAwMH0="
}

InstancesGetPage2

Sample Request

GET https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/instances?api-version=2018-11-01-preview

Sample Response

{
  "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"
      }
    }
  ],
  "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrASI6MTAwMH0="
}

InstancesGetPage3

Sample Request

GET https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/instances?api-version=2018-11-01-preview

Sample Response

{
  "instances": []
}

Definitions

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

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. May be 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

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

Contains additional error information. May be null.

innerError

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.