Query - Execute

Führt Zeitreihenabfrage in Ergebnisseiten aus: Ereignisse abrufen, Serie abrufen oder Aggregatreihen.

POST https://{environmentFqdn}/timeseries/query?api-version=2020-07-31
POST https://{environmentFqdn}/timeseries/query?api-version=2020-07-31&storeType={storeType}

URI-Parameter

Name In Erforderlich Typ Beschreibung
environmentFqdn
path True

string

FQDN pro Umgebung, z. B. 10000000-0000-0000-0000-100000000109.env.timeseries.azure.com. Sie können diesen Domänennamen aus der Antwort der Get Environments-API, Azure-Portal oder Azure Resource Manager abrufen.

api-version
query True

string

Version der API, die mit der Clientanforderung verwendet werden soll. Derzeit wird die Version "2020-07-31" unterstützt.

storeType
query

string

Für Umgebungen mit aktiviertem Warmspeicher kann die Abfrage entweder im "WarmStore" oder "ColdStore" ausgeführt werden. Dieser Parameter in der Abfrage definiert, in welchem Speicher die Abfrage ausgeführt werden soll. Wenn nicht definiert, wird die Abfrage im kalten Speicher ausgeführt.

Anforderungsheader

Name Erforderlich Typ Beschreibung
x-ms-continuation

string

Fortsetzungstoken von der vorherigen Seite der Ergebnisse, um die nächste Seite der Ergebnisse in Aufrufen abzurufen, die Paginierung unterstützen. Um die Ergebnisse der ersten Seite zu erhalten, geben Sie das NULL-Fortsetzungstoken als Parameterwert an. Das zurückgegebene Fortsetzungstoken ist NULL, wenn alle Ergebnisse zurückgegeben wurden und keine nächste Seite mit Ergebnissen vorhanden ist.

x-ms-client-request-id

string

Optionale Clientanforderungs-ID. Der Dienst zeichnet diesen Wert auf. Ermöglicht dem Dienst die dienstübergreifende Ablaufverfolgung des Vorgangs und ermöglicht es dem Kunden, sich bezüglich einer bestimmten Anforderung an den Support zu wenden.

x-ms-client-session-id

string

Optionale Clientsitzungs-ID. Der Dienst zeichnet diesen Wert auf. Ermöglicht dem Dienst das Nachverfolgen einer Gruppe verwandter Vorgänge über Dienste hinweg und ermöglicht es dem Kunden, den Support bezüglich einer bestimmten Gruppe von Anforderungen zu kontaktieren.

Anforderungstext

Name Typ Beschreibung
aggregateSeries

AggregateSeries

Aggregatreihenabfrage. Ermöglicht das Berechnen einer aggregierten Zeitreihe aus Ereignissen für eine bestimmte Zeitreihen-ID und eine bestimmte Suchspanne.

getEvents

GetEvents

Abfrage "Ereignisse abrufen". Ermöglicht das Abrufen von Rohereignissen für eine bestimmte Zeitreihen-ID und suchspanne.

getSeries

GetSeries

Abrufen der Series-Abfrage. Ermöglicht das Abrufen von Zeitreihen berechneter Variablenwerte aus Ereignissen für eine bestimmte Zeitreihen-ID und eine bestimmte Suchspanne.

Antworten

Name Typ Beschreibung
200 OK

QueryResultPage

Erfolgreiche Abfrage.

Headers

x-ms-request-id: string

Other Status Codes

TsiError

Unerwarteter Fehler.

Headers

x-ms-request-id: string

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

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

Scopes

Name Beschreibung
user_impersonation Identitätswechsel Ihres Benutzerkontos

Beispiele

ColdStoreQueryAggregateSeriesPage1
ColdStoreQueryAggregateSeriesPage2
ColdStoreQueryGetEventsPage1
ColdStoreQueryGetEventsPage2
ColdStoreQueryGetEventsPage3
ColdStoreQueryGetEventsPage4
ColdStoreQueryGetSeriesPage1
ColdStoreQueryGetSeriesPage2
ColdStoreQueryGetSeriesPage3
QueryAggregateSeriesPage1
QueryAggregateSeriesPage2
QueryAggregateSeriesWithCategoricalInterpolatedVariable
QueryAggregateSeriesWithCategoricalVariable
QueryAggregateSeriesWithSampleInterpolation
QueryGetEventsPage1
QueryGetEventsPage2
QueryGetEventsPage3
QueryGetEventsPage4
QueryGetEventsWithTakePage1
QueryGetEventsWithTakePage2
QueryGetSeriesPage1
QueryGetSeriesPage2
QueryGetSeriesPage3
QueryGetSeriesWithTakePage1
QueryGetSeriesWithTakePage2
WarmStoreQueryAggregateSeriesPage
WarmStoreQueryGetEventsPage1
WarmStoreQueryGetEventsPage2
WarmStoreQueryGetEventsPage3
WarmStoreQueryGetEventsPage4
WarmStoreQueryGetSeriesPage1
WarmStoreQueryGetSeriesPage2
WarmStoreQueryGetSeriesPage3

ColdStoreQueryAggregateSeriesPage1

Sample Request

POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/query?api-version=2020-07-31&storeType=coldstore

{
  "aggregateSeries": {
    "timeSeriesId": [
      "006dfc2d-0324-4937-998c-d16f3b4f1952",
      "T1"
    ],
    "searchSpan": {
      "from": "2016-08-01T00:00:00Z",
      "to": "2016-08-01T00:16:50Z"
    },
    "interval": "PT1M",
    "inlineVariables": {
      "Count": {
        "kind": "aggregate",
        "filter": null,
        "aggregation": {
          "tsx": "count()"
        }
      },
      "MinTemperature": {
        "kind": "numeric",
        "value": {
          "tsx": "$event.Temperature"
        },
        "filter": null,
        "aggregation": {
          "tsx": "min($value)"
        }
      },
      "MaxTemperature": {
        "kind": "numeric",
        "value": {
          "tsx": "$event.Temperature"
        },
        "filter": null,
        "aggregation": {
          "tsx": "max($value)"
        }
      }
    },
    "projectedVariables": [
      "Count",
      "MinTemperature",
      "MaxTemperature"
    ]
  }
}

Sample Response

{
  "progress": 50,
  "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrZSI6MTAwMH0="
}

ColdStoreQueryAggregateSeriesPage2

Sample Request

POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/query?api-version=2020-07-31&storeType=coldstore

{
  "aggregateSeries": {
    "timeSeriesId": [
      "006dfc2d-0324-4937-998c-d16f3b4f1952",
      "T1"
    ],
    "searchSpan": {
      "from": "2016-08-01T00:00:00Z",
      "to": "2016-08-01T00:16:50Z"
    },
    "interval": "PT1M",
    "inlineVariables": {
      "Count": {
        "kind": "aggregate",
        "filter": null,
        "aggregation": {
          "tsx": "count()"
        }
      },
      "MinTemperature": {
        "kind": "numeric",
        "value": {
          "tsx": "$event.Temperature"
        },
        "filter": null,
        "aggregation": {
          "tsx": "min($value)"
        }
      },
      "MaxTemperature": {
        "kind": "numeric",
        "value": {
          "tsx": "$event.Temperature"
        },
        "filter": null,
        "aggregation": {
          "tsx": "max($value)"
        }
      }
    },
    "projectedVariables": [
      "Count",
      "MinTemperature",
      "MaxTemperature"
    ]
  }
}

Sample Response

{
  "timestamps": [
    "2016-08-01T00:00:00Z",
    "2016-08-01T00:01:00Z",
    "2016-08-01T00:02:00Z",
    "2016-08-01T00:03:00Z",
    "2016-08-01T00:04:00Z",
    "2016-08-01T00:05:00Z",
    "2016-08-01T00:06:00Z",
    "2016-08-01T00:07:00Z",
    "2016-08-01T00:08:00Z",
    "2016-08-01T00:09:00Z",
    "2016-08-01T00:10:00Z"
  ],
  "properties": [
    {
      "name": "Count",
      "type": "Long",
      "values": [
        50,
        60,
        60,
        60,
        60,
        60,
        60,
        60,
        60,
        60,
        null
      ]
    },
    {
      "name": "AverageTemperature",
      "type": "Double",
      "values": [
        71.25,
        85,
        82.5,
        80,
        89.16666666666667,
        75,
        90,
        75.83333333333333,
        85,
        82.5,
        null
      ]
    },
    {
      "name": "MinTemperature",
      "type": "Double",
      "values": [
        65.125,
        77.625,
        65.125,
        72.625,
        65.125,
        67.625,
        82.625,
        65.125,
        77.625,
        65.125,
        null
      ]
    },
    {
      "name": "MaxTemperature",
      "type": "Double",
      "values": [
        77.375,
        92.375,
        99.875,
        87.375,
        99.875,
        82.375,
        97.375,
        99.875,
        92.375,
        99.875,
        null
      ]
    }
  ],
  "progress": 100
}

ColdStoreQueryGetEventsPage1

Sample Request

POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/query?api-version=2020-07-31&storeType=coldstore

{
  "getEvents": {
    "timeSeriesId": [
      "006dfc2d-0324-4937-998c-d16f3b4f1952",
      "T1"
    ],
    "searchSpan": {
      "from": "2016-08-01T00:00:00Z",
      "to": "2016-08-01T00:16:50Z"
    },
    "filter": {
      "tsx": "($event.Value.Double != null) OR ($event.Status.String = 'Good')"
    },
    "projectedProperties": [
      {
        "name": "Building",
        "type": "String"
      },
      {
        "name": "Temperature",
        "type": "Double"
      }
    ]
  }
}

Sample Response

{
  "progress": 50,
  "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrZSI6MTAwMH0="
}

ColdStoreQueryGetEventsPage2

Sample Request

POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/query?api-version=2020-07-31&storeType=coldstore

