Time Series Types - List

Referentie

Service:: Time Series Insights

API-versie:: 2020-07-31

Hiermee haalt u tijdreekstypen op in pagina's.

GET https://{environmentFqdn}/timeseries/types?api-version=2020-07-31

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 ophalen uit het antwoord van de Get Environments-API, Azure Portal of Azure Resource Manager.
api-version	query	True	string	Versie van de API die moet worden gebruikt met de clientaanvraag. Momenteel wordt versie 2020-07-31 ondersteund.

Aanvraagkoptekst

Name	Type	Description
x-ms-continuation	string	Vervolgtoken van de vorige pagina met resultaten om de volgende pagina van de resultaten op te halen in oproepen die ondersteuning bieden voor paginering. Als u de resultaten van de eerste pagina wilt ophalen, geeft u 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 de 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 met betrekking tot een bepaalde groep aanvragen.

Antwoorden

Name	Type	Description
200 OK	GetTypesPage	Geslaagde bewerking. Kopteksten x-ms-request-id: string
Other Status Codes	TsiError	Onverwachte fout. Kopteksten x-ms-request-id: string

Name

Type

Description

200 OK

GetTypesPage

Geslaagde bewerking.

Kopteksten

x-ms-request-id: string

Other Status Codes

TsiError

Onverwachte fout.

Kopteksten

x-ms-request-id: string

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

TypesListPage1

TypesListPage2

TypesListPage3

TypesListPage1

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

Statuscode:: 200

{
  "types": [
    {
      "id": "1be09af9-f089-4d6b-9f0b-48018b5f7393",
      "name": "DefaultType",
      "description": "My Default type",
      "variables": {
        "EventCount": {
          "kind": "aggregate",
          "filter": null,
          "aggregation": {
            "tsx": "count()"
          }
        }
      }
    }
  ],
  "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrZSI6MTAwMH0="
}

TypesListPage2

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

Statuscode:: 200

{
  "types": [
    {
      "id": "9b84e946-7b36-4aa0-9d26-71bf48cb2aff",
      "name": "TurbineSensor",
      "description": "Wind turbine sensor",
      "variables": {
        "Value": {
          "kind": "numeric",
          "value": {
            "tsx": "$event.value.Double"
          },
          "aggregation": {
            "tsx": "avg($value)"
          }
        }
      }
    }
  ],
  "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrASI6MTAwMH0="
}

TypesListPage3

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

Statuscode:: 200

{
  "types": []
}

Definities

Name	Description
AggregateVariable	Aggregatievariabele vertegenwoordigt een 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 signaal dat moet worden geanalyseerd op basis van het aantal of de duur van het optreden van een beperkte set gedefinieerde waarden.
GetTypesPage	Gedeeltelijke lijst met tijdreekstypen die in één aanvraag worden geretourneerd.
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 moet worden toegepast.
InterpolationKind	Het type interpolatietechniek: 'Lineair' of 'Stap'.
NumericVariable	Een numerieke variabele vertegenwoordigt één doorlopend numeriek signaal dat kan worden gereconstrueerd met behulp van interpolatie.
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.
TimeSeriesType	Het tijdreekstype definieert variabelen of formules voor het uitvoeren van berekeningen op gebeurtenissen die zijn gekoppeld aan tijdreeksexemplaren. Elke time series-instantie is gekoppeld aan precies één type. Een type kan een of meer variabelen hebben. Een tijdreeksexemplaren kunnen bijvoorbeeld van het type Temperatuursensor zijn, die bestaat uit de variabelen gemiddelde temperatuur, minimumtemperatuur en maximale temperatuur.
TsiError	Informatie over een API-fout.
TsiErrorBody	Een bepaalde API-fout met een foutcode en een bericht.
TsiErrorDetails	Aanvullende foutinformatie.
Tsx	Tijdreeksexpressie (TSX) die als één tekenreeks is geschreven. Voorbeelden: '$event. Status.String='Good', 'avg($event. Temperatuur)". Raadpleeg de documentatie over het schrijven van tijdreeksexpressies.

AggregateVariable

Object

Aggregatievariabele vertegenwoordigt een aggregatieberekening. Statistische variabelen bieden geen ondersteuning voor interpolatie.

Name	Type	Description
aggregation	Tsx	Expressie voor tijdreeksen voor aggregatie wanneer soort 'aggregaat' wordt gebruikt om de aggregatie weer 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 wordt overwogen voor berekeningen. Voorbeeld: '$event. Status.String='Good'". Facultatief.
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 te aggregeren, kunt u met het type 'aggregaat' rechtstreeks aggregeren op de gebeurteniseigenschappen zonder waarde op te geven.

Boundary

Object

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 (duration)

CategoricalVariable

