Share via

Time Series Types - Execute Batch

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

Hiermee wordt een batchbewerking voor ophalen, maken, bijwerken en verwijderen uitgevoerd op meerdere tijdreekstypen.

POST https://{environmentFqdn}/timeseries/types/$batch?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 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.

Aanvraagkoptekst

Name Vereist Type Description
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
delete

TypesRequestBatchGetOrDelete

Definitie van welke tijdreekstypen moeten worden verwijderd.
get

TypesRequestBatchGetOrDelete

Definitie van welke tijdreekstypen moeten worden geretourneerd.
put

TimeSeriesType[]

Definitie van welke tijdreekstypen moeten worden bijgewerkt of gemaakt.

Antwoorden

Name Type Description
200 OK

TypesBatchResponse

De bewerking is voltooid.

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

TypesBatchDeleteByIds
TypesBatchDeleteByNames
TypesBatchGetByIds
TypesBatchGetByNames
TypesBatchPut

TypesBatchDeleteByIds

Sample Request

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

{
  "delete": {
    "typeIds": [
      "9250f816-faed-44c4-88e6-630e5eefa38b"
    ]
  }
}

Sample Response

Status code:
200 
{
  "delete": [
    null
  ]
}

TypesBatchDeleteByNames

Sample Request

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

{
  "delete": {
    "names": [
      "TemperatureSensor"
    ]
  }
}

Sample Response

Status code:
200 
{
  "delete": [
    null
  ]
}

TypesBatchGetByIds

Sample Request

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

{
  "get": {
    "typeIds": [
      "1be09af9-f089-4d6b-9f0b-48018b5f7393",
      "c1cb7a33-ed9b-4cf1-9958-f3162fed8ee8"
    ],
    "names": null
  }
}

Sample Response

Status code:
200 
{
  "get": [
    {
      "timeSeriesType": {
        "id": "1be09af9-f089-4d6b-9f0b-48018b5f7393",
        "name": "DefaultType",
        "description": "Default type",
        "variables": {
          "EventCount": {
            "kind": "aggregate",
            "filter": null,
            "aggregation": {
              "tsx": "count()"
            }
          }
        }
      },
      "error": null
    },
    {
      "timeSeriesType": {
        "id": "c1cb7a33-ed9b-4cf1-9958-f3162fed8ee8",
        "name": "TemperatureSensor",
        "description": "This is a temperature sensor.",
        "variables": {
          "AverageTemperature": {
            "kind": "numeric",
            "value": {
              "tsx": "$event.Temperature.Double"
            },
            "filter": null,
            "aggregation": {
              "tsx": "avg($value)"
            }
          }
        }
      },
      "error": null
    }
  ]
}

TypesBatchGetByNames

Sample Request

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

{
  "get": {
    "names": [
      "DefaultType",
      "TemperatureSensor"
    ]
  }
}

Sample Response

Status code:
200 
{
  "get": [
    {
      "timeSeriesType": {
        "id": "1be09af9-f089-4d6b-9f0b-48018b5f7393",
        "name": "DefaultType",
        "description": "Default type",
        "variables": {
          "EventCount": {
            "kind": "aggregate",
            "filter": null,
            "aggregation": {
              "tsx": "count()"
            }
          }
        }
      },
      "error": null
    },
    {
      "timeSeriesType": {
        "id": "c1cb7a33-ed9b-4cf1-9958-f3162fed8ee8",
        "name": "TemperatureSensor",
        "description": "This is a temperature sensor.",
        "variables": {
          "AverageTemperature": {
            "kind": "numeric",
            "value": {
              "tsx": "$event.Temperature.Double"
            },
            "filter": null,
            "aggregation": {
              "tsx": "avg($value)"
            }
          }
        }
      },
      "error": null
    }
  ]
}

TypesBatchPut

Sample Request

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

{
  "put": [
    {
      "id": "1be09af9-f089-4d6b-9f0b-48018b5f7393",
      "name": "DefaultType",
      "description": "My Default type",
      "variables": {
        "EventCount": {
          "kind": "aggregate",
          "filter": null,
          "aggregation": {
            "tsx": "count()"
          }
        }
      }
    },
    {
      "id": "c1cb7a33-ed9b-4cf1-9958-f3162fed8ee8",
      "name": "OutdoorTemperatureSensor",
      "description": "This is an outdoor temperature sensor.",
      "variables": {
        "AverageTemperature": {
          "kind": "numeric",
          "value": {
            "tsx": "$event.Temperature.Double"
          },
          "filter": {
            "tsx": "$event.Mode.String = 'outdoor'"
          },
          "aggregation": {
            "tsx": "avg($value)"
          }
        }
      }
    }
  ]
}

Sample Response

Status code:
200 
{
  "put": [
    {
      "timeSeriesType": {
        "id": "1be09af9-f089-4d6b-9f0b-48018b5f7393",
        "name": "DefaultType",
        "description": "My Default type",
        "variables": {
          "EventCount": {
            "kind": "aggregate",
            "filter": null,
            "aggregation": {
              "tsx": "count()"
            }
          }
        }
      },
      "error": null
    },
    {
      "timeSeriesType": {
        "id": "c1cb7a33-ed9b-4cf1-9958-f3162fed8ee8",
        "name": "OutdoorTemperatureSensor",
        "description": "This is an outdoor temperature sensor.",
        "variables": {
          "AverageTemperature": {
            "kind": "numeric",
            "value": {
              "tsx": "$event.Temperature.Double"
            },
            "filter": {
              "tsx": "$event.Mode.String = 'outdoor'"
            },
            "aggregation": {
              "tsx": "avg($value)"
            }
          }
        }
      },
      "error": null
    }
  ]
}