{
  "getEvents": {
    "timeSeriesId": [
      "006dfc2d-0324-4937-998c-d16f3b4f1952",
      "T1"
    ],
    "searchSpan": {
      "from": "2016-08-01T00:00:00Z",
      "to": "2016-08-01T00:16:50Z"
    },
    "filter": {
      "tsx": "($event.Value.Double != null) OR ($event.Status.String = 'Good')"
    },
    "projectedProperties": [
      {
        "name": "Building",
        "type": "String"
      },
      {
        "name": "Temperature",
        "type": "Double"
      }
    ]
  }
}

Sample Response

{
  "timestamps": [
    "2016-08-01T00:00:10Z",
    "2016-08-01T00:00:11Z",
    "2016-08-01T00:00:12Z",
    "2016-08-01T00:00:13Z",
    "2016-08-01T00:00:14Z",
    "2016-08-01T00:00:15Z",
    "2016-08-01T00:00:16Z",
    "2016-08-01T00:00:17Z",
    "2016-08-01T00:00:18Z",
    "2016-08-01T00:00:19Z"
  ],
  "properties": [
    {
      "name": "Building",
      "type": "String",
      "values": [
        "Millenium",
        "Millenium",
        "Millenium",
        "Millenium",
        "Millenium",
        "Millenium",
        "Millenium",
        "Millenium",
        "Millenium",
        "Millenium"
      ]
    },
    {
      "name": "Temperature",
      "type": "Double",
      "values": [
        65.125,
        65.375,
        65.625,
        65.875,
        66.125,
        66.375,
        66.625,
        66.875,
        67.125,
        67.375
      ]
    }
  ],
  "progress": 50,
  "continuationToken": "aXsic2tpcCI6MTAxYZwidGFrZSI6MTAwMH0="
}

ColdStoreQueryGetEventsPage3

Sample Request

POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/query?api-version=2020-07-31&storeType=coldstore

{
  "getEvents": {
    "timeSeriesId": [
      "006dfc2d-0324-4937-998c-d16f3b4f1952",
      "T1"
    ],
    "searchSpan": {
      "from": "2016-08-01T00:00:00Z",
      "to": "2016-08-01T00:16:50Z"
    },
    "filter": {
      "tsx": "($event.Value.Double != null) OR ($event.Status.String = 'Good')"
    },
    "projectedProperties": [
      {
        "name": "Building",
        "type": "String"
      },
      {
        "name": "Temperature",
        "type": "Double"
      }
    ]
  }
}

Sample Response

{
  "timestamps": [
    "2016-08-01T00:00:20Z"
  ],
  "properties": [
    {
      "name": "Building",
      "type": "String",
      "values": [
        "Millenium"
      ]
    },
    {
      "name": "Temperature",
      "type": "Double",
      "values": [
        67.575
      ]
    }
  ],
  "progress": 50,
  "continuationToken": "aXsic2tpcCI6MTAbCDewidGFrZSI6MTAwMH0="
}

ColdStoreQueryGetEventsPage4

Sample Request

POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/query?api-version=2020-07-31&storeType=coldstore

{
  "getEvents": {
    "timeSeriesId": [
      "006dfc2d-0324-4937-998c-d16f3b4f1952",
      "T1"
    ],
    "searchSpan": {
      "from": "2016-08-01T00:00:00Z",
      "to": "2016-08-01T00:16:50Z"
    },
    "filter": {
      "tsx": "($event.Value.Double != null) OR ($event.Status.String = 'Good')"
    },
    "projectedProperties": [
      {
        "name": "Building",
        "type": "String"
      },
      {
        "name": "Temperature",
        "type": "Double"
      }
    ]
  }
}

Sample Response

{
  "timestamps": [],
  "properties": [],
  "progress": 100
}

ColdStoreQueryGetSeriesPage1

Sample Request

POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/query?api-version=2020-07-31&storeType=coldstore

{
  "getSeries": {
    "timeSeriesId": [
      "006dfc2d-0324-4937-998c-d16f3b4f1952",
      "T1"
    ],
    "searchSpan": {
      "from": "2016-08-01T00:00:00Z",
      "to": "2016-08-01T00:16:50Z"
    },
    "filter": null,
    "inlineVariables": {
      "temperatures": {
        "kind": "numeric",
        "value": {
          "tsx": "$event.Temperature"
        },
        "filter": null,
        "aggregation": {
          "tsx": "avg($value)"
        }
      }
    },
    "projectedVariables": [
      "temperatures"
    ]
  }
}

Sample Response

{
  "progress": 50,
  "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrZSI6MTAwMH0="
}

ColdStoreQueryGetSeriesPage2

Sample Request

POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/query?api-version=2020-07-31&storeType=coldstore

{
  "getSeries": {
    "timeSeriesId": [
      "006dfc2d-0324-4937-998c-d16f3b4f1952",
      "T1"
    ],
    "searchSpan": {
      "from": "2016-08-01T00:00:00Z",
      "to": "2016-08-01T00:16:50Z"
    },
    "filter": null,
    "inlineVariables": {
      "temperatures": {
        "kind": "numeric",
        "value": {
          "tsx": "$event.Temperature"
        },
        "filter": null,
        "aggregation": {
          "tsx": "avg($value)"
        }
      }
    },
    "projectedVariables": [
      "temperatures"
    ]
  }
}

Sample Response

{
  "timestamps": [
    "2016-08-01T00:00:10Z",
    "2016-08-01T00:00:11Z",
    "2016-08-01T00:00:12Z",
    "2016-08-01T00:00:13Z",
    "2016-08-01T00:00:14Z",
    "2016-08-01T00:00:15Z",
    "2016-08-01T00:00:16Z",
    "2016-08-01T00:00:17Z",
    "2016-08-01T00:00:18Z",
    "2016-08-01T00:00:19Z",
    "2016-08-01T00:00:20Z"
  ],
  "properties": [
    {
      "name": "temperatures",
      "type": "Double",
      "values": [
        65.125,
        65.375,
        65.625,
        65.875,
        66.125,
        66.375,
        66.625,
        66.875,
        67.125,
        67.375,
        67.625
      ]
    }
  ],
  "progress": 50,
  "continuationToken": "aXsic2tpcCI6MTAxYZwidGFrZSI6MTAwMH0="
}

ColdStoreQueryGetSeriesPage3

Sample Request

POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/query?api-version=2020-07-31&storeType=coldstore

{
  "getSeries": {
    "timeSeriesId": [
      "006dfc2d-0324-4937-998c-d16f3b4f1952",
      "T1"
    ],
    "searchSpan": {
      "from": "2016-08-01T00:00:00Z",
      "to": "2016-08-01T00:16:50Z"
    },
    "filter": null,
    "inlineVariables": {
      "temperatures": {
        "kind": "numeric",
        "value": {
          "tsx": "$event.Temperature"
        },
        "filter": null,
        "aggregation": {
          "tsx": "avg($value)"
        }
      }
    },
    "projectedVariables": [
      "temperatures"
    ]
  }
}

Sample Response

{
  "timestamps": [
    "2016-08-01T00:00:21Z"
  ],
  "properties": [
    {
      "name": "temperatures",
      "type": "Double",
      "values": [
        67.825
      ]
    }
  ],
  "progress": 100
}

QueryAggregateSeriesPage1

Sample Request

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

{
  "aggregateSeries": {
    "timeSeriesId": [
      "006dfc2d-0324-4937-998c-d16f3b4f1952",
      "T1"
    ],
    "searchSpan": {
      "from": "2016-08-01T00:00:00Z",
      "to": "2016-08-01T00:16:50Z"
    },
    "interval": "PT1M",
    "inlineVariables": {
      "Count": {
        "kind": "aggregate",
        "filter": null,
        "aggregation": {
          "tsx": "count()"
        }
      },
      "MinTemperature": {
        "kind": "numeric",
        "value": {
          "tsx": "$event.Temperature"
        },
        "filter": null,
        "aggregation": {
          "tsx": "min($value)"
        }
      },
      "MaxTemperature": {
        "kind": "numeric",
        "value": {
          "tsx": "$event.Temperature"
        },
        "filter": null,
        "aggregation": {
          "tsx": "max($value)"
        }
      }
    },
    "projectedVariables": [
      "Count",
      "MinTemperature",
      "MaxTemperature"
    ]
  }
}

Sample Response

{
  "progress": 50,
  "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrZSI6MTAwMH0="
}

QueryAggregateSeriesPage2

Sample Request

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

{
  "aggregateSeries": {
    "timeSeriesId": [
      "006dfc2d-0324-4937-998c-d16f3b4f1952",
      "T1"
    ],
    "searchSpan": {
      "from": "2016-08-01T00:00:00Z",
      "to": "2016-08-01T00:16:50Z"
    },
    "interval": "PT1M",
    "inlineVariables": {
      "Count": {
        "kind": "aggregate",
        "filter": null,
        "aggregation": {
          "tsx": "count()"
        }
      },
      "MinTemperature": {
        "kind": "numeric",
        "value": {
          "tsx": "$event.Temperature"
        },
        "filter": null,
        "aggregation": {
          "tsx": "min($value)"
        }
      },
      "MaxTemperature": {
        "kind": "numeric",
        "value": {
          "tsx": "$event.Temperature"
        },
        "filter": null,
        "aggregation": {
          "tsx": "max($value)"
        }
      }
    },
    "projectedVariables": [
      "Count",
      "MinTemperature",
      "MaxTemperature"
    ]
  }
}

Sample Response

