Query - Execute
Ejecuta la consulta de serie temporal en páginas de resultados: obtener eventos, obtener series o series agregadas.
POST https://{environmentFqdn}/timeseries/query?api-version=2020-07-31POST https://{environmentFqdn}/timeseries/query?api-version=2020-07-31&storeType={storeType}Parámetros de identificador URI
| Nombre | En | Requerido | Tipo | Description |
|---|---|---|---|---|
|
environment
|
path | True |
string |
Por FQDN de entorno, por ejemplo, 10000000-0000-0000-0000-100000000109.env.timeseries.azure.com. Puede obtener este nombre de dominio de la respuesta de Get Environments API, Azure Portal o Azure Resource Manager. |
|
api-version
|
query | True |
string |
Versión de la API que se va a usar con la solicitud de cliente. La versión admitida actualmente es "2020-07-31". |
|
store
|
query |
string |
Para los entornos con almacenamiento intermedio habilitado, la consulta se puede ejecutar en "WarmStore" o "ColdStore". Este parámetro de la consulta define en qué almacén debe ejecutarse la consulta. Si no se define, la consulta se ejecutará en el almacén frío. |
Encabezado de la solicitud
| Nombre | Requerido | Tipo | Description |
|---|---|---|---|
| x-ms-continuation |
string |
Token de continuación de la página anterior de resultados para recuperar la página siguiente de los resultados en llamadas que admiten la paginación. Para obtener los resultados de la primera página, especifique el token de continuación null como valor de parámetro. El token de continuación devuelto es NULL si se han devuelto todos los resultados y no hay ninguna página siguiente de resultados. |
|
| x-ms-client-request-id |
string |
Identificador de solicitud de cliente opcional. El servicio registra este valor. Permite al servicio realizar un seguimiento de la operación entre servicios y permite al cliente ponerse en contacto con el soporte técnico con respecto a una solicitud determinada. |
|
| x-ms-client-session-id |
string |
Identificador de sesión de cliente opcional. El servicio registra este valor. Permite al servicio realizar un seguimiento de un grupo de operaciones relacionadas entre servicios y permite al cliente ponerse en contacto con el soporte técnico con respecto a un grupo determinado de solicitudes. |
Cuerpo de la solicitud
| Nombre | Tipo | Description |
|---|---|---|
| aggregateSeries |
Consulta de series de agregados. Permite calcular una serie temporal agregada a partir de eventos para un determinado identificador de serie temporal y un intervalo de búsqueda. |
|
| getEvents |
Obtener consulta de eventos. Permite recuperar eventos sin procesar para un identificador de serie temporal y un intervalo de búsqueda determinado. |
|
| getSeries |
Obtener consulta de serie. Permite recuperar series temporales de valores de variable calculados de eventos para un determinado identificador de serie temporal y un intervalo de búsqueda. |
Respuestas
| Nombre | Tipo | Description |
|---|---|---|
| 200 OK |
Consulta correcta. Headers x-ms-request-id: string |
|
| Other Status Codes |
error inesperado. Headers x-ms-request-id: string |
Seguridad
azure_auth
Flujo OAuth2 de Azure Active Directory
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
| Nombre | Description |
|---|---|
| user_impersonation | suplantación de su cuenta de usuario |
Ejemplos
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
}Definiciones
| Nombre | Description |
|---|---|
|
Aggregate |
Consulta de series de agregados. Permite calcular una serie temporal agregada a partir de eventos para un determinado identificador de serie temporal y un intervalo de búsqueda. |
|
Aggregate |
La variable de agregado representa cualquier cálculo de agregación. Las variables de agregado no admiten la interpolación. |
| Boundary |
Intervalo de tiempo a la izquierda y a la derecha del intervalo de búsqueda que se va a usar para interpolación. Esto resulta útil en escenarios en los que faltan puntos de datos cerca del inicio o final del intervalo de búsqueda de entrada. Puede ser NULL. |
|
Categorical |
Variable categórica representa la señal que debe analizarse en función del recuento o la duración de la repetición de un conjunto limitado de valores definidos. |
|
Date |
Intervalo de tiempo. No puede ser null o negativo. |
|
Event |
Propiedad de un evento que se almacena o calcula. Las propiedades se identifican por nombre y tipo. Los distintos eventos pueden tener propiedades con el mismo nombre, pero un tipo diferente. |
|
Get |
Obtener consulta de eventos. Permite recuperar eventos sin procesar para un identificador de serie temporal y un intervalo de búsqueda determinado. |
|
Get |
Obtener consulta de serie. Permite recuperar series temporales de valores de variable calculados de eventos para un determinado identificador de serie temporal y un intervalo de búsqueda. |
| Interpolation |
Operación de interpolación que se va a realizar en los puntos de datos sin procesar. Actualmente, solo se permite el muestreo de series temporales interpoladas. Función de agregado permitida: por ejemplo: left($value). Puede ser null si no es necesario aplicar ninguna interpolación. |
|
Interpolation |
Tipo de técnica de interpolación: "Lineal" o "Paso". |
|
Numeric |
La variable numérica representa una única señal numérica continua que se puede reconstruir mediante la interpolación. |
|
Property |
Tipo de la propiedad. |
|
Property |
Valores de una sola propiedad correspondiente a las marcas de tiempo. Puede contener valores NULL. El tipo de valores coincide con el tipo de propiedad. |
|
Query |
Solicitud para ejecutar una consulta de serie temporal a través de eventos. Se debe establecer exactamente uno de los elementos "getEvents", "getSeries" o "aggregateSeries". |
|
Query |
Una sola página de resultados de la consulta. Si la consulta aún no ha finalizado, se establecerá un token de continuación en una página. En este caso, para obtener la siguiente página de resultados, envíe de nuevo la misma solicitud con el parámetro de token de continuación. Si se ha completado la consulta, el token de continuación es NULL. También es posible obtener una página vacía con solo el token de continuación establecido cuando aún no se han calculado resultados de consulta. Si la paginación se ha completado (el token de continuación es NULL), las marcas de tiempo y las propiedades pueden estar vacías si no hay datos que devolver. |
|
Time |
Categoría usada en variables categóricas. Una categoría se define mediante "label" y los "valores" asignados a esta etiqueta. |
|
Time |
Representa la categoría predeterminada. |
|
Tsi |
Información sobre un error de API. |
|
Tsi |
Un error de API determinado con un código de error y un mensaje. |
|
Tsi |
Información adicional de error. |
| Tsx |
Expresión de serie temporal (TSX) escrita como una sola cadena. Ejemplos: "$event. Status.String='Good'", "avg($event. Temperatura)". Consulte la documentación sobre cómo escribir expresiones de serie temporal. |
AggregateSeries
Consulta de series de agregados. Permite calcular una serie temporal agregada a partir de eventos para un determinado identificador de serie temporal y un intervalo de búsqueda.
| Nombre | Tipo | Description |
|---|---|---|
| filter |
Filtro de nivel superior sobre los eventos que restringen el número de eventos que se están considerando para el cálculo. Este filtro es AND'ed con filtro en cada variable. Ejemplo: "$event. Status.String='Good'". Opcional. |
|
| inlineVariables |
object |
Esto permite al usuario definir opcionalmente variables insertadas aparte de las ya definidas en el modelo. Cuando los nombres de las variables insertadas tienen el mismo nombre que el modelo, la definición de variable insertada tiene prioridad. Puede ser NULL. |
| interval |
string |
El tamaño del intervalo se especifica en formato de duración ISO-8601. Todos los intervalos tienen el mismo tamaño. Un mes siempre se convierte en 30 días y un año siempre es de 365 días. Ejemplos: 1 minuto es "PT1M", 1 milisegundos es "PT0.001S". Para obtener más información, vea https://www.w3.org/TR/xmlschema-2/#duration. |
| projectedVariables |
string[] |
Esto permite al usuario seleccionar opcionalmente las variables que deben proyectarse. Cuando es NULL o no se establece, se devuelven todas las variables de inlineVariables y model. Puede ser NULL. |
| searchSpan |
Intervalo de tiempo en el que se ejecuta la consulta. No puede ser NULL. |
|
| timeSeriesId |
Time |
Valor de identificador de serie temporal único que identifica de forma única una única instancia de serie temporal (por ejemplo, un dispositivo). Tenga en cuenta que un único identificador de serie temporal se puede componer si se especifican varias propiedades como id. de serie temporal en el momento de la creación del entorno. La posición y el tipo de valores deben coincidir con las propiedades de id. de serie temporal especificadas en el entorno y devueltas por Get Model Setting API. No puede ser NULL. |
AggregateVariable
La variable de agregado representa cualquier cálculo de agregación. Las variables de agregado no admiten la interpolación.
| Nombre | Tipo | Description |
|---|---|---|
| aggregation |
Expresión de serie temporal de agregación cuando el tipo es "agregado" se usa para representar la agregación que debe realizarse directamente mediante propiedades de evento como "$event. Temperatura". Por ejemplo, la agregación para calcular el intervalo de cambios de temperatura se puede escribir como: "max($event. Temperatura)-min($event. Temperatura)". |
|
| filter |
Filtre por los eventos que restringen el número de eventos que se están considerando para el cálculo. Ejemplo: "$event. Status.String='Good'". Opcional. |
|
| kind |
string:
aggregate |
Los valores permitidos "kind" son: "numeric" o "aggregate". Aunque "numeric" permite especificar el valor de la señal reconstruida y la expresión para agregarlas, el tipo "aggregate" le permite agregar directamente en las propiedades del evento sin especificar el valor. |
Boundary
Intervalo de tiempo a la izquierda y a la derecha del intervalo de búsqueda que se va a usar para interpolación. Esto resulta útil en escenarios en los que faltan puntos de datos cerca del inicio o final del intervalo de búsqueda de entrada. Puede ser NULL.
| Nombre | Tipo | Description |
|---|---|---|
| span |
string |
CategoricalVariable
Variable categórica representa la señal que debe analizarse en función del recuento o la duración de la repetición de un conjunto limitado de valores definidos.
| Nombre | Tipo | Description |
|---|---|---|
| categories |
Categoría usada en variables categóricas. Una categoría se define mediante "label" y los "valores" asignados a esta etiqueta. |
|
| defaultCategory |
Representa la categoría predeterminada. |
|
| filter |
Filtre por los eventos que restringen el número de eventos que se están considerando para el cálculo. Ejemplo: "$event. Status.String='Good'". Opcional. |
|
| interpolation |
La variable categórica solo admite la interpolación de "paso". |
|
| kind |
string:
categorical |
Los valores permitidos "kind" son: "numeric" o "aggregate". Aunque "numeric" permite especificar el valor de la señal reconstruida y la expresión para agregarlas, el tipo "aggregate" le permite agregar directamente en las propiedades del evento sin especificar el valor. |
| value |
La expresión de serie temporal de valor se usa para representar el valor de la señal que se va a clasificar. Solo se puede evaluar el tipo "String" o "Long" para las variables categóricas. |
DateTimeRange
Intervalo de tiempo. No puede ser null o negativo.
| Nombre | Tipo | Description |
|---|---|---|
| from |
string |
Marca de tiempo de inicio del intervalo de tiempo. La marca de tiempo de inicio es inclusiva cuando se usa en las solicitudes de consulta de serie temporal. Se incluyen eventos que tienen esta marca de tiempo. |
| to |
string |
Marca de tiempo de finalización del intervalo de tiempo. La marca de tiempo de finalización es exclusiva cuando se usa en las solicitudes de consulta de serie temporal. Los eventos que coinciden con esta marca de tiempo se excluyen. Tenga en cuenta que la marca de tiempo final es inclusiva cuando la devuelve Get Availability (lo que significa que hay un evento con esta marca de tiempo exacta de "a"). |
EventProperty
Propiedad de un evento que se almacena o calcula. Las propiedades se identifican por nombre y tipo. Los distintos eventos pueden tener propiedades con el mismo nombre, pero un tipo diferente.
| Nombre | Tipo | Description |
|---|---|---|
| name |
string |
Nombre de la propiedad. |
| type |
Tipo de la propiedad. |
GetEvents
Obtener consulta de eventos. Permite recuperar eventos sin procesar para un identificador de serie temporal y un intervalo de búsqueda determinado.
| Nombre | Tipo | Description |
|---|---|---|
| filter |
Filtro de nivel superior opcional para la consulta que se aplicará a todas las variables de la consulta. Ejemplo: "$event. Status.String='Good'". Puede ser NULL. |
|
| projectedProperties |
Las propiedades proyectadas son una matriz de propiedades que desea proyectar. Estas propiedades deben aparecer en los eventos; de lo contrario, no se devuelven. |
|
| searchSpan |
Intervalo de tiempo en el que se ejecuta la consulta. No puede ser NULL. |
|
| take |
integer |
Número máximo de valores de propiedad en todo el conjunto de respuestas, no el número máximo de valores de propiedad por página. El valor predeterminado es 10 000 cuando no se establece. El valor máximo de toma puede ser 250 000. |
| timeSeriesId |
Time |
Valor de identificador de serie temporal único que identifica de forma única una única instancia de serie temporal (por ejemplo, un dispositivo). Tenga en cuenta que un único identificador de serie temporal se puede componer si se especifican varias propiedades como id. de serie temporal en el momento de la creación del entorno. La posición y el tipo de valores deben coincidir con las propiedades de id. de serie temporal especificadas en el entorno y devueltas por Get Model Setting API. No puede ser NULL. |
GetSeries
Obtener consulta de serie. Permite recuperar series temporales de valores de variable calculados de eventos para un determinado identificador de serie temporal y un intervalo de búsqueda.
| Nombre | Tipo | Description |
|---|---|---|
| filter |
Filtro de nivel superior sobre los eventos que restringen el número de eventos que se están considerando para el cálculo. Este filtro es AND'ed con filtro en cada variable. Ejemplo: "$event. Status.String='Good'". Opcional. |
|
| inlineVariables |
object |
Variables insertadas opcionales aparte de las ya definidas en el tipo de serie temporal del modelo. Cuando el nombre de la variable insertada es el mismo nombre que en el modelo, la definición de variable insertada tiene prioridad. Puede ser NULL. |
| projectedVariables |
string[] |
Variables seleccionadas que deben proyectarse en el resultado de la consulta. Cuando es null o no se establece, se devuelven todas las variables de inlineVariables y el tipo de serie temporal del modelo. Puede ser NULL. |
| searchSpan |
Intervalo de tiempo en el que se ejecuta la consulta. No puede ser NULL. |
|
| take |
integer |
Número máximo de valores de propiedad en todo el conjunto de respuestas, no el número máximo de valores de propiedad por página. El valor predeterminado es 10 000 cuando no se establece. El valor máximo de toma puede ser 250 000. |
| timeSeriesId |
Time |
Valor de identificador de serie temporal único que identifica de forma única una única instancia de serie temporal (por ejemplo, un dispositivo). Tenga en cuenta que un único identificador de serie temporal se puede componer si se especifican varias propiedades como id. de serie temporal en el momento de la creación del entorno. La posición y el tipo de valores deben coincidir con las propiedades de id. de serie temporal especificadas en el entorno y devueltas por Get Model Setting API. No puede ser NULL. |
Interpolation
Operación de interpolación que se va a realizar en los puntos de datos sin procesar. Actualmente, solo se permite el muestreo de series temporales interpoladas. Función de agregado permitida: por ejemplo: left($value). Puede ser null si no es necesario aplicar ninguna interpolación.
| Nombre | Tipo | Description |
|---|---|---|
| boundary |
Intervalo de tiempo a la izquierda y a la derecha del intervalo de búsqueda que se va a usar para interpolación. Esto resulta útil en escenarios en los que faltan puntos de datos cerca del inicio o final del intervalo de búsqueda de entrada. Puede ser NULL. |
|
| kind |
Tipo de técnica de interpolación: "Lineal" o "Paso". |
InterpolationKind
Tipo de técnica de interpolación: "Lineal" o "Paso".
| Nombre | Tipo | Description |
|---|---|---|
| Linear |
string |
|
| Step |
string |
NumericVariable
La variable numérica representa una única señal numérica continua que se puede reconstruir mediante la interpolación.
| Nombre | Tipo | Description |
|---|---|---|
| aggregation |
Expresión de serie temporal de agregación cuando el tipo es "numérico" se usa para representar la agregación que se debe realizar en la expresión $value. Esto requiere que se especifique $value y solo puede usar $value dentro de las funciones de agregado. Por ejemplo, la agregación para calcular el mínimo del $value se escribe como: "min($value)". |
|
| filter |
Filtre por los eventos que restringen el número de eventos que se están considerando para el cálculo. Ejemplo: "$event. Status.String='Good'". Opcional. |
|
| interpolation |
Operación de interpolación que se va a realizar en los puntos de datos sin procesar. Actualmente, solo se permite el muestreo de series temporales interpoladas. Función de agregado permitida: por ejemplo: left($value). Puede ser null si no es necesario aplicar ninguna interpolación. |
|
| kind |
string:
numeric |
Los valores permitidos "kind" son: "numeric" o "aggregate". Aunque "numeric" permite especificar el valor de la señal reconstruida y la expresión para agregarlas, el tipo "aggregate" le permite agregar directamente en las propiedades del evento sin especificar el valor. |
| value |
La expresión de serie temporal de valor se usa para representar el valor de la señal que se va a agregar o interpolar. Por ejemplo, los valores de temperatura del evento se representan de la siguiente manera: "$event. Temperature.Double". |
PropertyTypes
Tipo de la propiedad.
| Nombre | Tipo | Description |
|---|---|---|
| Bool |
string |
|
| DateTime |
string |
|
| Double |
string |
|
| Long |
string |
|
| String |
string |
|
| TimeSpan |
string |
PropertyValues
Valores de una sola propiedad correspondiente a las marcas de tiempo. Puede contener valores NULL. El tipo de valores coincide con el tipo de propiedad.
| Nombre | Tipo | Description |
|---|---|---|
| name |
string |
Nombre de la propiedad. |
| type |
Tipo de la propiedad. |
|
| values |
Values[] |
Valores de una sola propiedad correspondiente a las marcas de tiempo. Puede contener valores NULL. El tipo de valores coincide con el tipo de propiedad. |
QueryRequest
Solicitud para ejecutar una consulta de serie temporal a través de eventos. Se debe establecer exactamente uno de los elementos "getEvents", "getSeries" o "aggregateSeries".
| Nombre | Tipo | Description |
|---|---|---|
| aggregateSeries |
Consulta de series de agregados. Permite calcular una serie temporal agregada a partir de eventos para un determinado identificador de serie temporal y un intervalo de búsqueda. |
|
| getEvents |
Obtener consulta de eventos. Permite recuperar eventos sin procesar para un identificador de serie temporal y un intervalo de búsqueda determinado. |
|
| getSeries |
Obtener consulta de serie. Permite recuperar series temporales de valores de variable calculados de eventos para un determinado identificador de serie temporal y un intervalo de búsqueda. |
QueryResultPage
Una sola página de resultados de la consulta. Si la consulta aún no ha finalizado, se establecerá un token de continuación en una página. En este caso, para obtener la siguiente página de resultados, envíe de nuevo la misma solicitud con el parámetro de token de continuación. Si se ha completado la consulta, el token de continuación es NULL. También es posible obtener una página vacía con solo el token de continuación establecido cuando aún no se han calculado resultados de consulta. Si la paginación se ha completado (el token de continuación es NULL), las marcas de tiempo y las propiedades pueden estar vacías si no hay datos que devolver.
| Nombre | Tipo | Description |
|---|---|---|
| continuationToken |
string |
Si se devuelve, esto significa que los resultados actuales representan un resultado parcial. El token de continuación permite obtener la siguiente página de resultados. Para obtener la siguiente página de resultados de la consulta, envíe la misma solicitud con el parámetro de token de continuación en el encabezado HTTP "x-ms-continuation". |
| progress |
number |
Progreso aproximado de la consulta en porcentaje. Puede estar entre 0 y 100. Cuando el token de continuación de la respuesta es NULL, se espera que el progreso sea 100. |
| properties |
Colección de propiedades y valores de serie temporal para cada una de las marcas de tiempo. Puede ser null si el servidor no pudo rellenar la página en esta solicitud o puede estar vacío si no hay más objetos cuando el token de continuación es NULL. |
|
| timestamps |
string[] |
Marcas de tiempo de los valores de la serie temporal. Si se usa una agregación sobre intervalos, las marcas de tiempo representan el inicio de los intervalos correspondientes. Si se recuperan eventos, las marcas de tiempo son valores de marca de tiempo $ts propiedad de eventos. Puede ser null si el servidor no pudo rellenar la página en esta solicitud o puede estar vacío si no hay más objetos cuando el token de continuación es NULL. |
TimeSeriesAggregateCategory
Categoría usada en variables categóricas. Una categoría se define mediante "label" y los "valores" asignados a esta etiqueta.
| Nombre | Tipo | Description |
|---|---|---|
| label |
string |
Nombre de la categoría que se usará para construir los nombres de variable de salida. |
| values |
object[] |
Lista de valores a los que se asigna una categoría. Puede ser una lista única de cadenas o una lista de long. |
TimeSeriesDefaultCategory
Representa la categoría predeterminada.
| Nombre | Tipo | Description |
|---|---|---|
| label |
string |
Nombre de la categoría predeterminada que se asignará a los valores que no coinciden con ninguno de los definidos en las "categorías". |
TsiError
Información sobre un error de API.
| Nombre | Tipo | Description |
|---|---|---|
| error |
Un error de API determinado con un código de error y un mensaje. |
TsiErrorBody
Un error de API determinado con un código de error y un mensaje.
| Nombre | Tipo | Description |
|---|---|---|
| code |
string |
Cadena legible e independiente del lenguaje que define un código de error específico del servicio. Este código actúa como un indicador más específico para el código de error HTTP especificado en la respuesta. Se puede usar para controlar mediante programación casos de error específicos. |
| details |
Contiene información de error adicional. Su valor puede ser null. |
|
| innerError |
Contiene un error más específico que limita la causa. Su valor puede ser null. |
|
| message |
string |
Representación independiente del idioma y legible del error. Está pensado como ayuda para los desarrolladores y no es adecuado para la exposición a los usuarios finales. |
| target |
string |
Destino del error determinado (por ejemplo, el nombre de la propiedad en error). Su valor puede ser null. |
TsiErrorDetails
Información adicional de error.
| Nombre | Tipo | Description |
|---|---|---|
| code |
string |
Cadena legible e independiente del lenguaje que define un código de error específico del servicio. Este código actúa como un indicador más específico para el código de error HTTP especificado en la respuesta. Se puede usar para controlar mediante programación casos de error específicos. |
| message |
string |
Representación independiente del idioma y legible del error. Está pensado como ayuda para los desarrolladores y no es adecuado para la exposición a los usuarios finales. |
Tsx
Expresión de serie temporal (TSX) escrita como una sola cadena. Ejemplos: "$event. Status.String='Good'", "avg($event. Temperatura)". Consulte la documentación sobre cómo escribir expresiones de serie temporal.
| Nombre | Tipo | Description |
|---|---|---|
| tsx |
string |
Expresión de serie temporal (TSX) escrita como una sola cadena. Ejemplos: "$event. Status.String='Good'", "avg($event. Temperatura)". Consulte la documentación sobre cómo escribir expresiones de serie temporal. |