Dela via

Time Series Types - Execute Batch

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

Kör en batch-åtgärd för att hämta, skapa, uppdatera och ta bort på flera typer av tidsserier.

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

URI-parametrar

Name I Obligatorisk Typ Description
environmentFqdn
 path True

string

FQDN per miljö, till exempel 10000000-0000-0000-0000-100000000109.env.timeseries.azure.com. Du kan hämta det här domännamnet från svaret från GET Environments API, Azure Portal eller Azure Resource Manager.
api-version
 query True

string

Version av API:et som ska användas med klientbegäran. Den version som stöds för närvarande är "2020-07-31".

Begärandehuvud

Name Obligatorisk Typ Description
x-ms-client-request-id

string

Valfritt klientbegärans-ID. Tjänsten registrerar det här värdet. Tillåter att tjänsten spårar åtgärder mellan tjänster och gör att kunden kan kontakta supporten angående en viss begäran.
x-ms-client-session-id

string

Valfritt klientsessions-ID. Tjänsten registrerar det här värdet. Gör att tjänsten kan spåra en grupp relaterade åtgärder mellan tjänster och gör att kunden kan kontakta supporten för en viss grupp med begäranden.

Begärandetext

Name Typ Description
delete

TypesRequestBatchGetOrDelete

Definition av vilka tidsserietyper som ska tas bort.
get

TypesRequestBatchGetOrDelete

Definition av vilka tidsserietyper som ska returneras.
put

TimeSeriesType[]

Definition av vilka tidsserietyper som ska uppdateras eller skapas.

Svar

Name Typ Description
200 OK

TypesBatchResponse

Åtgärden lyckades.

Headers

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

TsiError

Oväntat fel.

Headers

x-ms-request-id: string

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name Description
user_impersonation personifiera ditt användarkonto

Exempel

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
    }
  ]
}

Definitioner

Name Description
AggregateVariable

Aggregeringsvariabeln representerar alla aggregeringsberäkningar. Mängdvariabler stöder inte interpolering.
Boundary

Tidsintervallet till vänster och höger om sökomfånget som ska användas för interpolering. Detta är användbart i scenarier där datapunkterna saknas nära början eller slutet av sökintervallet för indata. Kan vara null.
CategoricalVariable

Kategorisk variabel representerar signaler som behöver analyseras baserat på antalet eller varaktigheten för förekomsten av en begränsad uppsättning definierade värden.
Interpolation

Interpoleringsåtgärden som ska utföras på rådatapunkterna. För närvarande tillåts endast sampling av interpolerade tidsserier. Tillåten mängdfunktion – t.ex. left($value). Kan vara null om ingen interpolering behöver tillämpas.
InterpolationKind

Typen av interpoleringsteknik: "Linjär" eller "Steg".
NumericVariable

Numerisk variabel representerar en enda kontinuerlig numerisk signal som kan rekonstrueras med hjälp av interpolering.
TimeSeriesAggregateCategory

Kategori som används i kategoriska variabler. En kategori definieras av "etikett" och de "värden" som tilldelas den här etiketten.
TimeSeriesDefaultCategory

Representerar standardkategorin.
TimeSeriesType

Typ av tidsserie definierar variabler eller formler för beräkning av händelser som är associerade med tidsserieinstanser. Varje tidsserieinstans är associerad med exakt en typ. En typ kan ha en eller flera variabler. Till exempel kan en tidsserieinstans vara av typen Temperatursensor, som består av variablerna genomsnittlig temperatur, lägsta temperatur och maxtemperatur.
TimeSeriesTypeOrError

Resultatet av en batchåtgärd för en viss tidsserietyp. Typobjektet anges när åtgärden lyckas och felobjektet anges när åtgärden misslyckas.
TsiError

Information om ett API-fel.
TsiErrorBody

Ett visst API-fel med en felkod och ett meddelande.
TsiErrorDetails

Ytterligare felinformation.
Tsx

Tidsserieuttryck (TSX) skrivet som en enda sträng. Exempel: "$event. Status.String='Good'", "avg($event. Temperatur)". Läs dokumentationen om hur du skriver tidsserieuttryck.
TypesBatchRequest

Begäran om att utföra en enda åtgärd på en batch med tidsserietyper. Exakt en av "get", "put" eller "delete" måste anges.
TypesBatchResponse

Svar på en enskild åtgärd på en batch med tidsserietyper. Exakt en av "get", "put" eller "delete" anges.
TypesRequestBatchGetOrDelete

Begäran om att hämta eller ta bort tidsserietyper efter ID:t eller typnamn. Exakt ett av "typeIds" eller "namn" måste anges.

AggregateVariable

Aggregeringsvariabeln representerar alla aggregeringsberäkningar. Mängdvariabler stöder inte interpolering.

Name Typ Description
aggregation

Tsx