{
  "timestamps": [
    "2016-08-01T00:00:00Z",
    "2016-08-01T00:01:00Z",
    "2016-08-01T00:02:00Z",
    "2016-08-01T00:03:00Z",
    "2016-08-01T00:04:00Z",
    "2016-08-01T00:05:00Z",
    "2016-08-01T00:06:00Z",
    "2016-08-01T00:07:00Z",
    "2016-08-01T00:08:00Z",
    "2016-08-01T00:09:00Z",
    "2016-08-01T00:10:00Z"
  ],
  "properties": [
    {
      "name": "Count",
      "type": "Long",
      "values": [
        50,
        60,
        60,
        60,
        60,
        60,
        60,
        60,
        60,
        60,
        null
      ]
    },
    {
      "name": "AverageTemperature",
      "type": "Double",
      "values": [
        71.25,
        85,
        82.5,
        80,
        89.16666666666667,
        75,
        90,
        75.83333333333333,
        85,
        82.5,
        null
      ]
    },
    {
      "name": "MinTemperature",
      "type": "Double",
      "values": [
        65.125,
        77.625,
        65.125,
        72.625,
        65.125,
        67.625,
        82.625,
        65.125,
        77.625,
        65.125,
        null
      ]
    },
    {
      "name": "MaxTemperature",
      "type": "Double",
      "values": [
        77.375,
        92.375,
        99.875,
        87.375,
        99.875,
        82.375,
        97.375,
        99.875,
        92.375,
        99.875,
        null
      ]
    }
  ],
  "progress": 100
}

QueryAggregateSeriesWithCategoricalInterpolatedVariable

Sample Request

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

{
  "aggregateSeries": {
    "searchSpan": {
      "from": "2019-10-10T23:41:04.021Z",
      "to": "2019-10-10T23:42:22.846Z"
    },
    "timeSeriesId": [
      "Sensor_58"
    ],
    "interval": "PT2S",
    "inlineVariables": {
      "Status_String": {
        "kind": "categorical",
        "value": {
          "tsx": "$event.[Status].String"
        },
        "interpolation": {
          "kind": "Step",
          "boundary": {
            "span": "PT5S"
          }
        },
        "categories": [
          {
            "label": "Good",
            "values": [
              "Good",
              "Very Good",
              "Excellent"
            ]
          },
          {
            "label": "Bad",
            "values": [
              "Bad",
              "OK"
            ]
          },
          {
            "label": "Other",
            "values": [
              "Other"
            ]
          }
        ],
        "defaultCategory": {
          "label": "Unknown"
        }
      },
      "Status_Long": {
        "kind": "categorical",
        "value": {
          "tsx": "tolong($event.[Status].Double)"
        },
        "interpolation": {
          "kind": "Step",
          "boundary": {
            "span": "PT5S"
          }
        },
        "categories": [
          {
            "label": "Good",
            "values": [
              0,
              1,
              2
            ]
          },
          {
            "label": "Bad",
            "values": [
              3,
              4
            ]
          },
          {
            "label": "Other",
            "values": [
              5
            ]
          }
        ],
        "defaultCategory": {
          "label": "Unknown"
        }
      }
    },
    "projectedVariables": [
      "Status_String",
      "Status_Long"
    ]
  }
}

Sample Response

{
  "timestamps": [
    "2019-10-10T23:41:04Z",
    "2019-10-10T23:41:06Z",
    "2019-10-10T23:41:08Z",
    "2019-10-10T23:41:10Z",
    "2019-10-10T23:41:12Z",
    "2019-10-10T23:41:14Z",
    "2019-10-10T23:41:16Z",
    "2019-10-10T23:41:18Z",
    "2019-10-10T23:41:20Z",
    "2019-10-10T23:41:22Z"
  ],
  "properties": [
    {
      "values": [
        0.203,
        0.141,
        0.268,
        0.398,
        0.402,
        0.047,
        0.1245,
        0.75,
        0.206,
        0.2635
      ],
      "name": "Status_String[Good]",
      "type": "Double"
    },
    {
      "values": [
        0.266,
        0.1955,
        0.242,
        0.148,
        0.25,
        0.055,
        0.6295,
        0.109,
        0.41,
        0.2125
      ],
      "name": "Status_String[Bad]",
      "type": "Double"
    },
    {
      "values": [
        0.5205,
        0.6635,
        0.49,
        0.454,
        0.348,
        0.898,
        0.246,
        0.141,
        0.384,
        0.524
      ],
      "name": "Status_String[Other]",
      "type": "Double"
    },
    {
      "values": [
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0
      ],
      "name": "Status_String[Unknown]",
      "type": "Double"
    },
    {
      "values": [
        0.203,
        0.141,
        0.268,
        0.398,
        0.402,
        0.047,
        0.1245,
        0.75,
        0.206,
        0.2635
      ],
      "name": "Status_Long[Good]",
      "type": "Double"
    },
    {
      "values": [
        0.266,
        0.1955,
        0.242,
        0.148,
        0.25,
        0.055,
        0.6295,
        0.109,
        0.41,
        0.2125
      ],
      "name": "Status_Long[Bad]",
      "type": "Double"
    },
    {
      "values": [
        0.5205,
        0.6635,
        0.49,
        0.454,
        0.348,
        0.898,
        0.246,
        0.141,
        0.384,
        0.524
      ],
      "name": "Status_Long[Other]",
      "type": "Double"
    },
    {
      "values": [
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0
      ],
      "name": "Status_Long[Unknown]",
      "type": "Double"
    }
  ],
  "progress": 100
}

QueryAggregateSeriesWithCategoricalVariable

Sample Request

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

{
  "aggregateSeries": {
    "searchSpan": {
      "from": "2019-10-10T23:42:00.000Z",
      "to": "2019-10-10T23:42:20.000Z"
    },
    "timeSeriesId": [
      "Sensor_58"
    ],
    "interval": "PT2S",
    "inlineVariables": {
      "Status_String": {
        "kind": "categorical",
        "value": {
          "tsx": "$event.[Status].String"
        },
        "categories": [
          {
            "label": "Good",
            "values": [
              "Good",
              "Very Good",
              "Excellent"
            ]
          },
          {
            "label": "Bad",
            "values": [
              "Bad",
              "OK"
            ]
          },
          {
            "label": "Other",
            "values": [
              "Other"
            ]
          }
        ],
        "defaultCategory": {
          "label": "Unknown"
        }
      },
      "Status_Long": {
        "kind": "categorical",
        "value": {
          "tsx": "tolong($event.[Status].Double)"
        },
        "categories": [
          {
            "label": "Good",
            "values": [
              0,
              1,
              2
            ]
          },
          {
            "label": "Bad",
            "values": [
              3,
              4
            ]
          },
          {
            "label": "Other",
            "values": [
              5
            ]
          }
        ],
        "defaultCategory": {
          "label": "Unknown"
        }
      }
    },
    "projectedVariables": [
      "Status_String",
      "Status_Long"
    ]
  }
}

Sample Response

{
  "timestamps": [
    "2019-10-10T23:42:00Z",
    "2019-10-10T23:42:02Z",
    "2019-10-10T23:42:04Z",
    "2019-10-10T23:42:06Z",
    "2019-10-10T23:42:08Z",
    "2019-10-10T23:42:10Z",
    "2019-10-10T23:42:12Z",
    "2019-10-10T23:42:14Z",
    "2019-10-10T23:42:16Z",
    "2019-10-10T23:42:18Z"
  ],
  "properties": [
    {
      "values": [
        5,
        8,
        4,
        6,
        9,
        8,
        3,
        6,
        5,
        8
      ],
      "name": "Status_String[Good]",
      "type": "Long"
    },
    {
      "values": [
        4,
        3,
        3,
        5,
        5,
        3,
        9,
        7,
        7,
        7
      ],
      "name": "Status_String[Bad]",
      "type": "Long"
    },
    {
      "values": [
        11,
        9,
        13,
        9,
        6,
        9,
        8,
        7,
        8,
        5
      ],
      "name": "Status_String[Other]",
      "type": "Long"
    },
    {
      "values": [
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0
      ],
      "name": "Status_String[Unknown]",
      "type": "Long"
    },
    {
      "values": [
        5,
        8,
        4,
        6,
        9,
        8,
        3,
        6,
        5,
        8
      ],
      "name": "Status_Long[Good]",
      "type": "Long"
    },
    {
      "values": [
        4,
        3,
        3,
        5,
        5,
        3,
        9,
        7,
        7,
        7
      ],
      "name": "Status_Long[Bad]",
      "type": "Long"
    },
    {
      "values": [
        11,
        9,
        13,
        9,
        6,
        9,
        8,
        7,
        8,
        5
      ],
      "name": "Status_Long[Other]",
      "type": "Long"
    },
    {
      "values": [
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0
      ],
      "name": "Status_Long[Unknown]",
      "type": "Long"
    }
  ],
  "progress": 100
}

QueryAggregateSeriesWithSampleInterpolation

Sample Request

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

{
  "aggregateSeries": {
    "timeSeriesId": [
      "006dfc2d-0324-4937-998c-d16f3b4f1952",
      "T1"
    ],
    "searchSpan": {
      "from": "2016-08-01T00:00:00Z",
      "to": "2016-08-01T00:16:50Z"
    },
    "interval": "PT1M",
    "inlineVariables": {
      "LinearSampleInterpolation": {
        "kind": "numeric",
        "value": {
          "tsx": "$event.Temperature"
        },
        "filter": null,
        "interpolation": {
          "kind": "Linear",
          "boundary": {
            "span": "P1D"
          }
        },
        "aggregation": {
          "tsx": "left($value)"
        }
      },
      "StepSampleInterpolation": {
        "kind": "numeric",
        "value": {
          "tsx": "$event.Temperature"
        },
        "filter": null,
        "interpolation": {
          "kind": "Step",
          "boundary": {
            "span": "P1D"
          }
        },
        "aggregation": {
          "tsx": "left($value)"
        }
      }
    },
    "projectedVariables": [
      "LinearSampleInterpolation",
      "StepSampleInterpolation"
    ]
  }
}

Sample Response

