Query - Execute

  • Referentie
Service:
Time Series Insights
API Version:
2020-07-31

Hiermee wordt een Time Series-query uitgevoerd op pagina's met resultaten : Gebeurtenissen ophalen, Reeks ophalen of Statistische reeks.

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

URI-parameters

Name In Vereist Type Description
environmentFqdn
 path True

string

FQDN per omgeving, bijvoorbeeld 10000000-0000-0000-0000-100000000109.env.timeseries.azure.com. U kunt deze domeinnaam verkrijgen uit het antwoord van de API Omgevingen ophalen, Azure Portal of Azure Resource Manager.
api-version
 query True

string

Versie van de API die moet worden gebruikt met de clientaanvraag. De momenteel ondersteunde versie is 2020-07-31.
storeType
 query

string

Voor de omgevingen waarvoor warm opslaan is ingeschakeld, kan de query worden uitgevoerd op de 'WarmStore' of 'ColdStore'. Deze parameter in de query definieert op welk archief de query moet worden uitgevoerd. Als deze niet is gedefinieerd, wordt de query uitgevoerd in de koelopslag.

Aanvraagkoptekst

Name Vereist Type Description
x-ms-continuation

string

Vervolgtoken van de vorige pagina met resultaten om de volgende pagina van de resultaten op te halen in aanroepen die paginering ondersteunen. Als u de resultaten van de eerste pagina wilt ophalen, geeft u het null-vervolgtoken op als parameterwaarde. Het geretourneerde vervolgtoken is null als alle resultaten zijn geretourneerd en er geen volgende pagina met resultaten is.
x-ms-client-request-id

string

Optionele clientaanvraag-id. Service registreert deze waarde. Hiermee kan de service de bewerking tussen services traceren en kan de klant contact opnemen met ondersteuning met betrekking tot een bepaalde aanvraag.
x-ms-client-session-id

string

Optionele clientsessie-id. Service registreert deze waarde. Hiermee kan de service een groep gerelateerde bewerkingen in verschillende services traceren en kan de klant contact opnemen met de ondersteuning voor een bepaalde groep aanvragen.

Aanvraagbody

Name Type Description
aggregateSeries

AggregateSeries

Query voor statistische reeks. Hiermee kunt u een geaggregeerde tijdreeks berekenen op basis van gebeurtenissen voor een bepaalde tijdreeks-id en zoekbereik.
getEvents

GetEvents

Query Gebeurtenissen ophalen. Hiermee kunnen onbewerkte gebeurtenissen voor een bepaalde tijdreeks-id en zoekbereik worden opgehaald.
getSeries

GetSeries

Reeksquery ophalen. Hiermee kunt u tijdreeksen van berekende variabelewaarden ophalen uit gebeurtenissen voor een bepaalde tijdreeks-id en zoekbereik.

Antwoorden

Name Type Description
200 OK

QueryResultPage

Geslaagde query.

Headers

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

TsiError

Onverwachte fout.

Headers

x-ms-request-id: string

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

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

Scopes

Name Description
user_impersonation Uw gebruikersaccount imiteren

Voorbeelden

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

ColdStoreQueryAggregateSeriesPage1

Sample Request

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

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

Sample Response

