Query - Execute
Executa a Consulta de Série Temporal em páginas de resultados – Obter Eventos, Obter Série ou Série Agregada.
POST https://{environmentFqdn}/timeseries/query?api-version=2020-07-31POST https://{environmentFqdn}/timeseries/query?api-version=2020-07-31&storeType={storeType}Parâmetros de URI
| Nome | Em | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
environment
|
path | True |
string |
Por FQDN de ambiente, por exemplo, 10000000-0000-0000-0000-100000000109.env.timeseries.azure.com. Você pode obter esse nome de domínio da resposta da API Obter Ambientes, portal do Azure ou Resource Manager do Azure. |
|
api-version
|
query | True |
string |
Versão da API a ser usada com a solicitação do cliente. A versão atualmente com suporte é "2020-07-31". |
|
store
|
query |
string |
Para os ambientes com o repositório warm habilitado, a consulta pode ser executada no 'WarmStore' ou 'ColdStore'. Esse parâmetro na consulta define em qual armazenamento a consulta deve ser executada. Se ele não estiver definido, a consulta será executada no armazenamento cold. |
Cabeçalho da solicitação
| Nome | Obrigatório | Tipo | Description |
|---|---|---|---|
| x-ms-continuation |
string |
Token de continuação da página anterior de resultados para recuperar a próxima página dos resultados em chamadas que dão suporte à paginação. Para obter os resultados da primeira página, especifique o token de continuação nula como valor de parâmetro. O token de continuação retornado será nulo se todos os resultados tiverem sido retornados e não houver nenhuma próxima página de resultados. |
|
| x-ms-client-request-id |
string |
ID de solicitação de cliente opcional. O serviço registra esse valor. Permite que o serviço rastreie a operação entre serviços e permite que o cliente entre em contato com o suporte em relação a uma solicitação específica. |
|
| x-ms-client-session-id |
string |
ID de sessão do cliente opcional. O serviço registra esse valor. Permite que o serviço rastreie um grupo de operações relacionadas entre serviços e permite que o cliente entre em contato com o suporte em relação a um grupo específico de solicitações. |
Corpo da solicitação
| Nome | Tipo | Description |
|---|---|---|
| aggregateSeries |
Consulta de série de agregação. Permite calcular uma série temporal agregada de eventos para uma determinada ID de Série Temporal e um intervalo de pesquisa. |
|
| getEvents |
Obter a consulta Eventos. Permite recuperar eventos brutos para uma determinada ID de Série Temporal e um intervalo de pesquisa. |
|
| getSeries |
Obter consulta de Série. Permite recuperar séries temporais de valores de variáveis calculados de eventos para uma determinada ID de Série Temporal e intervalo de pesquisa. |
Respostas
| Nome | Tipo | Description |
|---|---|---|
| 200 OK |
Consulta bem-sucedida. Headers x-ms-request-id: string |
|
| Other Status Codes |
Erro inesperado. Headers x-ms-request-id: string |
Segurança
azure_auth
Fluxo do OAuth2 do Azure Active Directory
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
| Nome | Description |
|---|---|
| user_impersonation | representar sua conta de usuário |
Exemplos
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
}Definições
| Nome | Description |
|---|---|
|
Aggregate |
Consulta de série de agregação. Permite calcular uma série temporal agregada de eventos para uma determinada ID de Série Temporal e um intervalo de pesquisa. |
|
Aggregate |
A variável de agregação representa qualquer cálculo de agregação. As Variáveis de Agregação não dão suporte à interpolação. |
| Boundary |
O intervalo de tempo à esquerda e à direita do intervalo de pesquisa a ser usado para Interpolação. Isso é útil em cenários em que os pontos de dados estão ausentes perto do início ou final do intervalo de pesquisa de entrada. Pode ser nulo. |
|
Categorical |
A variável categórica representa o sinal que precisa ser analisado com base na contagem ou duração da ocorrência de um conjunto limitado de valores definidos. |
|
Date |
O intervalo de tempo. Não pode ser nulo ou negativo. |
|
Event |
Propriedade de um evento armazenado ou computado. As propriedades são identificadas por nome e tipo. Eventos diferentes podem ter propriedades com o mesmo nome, mas tipo diferente. |
|
Get |
Consulta Obter Eventos. Permite recuperar eventos brutos para uma determinada ID de Série Temporal e um intervalo de pesquisa. |
|
Get |
Obter consulta de série. Permite recuperar séries temporais de valores de variáveis calculadas de eventos para uma determinada ID de Série Temporal e um intervalo de pesquisa. |
| Interpolation |
A operação de interpolação a ser executada nos pontos de dados brutos. Atualmente, apenas a amostragem de séries temporais interpoladas é permitida. Função de agregação permitida – por exemplo: left($value). Pode ser nulo se nenhuma interpolação precisar ser aplicada. |
|
Interpolation |
O tipo de técnica de interpolação: "Linear" ou "Step". |
|
Numeric |
A variável numérica representa um único sinal numérico contínuo que pode ser reconstruído usando interpolação. |
|
Property |
O tipo da propriedade. |
|
Property |
Valores de uma única propriedade correspondente aos carimbos de data/hora. Pode conter nulos. O tipo de valores corresponde ao tipo de propriedade . |
|
Query |
Solicitação para executar uma consulta de série temporal em eventos. Exatamente um dos "getEvents", "getSeries" ou "aggregateSeries" deve ser definido. |
|
Query |
Uma única página de resultados da consulta. Se a consulta ainda não tiver sido concluída, uma página terá o token de continuação definido. Nesse caso, para obter a próxima página de resultados, envie a mesma solicitação novamente com o parâmetro de token de continuação. Se a consulta tiver sido concluída, o token de continuação será nulo. Também é possível obter uma página vazia com apenas token de continuação definido quando nenhum resultado de consulta tiver sido calculado ainda. Se a paginação tiver sido concluída (o token de continuação é nulo), os carimbos de data/hora e as propriedades poderão estar vazios se não houver dados a serem retornados. |
|
Time |
Categoria usada em variáveis categóricas. Uma categoria é definida por 'label' e 'values' que recebem esse rótulo. |
|
Time |
Representa a categoria padrão. |
|
Tsi |
Informações sobre um erro de API. |
|
Tsi |
Um erro de API específico com um código de erro e uma mensagem. |
|
Tsi |
Informações adicionais de erro. |
| Tsx |
Expressão de série temporal (TSX) escrita como uma única cadeia de caracteres. Exemplos: "$event. Status.String='Good'", "avg($event. Temperatura)". Consulte a documentação sobre como escrever expressões de série temporal. |
AggregateSeries
Consulta de série de agregação. Permite calcular uma série temporal agregada de eventos para uma determinada ID de Série Temporal e um intervalo de pesquisa.
| Nome | Tipo | Description |
|---|---|---|
| filter |
Filtro de nível superior sobre os eventos que restringem o número de eventos que estão sendo considerados para computação. Esse filtro é AND'ed com filtro em cada variável. Exemplo: "$event. Status.String='Good'". Opcional. |
|
| inlineVariables |
object |
Isso permite que o usuário defina opcionalmente variáveis embutidas além daquelas já definidas no modelo. Quando os nomes de variáveis embutidas têm o mesmo nome que o modelo, a definição de variável embutida tem precedência. Pode ser nulo. |
| interval |
string |
O tamanho do intervalo é especificado no formato de duração ISO-8601. Todos os intervalos têm o mesmo tamanho. Um mês é sempre convertido em 30 dias e um ano é sempre 365 dias. Exemplos: 1 minuto é "PT1M", 1 milissegundo é "PT0.001S". Para obter mais informações, consulte https://www.w3.org/TR/xmlschema-2/#duration. |
| projectedVariables |
string[] |
Isso permite que o usuário selecione opcionalmente as variáveis que precisam ser projetadas. Quando é nulo ou não definido, todas as variáveis de inlineVariables e model são retornadas. Pode ser nulo. |
| searchSpan |
O intervalo de tempo no qual a consulta é executada. Não pode ser nulo. |
|
| timeSeriesId |
Time |
Um único valor de ID de Série Temporal que identifica exclusivamente uma única instância de série temporal (por exemplo, um dispositivo). Observe que uma única ID de Série Temporal poderá ser composta se várias propriedades forem especificadas como ID de Série Temporal no momento da criação do ambiente. A posição e o tipo de valores devem corresponder às propriedades de ID de Série Temporal especificadas no ambiente e retornadas pela API Obter Configuração de Modelo. Não pode ser nulo. |
AggregateVariable
A variável de agregação representa qualquer cálculo de agregação. As Variáveis de Agregação não dão suporte à interpolação.
| Nome | Tipo | Description |
|---|---|---|
| aggregation |
A expressão de série temporal de agregação quando kind é "aggregate" é usada para representar a agregação que precisa ser executada diretamente usando propriedades de evento como "$event. Temperatura". Por exemplo, a agregação para calcular o intervalo de alterações de temperatura pode ser gravada como: "max($event. Temperature)-min($event. Temperatura)". |
|
| filter |
Filtre os eventos que restringem o número de eventos que estão sendo considerados para computação. Exemplo: "$event. Status.String='Good'". Opcional. |
|
| kind |
string:
aggregate |
Os valores "kind" permitidos são : "numérico" ou "aggregate". Embora "numérico" permita que você especifique o valor do sinal reconstruído e a expressão para agregá-los, o tipo "agregação" permite agregar diretamente nas propriedades do evento sem especificar valor. |
Boundary
O intervalo de tempo à esquerda e à direita do intervalo de pesquisa a ser usado para Interpolação. Isso é útil em cenários em que os pontos de dados estão ausentes perto do início ou final do intervalo de pesquisa de entrada. Pode ser nulo.
| Nome | Tipo | Description |
|---|---|---|
| span |
string |
CategoricalVariable
A variável categórica representa o sinal que precisa ser analisado com base na contagem ou duração da ocorrência de um conjunto limitado de valores definidos.
| Nome | Tipo | Description |
|---|---|---|
| categories |
Categoria usada em variáveis categóricas. Uma categoria é definida por 'label' e 'values' que recebem esse rótulo. |
|
| defaultCategory |
Representa a categoria padrão. |
|
| filter |
Filtre os eventos que restringem o número de eventos que estão sendo considerados para computação. Exemplo: "$event. Status.String='Good'". Opcional. |
|
| interpolation |
A variável categórica dá suporte apenas à interpolação 'step'. |
|
| kind |
string:
categorical |
Os valores "kind" permitidos são : "numérico" ou "aggregate". Embora "numérico" permita que você especifique o valor do sinal reconstruído e a expressão para agregá-los, o tipo "agregação" permite agregar diretamente nas propriedades do evento sem especificar valor. |
| value |
A expressão de série temporal de valor é usada para representar o valor do sinal que será categorizado. Ele pode avaliar apenas o tipo 'String' ou 'Long' para variáveis categóricas. |
DateTimeRange
O intervalo de tempo. Não pode ser nulo ou negativo.
| Nome | Tipo | Description |
|---|---|---|
| from |
string |
Iniciar carimbo de data/hora do intervalo de tempo. O carimbo de data/hora de início é inclusivo quando usado em solicitações de consulta de série temporal. Os eventos que têm esse carimbo de data/hora são incluídos. |
| to |
string |
Carimbo de data/hora final do intervalo de tempo. O carimbo de data/hora final é exclusivo quando usado em solicitações de consulta de série temporal. Os eventos que correspondem a esse carimbo de data/hora são excluídos. Observe que o carimbo de data/hora final é inclusivo quando retornado por Obter Disponibilidade (o que significa que há um evento com esse carimbo de data/hora "to" exato). |
EventProperty
Propriedade de um evento armazenado ou computado. As propriedades são identificadas por nome e tipo. Eventos diferentes podem ter propriedades com o mesmo nome, mas tipo diferente.
| Nome | Tipo | Description |
|---|---|---|
| name |
string |
O nome da propriedade. |
| type |
O tipo da propriedade. |
GetEvents
Consulta Obter Eventos. Permite recuperar eventos brutos para uma determinada ID de Série Temporal e um intervalo de pesquisa.
| Nome | Tipo | Description |
|---|---|---|
| filter |
Filtro de nível superior opcional para a consulta que será aplicada a todas as variáveis na consulta. Exemplo: "$event. Status.String='Good'". Pode ser nulo. |
|
| projectedProperties |
As propriedades projetadas são uma matriz de propriedades que você deseja projetar. Essas propriedades devem aparecer nos eventos; caso contrário, eles não serão retornados. |
|
| searchSpan |
O intervalo de tempo no qual a consulta é executada. Não pode ser nulo. |
|
| take |
integer |
Número máximo de valores de propriedade em todo o conjunto de respostas, não o número máximo de valores de propriedade por página. O padrão é 10.000 quando não definido. O valor máximo de take pode ser 250.000. |
| timeSeriesId |
Time |
Um único valor de ID de Série Temporal que identifica exclusivamente uma única instância de série temporal (por exemplo, um dispositivo). Observe que uma única ID de Série Temporal poderá ser composta se várias propriedades forem especificadas como ID de Série Temporal no momento da criação do ambiente. A posição e o tipo de valores devem corresponder às propriedades de ID de Série Temporal especificadas no ambiente e retornadas pela API Obter Configuração de Modelo. Não pode ser nulo. |
GetSeries
Obter consulta de série. Permite recuperar séries temporais de valores de variáveis calculadas de eventos para uma determinada ID de Série Temporal e um intervalo de pesquisa.
| Nome | Tipo | Description |
|---|---|---|
| filter |
Filtro de nível superior sobre os eventos que restringem o número de eventos que estão sendo considerados para computação. Esse filtro é AND'ed com filtro em cada variável. Exemplo: "$event. Status.String='Good'". Opcional. |
|
| inlineVariables |
object |
Variáveis embutidas opcionais, além daquelas já definidas no tipo de série temporal no modelo. Quando o nome da variável embutida é o mesmo nome do modelo, a definição de variável embutida tem precedência. Pode ser nulo. |
| projectedVariables |
string[] |
Variáveis selecionadas que precisam ser projetadas no resultado da consulta. Quando é nulo ou não definido, todas as variáveis de inlineVariables e tipo de série temporal no modelo são retornadas. Pode ser nulo. |
| searchSpan |
O intervalo de tempo no qual a consulta é executada. Não pode ser nulo. |
|
| take |
integer |
Número máximo de valores de propriedade em todo o conjunto de respostas, não o número máximo de valores de propriedade por página. O padrão é 10.000 quando não definido. O valor máximo de take pode ser 250.000. |
| timeSeriesId |
Time |
Um único valor de ID de Série Temporal que identifica exclusivamente uma única instância de série temporal (por exemplo, um dispositivo). Observe que uma única ID de Série Temporal poderá ser composta se várias propriedades forem especificadas como ID de Série Temporal no momento da criação do ambiente. A posição e o tipo de valores devem corresponder às propriedades de ID de Série Temporal especificadas no ambiente e retornadas pela API Obter Configuração de Modelo. Não pode ser nulo. |
Interpolation
A operação de interpolação a ser executada nos pontos de dados brutos. Atualmente, apenas a amostragem de séries temporais interpoladas é permitida. Função de agregação permitida – por exemplo: left($value). Pode ser nulo se nenhuma interpolação precisar ser aplicada.
| Nome | Tipo | Description |
|---|---|---|
| boundary |
O intervalo de tempo à esquerda e à direita do intervalo de pesquisa a ser usado para Interpolação. Isso é útil em cenários em que os pontos de dados estão ausentes perto do início ou final do intervalo de pesquisa de entrada. Pode ser nulo. |
|
| kind |
O tipo de técnica de interpolação: "Linear" ou "Step". |
InterpolationKind
O tipo de técnica de interpolação: "Linear" ou "Step".
| Nome | Tipo | Description |
|---|---|---|
| Linear |
string |
|
| Step |
string |
NumericVariable
A variável numérica representa um único sinal numérico contínuo que pode ser reconstruído usando interpolação.
| Nome | Tipo | Description |
|---|---|---|
| aggregation |
A expressão de série temporal de agregação quando kind é "numeric" é usada para representar a agregação que precisa ser executada na expressão $value. Isso requer que $value sejam especificados e só podem usar $value dentro das funções de agregação. Por exemplo, a agregação para calcular o mínimo do $value é escrita como: "min($value)". |
|
| filter |
Filtre os eventos que restringem o número de eventos que estão sendo considerados para computação. Exemplo: "$event. Status.String='Good'". Opcional. |
|
| interpolation |
A operação de interpolação a ser executada nos pontos de dados brutos. Atualmente, apenas a amostragem de séries temporais interpoladas é permitida. Função de agregação permitida – por exemplo: left($value). Pode ser nulo se nenhuma interpolação precisar ser aplicada. |
|
| kind |
string:
numeric |
Os valores "kind" permitidos são : "numérico" ou "aggregate". Embora "numérico" permita que você especifique o valor do sinal reconstruído e a expressão para agregá-los, o tipo "agregação" permite agregar diretamente nas propriedades do evento sem especificar valor. |
| value |
A expressão de série temporal de valor é usada para representar o valor do sinal que será agregado ou interpolado. Por exemplo, os valores de temperatura do evento são representados da seguinte maneira: "$event. Temperature.Double". |
PropertyTypes
O tipo da propriedade.
| Nome | Tipo | Description |
|---|---|---|
| Bool |
string |
|
| DateTime |
string |
|
| Double |
string |
|
| Long |
string |
|
| String |
string |
|
| TimeSpan |
string |
PropertyValues
Valores de uma única propriedade correspondente aos carimbos de data/hora. Pode conter nulos. O tipo de valores corresponde ao tipo de propriedade .
| Nome | Tipo | Description |
|---|---|---|
| name |
string |
O nome da propriedade. |
| type |
O tipo da propriedade. |
|
| values |
Values[] |
Valores de uma única propriedade correspondente aos carimbos de data/hora. Pode conter nulos. O tipo de valores corresponde ao tipo de propriedade . |
QueryRequest
Solicitação para executar uma consulta de série temporal em eventos. Exatamente um dos "getEvents", "getSeries" ou "aggregateSeries" deve ser definido.
| Nome | Tipo | Description |
|---|---|---|
| aggregateSeries |
Consulta de série de agregação. Permite calcular uma série temporal agregada de eventos para uma determinada ID de Série Temporal e um intervalo de pesquisa. |
|
| getEvents |
Consulta Obter Eventos. Permite recuperar eventos brutos para uma determinada ID de Série Temporal e um intervalo de pesquisa. |
|
| getSeries |
Obter consulta de série. Permite recuperar séries temporais de valores de variáveis calculadas de eventos para uma determinada ID de Série Temporal e um intervalo de pesquisa. |
QueryResultPage
Uma única página de resultados da consulta. Se a consulta ainda não tiver sido concluída, uma página terá o token de continuação definido. Nesse caso, para obter a próxima página de resultados, envie a mesma solicitação novamente com o parâmetro de token de continuação. Se a consulta tiver sido concluída, o token de continuação será nulo. Também é possível obter uma página vazia com apenas token de continuação definido quando nenhum resultado de consulta tiver sido calculado ainda. Se a paginação tiver sido concluída (o token de continuação é nulo), os carimbos de data/hora e as propriedades poderão estar vazios se não houver dados a serem retornados.
| Nome | Tipo | Description |
|---|---|---|
| continuationToken |
string |
Se retornado, isso significa que os resultados atuais representam um resultado parcial. O token de continuação permite obter a próxima página de resultados. Para obter a próxima página de resultados da consulta, envie a mesma solicitação com o parâmetro de token de continuação no cabeçalho HTTP "x-ms-continuation". |
| progress |
number |
Progresso aproximado da consulta em porcentagem. Pode estar entre 0 e 100. Quando o token de continuação na resposta é nulo, espera-se que o progresso seja 100. |
| properties |
Coleção de propriedades e valores de série temporal para cada um dos carimbos de data/hora. Pode ser nulo se o servidor não puder preencher a página nesta solicitação ou ficar vazio se não houver mais objetos quando o token de continuação for nulo. |
|
| timestamps |
string[] |
Os carimbos de data/hora dos valores da série temporal. Se uma agregação em intervalos for usada, os carimbos de data/hora representarão o início dos intervalos correspondentes. Se os eventos forem recuperados, os carimbos de data/hora serão valores de carimbo de data/hora $ts propriedade de eventos. Pode ser nulo se o servidor não puder preencher a página nesta solicitação ou ficar vazio se não houver mais objetos quando o token de continuação for nulo. |
TimeSeriesAggregateCategory
Categoria usada em variáveis categóricas. Uma categoria é definida por 'label' e 'values' que recebem esse rótulo.
| Nome | Tipo | Description |
|---|---|---|
| label |
string |
O nome da categoria que será usada na construção dos nomes das variáveis de saída. |
| values |
object[] |
A lista de valores para os quais uma categoria mapeia. Pode ser uma lista exclusiva de cadeia de caracteres ou uma lista de long. |
TimeSeriesDefaultCategory
Representa a categoria padrão.
| Nome | Tipo | Description |
|---|---|---|
| label |
string |
O nome da categoria padrão que será atribuída aos valores que não correspondem a nenhum dos definidos nas 'categorias'. |
TsiError
Informações sobre um erro de API.
| Nome | Tipo | Description |
|---|---|---|
| error |
Um erro de API específico com um código de erro e uma mensagem. |
TsiErrorBody
Um erro de API específico com um código de erro e uma mensagem.
| Nome | Tipo | Description |
|---|---|---|
| code |
string |
Cadeia de caracteres legível e independente de linguagem que define um código de erro específico do serviço. Esse código serve como um indicador mais específico para o código de erro HTTP especificado na resposta. Pode ser usado para lidar programaticamente com casos de erro específicos. |
| details |
Contém informações de erro adicionais. Pode ser nulo. |
|
| innerError |
Contém um erro mais específico que restringe a causa. Pode ser nulo. |
|
| message |
string |
Representação independente de idioma e legível por humanos do erro. Ele se destina como um auxílio aos desenvolvedores e não é adequado para exposição aos usuários finais. |
| target |
string |
Destino do erro específico (por exemplo, o nome da propriedade em erro). Pode ser nulo. |
TsiErrorDetails
Informações adicionais de erro.
| Nome | Tipo | Description |
|---|---|---|
| code |
string |
Cadeia de caracteres legível e independente de linguagem que define um código de erro específico do serviço. Esse código serve como um indicador mais específico para o código de erro HTTP especificado na resposta. Pode ser usado para lidar programaticamente com casos de erro específicos. |
| message |
string |
Representação independente de idioma e legível por humanos do erro. Ele se destina como um auxílio aos desenvolvedores e não é adequado para exposição aos usuários finais. |
Tsx
Expressão de série temporal (TSX) escrita como uma única cadeia de caracteres. Exemplos: "$event. Status.String='Good'", "avg($event. Temperatura)". Consulte a documentação sobre como escrever expressões de série temporal.
| Nome | Tipo | Description |
|---|---|---|
| tsx |
string |
Expressão de série temporal (TSX) escrita como uma única cadeia de caracteres. Exemplos: "$event. Status.String='Good'", "avg($event. Temperatura)". Consulte a documentação sobre como escrever expressões de série temporal. |