{
  "timestamps": [
    "2016-08-01T00:00:00Z",
    "2016-08-01T00:01:00Z",
    "2016-08-01T00:02:00Z",
    "2016-08-01T00:03:00Z",
    "2016-08-01T00:04:00Z",
    "2016-08-01T00:05:00Z",
    "2016-08-01T00:06:00Z",
    "2016-08-01T00:07:00Z",
    "2016-08-01T00:08:00Z",
    "2016-08-01T00:09:00Z",
    "2016-08-01T00:10:00Z"
  ],
  "properties": [
    {
      "name": "LinearSampleInterpolation",
      "type": "Double",
      "values": [
        50,
        60,
        60,
        60,
        60,
        60,
        60,
        60,
        60,
        60,
        62
      ]
    },
    {
      "name": "StepSampleInterpolation",
      "type": "Double",
      "values": [
        71.25,
        85,
        82.5,
        80,
        89.16666666666667,
        75,
        90,
        75.83333333333333,
        85,
        82.5,
        84
      ]
    }
  ],
  "progress": 100
}

QueryGetEventsPage1

Sample Request

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

{
  "getEvents": {
    "timeSeriesId": [
      "006dfc2d-0324-4937-998c-d16f3b4f1952",
      "T1"
    ],
    "searchSpan": {
      "from": "2016-08-01T00:00:00Z",
      "to": "2016-08-01T00:16:50Z"
    },
    "filter": {
      "tsx": "($event.Value.Double != null) OR ($event.Status.String = 'Good')"
    },
    "projectedProperties": [
      {
        "name": "Building",
        "type": "String"
      },
      {
        "name": "Temperature",
        "type": "Double"
      }
    ]
  }
}

Sample Response

{
  "progress": 50,
  "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrZSI6MTAwMH0="
}

QueryGetEventsPage2

Sample Request

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

{
  "getEvents": {
    "timeSeriesId": [
      "006dfc2d-0324-4937-998c-d16f3b4f1952",
      "T1"
    ],
    "searchSpan": {
      "from": "2016-08-01T00:00:00Z",
      "to": "2016-08-01T00:16:50Z"
    },
    "filter": {
      "tsx": "($event.Value.Double != null) OR ($event.Status.String = 'Good')"
    },
    "projectedProperties": [
      {
        "name": "Building",
        "type": "String"
      },
      {
        "name": "Temperature",
        "type": "Double"
      }
    ]
  }
}

Sample Response

{
  "timestamps": [
    "2016-08-01T00:00:10Z",
    "2016-08-01T00:00:11Z",
    "2016-08-01T00:00:12Z",
    "2016-08-01T00:00:13Z",
    "2016-08-01T00:00:14Z",
    "2016-08-01T00:00:15Z",
    "2016-08-01T00:00:16Z",
    "2016-08-01T00:00:17Z",
    "2016-08-01T00:00:18Z",
    "2016-08-01T00:00:19Z"
  ],
  "properties": [
    {
      "name": "Building",
      "type": "String",
      "values": [
        "Millenium",
        "Millenium",
        "Millenium",
        "Millenium",
        "Millenium",
        "Millenium",
        "Millenium",
        "Millenium",
        "Millenium",
        "Millenium"
      ]
    },
    {
      "name": "Temperature",
      "type": "Double",
      "values": [
        65.125,
        65.375,
        65.625,
        65.875,
        66.125,
        66.375,
        66.625,
        66.875,
        67.125,
        67.375
      ]
    }
  ],
  "progress": 50,
  "continuationToken": "aXsic2tpcCI6MTAxYZwidGFrZSI6MTAwMH0="
}

QueryGetEventsPage3

Sample Request

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

{
  "getEvents": {
    "timeSeriesId": [
      "006dfc2d-0324-4937-998c-d16f3b4f1952",
      "T1"
    ],
    "searchSpan": {
      "from": "2016-08-01T00:00:00Z",
      "to": "2016-08-01T00:16:50Z"
    },
    "filter": {
      "tsx": "($event.Value.Double != null) OR ($event.Status.String = 'Good')"
    },
    "projectedProperties": [
      {
        "name": "Building",
        "type": "String"
      },
      {
        "name": "Temperature",
        "type": "Double"
      }
    ]
  }
}

Sample Response

{
  "timestamps": [
    "2016-08-01T00:00:20Z"
  ],
  "properties": [
    {
      "name": "Building",
      "type": "String",
      "values": [
        "Millenium"
      ]
    },
    {
      "name": "Temperature",
      "type": "Double",
      "values": [
        67.575
      ]
    }
  ],
  "progress": 50,
  "continuationToken": "aXsic2tpcCI6MTAbCDewidGFrZSI6MTAwMH0="
}

QueryGetEventsPage4

Sample Request

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

{
  "getEvents": {
    "timeSeriesId": [
      "006dfc2d-0324-4937-998c-d16f3b4f1952",
      "T1"
    ],
    "searchSpan": {
      "from": "2016-08-01T00:00:00Z",
      "to": "2016-08-01T00:16:50Z"
    },
    "filter": {
      "tsx": "($event.Value.Double != null) OR ($event.Status.String = 'Good')"
    },
    "projectedProperties": [
      {
        "name": "Building",
        "type": "String"
      },
      {
        "name": "Temperature",
        "type": "Double"
      }
    ]
  }
}

Sample Response

{
  "timestamps": [],
  "properties": [],
  "progress": 100
}

QueryGetEventsWithTakePage1

Sample Request

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

{
  "getEvents": {
    "timeSeriesId": [
      "006dfc2d-0324-4937-998c-d16f3b4f1952",
      "T1"
    ],
    "searchSpan": {
      "from": "2016-08-01T00:00:00Z",
      "to": "2016-08-01T00:16:50Z"
    },
    "filter": {
      "tsx": "($event.Value.Double != null) OR ($event.Status.String = 'Good')"
    },
    "projectedProperties": [
      {
        "name": "Building",
        "type": "String"
      },
      {
        "name": "Temperature",
        "type": "Double"
      }
    ],
    "take": 10
  }
}

Sample Response

{
  "progress": 50,
  "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrZSI6MTAwMH0="
}

QueryGetEventsWithTakePage2

Sample Request

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

{
  "getEvents": {
    "timeSeriesId": [
      "006dfc2d-0324-4937-998c-d16f3b4f1952",
      "T1"
    ],
    "searchSpan": {
      "from": "2016-08-01T00:00:00Z",
      "to": "2016-08-01T00:16:50Z"
    },
    "filter": {
      "tsx": "($event.Value.Double != null) OR ($event.Status.String = 'Good')"
    },
    "projectedProperties": [
      {
        "name": "Building",
        "type": "String"
      },
      {
        "name": "Temperature",
        "type": "Double"
      }
    ],
    "take": 10
  }
}

Sample Response

{
  "timestamps": [
    "2016-08-01T00:00:10Z",
    "2016-08-01T00:00:11Z",
    "2016-08-01T00:00:12Z",
    "2016-08-01T00:00:13Z",
    "2016-08-01T00:00:14Z",
    "2016-08-01T00:00:15Z",
    "2016-08-01T00:00:16Z",
    "2016-08-01T00:00:17Z",
    "2016-08-01T00:00:18Z",
    "2016-08-01T00:00:19Z"
  ],
  "properties": [
    {
      "name": "Building",
      "type": "String",
      "values": [
        "Millenium",
        "Millenium",
        "Millenium",
        "Millenium",
        "Millenium",
        "Millenium",
        "Millenium",
        "Millenium",
        "Millenium",
        "Millenium"
      ]
    },
    {
      "name": "Temperature",
      "type": "Double",
      "values": [
        65.125,
        65.375,
        65.625,
        65.875,
        66.125,
        66.375,
        66.625,
        66.875,
        67.125,
        67.375
      ]
    }
  ],
  "progress": 100
}

QueryGetSeriesPage1

Sample Request

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

{
  "getSeries": {
    "timeSeriesId": [
      "006dfc2d-0324-4937-998c-d16f3b4f1952",
      "T1"
    ],
    "searchSpan": {
      "from": "2016-08-01T00:00:00Z",
      "to": "2016-08-01T00:16:50Z"
    },
    "filter": null,
    "inlineVariables": {
      "temperatures": {
        "kind": "numeric",
        "value": {
          "tsx": "$event.Temperature"
        },
        "filter": null,
        "aggregation": {
          "tsx": "avg($value)"
        }
      }
    },
    "projectedVariables": [
      "temperatures"
    ]
  }
}

Sample Response

{
  "progress": 50,
  "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrZSI6MTAwMH0="
}

QueryGetSeriesPage2

Sample Request

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

{
  "getSeries": {
    "timeSeriesId": [
      "006dfc2d-0324-4937-998c-d16f3b4f1952",
      "T1"
    ],
    "searchSpan": {
      "from": "2016-08-01T00:00:00Z",
      "to": "2016-08-01T00:16:50Z"
    },
    "filter": null,
    "inlineVariables": {
      "temperatures": {
        "kind": "numeric",
        "value": {
          "tsx": "$event.Temperature"
        },
        "filter": null,
        "aggregation": {
          "tsx": "avg($value)"
        }
      }
    },
    "projectedVariables": [
      "temperatures"
    ]
  }
}

Sample Response

{
  "timestamps": [
    "2016-08-01T00:00:10Z",
    "2016-08-01T00:00:11Z",
    "2016-08-01T00:00:12Z",
    "2016-08-01T00:00:13Z",
    "2016-08-01T00:00:14Z",
    "2016-08-01T00:00:15Z",
    "2016-08-01T00:00:16Z",
    "2016-08-01T00:00:17Z",
    "2016-08-01T00:00:18Z",
    "2016-08-01T00:00:19Z",
    "2016-08-01T00:00:20Z"
  ],
  "properties": [
    {
      "name": "temperatures",
      "type": "Double",
      "values": [
        65.125,
        65.375,
        65.625,
        65.875,
        66.125,
        66.375,
        66.625,
        66.875,
        67.125,
        67.375,
        67.625
      ]
    }
  ],
  "progress": 50,
  "continuationToken": "aXsic2tpcCI6MTAxYZwidGFrZSI6MTAwMH0="
}