Definities

Name Description
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.
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

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 type tijdreeks definieert variabelen of formules voor het uitvoeren van berekeningen op gebeurtenissen die zijn gekoppeld aan tijdreeksexemplaren. Elk tijdreeksexemplaar is gekoppeld aan precies één type. Een type kan een of meer variabelen hebben. Een tijdreeksexemplaar kan bijvoorbeeld van het type Temperatuursensor zijn, die bestaat uit de variabelen gemiddelde temperatuur, minimumtemperatuur en maximumtemperatuur.
TimeSeriesTypeOrError

Resultaat van een batchbewerking op een bepaald tijdreekstype. Het typeobject wordt ingesteld wanneer de bewerking is geslaagd en het foutobject wordt ingesteld wanneer de bewerking mislukt.
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.
TypesBatchRequest

Aanvraag om één bewerking uit te voeren op een batch tijdreekstypen. Er moet precies één van 'get', 'put' of 'delete' zijn ingesteld.
TypesBatchResponse

Reactie van één bewerking op een batch van tijdreekstypen. Er wordt precies één van 'get', 'put' of 'delete' ingesteld.
TypesRequestBatchGetOrDelete

Aanvraag om tijdreekstypen op te halen of te verwijderen op id's of typenamen. Er moet precies een van de 'typeIds' of 'names' zijn ingesteld.

AggregateVariable

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

Name Type Description
aggregation

Tsx

Expressie voor 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 berekeningen. 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 te aggregeren, 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 berekeningen. Voorbeeld: '$event. Status.String='Good'". Optioneel.
interpolation

Interpolation

Categorische variabele ondersteunt alleen interpolatie van 'stap'.
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 'aggregatie' rechtstreeks aggregeren op de gebeurteniseigenschappen zonder waarde op te geven.
value

Tsx

De waardetijdreeksexpressie 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.

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

Een 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 aan 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 berekeningen. 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 te aggregeren, kunt u met het type 'aggregatie' 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

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'.

TimeSeriesType

Het type tijdreeks definieert variabelen of formules voor het uitvoeren van berekeningen op gebeurtenissen die zijn gekoppeld aan tijdreeksexemplaren. Elk tijdreeksexemplaar is gekoppeld aan precies één type. Een type kan een of meer variabelen hebben. Een tijdreeksexemplaar kan bijvoorbeeld van het type Temperatuursensor zijn, die bestaat uit de variabelen gemiddelde temperatuur, minimumtemperatuur en maximumtemperatuur.

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 aanvragen voor maken of bijwerken, waarna de server de id genereert. Niet null bij get- en delete-bewerkingen.
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.

TimeSeriesTypeOrError

Resultaat van een batchbewerking op een bepaald tijdreekstype. Het typeobject wordt ingesteld wanneer de bewerking is geslaagd en het foutobject wordt ingesteld wanneer de bewerking mislukt.

Name Type Description
error

TsiErrorBody

Foutobject : ingesteld wanneer de bewerking mislukt.
timeSeriesType

TimeSeriesType

Object van het type Tijdreeks : ingesteld wanneer de bewerking is geslaagd.

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 de mens 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

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 de mens 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.

TypesBatchRequest

Aanvraag om één bewerking uit te voeren op een batch tijdreekstypen. Er moet precies één van 'get', 'put' of 'delete' zijn ingesteld.

Name Type Description
delete

TypesRequestBatchGetOrDelete

Definitie van welke tijdreekstypen moeten worden verwijderd.
get

TypesRequestBatchGetOrDelete

Definitie van welke tijdreekstypen moeten worden geretourneerd.
put

TimeSeriesType[]

Definitie van welke tijdreekstypen moeten worden bijgewerkt of gemaakt.

TypesBatchResponse

Reactie van één bewerking op een batch van tijdreekstypen. Er wordt precies één van 'get', 'put' of 'delete' ingesteld.

Name Type Description
delete

TsiErrorBody[]

Lijst met foutobjecten die per positie overeenkomen met de 'delete'-matrix in de aanvraag- null wanneer de bewerking is geslaagd.
get

TimeSeriesTypeOrError[]

Lijst met typen of foutobjecten die per positie overeenkomen met de 'get'-matrix in de aanvraag. Het typeobject wordt ingesteld wanneer de bewerking is geslaagd en het foutobject wordt ingesteld wanneer de bewerking mislukt.
put

TimeSeriesTypeOrError[]

Lijst met typen of foutobjecten die overeenkomen met de positie van de 'put'-matrix in de aanvraag. Het typeobject wordt ingesteld wanneer de bewerking is geslaagd en het foutobject wordt ingesteld wanneer de bewerking mislukt.

TypesRequestBatchGetOrDelete

Aanvraag om tijdreekstypen op te halen of te verwijderen op id's of typenamen. Er moet precies een van de 'typeIds' of 'names' zijn ingesteld.

Name Type Description
names

string[]

Lijst met namen van tijdreekstypen die moeten worden geretourneerd of verwijderd.
typeIds

string[]

Lijst met id's van tijdreekstypen die moeten worden geretourneerd of verwijderd.