Tidsserieuttryck för sammansättning när typen är "aggregering" används för att representera den aggregering som måste utföras direkt med händelseegenskaper som "$event. Temperatur". Till exempel kan aggregering för beräkning av temperaturändringar skrivas som: "max($event. Temperatur)-min($event. Temperatur)".
filter

Tsx

Filtrera över de händelser som begränsar antalet händelser som övervägs för beräkning. Exempel: "$event. Status.String='Good'". Valfritt.
kind string:

aggregate

Tillåtna "typ"-värden är – "numeriska" eller "aggregerade". Även om "numerisk" låter dig ange värdet för den rekonstruerade signalen och uttrycket för att aggregera dem, kan du med typen "aggregera" direkt på händelseegenskaperna utan att ange värde.

Boundary

Tidsintervallet till vänster och höger om sökomfånget som ska användas för interpolering. Detta är användbart i scenarier där datapunkterna saknas nära början eller slutet av sökintervallet för indata. Kan vara null.

Name Typ Description
span

string

CategoricalVariable

Kategorisk variabel representerar signaler som behöver analyseras baserat på antalet eller varaktigheten för förekomsten av en begränsad uppsättning definierade värden.

Name Typ Description
categories

TimeSeriesAggregateCategory[]

Kategori som används i kategoriska variabler. En kategori definieras av "etikett" och de "värden" som tilldelas den här etiketten.
defaultCategory

TimeSeriesDefaultCategory

Representerar standardkategorin.
filter

Tsx

Filtrera över de händelser som begränsar antalet händelser som övervägs för beräkning. Exempel: "$event. Status.String='Good'". Valfritt.
interpolation

Interpolation

Kategorivariabeln stöder endast "steg"-interpolering.
kind string:

categorical

Tillåtna "typ"-värden är – "numeriska" eller "aggregerade". Även om "numerisk" låter dig ange värdet för den rekonstruerade signalen och uttrycket för att aggregera dem, kan du med typen "aggregera" direkt på händelseegenskaperna utan att ange värde.
value

Tsx

Tidsserieuttryck för värde används för att representera värdet för den signal som ska kategoriseras. Den kan endast utvärderas till typen "String" eller "Long" för kategoriska variabler.

Interpolation

Interpoleringsåtgärden som ska utföras på rådatapunkterna. För närvarande tillåts endast sampling av interpolerade tidsserier. Tillåten mängdfunktion – t.ex. left($value). Kan vara null om ingen interpolering behöver tillämpas.

Name Typ Description
boundary

Boundary

Tidsintervallet till vänster och höger om sökomfånget som ska användas för interpolering. Detta är användbart i scenarier där datapunkterna saknas nära början eller slutet av sökintervallet för indata. Kan vara null.
kind

InterpolationKind

Typen av interpoleringsteknik: "Linjär" eller "Steg".

InterpolationKind

Typen av interpoleringsteknik: "Linjär" eller "Steg".

Name Typ Description
Linear

string

Step

string

NumericVariable

Numerisk variabel representerar en enda kontinuerlig numerisk signal som kan rekonstrueras med hjälp av interpolering.

Name Typ Description
aggregation

Tsx

Tidsserieuttryck för aggregering när sorten är "numerisk" används för att representera den aggregering som måste utföras på $value-uttrycket. Detta kräver att $value anges och endast kan använda $value inuti mängdfunktionerna. Till exempel skrivs aggregering för beräkning av minsta $value som: "min($value)".
filter

Tsx

Filtrera över de händelser som begränsar antalet händelser som övervägs för beräkning. Exempel: "$event. Status.String='Good'". Valfritt.
interpolation

Interpolation

Interpoleringsåtgärden som ska utföras på rådatapunkterna. För närvarande tillåts endast sampling av interpolerade tidsserier. Tillåten mängdfunktion – t.ex. left($value). Kan vara null om ingen interpolering behöver tillämpas.
kind string:

numeric

Tillåtna "typ"-värden är – "numeriska" eller "aggregerade". Även om "numerisk" låter dig ange värdet för den rekonstruerade signalen och uttrycket för att aggregera dem, kan du med typen "aggregera" direkt på händelseegenskaperna utan att ange värde.
value

Tsx

Värdets tidsserieuttryck används för att representera värdet för den signal som ska aggregeras eller interpoleras. Temperaturvärden från händelsen representeras till exempel så här: "$event. Temperature.Double".

TimeSeriesAggregateCategory

Kategori som används i kategoriska variabler. En kategori definieras av "etikett" och de "värden" som tilldelas den här etiketten.

Name Typ Description
label

string

Namnet på den kategori som ska användas för att konstruera utdatavariabelnamnen.
values

object[]

Listan med värden som en kategori mappar till. Kan vara antingen en unik lista med strängar eller en lista över långa.

TimeSeriesDefaultCategory

Representerar standardkategorin.

Name Typ Description
label

string

Namnet på standardkategorin som ska tilldelas till de värden som inte matchar någon av dem som definieras i kategorierna.