QueryGetSeriesPage3

Sample Request

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

{
  "getSeries": {
    "timeSeriesId": [
      "006dfc2d-0324-4937-998c-d16f3b4f1952",
      "T1"
    ],
    "searchSpan": {
      "from": "2016-08-01T00:00:00Z",
      "to": "2016-08-01T00:16:50Z"
    },
    "filter": null,
    "inlineVariables": {
      "temperatures": {
        "kind": "numeric",
        "value": {
          "tsx": "$event.Temperature"
        },
        "filter": null,
        "aggregation": {
          "tsx": "avg($value)"
        }
      }
    },
    "projectedVariables": [
      "temperatures"
    ]
  }
}

Sample Response

{
  "timestamps": [
    "2016-08-01T00:00:21Z"
  ],
  "properties": [
    {
      "name": "temperatures",
      "type": "Double",
      "values": [
        67.825
      ]
    }
  ],
  "progress": 100
}

QueryGetSeriesWithTakePage1

Sample Request

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

{
  "getSeries": {
    "timeSeriesId": [
      "006dfc2d-0324-4937-998c-d16f3b4f1952",
      "T1"
    ],
    "searchSpan": {
      "from": "2016-08-01T00:00:00Z",
      "to": "2016-08-01T00:16:50Z"
    },
    "filter": null,
    "inlineVariables": {
      "temperatures": {
        "kind": "numeric",
        "value": {
          "tsx": "$event.Temperature"
        },
        "filter": null,
        "aggregation": {
          "tsx": "avg($value)"
        }
      }
    },
    "projectedVariables": [
      "temperatures"
    ],
    "take": 10
  }
}

Sample Response

{
  "progress": 50,
  "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrZSI6MTAwMH0="
}

QueryGetSeriesWithTakePage2

Sample Request

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

{
  "getSeries": {
    "timeSeriesId": [
      "006dfc2d-0324-4937-998c-d16f3b4f1952",
      "T1"
    ],
    "searchSpan": {
      "from": "2016-08-01T00:00:00Z",
      "to": "2016-08-01T00:16:50Z"
    },
    "filter": null,
    "inlineVariables": {
      "temperatures": {
        "kind": "numeric",
        "value": {
          "tsx": "$event.Temperature"
        },
        "filter": null,
        "aggregation": {
          "tsx": "avg($value)"
        }
      }
    },
    "projectedVariables": [
      "temperatures"
    ],
    "take": 10
  }
}

Sample Response

{
  "timestamps": [
    "2016-08-01T00:00:10Z",
    "2016-08-01T00:00:11Z",
    "2016-08-01T00:00:12Z",
    "2016-08-01T00:00:13Z",
    "2016-08-01T00:00:14Z",
    "2016-08-01T00:00:15Z",
    "2016-08-01T00:00:16Z",
    "2016-08-01T00:00:17Z",
    "2016-08-01T00:00:18Z",
    "2016-08-01T00:00:19Z",
    "2016-08-01T00:00:20Z"
  ],
  "properties": [
    {
      "name": "temperatures",
      "type": "Double",
      "values": [
        65.125,
        65.375,
        65.625,
        65.875,
        66.125,
        66.375,
        66.625,
        66.875,
        67.125,
        67.375,
        67.625
      ]
    }
  ],
  "progress": 100
}

WarmStoreQueryAggregateSeriesPage

Sample Request

POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/query?api-version=2020-07-31&storeType=warmstore

{
  "aggregateSeries": {
    "timeSeriesId": [
      "006dfc2d-0324-4937-998c-d16f3b4f1952",
      "T1"
    ],
    "searchSpan": {
      "from": "2016-08-01T00:00:00Z",
      "to": "2016-08-01T00:16:50Z"
    },
    "interval": "PT1M",
    "inlineVariables": {
      "Count": {
        "kind": "aggregate",
        "filter": null,
        "aggregation": {
          "tsx": "count()"
        }
      },
      "MinTemperature": {
        "kind": "numeric",
        "value": {
          "tsx": "$event.Temperature"
        },
        "filter": null,
        "aggregation": {
          "tsx": "min($value)"
        }
      },
      "MaxTemperature": {
        "kind": "numeric",
        "value": {
          "tsx": "$event.Temperature"
        },
        "filter": null,
        "aggregation": {
          "tsx": "max($value)"
        }
      }
    },
    "projectedVariables": [
      "Count",
      "MinTemperature",
      "MaxTemperature"
    ]
  }
}

Sample Response

{
  "timestamps": [
    "2016-08-01T00:00:00Z",
    "2016-08-01T00:01:00Z",
    "2016-08-01T00:02:00Z",
    "2016-08-01T00:03:00Z",
    "2016-08-01T00:04:00Z",
    "2016-08-01T00:05:00Z",
    "2016-08-01T00:06:00Z",
    "2016-08-01T00:07:00Z",
    "2016-08-01T00:08:00Z",
    "2016-08-01T00:09:00Z",
    "2016-08-01T00:10:00Z"
  ],
  "properties": [
    {
      "name": "Count",
      "type": "Long",
      "values": [
        50,
        60,
        60,
        60,
        60,
        60,
        60,
        60,
        60,
        60,
        null
      ]
    },
    {
      "name": "AverageTemperature",
      "type": "Double",
      "values": [
        71.25,
        85,
        82.5,
        80,
        89.16666666666667,
        75,
        90,
        75.83333333333333,
        85,
        82.5,
        null
      ]
    },
    {
      "name": "MinTemperature",
      "type": "Double",
      "values": [
        65.125,
        77.625,
        65.125,
        72.625,
        65.125,
        67.625,
        82.625,
        65.125,
        77.625,
        65.125,
        null
      ]
    },
    {
      "name": "MaxTemperature",
      "type": "Double",
      "values": [
        77.375,
        92.375,
        99.875,
        87.375,
        99.875,
        82.375,
        97.375,
        99.875,
        92.375,
        99.875,
        null
      ]
    }
  ],
  "progress": 100
}

WarmStoreQueryGetEventsPage1

Sample Request

POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/query?api-version=2020-07-31&storeType=warmstore

{
  "getEvents": {
    "timeSeriesId": [
      "006dfc2d-0324-4937-998c-d16f3b4f1952",
      "T1"
    ],
    "searchSpan": {
      "from": "2016-08-01T00:00:00Z",
      "to": "2016-08-01T00:16:50Z"
    },
    "filter": {
      "tsx": "($event.Value.Double != null) OR ($event.Status.String = 'Good')"
    },
    "projectedProperties": [
      {
        "name": "Building",
        "type": "String"
      },
      {
        "name": "Temperature",
        "type": "Double"
      }
    ]
  }
}

Sample Response

{
  "progress": 50,
  "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrZSI6MTAwMH0="
}

WarmStoreQueryGetEventsPage2

Sample Request

POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/query?api-version=2020-07-31&storeType=warmstore

{
  "getEvents": {
    "timeSeriesId": [
      "006dfc2d-0324-4937-998c-d16f3b4f1952",
      "T1"
    ],
    "searchSpan": {
      "from": "2016-08-01T00:00:00Z",
      "to": "2016-08-01T00:16:50Z"
    },
    "filter": {
      "tsx": "($event.Value.Double != null) OR ($event.Status.String = 'Good')"
    },
    "projectedProperties": [
      {
        "name": "Building",
        "type": "String"
      },
      {
        "name": "Temperature",
        "type": "Double"
      }
    ]
  }
}

Sample Response

{
  "timestamps": [
    "2016-08-01T00:00:10Z",
    "2016-08-01T00:00:11Z",
    "2016-08-01T00:00:12Z",
    "2016-08-01T00:00:13Z",
    "2016-08-01T00:00:14Z",
    "2016-08-01T00:00:15Z",
    "2016-08-01T00:00:16Z",
    "2016-08-01T00:00:17Z",
    "2016-08-01T00:00:18Z",
    "2016-08-01T00:00:19Z"
  ],
  "properties": [
    {
      "name": "Building",
      "type": "String",
      "values": [
        "Millenium",
        "Millenium",
        "Millenium",
        "Millenium",
        "Millenium",
        "Millenium",
        "Millenium",
        "Millenium",
        "Millenium",
        "Millenium"
      ]
    },
    {
      "name": "Temperature",
      "type": "Double",
      "values": [
        65.125,
        65.375,
        65.625,
        65.875,
        66.125,
        66.375,
        66.625,
        66.875,
        67.125,
        67.375
      ]
    }
  ],
  "progress": 50,
  "continuationToken": "aXsic2tpcCI6MTAxYZwidGFrZSI6MTAwMH0="
}

WarmStoreQueryGetEventsPage3

Sample Request

POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/query?api-version=2020-07-31&storeType=warmstore

{
  "getEvents": {
    "timeSeriesId": [
      "006dfc2d-0324-4937-998c-d16f3b4f1952",
      "T1"
    ],
    "searchSpan": {
      "from": "2016-08-01T00:00:00Z",
      "to": "2016-08-01T00:16:50Z"
    },
    "filter": {
      "tsx": "($event.Value.Double != null) OR ($event.Status.String = 'Good')"
    },
    "projectedProperties": [
      {
        "name": "Building",
        "type": "String"
      },
      {
        "name": "Temperature",
        "type": "Double"
      }
    ]
  }
}

Sample Response