Object

Categorische variabele vertegenwoordigt 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 wordt overwogen voor berekeningen. Voorbeeld: '$event. Status.String='Good'". Facultatief.
interpolation	Interpolation	Categorische variabele ondersteunt alleen 'stap'-interpolatie.
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 te aggregeren, kunt u met het type 'aggregaat' 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.

GetTypesPage

Object

Gedeeltelijke lijst met tijdreekstypen die in één aanvraag worden geretourneerd.

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 vervolgtokenparameter in de HTTP-header x-ms-continuation.
types	TimeSeriesType[]	Gedeeltelijke lijst met tijdreekstypen die in één aanvraag worden geretourneerd. Kan leeg zijn als de server de pagina niet kan vullen met meer typen in deze aanvraag of als er geen typen meer typen zijn wanneer het vervolgtoken null is.

Interpolation

Object

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 moet 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

Inventarisatie

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

Waarde	Description
Linear
Step

NumericVariable

Object

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

Name	Type	Description
aggregation	Tsx	Expressie voor tijdreeksen voor aggregatie 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 binnen 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 wordt overwogen voor berekeningen. Voorbeeld: '$event. Status.String='Good'". Facultatief.
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 moet 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 te aggregeren, kunt u met het type 'aggregaat' rechtstreeks aggregeren op de gebeurteniseigenschappen zonder waarde op te geven.
value	Tsx	Waardetijdreeksexpressie 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".

TimeSeriesAggregateCategory

Object

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 is toegewezen. Dit kan een unieke lijst met tekenreeksen of lange lijsten zijn.

TimeSeriesDefaultCategory

Object

Vertegenwoordigt de standaardcategorie.

Name	Type	Description
label	string	De naam van de standaardcategorie die wordt toegewezen aan de waarden die niet overeenkomen met een van de waarden die zijn gedefinieerd in de 'categorieën'.

TimeSeriesType

Object

Het tijdreekstype definieert variabelen of formules voor het uitvoeren van berekeningen op gebeurtenissen die zijn gekoppeld aan tijdreeksexemplaren. Elke time series-instantie is gekoppeld aan precies één type. Een type kan een of meer variabelen hebben. Een tijdreeksexemplaren kunnen bijvoorbeeld van het type Temperatuursensor zijn, die bestaat uit de variabelen gemiddelde temperatuur, minimumtemperatuur en maximale temperatuur.

Name	Type	Description
description	string	Beschrijving van het type. Kan null zijn.
id	string	Hoofdlettergevoelige unieke type-id die onveranderbaar is. Kan null zijn bij het maken of bijwerken van aanvragen en de server genereert vervolgens de id. Niet null bij get- en verwijderbewerkingen.
name	string	Door de gebruiker opgegeven unieke naam voor het type. Veranderlijk, niet null.
variables	object	Verschillende variabelen die aan het type zijn gekoppeld. Niet leeg, niet null.

TsiError

Object

Informatie over een API-fout.

Name	Type	Description
error	TsiErrorBody	Een bepaalde API-fout met een foutcode en een bericht.

TsiErrorBody

Object

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 om programmatisch specifieke foutcases af te handelen.
details	TsiErrorDetails[]	Bevat aanvullende foutinformatie. Kan null zijn.
innerError	TsiErrorBody	Bevat specifiekere fouten die de oorzaak beperken. Kan null zijn.
message	string	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 in fout). Kan null zijn.

TsiErrorDetails

Object

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 om programmatisch specifieke foutcases af te handelen.
message	string	Leesbare, taalonafhankelijke weergave van de fout. Het is bedoeld als hulpmiddel voor ontwikkelaars en is niet geschikt voor blootstelling aan eindgebruikers.

Tsx

Object

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

Name	Type	Description
tsx	string	Tijdreeksexpressie (TSX) die als één tekenreeks is geschreven. Voorbeelden: '$event. Status.String='Good', 'avg($event. Temperatuur)". Raadpleeg de documentatie over het schrijven van tijdreeksexpressies.

Delen via

Time Series Types - List

URI-parameters

Aanvraagkoptekst

Antwoorden

Beveiliging

azure_auth

Bereiken

Voorbeelden

TypesListPage1

Voorbeeldaanvraag

Voorbeeldrespons

TypesListPage2

Voorbeeldaanvraag

Voorbeeldrespons

TypesListPage3

Voorbeeldaanvraag

Voorbeeldrespons

Definities

AggregateVariable

Boundary

CategoricalVariable

GetTypesPage

Interpolation

InterpolationKind

NumericVariable

TimeSeriesAggregateCategory

TimeSeriesDefaultCategory

TimeSeriesType

TsiError

TsiErrorBody

TsiErrorDetails

Tsx