TimeSeriesType

Typ av tidsserie definierar variabler eller formler för beräkning av händelser som är associerade med tidsserieinstanser. Varje tidsserieinstans är associerad med exakt en typ. En typ kan ha en eller flera variabler. Till exempel kan en tidsserieinstans vara av typen Temperatursensor, som består av variablerna genomsnittlig temperatur, lägsta temperatur och maxtemperatur.

Name Typ Description
description

string

Beskrivning av typen. Kan vara null.
id

string

Skiftlägeskänslig unik typidentifierare som inte kan ändras. Kan vara null vid begäranden om att skapa eller uppdatera och sedan genererar servern ID:t. Inte null vid get- och delete-åtgärder.
name

string

Användardefingivet unikt namn för typen. Föränderlig, inte null.
variables

object

Olika variabler som är associerade med typen. Inte tomt, inte null.

TimeSeriesTypeOrError

Resultatet av en batchåtgärd för en viss tidsserietyp. Typobjektet anges när åtgärden lyckas och felobjektet anges när åtgärden misslyckas.

Name Typ Description
error

TsiErrorBody

Felobjekt – ange när åtgärden misslyckas.
timeSeriesType

TimeSeriesType

Tidsserietypobjekt – ange när åtgärden lyckas.

TsiError

Information om ett API-fel.

Name Typ Description
error

TsiErrorBody

Ett visst API-fel med en felkod och ett meddelande.

TsiErrorBody

Ett visst API-fel med en felkod och ett meddelande.

Name Typ Description
code

string

Språkoberoende, läsbar sträng som definierar en tjänstspecifik felkod. Den här koden fungerar som en mer specifik indikator för HTTP-felkoden som anges i svaret. Kan användas för att programmatiskt hantera specifika felfall.
details

TsiErrorDetails[]

Innehåller ytterligare felinformation. Kan vara null.
innerError

TsiErrorBody

Innehåller mer specifika fel som begränsar orsaken. Kan vara null.
message

string

Mänsklig läsbar, språkoberoende representation av felet. Det är avsett som ett stöd för utvecklare och är inte lämpligt för exponering för slutanvändare.
target

string

Mål för det specifika felet (till exempel namnet på egenskapen i fel). Kan vara null.

TsiErrorDetails

Ytterligare felinformation.

Name Typ Description
code

string

Språkoberoende, läsbar sträng som definierar en tjänstspecifik felkod. Den här koden fungerar som en mer specifik indikator för HTTP-felkoden som anges i svaret. Kan användas för att programmatiskt hantera specifika felfall.
message

string

Mänsklig läsbar, språkoberoende representation av felet. Det är avsett som ett stöd för utvecklare och är inte lämpligt för exponering för slutanvändare.

Tsx

Tidsserieuttryck (TSX) skrivet som en enda sträng. Exempel: "$event. Status.String='Good'", "avg($event. Temperatur)". Läs dokumentationen om hur du skriver tidsserieuttryck.

Name Typ Description
tsx

string

Tidsserieuttryck (TSX) skrivet som en enda sträng. Exempel: "$event. Status.String='Good'", "avg($event. Temperatur)". Läs dokumentationen om hur du skriver tidsserieuttryck.

TypesBatchRequest

Begäran om att utföra en enda åtgärd på en batch med tidsserietyper. Exakt en av "get", "put" eller "delete" måste anges.

Name Typ Description
delete

TypesRequestBatchGetOrDelete

Definition av vilka tidsserietyper som ska tas bort.
get

TypesRequestBatchGetOrDelete

Definition av vilka tidsserietyper som ska returneras.
put

TimeSeriesType[]

Definition av vilka tidsserietyper som ska uppdateras eller skapas.

TypesBatchResponse

Svar på en enskild åtgärd på en batch med tidsserietyper. Exakt en av "get", "put" eller "delete" anges.

Name Typ Description
delete

TsiErrorBody[]

Lista över felobjekt som motsvarar placeringen av matrisen "delete" i begäran – null när åtgärden har slutförts.
get

TimeSeriesTypeOrError[]

Lista över typer eller felobjekt som motsvarar placeringen av matrisen "get" i begäran. Typobjektet anges när åtgärden lyckas och felobjektet anges när åtgärden misslyckas.
put

TimeSeriesTypeOrError[]

Lista över typer eller felobjekt som motsvarar position för matrisen "put" i begäran. Typobjektet anges när åtgärden lyckas och felobjektet anges när åtgärden misslyckas.

TypesRequestBatchGetOrDelete

Begäran om att hämta eller ta bort tidsserietyper efter ID:t eller typnamn. Exakt ett av "typeIds" eller "namn" måste anges.

Name Typ Description
names

string[]

Lista över namn på tidsserietyper som ska returneras eller tas bort.
typeIds

string[]

Lista över ID:t för tidsserietyper som ska returneras eller tas bort.