{
  "timestamps": [
    "2016-08-01T00:00:20Z"
  ],
  "properties": [
    {
      "name": "Building",
      "type": "String",
      "values": [
        "Millenium"
      ]
    },
    {
      "name": "Temperature",
      "type": "Double",
      "values": [
        67.575
      ]
    }
  ],
  "progress": 50,
  "continuationToken": "aXsic2tpcCI6MTAbCDewidGFrZSI6MTAwMH0="
}

WarmStoreQueryGetEventsPage4

Sample Request

POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/query?api-version=2020-07-31&storeType=warmstore

{
  "getEvents": {
    "timeSeriesId": [
      "006dfc2d-0324-4937-998c-d16f3b4f1952",
      "T1"
    ],
    "searchSpan": {
      "from": "2016-08-01T00:00:00Z",
      "to": "2016-08-01T00:16:50Z"
    },
    "filter": {
      "tsx": "($event.Value.Double != null) OR ($event.Status.String = 'Good')"
    },
    "projectedProperties": [
      {
        "name": "Building",
        "type": "String"
      },
      {
        "name": "Temperature",
        "type": "Double"
      }
    ]
  }
}

Sample Response

{
  "timestamps": [],
  "properties": [],
  "progress": 100
}

WarmStoreQueryGetSeriesPage1

Sample Request

POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/query?api-version=2020-07-31&storeType=warmstore

{
  "getSeries": {
    "timeSeriesId": [
      "006dfc2d-0324-4937-998c-d16f3b4f1952",
      "T1"
    ],
    "searchSpan": {
      "from": "2016-08-01T00:00:00Z",
      "to": "2016-08-01T00:16:50Z"
    },
    "filter": null,
    "inlineVariables": {
      "temperatures": {
        "kind": "numeric",
        "value": {
          "tsx": "$event.Temperature"
        },
        "filter": null,
        "aggregation": {
          "tsx": "avg($value)"
        }
      }
    },
    "projectedVariables": [
      "temperatures"
    ]
  }
}

Sample Response

{
  "progress": 50,
  "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrZSI6MTAwMH0="
}

WarmStoreQueryGetSeriesPage2

Sample Request

POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/query?api-version=2020-07-31&storeType=warmstore

{
  "getSeries": {
    "timeSeriesId": [
      "006dfc2d-0324-4937-998c-d16f3b4f1952",
      "T1"
    ],
    "searchSpan": {
      "from": "2016-08-01T00:00:00Z",
      "to": "2016-08-01T00:16:50Z"
    },
    "filter": null,
    "inlineVariables": {
      "temperatures": {
        "kind": "numeric",
        "value": {
          "tsx": "$event.Temperature"
        },
        "filter": null,
        "aggregation": {
          "tsx": "avg($value)"
        }
      }
    },
    "projectedVariables": [
      "temperatures"
    ]
  }
}

Sample Response

{
  "timestamps": [
    "2016-08-01T00:00:10Z",
    "2016-08-01T00:00:11Z",
    "2016-08-01T00:00:12Z",
    "2016-08-01T00:00:13Z",
    "2016-08-01T00:00:14Z",
    "2016-08-01T00:00:15Z",
    "2016-08-01T00:00:16Z",
    "2016-08-01T00:00:17Z",
    "2016-08-01T00:00:18Z",
    "2016-08-01T00:00:19Z",
    "2016-08-01T00:00:20Z"
  ],
  "properties": [
    {
      "name": "temperatures",
      "type": "Double",
      "values": [
        65.125,
        65.375,
        65.625,
        65.875,
        66.125,
        66.375,
        66.625,
        66.875,
        67.125,
        67.375,
        67.625
      ]
    }
  ],
  "progress": 50,
  "continuationToken": "aXsic2tpcCI6MTAxYZwidGFrZSI6MTAwMH0="
}

WarmStoreQueryGetSeriesPage3

Sample Request

POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/query?api-version=2020-07-31&storeType=warmstore

{
  "getSeries": {
    "timeSeriesId": [
      "006dfc2d-0324-4937-998c-d16f3b4f1952",
      "T1"
    ],
    "searchSpan": {
      "from": "2016-08-01T00:00:00Z",
      "to": "2016-08-01T00:16:50Z"
    },
    "filter": null,
    "inlineVariables": {
      "temperatures": {
        "kind": "numeric",
        "value": {
          "tsx": "$event.Temperature"
        },
        "filter": null,
        "aggregation": {
          "tsx": "avg($value)"
        }
      }
    },
    "projectedVariables": [
      "temperatures"
    ]
  }
}

Sample Response

{
  "timestamps": [
    "2016-08-01T00:00:21Z"
  ],
  "properties": [
    {
      "name": "temperatures",
      "type": "Double",
      "values": [
        67.825
      ]
    }
  ],
  "progress": 100
}

Definitionen

Name Beschreibung
AggregateSeries

Aggregatreihenabfrage. Ermöglicht das Berechnen einer aggregierten Zeitreihe aus Ereignissen für eine bestimmte Zeitreihen-ID und eine bestimmte Suchspanne.

AggregateVariable

Die Aggregatvariable stellt eine beliebige Aggregationsberechnung dar. Aggregatvariablen unterstützen keine Interpolation.

Boundary

Der Zeitbereich links und rechts von der Suchspanne, die für die Interpolation verwendet werden soll. Dies ist in Szenarien hilfreich, in denen die Datenpunkte am Anfang oder Ende der Eingabesuchspanne fehlen. Kann NULL sein.

CategoricalVariable

Die kategorische Variable stellt ein Signal dar, das basierend auf der Anzahl oder Dauer des Vorkommens eines begrenzten Satzes definierter Werte analysiert werden muss.

DateTimeRange

Der Zeitbereich. Darf nicht NULL oder negativ sein.

EventProperty

Eigenschaft eines Ereignisses, das entweder gespeichert oder berechnet wird. Eigenschaften werden sowohl anhand des Namens als auch des Typs identifiziert. Verschiedene Ereignisse können Eigenschaften mit demselben Namen, aber einem anderen Typ aufweisen.

GetEvents

Abfrage "Ereignisse abrufen". Ermöglicht das Abrufen von Rohereignissen für eine bestimmte Zeitreihen-ID und suchspanne.

GetSeries

Abrufen der Series-Abfrage. Ermöglicht das Abrufen von Zeitreihen berechneter Variablenwerte aus Ereignissen für eine bestimmte Zeitreihen-ID und eine bestimmte Suchspanne.

Interpolation

Der Interpolationsvorgang, der für die Rohdatenpunkte ausgeführt werden soll. Derzeit ist nur das Sampling interpolierter Zeitreihen zulässig. Zulässige Aggregatfunktion – z. B. left($value). Kann NULL sein, wenn keine Interpolation angewendet werden muss.

InterpolationKind

Der Typ der Interpolationstechnik: "Linear" oder "Schritt".

NumericVariable

Die numerische Variable stellt ein einzelnes kontinuierliches numerisches Signal dar, das mithilfe von Interpolation rekonstruiert werden kann.

PropertyTypes

Den Typ der Eigenschaft.

PropertyValues

Werte einer einzelnen Eigenschaft, die den Zeitstempeln entspricht. Kann NULL-Werte enthalten. Der Typ der Werte entspricht dem Typ der Eigenschaft.

QueryRequest

Anforderung zum Ausführen einer Zeitreihenabfrage für Ereignisse. Genau eines von "getEvents", "getSeries" oder "aggregateSeries" muss festgelegt werden.

QueryResultPage

Eine einzelne Seite mit Abfrageergebnissen. Wenn die Abfrage noch nicht abgeschlossen ist, wird auf einer Seite das Fortsetzungstoken festgelegt. Um die nächste Ergebnisseite zu erhalten, senden Sie in diesem Fall dieselbe Anforderung erneut mit dem Parameter "Fortsetzungstoken". Wenn die Abfrage abgeschlossen ist, ist das Fortsetzungstoken NULL. Es ist auch möglich, eine leere Seite mit nur festgelegtem Fortsetzungstoken abzurufen, wenn noch keine Abfrageergebnisse berechnet wurden. Wenn die Paginierung abgeschlossen ist (Fortsetzungstoken ist NULL), sind Zeitstempel und Eigenschaften möglicherweise leer, wenn keine Daten zurückgegeben werden.

TimeSeriesAggregateCategory

Kategorie, die in kategorischen Variablen verwendet wird. Eine Kategorie wird durch "label" und die "Werte" definiert, denen diese Bezeichnung zugewiesen ist.

TimeSeriesDefaultCategory

Stellt die Standardkategorie dar.

TsiError

Informationen zu einem API-Fehler.

TsiErrorBody

Ein bestimmter API-Fehler mit einem Fehlercode und einer Meldung.

TsiErrorDetails

Zusätzliche Fehlerinformationen.

Tsx

Zeitreihenausdruck (TIME Series Expression, TSX), der als einzelne Zeichenfolge geschrieben wird. Beispiele: "$event. Status.String='Good'", "avg($event. Temperature)". Informationen zum Schreiben von Zeitreihenausdrücken finden Sie in der Dokumentation.

AggregateSeries

Aggregatreihenabfrage. Ermöglicht das Berechnen einer aggregierten Zeitreihe aus Ereignissen für eine bestimmte Zeitreihen-ID und eine bestimmte Suchspanne.

Name Typ Beschreibung
filter

Tsx

Filter auf oberster Ebene über die Ereignisse, die die Anzahl der Ereignisse einschränken, die für die Berechnung berücksichtigt werden. Dieser Filter ist AND'ed mit Filter in jeder Variablen. Beispiel: "$event. Status.String='Good'"" Optional.

inlineVariables

object

Dies ermöglicht es dem Benutzer, optional Inlinevariablen von den bereits im Modell definierten Variablen zu definieren. Wenn die Namen der Inlinevariablen denselben Namen wie das Modell haben, hat die Definition der Inlinevariablen Vorrang. Kann NULL sein.

