Query - Execute
Exécute une requête de série chronologique dans des pages de résultats : Obtenir des événements, Obtenir une série ou une série d’agrégats.
POST https://{environmentFqdn}/timeseries/query?api-version=2020-07-31POST https://{environmentFqdn}/timeseries/query?api-version=2020-07-31&storeType={storeType}Paramètres URI
| Nom | Dans | Obligatoire | Type | Description |
|---|---|---|---|---|
|
environment
|
path | True |
string |
Par nom de domaine complet de l’environnement, par exemple 10000000-0000-0000-0000-100000000109.env.timeseries.azure.com. Vous pouvez obtenir ce nom de domaine à partir de la réponse de l’API Get Environments, Portail Azure ou azure Resource Manager. |
|
api-version
|
query | True |
string |
Version de l’API à utiliser avec la demande cliente. La version actuellement prise en charge est « 31/07/2020 ». |
|
store
|
query |
string |
Pour les environnements où le magasin chaud est activé, la requête peut être exécutée sur « WarmStore » ou « ColdStore ». Ce paramètre dans la requête définit le magasin sur lequel la requête doit être exécutée. S’il n’est pas défini, la requête est exécutée sur le magasin Cold. |
En-tête de la demande
| Nom | Obligatoire | Type | Description |
|---|---|---|---|
| x-ms-continuation |
string |
Jeton de continuation de la page précédente des résultats pour récupérer la page suivante des résultats dans les appels qui prennent en charge la pagination. Pour obtenir les premiers résultats de la page, spécifiez le jeton de continuation Null comme valeur de paramètre. Le jeton de continuation retourné est null si tous les résultats ont été retournés et qu’il n’y a pas de page de résultats suivante. |
|
| x-ms-client-request-id |
string |
ID de demande client facultative. Le service enregistre cette valeur. Permet au service de suivre l’opération entre les services et permet au client de contacter le support technique pour une demande particulière. |
|
| x-ms-client-session-id |
string |
ID de session client facultatif. Le service enregistre cette valeur. Permet au service de suivre un groupe d’opérations associées entre les services et permet au client de contacter le support technique concernant un groupe particulier de demandes. |
Corps de la demande
| Nom | Type | Description |
|---|---|---|
| aggregateSeries |
Requête De série d’agrégats. Permet de calculer une série chronologique agrégée à partir d’événements pour un ID de série chronologique et une étendue de recherche donnés. |
|
| getEvents |
Requête Obtenir des événements. Permet de récupérer des événements bruts pour un ID de série chronologique et une étendue de recherche donnés. |
|
| getSeries |
Requête Obtenir une série. Permet de récupérer des séries chronologiques de valeurs de variables calculées à partir d’événements pour un ID de série chronologique et une étendue de recherche donnés. |
Réponses
| Nom | Type | Description |
|---|---|---|
| 200 OK |
Requête réussie. Headers x-ms-request-id: string |
|
| Other Status Codes |
Erreur inattendue. Headers x-ms-request-id: string |
Sécurité
azure_auth
Flux OAuth2 Azure Active Directory
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
| Nom | Description |
|---|---|
| user_impersonation | Emprunter l’identité de votre compte d’utilisateur |
Exemples
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
}Définitions
| Nom | Description |
|---|---|
|
Aggregate |
Requête de série d’agrégats. Permet de calculer une série chronologique agrégée à partir d’événements pour un ID de série chronologique et une étendue de recherche donnés. |
|
Aggregate |
La variable d’agrégation représente n’importe quel calcul d’agrégation. Les variables d’agrégation ne prennent pas en charge l’interpolation. |
| Boundary |
Intervalle de temps à gauche et à droite de l’étendue de recherche à utiliser pour l’interpolation. Cela est utile dans les scénarios où les points de données sont manquants près du début ou de la fin de l’étendue de recherche d’entrée. Peuvent avoir la valeur null. |
|
Categorical |
La variable catégorielle représente le signal qui doit être analysé en fonction du nombre ou de la durée d’occurrence d’un jeu limité de valeurs définies. |
|
Date |
Intervalle de temps. Ne peut pas être null ou négatif. |
|
Event |
Propriété d’un événement stocké ou calculé. Les propriétés sont identifiées par le nom et le type. Différents événements peuvent avoir des propriétés portant le même nom, mais de type différent. |
|
Get |
Obtenir la requête Événements. Permet de récupérer des événements bruts pour un ID de série chronologique et une étendue de recherche donnés. |
|
Get |
Obtenir une requête de série. Permet de récupérer des séries chronologiques de valeurs de variable calculées à partir d’événements pour un ID de série chronologique et une étendue de recherche donnés. |
| Interpolation |
Opération d’interpolation à effectuer sur les points de données brutes. Actuellement, seul l’échantillonnage de séries chronologiques interpolées est autorisé. Fonction d’agrégation autorisée - par exemple : left($value). Peut être null si aucune interpolation ne doit être appliquée. |
|
Interpolation |
Type de technique d’interpolation : « Linéaire » ou « Étape ». |
|
Numeric |
La variable numérique représente un signal numérique continu unique qui peut être reconstruit à l’aide de l’interpolation. |
|
Property |
Type de la propriété. |
|
Property |
Valeurs d’une propriété unique correspondant aux horodatages. Peut contenir des valeurs Null. Le type de valeurs correspond au type de propriété. |
|
Query |
Demande d’exécution d’une requête de série chronologique sur des événements. L’un des « getEvents », « getSeries » ou « aggregateSeries » doit être défini. |
|
Query |
Une seule page de résultats de requête. Si la requête n’est pas encore terminée, le jeton de continuation d’une page est défini. Dans ce cas, pour obtenir la page de résultats suivante, envoyez à nouveau la même requête avec le paramètre de jeton de continuation. Si la requête est terminée, le jeton de continuation est null. Il est également possible d’obtenir une page vide avec uniquement le jeton de continuation défini quand aucun résultat de requête n’a encore été calculé. Si la pagination est terminée (le jeton de continuation est null), les horodatages et les propriétés peuvent être vides s’il n’y a pas de données à retourner. |
|
Time |
Catégorie utilisée dans les variables catégorielles. Une catégorie est définie par « label » et les « valeurs » qui sont affectées à cette étiquette. |
|
Time |
Représente la catégorie par défaut. |
|
Tsi |
Informations sur une erreur d’API. |
|
Tsi |
Une erreur d’API particulière avec un code d’erreur et un message. |
|
Tsi |
Informations supplémentaires sur l’erreur. |
| Tsx |
Expression de série chronologique (TSX) écrite sous la forme d’une chaîne unique. Exemples : « $event. Status.String='Good' », « avg($event. Température) ». Reportez-vous à la documentation sur l’écriture d’expressions de série chronologique. |
AggregateSeries
Requête de série d’agrégats. Permet de calculer une série chronologique agrégée à partir d’événements pour un ID de série chronologique et une étendue de recherche donnés.
| Nom | Type | Description |
|---|---|---|
| filter |
Filtre de niveau supérieur sur les événements qui limitent le nombre d’événements pris en compte pour le calcul. Ce filtre est AND’ed avec filtre dans chaque variable. Exemple : « $event. Status.String='Good' ». facultatif. |
|
| inlineVariables |
object |
Cela permet à l’utilisateur de définir éventuellement des variables inline en dehors de celles déjà définies dans le modèle. Lorsque les noms de variables inline ont le même nom que le modèle, la définition de variable inline est prioritaire. Peuvent avoir la valeur null. |
| interval |
string |
La taille d’intervalle est spécifiée au format de durée ISO-8601. Tous les intervalles ont la même taille. Un mois est toujours converti en 30 jours, et un an est toujours de 365 jours. Exemples : 1 minute est « PT1M », 1 milliseconde est « PT0.001S ». Pour plus d'informations, consultez https://www.w3.org/TR/xmlschema-2/#duration |
| projectedVariables |
string[] |
Cela permet à l’utilisateur de sélectionner éventuellement les variables à projeter. Lorsqu’elle est null ou non définie, toutes les variables inlineVariables et model sont retournées. Peuvent avoir la valeur null. |
| searchSpan |
Intervalle de temps pendant lequel la requête est exécutée. Ne peut pas être null. |
|
| timeSeriesId |
Time |
Valeur d’ID de série chronologique unique qui identifie de manière unique un seul instance de série chronologique (par exemple, un appareil). Notez qu’un ID de série chronologique unique peut être composite si plusieurs propriétés sont spécifiées en tant qu’ID de série chronologique au moment de la création de l’environnement. La position et le type de valeurs doivent correspondre aux propriétés d’ID de série chronologique spécifiées dans l’environnement et retournées par l’API Get Model Setting. Ne peut pas être null. |
AggregateVariable
La variable d’agrégation représente n’importe quel calcul d’agrégation. Les variables d’agrégation ne prennent pas en charge l’interpolation.
| Nom | Type | Description |
|---|---|---|
| aggregation |
L’expression de série chronologique d’agrégation lorsque le type est « agrégat » est utilisée pour représenter l’agrégation qui doit être effectuée directement à l’aide de propriétés d’événement telles que « $event . Température ». Par exemple, l’agrégation pour le calcul de la plage de changements de température peut être écrite comme suit : « max($event. Température)-min($event. Température) ». |
|
| filter |
Filtrez les événements qui limitent le nombre d’événements pris en compte pour le calcul. Exemple : « $event. Status.String='Good' ». facultatif. |
|
| kind |
string:
aggregate |
Les valeurs « kind » autorisées sont « numeric » ou « aggregate ». Alors que « numeric » vous permet de spécifier la valeur du signal reconstruit et de l’expression pour les agréger, le type « aggregate » vous permet d’agréger directement sur les propriétés de l’événement sans spécifier de valeur. |
Boundary
Intervalle de temps à gauche et à droite de l’étendue de recherche à utiliser pour l’interpolation. Cela est utile dans les scénarios où les points de données sont manquants près du début ou de la fin de l’étendue de recherche d’entrée. Peuvent avoir la valeur null.
| Nom | Type | Description |
|---|---|---|
| span |
string |
CategoricalVariable
La variable catégorielle représente le signal qui doit être analysé en fonction du nombre ou de la durée d’occurrence d’un jeu limité de valeurs définies.
| Nom | Type | Description |
|---|---|---|
| categories |
Catégorie utilisée dans les variables catégorielles. Une catégorie est définie par « label » et les « valeurs » qui sont affectées à cette étiquette. |
|
| defaultCategory |
Représente la catégorie par défaut. |
|
| filter |
Filtrez les événements qui limitent le nombre d’événements pris en compte pour le calcul. Exemple : « $event. Status.String='Good' ». facultatif. |
|
| interpolation |
La variable catégorielle prend uniquement en charge l’interpolation « étape ». |
|
| kind |
string:
categorical |
Les valeurs « kind » autorisées sont « numeric » ou « aggregate ». Alors que « numeric » vous permet de spécifier la valeur du signal reconstruit et de l’expression pour les agréger, le type « aggregate » vous permet d’agréger directement sur les propriétés de l’événement sans spécifier de valeur. |
| value |
L’expression de série chronologique de valeur est utilisée pour représenter la valeur du signal qui va être classé. Il peut évaluer uniquement le type « String » ou « Long » pour les variables catégorielles. |
DateTimeRange
Intervalle de temps. Ne peut pas être null ou négatif.
| Nom | Type | Description |
|---|---|---|
| from |
string |
Horodatage de début de l’intervalle de temps. L’horodatage de début est inclusif lorsqu’il est utilisé dans les requêtes de série chronologique. Les événements qui ont cet horodatage sont inclus. |
| to |
string |
Horodatage de fin de l’intervalle de temps. L’horodatage de fin est exclusif lorsqu’il est utilisé dans les requêtes de série chronologique. Les événements qui correspondent à ce timestamp sont exclus. Notez que l’horodatage de fin est inclusif lorsqu’il est retourné par Get Availability (ce qui signifie qu’il existe un événement avec cet horodatage « à » exact). |
EventProperty
Propriété d’un événement stocké ou calculé. Les propriétés sont identifiées par le nom et le type. Différents événements peuvent avoir des propriétés portant le même nom, mais de type différent.
| Nom | Type | Description |
|---|---|---|
| name |
string |
Nom de la propriété. |
| type |
Type de la propriété. |
GetEvents
Obtenir la requête Événements. Permet de récupérer des événements bruts pour un ID de série chronologique et une étendue de recherche donnés.
| Nom | Type | Description |
|---|---|---|
| filter |
Filtre de niveau supérieur facultatif pour la requête qui sera appliqué à toutes les variables de la requête. Exemple : « $event. Status.String='Good' ». Peuvent avoir la valeur null. |
|
| projectedProperties |
Les propriétés projetées sont un tableau de propriétés que vous souhaitez projeter. Ces propriétés doivent apparaître dans les événements ; sinon, ils ne sont pas retournés. |
|
| searchSpan |
Intervalle de temps pendant lequel la requête est exécutée. Ne peut pas être null. |
|
| take |
integer |
Nombre maximal de valeurs de propriété dans l’ensemble du jeu de réponses, et non le nombre maximal de valeurs de propriété par page. La valeur par défaut est 10 000 lorsqu’elle n’est pas définie. La valeur maximale de take peut être 250 000. |
| timeSeriesId |
Time |
Valeur d’ID de série chronologique unique qui identifie de manière unique un seul instance de série chronologique (par exemple, un appareil). Notez qu’un ID de série chronologique unique peut être composite si plusieurs propriétés sont spécifiées en tant qu’ID de série chronologique au moment de la création de l’environnement. La position et le type de valeurs doivent correspondre aux propriétés d’ID de série chronologique spécifiées dans l’environnement et retournées par l’API Get Model Setting. Ne peut pas être null. |
GetSeries
Obtenir une requête de série. Permet de récupérer des séries chronologiques de valeurs de variable calculées à partir d’événements pour un ID de série chronologique et une étendue de recherche donnés.
| Nom | Type | Description |
|---|---|---|
| filter |
Filtre de niveau supérieur sur les événements qui limitent le nombre d’événements pris en compte pour le calcul. Ce filtre est AND’ed avec filtre dans chaque variable. Exemple : « $event. Status.String='Good' ». facultatif. |
|
| inlineVariables |
object |
Variables inline facultatives à l’exception de celles déjà définies dans le type de série chronologique dans le modèle. Lorsque le nom de la variable inline est le même nom que dans le modèle, la définition de la variable inline est prioritaire. Peuvent avoir la valeur null. |
| projectedVariables |
string[] |
Variables sélectionnées qui doivent être projetées dans le résultat de la requête. Lorsqu’elle est null ou non définie, toutes les variables inlineVariables et le type de série chronologique dans le modèle sont retournées. Peuvent avoir la valeur null. |
| searchSpan |
Intervalle de temps pendant lequel la requête est exécutée. Ne peut pas être null. |
|
| take |
integer |
Nombre maximal de valeurs de propriété dans l’ensemble du jeu de réponses, et non le nombre maximal de valeurs de propriété par page. La valeur par défaut est 10 000 lorsqu’elle n’est pas définie. La valeur maximale de take peut être 250 000. |
| timeSeriesId |
Time |
Valeur d’ID de série chronologique unique qui identifie de manière unique un seul instance de série chronologique (par exemple, un appareil). Notez qu’un ID de série chronologique unique peut être composite si plusieurs propriétés sont spécifiées en tant qu’ID de série chronologique au moment de la création de l’environnement. La position et le type de valeurs doivent correspondre aux propriétés d’ID de série chronologique spécifiées dans l’environnement et retournées par l’API Get Model Setting. Ne peut pas être null. |
Interpolation
Opération d’interpolation à effectuer sur les points de données brutes. Actuellement, seul l’échantillonnage de séries chronologiques interpolées est autorisé. Fonction d’agrégation autorisée - par exemple : left($value). Peut être null si aucune interpolation ne doit être appliquée.
| Nom | Type | Description |
|---|---|---|
| boundary |
Intervalle de temps à gauche et à droite de l’étendue de recherche à utiliser pour l’interpolation. Cela est utile dans les scénarios où les points de données sont manquants près du début ou de la fin de l’étendue de recherche d’entrée. Peuvent avoir la valeur null. |
|
| kind |
Type de technique d’interpolation : « Linéaire » ou « Étape ». |
InterpolationKind
Type de technique d’interpolation : « Linéaire » ou « Étape ».
| Nom | Type | Description |
|---|---|---|
| Linear |
string |
|
| Step |
string |
NumericVariable
La variable numérique représente un signal numérique continu unique qui peut être reconstruit à l’aide de l’interpolation.
| Nom | Type | Description |
|---|---|---|
| aggregation |
L’expression de série chronologique d’agrégation lorsque le type est « numérique » est utilisée pour représenter l’agrégation qui doit être effectuée sur l’expression $value. Cela nécessite que $value soient spécifiés et ne peut utiliser que $value à l’intérieur des fonctions d’agrégation. Par exemple, l’agrégation pour calculer le minimum de la $value est écrite comme suit : « min($value) ». |
|
| filter |
Filtrez les événements qui limitent le nombre d’événements pris en compte pour le calcul. Exemple : « $event. Status.String='Good' ». facultatif. |
|
| interpolation |
Opération d’interpolation à effectuer sur les points de données brutes. Actuellement, seul l’échantillonnage de séries chronologiques interpolées est autorisé. Fonction d’agrégation autorisée - par exemple : left($value). Peut être null si aucune interpolation ne doit être appliquée. |
|
| kind |
string:
numeric |
Les valeurs « kind » autorisées sont « numeric » ou « aggregate ». Alors que « numeric » vous permet de spécifier la valeur du signal reconstruit et de l’expression pour les agréger, le type « aggregate » vous permet d’agréger directement sur les propriétés de l’événement sans spécifier de valeur. |
| value |
L’expression de série chronologique value est utilisée pour représenter la valeur du signal qui va être agrégé ou interpolé. Par exemple, les valeurs de température de l’événement sont représentées comme suit : « $event. Temperature.Double ». |
PropertyTypes
Type de la propriété.
| Nom | Type | Description |
|---|---|---|
| Bool |
string |
|
| DateTime |
string |
|
| Double |
string |
|
| Long |
string |
|
| String |
string |
|
| TimeSpan |
string |
PropertyValues
Valeurs d’une propriété unique correspondant aux horodatages. Peut contenir des valeurs Null. Le type de valeurs correspond au type de propriété.
| Nom | Type | Description |
|---|---|---|
| name |
string |
Nom de la propriété. |
| type |
Type de la propriété. |
|
| values |
Values[] |
Valeurs d’une propriété unique correspondant aux horodatages. Peut contenir des valeurs Null. Le type de valeurs correspond au type de propriété. |
QueryRequest
Demande d’exécution d’une requête de série chronologique sur des événements. L’un des « getEvents », « getSeries » ou « aggregateSeries » doit être défini.
| Nom | Type | Description |
|---|---|---|
| aggregateSeries |
Requête de série d’agrégats. Permet de calculer une série chronologique agrégée à partir d’événements pour un ID de série chronologique et une étendue de recherche donnés. |
|
| getEvents |
Obtenir la requête Événements. Permet de récupérer des événements bruts pour un ID de série chronologique et une étendue de recherche donnés. |
|
| getSeries |
Obtenir une requête de série. Permet de récupérer des séries chronologiques de valeurs de variable calculées à partir d’événements pour un ID de série chronologique et une étendue de recherche donnés. |
QueryResultPage
Une seule page de résultats de requête. Si la requête n’est pas encore terminée, le jeton de continuation d’une page est défini. Dans ce cas, pour obtenir la page de résultats suivante, envoyez à nouveau la même requête avec le paramètre de jeton de continuation. Si la requête est terminée, le jeton de continuation est null. Il est également possible d’obtenir une page vide avec uniquement le jeton de continuation défini quand aucun résultat de requête n’a encore été calculé. Si la pagination est terminée (le jeton de continuation est null), les horodatages et les propriétés peuvent être vides s’il n’y a pas de données à retourner.
| Nom | Type | Description |
|---|---|---|
| continuationToken |
string |
S’il est retourné, cela signifie que les résultats actuels représentent un résultat partiel. Le jeton de continuation permet d’obtenir la page suivante des résultats. Pour obtenir la page suivante des résultats de la requête, envoyez la même requête avec le paramètre de jeton de continuation dans l’en-tête HTTP « x-ms-continuation ». |
| progress |
number |
Progression approximative de la requête en pourcentage. Il peut être compris entre 0 et 100. Lorsque le jeton de continuation dans la réponse est null, la progression est censée être égale à 100. |
| properties |
Collection de propriétés et de valeurs de série chronologique pour chacun des horodatages. Peut être null si le serveur n’a pas pu remplir la page dans cette demande, ou peut être vide s’il n’y a plus d’objets lorsque le jeton de continuation est null. |
|
| timestamps |
string[] |
Horodatages des valeurs de la série chronologique. Si une agrégation sur des intervalles est utilisée, les horodatages représentent le début des intervalles correspondants. Si des événements sont récupérés, les horodatages sont des valeurs d’horodatage $ts propriété des événements. Peut être null si le serveur n’a pas pu remplir la page dans cette demande, ou peut être vide s’il n’y a plus d’objets lorsque le jeton de continuation est null. |
TimeSeriesAggregateCategory
Catégorie utilisée dans les variables catégorielles. Une catégorie est définie par « label » et les « valeurs » qui sont affectées à cette étiquette.
| Nom | Type | Description |
|---|---|---|
| label |
string |
Nom de la catégorie qui sera utilisée pour construire les noms de variables de sortie. |
| values |
object[] |
Liste des valeurs auxquelles une catégorie est mappée. Il peut s’agir d’une liste unique de chaînes ou d’une liste de longues. |
TimeSeriesDefaultCategory
Représente la catégorie par défaut.
| Nom | Type | Description |
|---|---|---|
| label |
string |
Nom de la catégorie par défaut qui sera affectée aux valeurs qui ne correspondent à aucune de celles définies dans les « catégories ». |
TsiError
Informations sur une erreur d’API.
| Nom | Type | Description |
|---|---|---|
| error |
Erreur d’API particulière avec un code d’erreur et un message. |
TsiErrorBody
Une erreur d’API particulière avec un code d’erreur et un message.
| Nom | Type | Description |
|---|---|---|
| code |
string |
Chaîne indépendante du langage et lisible par l’homme qui définit un code d’erreur spécifique au service. Ce code sert d’indicateur plus spécifique pour le code d’erreur HTTP spécifié dans la réponse. Peut être utilisé pour gérer par programmation des cas d’erreur spécifiques. |
| details |
Contient des informations d’erreur supplémentaires. Ce paramètre peut être null. |
|
| innerError |
Contient une erreur plus spécifique qui limite la cause. Ce paramètre peut être null. |
|
| message |
string |
Représentation lisible et indépendante du langage de l’erreur. Il est destiné à aider les développeurs et n’est pas adapté à l’exposition des utilisateurs finaux. |
| target |
string |
Cible de l’erreur particulière (par exemple, le nom de la propriété dans l’erreur). Ce paramètre peut être null. |
TsiErrorDetails
Informations supplémentaires sur l’erreur.
| Nom | Type | Description |
|---|---|---|
| code |
string |
Chaîne indépendante du langage et lisible par l’homme qui définit un code d’erreur spécifique au service. Ce code sert d’indicateur plus spécifique pour le code d’erreur HTTP spécifié dans la réponse. Peut être utilisé pour gérer par programmation des cas d’erreur spécifiques. |
| message |
string |
Représentation lisible et indépendante du langage de l’erreur. Il est destiné à aider les développeurs et n’est pas adapté à l’exposition des utilisateurs finaux. |
Tsx
Expression de série chronologique (TSX) écrite sous la forme d’une chaîne unique. Exemples : « $event. Status.String='Good' », « avg($event. Température) ». Reportez-vous à la documentation sur l’écriture d’expressions de série chronologique.
| Nom | Type | Description |
|---|---|---|
| tsx |
string |
Expression de série chronologique (TSX) écrite sous la forme d’une chaîne unique. Exemples : « $event. Status.String='Good' », « avg($event. Température) ». Reportez-vous à la documentation sur l’écriture d’expressions de série chronologique. |