Status code:
200 
{
  "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

Status code:
200 
{
  "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

Status code:
200 
{
  "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

Status code:
200 
{
  "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

Status code:
200 
{
  "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

Status code:
200 
{
  "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

Status code:
200 
{
  "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

Status code:
200 
{
  "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

Status code:
200 
{
  "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

Status code:
200 
{
  "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

Status code:
200 
{
  "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

Status code:
200 
{
  "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

Status code:
200 
{
  "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

Status code:
200 
{
  "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

Status code:
200 
{
  "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

Status code:
200 
{
  "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

Status code:
200 
{
  "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

Status code:
200 
{
  "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

Status code:
200 
{
  "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

Status code:
200 
{
  "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

Status code:
200 
{
  "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

Status code:
200 
{
  "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

Status code:
200 
{
  "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

Status code:
200 
{
  "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

Status code:
200 
{
  "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

Status code:
200 
{
  "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

Status code:
200 
{
  "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

Status code:
200 
{
  "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

Status code:
200 
{
  "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

Status code:
200 
{
  "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

Status code:
200 
{
  "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

Status code:
200 
{
  "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

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

Definities

Name Description
AggregateSeries

Query voor statistische reeks. Hiermee kunt u een geaggregeerde tijdreeks berekenen op basis van gebeurtenissen voor een bepaalde tijdreeks-id en zoekbereik.
AggregateVariable

Statistische variabele vertegenwoordigt elke aggregatieberekening. Statistische variabelen bieden geen ondersteuning voor interpolatie.
Boundary

Het tijdsbereik links en rechts van het zoekbereik dat moet worden gebruikt voor interpolatie. Dit is handig in scenario's waarin de gegevenspunten dicht bij het begin of einde van het zoekbereik voor invoer ontbreken. Kan null zijn.
CategoricalVariable

Categorische variabele vertegenwoordigt een signaal dat moet worden geanalyseerd op basis van het aantal of de duur van het optreden van een beperkte set gedefinieerde waarden.
DateTimeRange

Het tijdsbereik. Kan niet null of negatief zijn.
EventProperty

Eigenschap van een gebeurtenis die wordt opgeslagen of berekend. Eigenschappen worden geïdentificeerd door zowel de naam als het type. Verschillende gebeurtenissen kunnen eigenschappen hebben met dezelfde naam, maar met een ander type.
GetEvents

Query Gebeurtenissen ophalen. Hiermee kunnen onbewerkte gebeurtenissen voor een bepaalde tijdreeks-id en zoekbereik worden opgehaald.
GetSeries

Reeksquery ophalen. Hiermee kunt u tijdreeksen van berekende variabelewaarden ophalen uit gebeurtenissen voor een bepaalde tijdreeks-id en zoekbereik.
Interpolation

De interpolatiebewerking die moet worden uitgevoerd op de onbewerkte gegevenspunten. Momenteel is alleen steekproeven van geïnterpoleerde tijdreeksen toegestaan. Toegestane statistische functie - bijvoorbeeld: left($value). Kan null zijn als er geen interpolatie hoeft te worden toegepast.
InterpolationKind

Het type interpolatietechniek: "Lineair" of "Stap".
NumericVariable

De numerieke variabele vertegenwoordigt één doorlopend numeriek signaal dat kan worden gereconstrueerd met behulp van interpolatie.
PropertyTypes

Het type van de eigenschap.
PropertyValues

Waarden van één eigenschap die overeenkomt met de tijdstempels. Kan null-waarden bevatten. Het type waarden komt overeen met het type eigenschap.
QueryRequest

Aanvraag om een tijdreeksquery uit te voeren op gebeurtenissen. Er moet precies een van 'getEvents', 'getSeries' of 'aggregateSeries' zijn ingesteld.
QueryResultPage

Eén pagina met queryresultaten. Als de query nog niet is voltooid, is op een pagina een vervolgtoken ingesteld. In dit geval verzendt u dezelfde aanvraag opnieuw met de parameter vervolgtoken om de volgende pagina met resultaten op te halen. Als de query is voltooid, is het vervolgtoken null. Het is ook mogelijk om een lege pagina op te halen met alleen een vervolgtokenset wanneer er nog geen queryresultaten zijn berekend. Als paging is voltooid (vervolgtoken is null), kunnen tijdstempels en eigenschappen leeg zijn als er geen gegevens zijn om te retourneren.
TimeSeriesAggregateCategory

Categorie die wordt gebruikt in categorische variabelen. Een categorie wordt gedefinieerd door 'label' en de 'waarden' waaraan dit label is toegewezen.
TimeSeriesDefaultCategory

Vertegenwoordigt de standaardcategorie.
TsiError

Informatie over een API-fout.
TsiErrorBody

Een bepaalde API-fout met een foutcode en een bericht.
TsiErrorDetails

Aanvullende foutinformatie.
Tsx

Time Series Expression (TSX) geschreven als één tekenreeks. Voorbeelden: '$event. Status.String='Good'", "avg($event. Temperatuur)'. Raadpleeg de documentatie over het schrijven van tijdreeksexpressies.

AggregateSeries

Query voor statistische reeks. Hiermee kunt u een geaggregeerde tijdreeks berekenen op basis van gebeurtenissen voor een bepaalde tijdreeks-id en zoekbereik.

Name Type Description
filter

Tsx

Filter op het hoogste niveau op de gebeurtenissen die het aantal gebeurtenissen beperken dat in aanmerking komt voor berekeningen. Dit filter is AND'ed met filter in elke variabele. Voorbeeld: '$event. Status.String='Good'". Optioneel.
inlineVariables

object

Hierdoor kan de gebruiker optioneel inlinevariabelen definiëren, afgezien van de variabelen die al in het model zijn gedefinieerd. Wanneer de namen van de inlinevariabelen dezelfde naam hebben als het model, heeft de definitie van de inlinevariabele voorrang. Kan null zijn.
interval

string

Intervalgrootte wordt opgegeven in de iso-8601-duurnotatie. Alle intervallen hebben dezelfde grootte. Eén maand wordt altijd geconverteerd naar 30 dagen en één jaar is altijd 365 dagen. Voorbeelden: 1 minuut is 'PT1M', 1 milliseconde is 'PT0.001S'. Zie https://www.w3.org/TR/xmlschema-2/#duration voor meer informatie
projectedVariables

string[]

Hiermee kan de gebruiker desgewenst de variabelen selecteren die moeten worden geprojecteerd. Wanneer deze null is of niet is ingesteld, worden alle variabelen van inlineVariables en het model geretourneerd. Kan null zijn.
searchSpan

DateTimeRange

Het tijdsbereik waarop de query wordt uitgevoerd. Kan niet null zijn.
timeSeriesId

TimeSeriesId[]

Een enkele Time Series-id-waarde die een uniek exemplaar van één tijdreeks identificeert (bijvoorbeeld een apparaat). Houd er rekening mee dat één Time Series-id kan worden samengesteld als meerdere eigenschappen zijn opgegeven als Tijdreeks-id tijdens het maken van de omgeving. De positie en het type waarden moeten overeenkomen met de eigenschappen van de Tijdreeks-id die zijn opgegeven in de omgeving en worden geretourneerd door de API voor modelinstellingen ophalen. Kan niet null zijn.

AggregateVariable

Statistische variabele vertegenwoordigt elke aggregatieberekening. Statistische variabelen bieden geen ondersteuning voor interpolatie.

Name Type Description
aggregation

Tsx

Expressie van aggregatietijdreeksen wanneer soort 'aggregatie' is, wordt gebruikt om de aggregatie aan te geven die rechtstreeks moet worden uitgevoerd met behulp van gebeurteniseigenschappen zoals '$event. Temperatuur'. Aggregatie voor het berekenen van het bereik van temperatuurwijzigingen kan bijvoorbeeld worden geschreven als: 'max($event. Temperatuur)-min($event. Temperatuur)'.
filter

Tsx

Filter op de gebeurtenissen die het aantal gebeurtenissen beperken dat in aanmerking komt voor berekening. Voorbeeld: '$event. Status.String='Good'". Optioneel.
kind string:

aggregate

Toegestane 'soort'-waarden zijn - 'numeriek' of 'aggregaat'. Hoewel u met 'numeriek' de waarde van het gereconstrueerde signaal en de expressie kunt opgeven om deze samen te voegen, kunt u met het type 'aggregatie' rechtstreeks aggregeren op de gebeurteniseigenschappen zonder waarde op te geven.

Boundary

Het tijdsbereik links en rechts van het zoekbereik dat moet worden gebruikt voor interpolatie. Dit is handig in scenario's waarin de gegevenspunten dicht bij het begin of einde van het zoekbereik voor invoer ontbreken. Kan null zijn.

Name Type Description
span

string

CategoricalVariable

Categorische variabele vertegenwoordigt een signaal dat moet worden geanalyseerd op basis van het aantal of de duur van het optreden van een beperkte set gedefinieerde waarden.

Name Type Description
categories

TimeSeriesAggregateCategory[]

Categorie die wordt gebruikt in categorische variabelen. Een categorie wordt gedefinieerd door 'label' en de 'waarden' waaraan dit label is toegewezen.
defaultCategory

TimeSeriesDefaultCategory

Vertegenwoordigt de standaardcategorie.
filter

Tsx

Filter op de gebeurtenissen die het aantal gebeurtenissen beperken dat in aanmerking komt voor berekening. Voorbeeld: '$event. Status.String='Good'". Optioneel.
interpolation

Interpolation

Categorische variabele ondersteunt alleen 'stapinterpolatie'.
kind string:

categorical

Toegestane 'soort'-waarden zijn - 'numeriek' of 'aggregaat'. Hoewel u met 'numeriek' de waarde van het gereconstrueerde signaal en de expressie kunt opgeven om deze samen te voegen, kunt u met het type 'aggregatie' rechtstreeks aggregeren op de gebeurteniseigenschappen zonder waarde op te geven.
value

Tsx

De expressie waardetijdreeks wordt gebruikt om de waarde weer te geven van het signaal dat wordt gecategoriseerd. Het kan alleen het type 'Tekenreeks' of 'Lang' voor categorische variabelen evalueren.

DateTimeRange

Het tijdsbereik. Kan niet null of negatief zijn.

Name Type Description
from

string

Begintijdstempel van het tijdsbereik. Start timestamp is inclusief wanneer deze wordt gebruikt in aanvragen voor tijdreeksquery's. Gebeurtenissen met deze tijdstempel worden opgenomen.
to

string

Eindtijdstempel van het tijdsbereik. Eindtijdstempel is exclusief wanneer deze wordt gebruikt in aanvragen voor tijdreeksquery's. Gebeurtenissen die overeenkomen met deze tijdstempel worden uitgesloten. Houd er rekening mee dat eindtijdstempel inclusief is wanneer deze wordt geretourneerd door Beschikbaarheid ophalen (wat betekent dat er een gebeurtenis is met dit exacte 'naar'-tijdstempel).

EventProperty

Eigenschap van een gebeurtenis die wordt opgeslagen of berekend. Eigenschappen worden geïdentificeerd door zowel de naam als het type. Verschillende gebeurtenissen kunnen eigenschappen hebben met dezelfde naam, maar met een ander type.

Name Type Description
name

string

De naam van de eigenschap.
type

PropertyTypes

Het type van de eigenschap.

GetEvents

Query Gebeurtenissen ophalen. Hiermee kunnen onbewerkte gebeurtenissen voor een bepaalde tijdreeks-id en zoekbereik worden opgehaald.

Name Type Description
filter

Tsx

Optioneel filter op het hoogste niveau voor de query dat wordt toegepast op alle variabelen in de query. Voorbeeld: '$event. Status.String='Good'". Kan null zijn.
projectedProperties

EventProperty[]

Geprojecteerde eigenschappen is een matrix met eigenschappen die u wilt projecteren. Deze eigenschappen moeten worden weergegeven in de gebeurtenissen; anders worden ze niet geretourneerd.
searchSpan

DateTimeRange

Het tijdsbereik waarop de query wordt uitgevoerd. Kan niet null zijn.
take

integer

Maximum aantal eigenschapswaarden in de volledige antwoordset, niet het maximum aantal eigenschapswaarden per pagina. De standaardwaarde is 10.000 als dit niet is ingesteld. De maximale waarde van de take kan 250.000 zijn.
timeSeriesId

TimeSeriesId[]

Een enkele Time Series-id-waarde die een uniek exemplaar van één tijdreeks identificeert (bijvoorbeeld een apparaat). Houd er rekening mee dat één Time Series-id kan worden samengesteld als meerdere eigenschappen zijn opgegeven als Tijdreeks-id tijdens het maken van de omgeving. De positie en het type waarden moeten overeenkomen met de eigenschappen van de Tijdreeks-id die zijn opgegeven in de omgeving en worden geretourneerd door de API voor modelinstellingen ophalen. Kan niet null zijn.

GetSeries

Reeksquery ophalen. Hiermee kunt u tijdreeksen van berekende variabelewaarden ophalen uit gebeurtenissen voor een bepaalde tijdreeks-id en zoekbereik.

Name Type Description
filter

Tsx

Filter op het hoogste niveau op de gebeurtenissen die het aantal gebeurtenissen beperken dat in aanmerking komt voor berekeningen. Dit filter is AND'ed met filter in elke variabele. Voorbeeld: '$event. Status.String='Good'". Optioneel.
inlineVariables

object

Optionele inlinevariabelen, afgezien van de variabelen die al zijn gedefinieerd in het tijdreekstype in het model. Wanneer de naam van de inlinevariabele dezelfde naam heeft als in het model, heeft de definitie van de inlinevariabele voorrang. Kan null zijn.
projectedVariables

string[]

Geselecteerde variabelen die moeten worden geprojecteerd in het queryresultaat. Wanneer deze null is of niet is ingesteld, worden alle variabelen van inlineVariables en het tijdreekstype in het model geretourneerd. Kan null zijn.
searchSpan

DateTimeRange

Het tijdsbereik waarop de query wordt uitgevoerd. Kan niet null zijn.
take

integer

Maximum aantal eigenschapswaarden in de volledige antwoordset, niet het maximum aantal eigenschapswaarden per pagina. De standaardwaarde is 10.000 als dit niet is ingesteld. De maximale waarde van de take kan 250.000 zijn.
timeSeriesId

TimeSeriesId[]

Een enkele Time Series-id-waarde die een uniek exemplaar van één tijdreeks identificeert (bijvoorbeeld een apparaat). Houd er rekening mee dat één Time Series-id kan worden samengesteld als meerdere eigenschappen zijn opgegeven als Tijdreeks-id tijdens het maken van de omgeving. De positie en het type waarden moeten overeenkomen met de eigenschappen van de Tijdreeks-id die zijn opgegeven in de omgeving en worden geretourneerd door de API voor modelinstellingen ophalen. Kan niet null zijn.

Interpolation

De interpolatiebewerking die moet worden uitgevoerd op de onbewerkte gegevenspunten. Momenteel is alleen steekproeven van geïnterpoleerde tijdreeksen toegestaan. Toegestane statistische functie - bijvoorbeeld: left($value). Kan null zijn als er geen interpolatie hoeft te worden toegepast.

Name Type Description
boundary

Boundary

Het tijdsbereik links en rechts van het zoekbereik dat moet worden gebruikt voor interpolatie. Dit is handig in scenario's waarin de gegevenspunten dicht bij het begin of einde van het zoekbereik voor invoer ontbreken. Kan null zijn.
kind

InterpolationKind

Het type interpolatietechniek: "Lineair" of "Stap".

InterpolationKind

Het type interpolatietechniek: "Lineair" of "Stap".

Name Type Description
Linear

string

Step

string

NumericVariable

De numerieke variabele vertegenwoordigt één doorlopend numeriek signaal dat kan worden gereconstrueerd met behulp van interpolatie.

Name Type Description
aggregation

Tsx

Aggregatietijdreeksexpressie wanneer soort 'numeriek' is, wordt gebruikt om de aggregatie weer te geven die moet worden uitgevoerd op de $value-expressie. Hiervoor moet $value worden opgegeven en kan alleen $value in de statistische functies worden gebruikt. Aggregatie voor het berekenen van het minimum van de $value wordt bijvoorbeeld geschreven als: 'min($value)'.
filter

Tsx

Filter op de gebeurtenissen die het aantal gebeurtenissen beperken dat in aanmerking komt voor berekening. Voorbeeld: '$event. Status.String='Good'". Optioneel.
interpolation

Interpolation

De interpolatiebewerking die moet worden uitgevoerd op de onbewerkte gegevenspunten. Momenteel is alleen steekproeven van geïnterpoleerde tijdreeksen toegestaan. Toegestane statistische functie - bijvoorbeeld: left($value). Kan null zijn als er geen interpolatie hoeft te worden toegepast.
kind string:

numeric

Toegestane 'soort'-waarden zijn - 'numeriek' of 'aggregaat'. Hoewel u met 'numeriek' de waarde van het gereconstrueerde signaal en de expressie kunt opgeven om deze samen te voegen, kunt u met het type 'aggregatie' rechtstreeks aggregeren op de gebeurteniseigenschappen zonder waarde op te geven.
value

Tsx

Expressie voor waardetijdreeksen wordt gebruikt om de waarde weer te geven van het signaal dat wordt geaggregeerd of geïnterpoleerd. Temperatuurwaarden van de gebeurtenis worden bijvoorbeeld als volgt weergegeven: '$event. Temperature.Double'.

PropertyTypes

Het type van de eigenschap.

Name Type Description
Bool

string

DateTime

string

Double

string

Long

string

String

string

TimeSpan

string

PropertyValues

Waarden van één eigenschap die overeenkomt met de tijdstempels. Kan null-waarden bevatten. Het type waarden komt overeen met het type eigenschap.

Name Type Description
name

string

De naam van de eigenschap.
type

PropertyTypes

Het type van de eigenschap.
values

Values[]

Waarden van één eigenschap die overeenkomt met de tijdstempels. Kan null-waarden bevatten. Het type waarden komt overeen met het type eigenschap.

QueryRequest

Aanvraag om een tijdreeksquery uit te voeren op gebeurtenissen. Er moet precies een van 'getEvents', 'getSeries' of 'aggregateSeries' zijn ingesteld.

Name Type Description
aggregateSeries

AggregateSeries

Query voor statistische reeks. Hiermee kunt u een geaggregeerde tijdreeks berekenen op basis van gebeurtenissen voor een bepaalde tijdreeks-id en zoekbereik.
getEvents

GetEvents

Query Gebeurtenissen ophalen. Hiermee kunnen onbewerkte gebeurtenissen voor een bepaalde tijdreeks-id en zoekbereik worden opgehaald.
getSeries

GetSeries

Reeksquery ophalen. Hiermee kunt u tijdreeksen van berekende variabelewaarden ophalen uit gebeurtenissen voor een bepaalde tijdreeks-id en zoekbereik.

QueryResultPage

Eén pagina met queryresultaten. Als de query nog niet is voltooid, is op een pagina een vervolgtoken ingesteld. In dit geval verzendt u dezelfde aanvraag opnieuw met de parameter vervolgtoken om de volgende pagina met resultaten op te halen. Als de query is voltooid, is het vervolgtoken null. Het is ook mogelijk om een lege pagina op te halen met alleen een vervolgtokenset wanneer er nog geen queryresultaten zijn berekend. Als paging is voltooid (vervolgtoken is null), kunnen tijdstempels en eigenschappen leeg zijn als er geen gegevens zijn om te retourneren.

Name Type Description
continuationToken

string

Als dit wordt geretourneerd, betekent dit dat de huidige resultaten een gedeeltelijk resultaat vertegenwoordigen. Met het vervolgtoken kunt u de volgende pagina met resultaten ophalen. Als u de volgende pagina met queryresultaten wilt ophalen, verzendt u dezelfde aanvraag met de parameter voor het vervolgtoken in de HTTP-header 'x-ms-continuation'.
progress

number

Geschatte voortgang van de query in percentage. Dit kan tussen 0 en 100 zijn. Wanneer het vervolgtoken in het antwoord null is, wordt verwacht dat de voortgang 100 is.
properties

PropertyValues[]

Verzameling van tijdreekseigenschappen en -waarden voor elk van de tijdstempels. Kan null zijn als de server de pagina in deze aanvraag niet kan vullen, of kan leeg zijn als er geen objecten meer zijn wanneer het vervolgtoken null is.
timestamps

string[]

De tijdstempels van de waarden van de tijdreeks. Als een aggregatie over intervallen wordt gebruikt, vertegenwoordigen tijdstempels het begin van de bijbehorende intervallen. Als gebeurtenissen worden opgehaald, zijn tijdstempels waarden van timestamp $ts eigenschap van gebeurtenissen. Kan null zijn als de server de pagina in deze aanvraag niet kan vullen, of kan leeg zijn als er geen objecten meer zijn wanneer het vervolgtoken null is.

TimeSeriesAggregateCategory

Categorie die wordt gebruikt in categorische variabelen. Een categorie wordt gedefinieerd door 'label' en de 'waarden' waaraan dit label is toegewezen.

Name Type Description
label

string

De naam van de categorie die wordt gebruikt bij het samenstellen van de namen van de uitvoervariabelen.
values

object[]

De lijst met waarden waaraan een categorie wordt toegewezen. Kan een unieke lijst met tekenreeksen of een lange lijst zijn.

TimeSeriesDefaultCategory

Vertegenwoordigt de standaardcategorie.

Name Type Description
label

string

De naam van de standaardcategorie die wordt toegewezen aan de waarden die niet overeenkomen met de waarden die zijn gedefinieerd in de 'categorieën'.

TsiError

Informatie over een API-fout.

Name Type Description
error

TsiErrorBody

Een bepaalde API-fout met een foutcode en een bericht.

TsiErrorBody

Een bepaalde API-fout met een foutcode en een bericht.

Name Type Description
code

string

Taalonafhankelijke, door mensen leesbare tekenreeks die een servicespecifieke foutcode definieert. Deze code fungeert als een specifiekere indicator voor de HTTP-foutcode die is opgegeven in het antwoord. Kan worden gebruikt voor het programmatisch afhandelen van specifieke foutgevallen.
details

TsiErrorDetails[]

Bevat aanvullende foutinformatie. Kan null zijn.
innerError

TsiErrorBody

Bevat een specifiekere fout die de oorzaak beperkt. Kan null zijn.
message

string

Door mensen leesbare, taalonafhankelijke weergave van de fout. Het is bedoeld als hulpmiddel voor ontwikkelaars en is niet geschikt voor blootstelling aan eindgebruikers.
target

string

Doel van de specifieke fout (bijvoorbeeld de naam van de eigenschap fout). Kan null zijn.

TsiErrorDetails

Aanvullende foutinformatie.

Name Type Description
code

string

Taalonafhankelijke, door mensen leesbare tekenreeks die een servicespecifieke foutcode definieert. Deze code fungeert als een specifiekere indicator voor de HTTP-foutcode die is opgegeven in het antwoord. Kan worden gebruikt voor het programmatisch afhandelen van specifieke foutgevallen.
message

string

Door mensen leesbare, taalonafhankelijke weergave van de fout. Het is bedoeld als hulpmiddel voor ontwikkelaars en is niet geschikt voor blootstelling aan eindgebruikers.

Tsx

Time Series Expression (TSX) geschreven als één tekenreeks. Voorbeelden: '$event. Status.String='Good'", "avg($event. Temperatuur)'. Raadpleeg de documentatie over het schrijven van tijdreeksexpressies.

Name Type Description
tsx

string

Time Series Expression (TSX) geschreven als één tekenreeks. Voorbeelden: '$event. Status.String='Good'", "avg($event. Temperatuur)'. Raadpleeg de documentatie over het schrijven van tijdreeksexpressies.