interval

string

Die Intervallgröße wird im ISO-8601-Dauerformat angegeben. Alle Intervalle haben die gleiche Größe. Ein Monat wird immer in 30 Tage und ein Jahr ist immer 365 Tage. Beispiele: 1 Minute ist "PT1M", 1 Millisekunde ist "PT0.001S". Weitere Informationen finden Sie unter https://www.w3.org/TR/xmlschema-2/#duration.

projectedVariables

string[]

Dadurch kann der Benutzer optional die Variablen auswählen, die projiziert werden müssen. Wenn null oder nicht festgelegt ist, werden alle Variablen aus inlineVariables und modell zurückgegeben. Kann NULL sein.

searchSpan

DateTimeRange

Der Zeitbereich, in dem die Abfrage ausgeführt wird. Darf nicht NULL sein.

timeSeriesId

TimeSeriesId[]

Ein einzelner Time Series ID-Wert, der eine einzelne Zeitreihe instance eindeutig identifiziert (z. B. ein Gerät). Beachten Sie, dass eine einzelne Zeitreihen-ID zusammengesetzt sein kann, wenn zum Zeitpunkt der Umgebungserstellung mehrere Eigenschaften als Time Series-ID angegeben werden. Die Position und der Typ der Werte müssen mit time Series ID-Eigenschaften übereinstimmen, die in der Umgebung angegeben und von der API zum Abrufen von Modelleinstellungen zurückgegeben werden. Darf nicht NULL sein.

AggregateVariable

Die Aggregatvariable stellt eine beliebige Aggregationsberechnung dar. Aggregatvariablen unterstützen keine Interpolation.

Name Typ Beschreibung
aggregation

Tsx

Aggregationszeitreihenausdruck, wenn art "aggregat" ist, wird verwendet, um die Aggregation darzustellen, die direkt mithilfe von Ereigniseigenschaften wie "$event. Temperatur". Beispielsweise kann die Aggregation zum Berechnen des Bereichs von Temperaturänderungen wie folgt geschrieben werden: "max($event. Temperature)-min($event. Temperature)".

filter

Tsx

Filtern Sie nach den Ereignissen, die die Anzahl der Ereignisse einschränken, die für die Berechnung berücksichtigt werden. Beispiel: "$event. Status.String='Good'"" Optional.

kind string:

aggregate

Zulässige "Kind"-Werte sind "numeric" oder "aggregate". Während Sie mit "numeric" den Wert des rekonstruierten Signals und des Ausdrucks angeben können, um sie zu aggregieren, können Sie mit der Art "Aggregat" die Ereigniseigenschaften direkt aggregieren, ohne wert anzugeben.

Boundary

Der Zeitbereich links und rechts von der Suchspanne, die für die Interpolation verwendet werden soll. Dies ist in Szenarien hilfreich, in denen die Datenpunkte am Anfang oder Ende der Eingabesuchspanne fehlen. Kann NULL sein.

Name Typ Beschreibung
span

string

CategoricalVariable

Die kategorische Variable stellt ein Signal dar, das basierend auf der Anzahl oder Dauer des Vorkommens eines begrenzten Satzes definierter Werte analysiert werden muss.

Name Typ Beschreibung
categories

TimeSeriesAggregateCategory[]

Kategorie, die in kategorischen Variablen verwendet wird. Eine Kategorie wird durch "label" und die "Werte" definiert, denen diese Bezeichnung zugewiesen ist.

defaultCategory

TimeSeriesDefaultCategory

Stellt die Standardkategorie dar.

filter

Tsx

Filtern Sie nach den Ereignissen, die die Anzahl der Ereignisse einschränken, die für die Berechnung berücksichtigt werden. Beispiel: "$event. Status.String='Good'"" Optional.

interpolation

Interpolation

Kategorische Variable unterstützt nur die "Schritt"-Interpolation.

kind string:

categorical

Zulässige "Kind"-Werte sind "numeric" oder "aggregate". Während Sie mit "numeric" den Wert des rekonstruierten Signals und des Ausdrucks angeben können, um sie zu aggregieren, können Sie mit der Art "Aggregat" die Ereigniseigenschaften direkt aggregieren, ohne wert anzugeben.

value

Tsx

Der Wertzeitreihenausdruck wird verwendet, um den Wert des Signals darzustellen, das kategorisiert werden soll. Es kann nur den Typ "String" oder "Long" für kategorische Variablen auswerten.

DateTimeRange

Der Zeitbereich. Darf nicht NULL oder negativ sein.

Name Typ Beschreibung
from

string

Startzeitstempel des Zeitbereichs. Der Startzeitstempel ist inklusive, wenn er in Zeitreihenabfrageanforderungen verwendet wird. Ereignisse, die über diesen Zeitstempel verfügen, werden eingeschlossen.

to

string

Endzeitstempel des Zeitbereichs. Endzeitstempel ist exklusiv, wenn es in Zeitreihenabfrageanforderungen verwendet wird. Ereignisse, die mit diesem Zeitstempel übereinstimmen, werden ausgeschlossen. Beachten Sie, dass der Endzeitstempel inklusive ist, wenn er von Get Availability zurückgegeben wird (was bedeutet, dass ein Ereignis mit genau diesem Zeitstempel "to" vorhanden ist).

EventProperty

Eigenschaft eines Ereignisses, das entweder gespeichert oder berechnet wird. Eigenschaften werden sowohl anhand des Namens als auch des Typs identifiziert. Verschiedene Ereignisse können Eigenschaften mit demselben Namen, aber einem anderen Typ aufweisen.

Name Typ Beschreibung
name

string

Den Namen der Eigenschaft.

type

PropertyTypes

Den Typ der Eigenschaft.

GetEvents

Abfrage "Ereignisse abrufen". Ermöglicht das Abrufen von Rohereignissen für eine bestimmte Zeitreihen-ID und suchspanne.

Name Typ Beschreibung
filter

Tsx

Optionaler Filter der obersten Ebene für die Abfrage, der auf alle Variablen in der Abfrage angewendet wird. Beispiel: "$event. Status.String='Good'"" Kann NULL sein.

projectedProperties

EventProperty[]

Projizierte Eigenschaften sind ein Array von Eigenschaften, die Sie projizieren möchten. Diese Eigenschaften müssen in den Ereignissen angezeigt werden. Andernfalls werden sie nicht zurückgegeben.

searchSpan

DateTimeRange

Der Zeitbereich, in dem die Abfrage ausgeführt wird. Darf nicht NULL sein.

take

integer

Maximale Anzahl von Eigenschaftswerten im gesamten Antwortsatz, nicht die maximale Anzahl von Eigenschaftswerten pro Seite. Der Standardwert ist 10.000, wenn nicht festgelegt. Der maximal zulässige Wert kann 250.000 sein.

timeSeriesId

TimeSeriesId[]

Ein einzelner Time Series ID-Wert, der eine einzelne Zeitreihe instance eindeutig identifiziert (z. B. ein Gerät). Beachten Sie, dass eine einzelne Zeitreihen-ID zusammengesetzt sein kann, wenn zum Zeitpunkt der Umgebungserstellung mehrere Eigenschaften als Time Series-ID angegeben werden. Die Position und der Typ der Werte müssen mit time Series ID-Eigenschaften übereinstimmen, die in der Umgebung angegeben und von der API zum Abrufen von Modelleinstellungen zurückgegeben werden. Darf nicht NULL sein.

GetSeries

Abrufen der Series-Abfrage. Ermöglicht das Abrufen von Zeitreihen berechneter Variablenwerte aus Ereignissen für eine bestimmte Zeitreihen-ID und eine bestimmte Suchspanne.

Name Typ Beschreibung
filter

Tsx

Filter auf oberster Ebene über die Ereignisse, die die Anzahl der Ereignisse einschränken, die für die Berechnung berücksichtigt werden. Dieser Filter ist AND'ed mit Filter in jeder Variablen. Beispiel: "$event. Status.String='Good'"" Optional.

inlineVariables

object

Optionale Inlinevariablen abgesehen von denen, die bereits im Zeitreihentyp im Modell definiert sind. Wenn der Name der Inlinevariablen den gleichen Namen wie im Modell hat, hat die Definition der Inlinevariablen Vorrang. Kann NULL sein.

projectedVariables

string[]

Ausgewählte Variablen, die im Abfrageergebnis projiziert werden müssen. Wenn null oder nicht festgelegt ist, werden alle Variablen aus inlineVariables und dem Zeitreihentyp im Modell zurückgegeben. Kann NULL sein.

searchSpan

DateTimeRange

Der Zeitbereich, in dem die Abfrage ausgeführt wird. Darf nicht NULL sein.

take

integer

Maximale Anzahl von Eigenschaftswerten im gesamten Antwortsatz, nicht die maximale Anzahl von Eigenschaftswerten pro Seite. Der Standardwert ist 10.000, wenn nicht festgelegt. Der maximal zulässige Wert kann 250.000 sein.

timeSeriesId

TimeSeriesId[]

Ein einzelner Time Series ID-Wert, der eine einzelne Zeitreihe instance eindeutig identifiziert (z. B. ein Gerät). Beachten Sie, dass eine einzelne Zeitreihen-ID zusammengesetzt sein kann, wenn zum Zeitpunkt der Umgebungserstellung mehrere Eigenschaften als Time Series-ID angegeben werden. Die Position und der Typ der Werte müssen mit time Series ID-Eigenschaften übereinstimmen, die in der Umgebung angegeben und von der API zum Abrufen von Modelleinstellungen zurückgegeben werden. Darf nicht NULL sein.

Interpolation

Der Interpolationsvorgang, der für die Rohdatenpunkte ausgeführt werden soll. Derzeit ist nur das Sampling interpolierter Zeitreihen zulässig. Zulässige Aggregatfunktion – z. B. left($value). Kann NULL sein, wenn keine Interpolation angewendet werden muss.

Name Typ Beschreibung
boundary

Boundary

Der Zeitbereich links und rechts von der Suchspanne, die für die Interpolation verwendet werden soll. Dies ist in Szenarien hilfreich, in denen die Datenpunkte am Anfang oder Ende der Eingabesuchspanne fehlen. Kann NULL sein.

kind

InterpolationKind

Der Typ der Interpolationstechnik: "Linear" oder "Schritt".

InterpolationKind

Der Typ der Interpolationstechnik: "Linear" oder "Schritt".

Name Typ Beschreibung
Linear

string

Step

string

NumericVariable

Die numerische Variable stellt ein einzelnes kontinuierliches numerisches Signal dar, das mithilfe von Interpolation rekonstruiert werden kann.

Name Typ Beschreibung
aggregation

Tsx

Der Aggregationszeitreihenausdruck, wenn art "numerisch" ist, wird verwendet, um die Aggregation darzustellen, die für den $value Ausdruck ausgeführt werden muss. Hierfür müssen $value angegeben werden und können nur $value innerhalb der Aggregatfunktionen verwenden. Beispielsweise wird die Aggregation zum Berechnen des Mindestwerts der $value als "min($value)" geschrieben.

filter

Tsx

Filtern Sie nach den Ereignissen, die die Anzahl der Ereignisse einschränken, die für die Berechnung berücksichtigt werden. Beispiel: "$event. Status.String='Good'"" Optional.

interpolation

Interpolation

Der Interpolationsvorgang, der für die Rohdatenpunkte ausgeführt werden soll. Derzeit ist nur das Sampling interpolierter Zeitreihen zulässig. Zulässige Aggregatfunktion – z. B. left($value). Kann NULL sein, wenn keine Interpolation angewendet werden muss.

kind string:

numeric

Zulässige "Kind"-Werte sind "numeric" oder "aggregate". Während Sie mit "numeric" den Wert des rekonstruierten Signals und des Ausdrucks angeben können, um sie zu aggregieren, können Sie mit der Art "Aggregat" die Ereigniseigenschaften direkt aggregieren, ohne wert anzugeben.

value

Tsx

Der Wertzeitreihenausdruck wird verwendet, um den Wert des Signals darzustellen, das aggregiert oder interpoliert werden soll. Beispielsweise werden Temperaturwerte aus dem Ereignis wie folgt dargestellt: "$event. Temperature.Double".

PropertyTypes

Den Typ der Eigenschaft.

Name Typ Beschreibung
Bool

string

DateTime

string

Double

string

Long

string

String

string

TimeSpan

string

PropertyValues

Werte einer einzelnen Eigenschaft, die den Zeitstempeln entspricht. Kann NULL-Werte enthalten. Der Typ der Werte entspricht dem Typ der Eigenschaft.

Name Typ Beschreibung
name

string

Den Namen der Eigenschaft.

type

PropertyTypes

Den Typ der Eigenschaft.

values

Values[]

Werte einer einzelnen Eigenschaft, die den Zeitstempeln entspricht. Kann NULL-Werte enthalten. Der Typ der Werte entspricht dem Typ der Eigenschaft.

QueryRequest

Anforderung zum Ausführen einer Zeitreihenabfrage für Ereignisse. Genau eines von "getEvents", "getSeries" oder "aggregateSeries" muss festgelegt werden.

Name Typ Beschreibung
aggregateSeries

AggregateSeries

Aggregatreihenabfrage. Ermöglicht das Berechnen einer aggregierten Zeitreihe aus Ereignissen für eine bestimmte Zeitreihen-ID und eine bestimmte Suchspanne.

getEvents

GetEvents

Abfrage "Ereignisse abrufen". Ermöglicht das Abrufen von Rohereignissen für eine bestimmte Zeitreihen-ID und suchspanne.

getSeries

GetSeries

Abrufen der Series-Abfrage. Ermöglicht das Abrufen von Zeitreihen berechneter Variablenwerte aus Ereignissen für eine bestimmte Zeitreihen-ID und eine bestimmte Suchspanne.

QueryResultPage

Eine einzelne Seite mit Abfrageergebnissen. Wenn die Abfrage noch nicht abgeschlossen ist, wird auf einer Seite das Fortsetzungstoken festgelegt. Um die nächste Ergebnisseite zu erhalten, senden Sie in diesem Fall dieselbe Anforderung erneut mit dem Parameter "Fortsetzungstoken". Wenn die Abfrage abgeschlossen ist, ist das Fortsetzungstoken NULL. Es ist auch möglich, eine leere Seite mit nur festgelegtem Fortsetzungstoken abzurufen, wenn noch keine Abfrageergebnisse berechnet wurden. Wenn die Paginierung abgeschlossen ist (Fortsetzungstoken ist NULL), sind Zeitstempel und Eigenschaften möglicherweise leer, wenn keine Daten zurückgegeben werden.

Name Typ Beschreibung
continuationToken

string

Wenn dies zurückgegeben wird, bedeutet dies, dass aktuelle Ergebnisse ein Teilergebnis darstellen. Fortsetzungstoken ermöglicht das Abrufen der nächsten Seite der Ergebnisse. Um die nächste Seite der Abfrageergebnisse zu erhalten, senden Sie dieselbe Anforderung mit dem Fortsetzungstokenparameter im HTTP-Header "x-ms-continuation".

progress

number

Ungefährer Fortschritt der Abfrage in Prozent. Es kann zwischen 0 und 100 sein. Wenn das Fortsetzungstoken in der Antwort NULL ist, wird erwartet, dass der Fortschritt 100 ist.

properties

PropertyValues[]

Sammlung von Zeitreiheneigenschaften und -werten für jeden Zeitstempel. Kann NULL sein, wenn der Server die Seite in dieser Anforderung nicht ausfüllen konnte, oder leer sein kann, wenn keine weiteren Objekte vorhanden sind, wenn das Fortsetzungstoken NULL ist.

timestamps

string[]

Die Zeitstempel der Werte der Zeitreihe. Wenn eine Aggregation über Intervallen verwendet wird, stellen Zeitstempel den Beginn der entsprechenden Intervalle dar. Wenn Ereignisse abgerufen werden, sind Zeitstempel Werte des Zeitstempels $ts Eigenschaft von Ereignissen. Kann NULL sein, wenn der Server die Seite in dieser Anforderung nicht ausfüllen konnte, oder leer sein kann, wenn keine weiteren Objekte vorhanden sind, wenn das Fortsetzungstoken NULL ist.

TimeSeriesAggregateCategory

Kategorie, die in kategorischen Variablen verwendet wird. Eine Kategorie wird durch "label" und die "Werte" definiert, denen diese Bezeichnung zugewiesen ist.

Name Typ Beschreibung
label

string

Der Name der Kategorie, die beim Erstellen der Namen der Ausgabevariablen verwendet wird.

values

object[]

Die Liste der Werte, denen eine Kategorie zugeordnet ist. Kann entweder eine eindeutige Liste von Zeichenfolgen oder eine Liste von langen sein.

TimeSeriesDefaultCategory

Stellt die Standardkategorie dar.

Name Typ Beschreibung
label

string

Der Name der Standardkategorie, die den Werten zugewiesen wird, die keinem der in den Kategorien definierten Werte entsprechen.

TsiError

Informationen zu einem API-Fehler.

Name Typ Beschreibung
error

TsiErrorBody

Ein bestimmter API-Fehler mit einem Fehlercode und einer Meldung.

TsiErrorBody

Ein bestimmter API-Fehler mit einem Fehlercode und einer Meldung.

Name Typ Beschreibung
code

string

Sprachunabhängige, für Menschen lesbare Zeichenfolge, die einen dienstspezifischen Fehlercode definiert. Dieser Code dient als spezifischerer Indikator für den in der Antwort angegebenen HTTP-Fehlercode. Kann verwendet werden, um bestimmte Fehlerfälle programmgesteuert zu behandeln.

details

TsiErrorDetails[]

Enthält zusätzliche Fehlerinformationen. Ist möglicherweise NULL.

innerError

TsiErrorBody

Enthält einen spezifischeren Fehler, der die Ursache eingrenzt. Ist möglicherweise NULL.

message

string

Für Menschen lesbare, sprachunabhängige Darstellung des Fehlers. Es ist als Hilfe für Entwickler gedacht und eignet sich nicht für die Exposition gegenüber Endbenutzern.

target

string

Ziel des bestimmten Fehlers (z. B. der Name der -Eigenschaft im Fehler). Ist möglicherweise NULL.

TsiErrorDetails

Zusätzliche Fehlerinformationen.

Name Typ Beschreibung
code

string

Sprachunabhängige, für Menschen lesbare Zeichenfolge, die einen dienstspezifischen Fehlercode definiert. Dieser Code dient als spezifischerer Indikator für den in der Antwort angegebenen HTTP-Fehlercode. Kann verwendet werden, um bestimmte Fehlerfälle programmgesteuert zu behandeln.

message

string

Für Menschen lesbare, sprachunabhängige Darstellung des Fehlers. Es ist als Hilfe für Entwickler gedacht und eignet sich nicht für die Exposition gegenüber Endbenutzern.

Tsx

Zeitreihenausdruck (TIME Series Expression, TSX), der als einzelne Zeichenfolge geschrieben wird. Beispiele: "$event. Status.String='Good'", "avg($event. Temperature)". Informationen zum Schreiben von Zeitreihenausdrücken finden Sie in der Dokumentation.

Name Typ Beschreibung
tsx

string

Zeitreihenausdruck (TIME Series Expression, TSX), der als einzelne Zeichenfolge geschrieben wird. Beispiele: "$event. Status.String='Good'", "avg($event. Temperature)". Informationen zum Schreiben von Zeitreihenausdrücken finden Sie in der Dokumentation.