Udostępnij za pośrednictwem

Time Series Types - Execute Batch

  • Odwołanie
Usługa:
Time Series Insights
Wersja interfejsu API:
2020-07-31

Wykonuje operację pobierania wsadowego, tworzenia, aktualizowania i usuwania dla wielu typów szeregów czasowych.

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
environmentFqdn
 path True

string

Na nazwę FQDN środowiska, na przykład 10000000-0000-0000-0000-100000000109.env.timeseries.azure.com. Tę nazwę domeny można uzyskać z odpowiedzi interfejsu API pobierania środowisk, Azure Portal lub usługi Azure Resource Manager.
api-version
 query True

string

Wersja interfejsu API do użycia z żądaniem klienta. Obecnie obsługiwana wersja to "2020-07-31".

Nagłówek żądania

Nazwa Wymagane Typ Opis
x-ms-client-request-id

string

Opcjonalny identyfikator żądania klienta. Usługa rejestruje tę wartość. Umożliwia usłudze śledzenie operacji między usługami i umożliwia klientowi kontaktowanie się z pomocą techniczną dotyczącą konkretnego żądania.
x-ms-client-session-id

string

Opcjonalny identyfikator sesji klienta. Usługa rejestruje tę wartość. Umożliwia usłudze śledzenie grupy powiązanych operacji w usługach i umożliwia klientowi kontaktowanie się z pomocą techniczną w odniesieniu do określonej grupy żądań.

Treść żądania

Nazwa Typ Opis
delete

TypesRequestBatchGetOrDelete

Definicja typów szeregów czasowych do usunięcia.
get

TypesRequestBatchGetOrDelete

Definicja typów szeregów czasowych, które mają być zwracane.
put

TimeSeriesType[]

Definicja typów szeregów czasowych do zaktualizowania lub utworzenia.

Odpowiedzi

Nazwa Typ Opis
200 OK

TypesBatchResponse

Operacja zakończona powodzeniem.

Nagłówki

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

TsiError

Nieoczekiwany błąd.

Nagłówki

x-ms-request-id: string

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa Opis
user_impersonation personifikacja konta użytkownika

Przykłady

TypesBatchDeleteByIds
TypesBatchDeleteByNames
TypesBatchGetByIds
TypesBatchGetByNames
TypesBatchPut

TypesBatchDeleteByIds

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:
200 
{
  "delete": [
    null
  ]
}

TypesBatchDeleteByNames

Przykładowe żądanie

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

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

Przykładowa odpowiedź

Kod stanu:
200 
{
  "delete": [
    null
  ]
}

TypesBatchGetByIds

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:
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

Przykładowe żądanie

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

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

Przykładowa odpowiedź

Kod stanu:
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

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:
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
    }
  ]
}

Definicje

Nazwa Opis
AggregateVariable

Zmienna agregacji reprezentuje dowolne obliczenie agregacji. Zmienne zagregowane nie obsługują interpolacji.
Boundary

Zakres czasu po lewej i prawej stronie zakresu wyszukiwania, który ma być używany do interpolacji. Jest to przydatne w scenariuszach, w których brakuje punktów danych blisko początku lub końca zakresu wyszukiwania wejściowego. Może mieć wartość null.
CategoricalVariable

Zmienna kategorii reprezentuje sygnał, który należy przeanalizować na podstawie liczby lub czasu trwania wystąpienia ograniczonego zestawu zdefiniowanych wartości.
Interpolation

Operacja interpolacji, która ma być wykonywana na nieprzetworzonych punktach danych. Obecnie dozwolone jest tylko próbkowanie interpolowanych szeregów czasowych. Dozwolona funkcja agregacji — np. left($value). Może mieć wartość null, jeśli nie trzeba stosować interpolacji.
InterpolationKind

Typ techniki interpolacji: "Liniowy" lub "Krok".
NumericVariable

Zmienna liczbowa reprezentuje pojedynczy ciągły sygnał liczbowy, który można odtworzyć przy użyciu interpolacji.
TimeSeriesAggregateCategory

Kategoria używana w zmiennych kategorii. Kategoria jest definiowana przez etykietę i "wartości", do których przypisano tę etykietę.
TimeSeriesDefaultCategory

Reprezentuje kategorię domyślną.
TimeSeriesType

Typ szeregów czasowych definiuje zmienne lub formuły do wykonywania obliczeń na zdarzeniach skojarzonych z wystąpieniami szeregów czasowych. Każde wystąpienie szeregów czasowych jest skojarzone z dokładnie jednym typem. Typ może mieć co najmniej jedną zmienną. Na przykład wystąpienie szeregów czasowych może mieć typ Czujnik temperatury, który składa się ze zmiennych średniej temperatury, temperatury minimalnej i maksymalnej temperatury.
TimeSeriesTypeOrError

Wynik operacji wsadowej dla określonego typu szeregów czasowych. Obiekt typu jest ustawiany, gdy operacja zakończy się pomyślnie, a obiekt błędu jest ustawiany, gdy operacja nie powiedzie się.
TsiError

Informacje o błędzie interfejsu API.
TsiErrorBody

Określony błąd interfejsu API z kodem błędu i komunikatem.
TsiErrorDetails

Dodatkowe informacje o błędzie.
Tsx

Wyrażenie szeregów czasowych (TSX) napisane jako pojedynczy ciąg. Przykłady: "$event. Status.String='Good'", "avg($event. Temperatura)". Zapoznaj się z dokumentacją dotyczącą pisania wyrażeń szeregów czasowych.
TypesBatchRequest

Żądanie wykonania pojedynczej operacji na partii typów szeregów czasowych. Należy ustawić dokładnie jedną z wartości "get", "put" lub "delete".
TypesBatchResponse

Odpowiedź pojedynczej operacji na partii typów szeregów czasowych. Zostanie ustawiona dokładnie jedna z opcji "get", "put" lub "delete".
TypesRequestBatchGetOrDelete

Żądanie pobrania lub usunięcia typów szeregów czasowych według identyfikatorów lub nazw typów. Należy ustawić dokładnie jedną z wartości "typeId" lub "names".

AggregateVariable

Zmienna agregacji reprezentuje dowolne obliczenie agregacji. Zmienne zagregowane nie obsługują interpolacji.

Nazwa Typ Opis
aggregation

Tsx

Wyrażenie agregacji szeregów czasowych, gdy rodzaj jest "agregowany" służy do reprezentowania agregacji, która musi być wykonywana bezpośrednio przy użyciu właściwości zdarzenia, takich jak "$event. Temperatura". Na przykład agregacja służąca do obliczania zakresu zmian temperatury może być zapisywana jako " max($event). Temperatura)-min($event. Temperatura)".
filter

Tsx

Filtruj według zdarzeń, które ograniczają liczbę zdarzeń rozważanych do obliczeń. Przykład: "$event. Status.String='Good'". Opcjonalny.
kind string:

aggregate

Dozwolone wartości "kind" to " numeryczne" lub "aggregate". Podczas gdy wyrażenie "numeryczne" umożliwia określenie wartości zrekonstruowanego sygnału i wyrażenia w celu ich agregowania, rodzaj "agregacji" umożliwia bezpośrednie agregowanie właściwości zdarzenia bez określania wartości.

Boundary

Zakres czasu po lewej i prawej stronie zakresu wyszukiwania, który ma być używany do interpolacji. Jest to przydatne w scenariuszach, w których brakuje punktów danych blisko początku lub końca zakresu wyszukiwania wejściowego. Może mieć wartość null.

Nazwa Typ Opis
span

string

CategoricalVariable

Zmienna kategorii reprezentuje sygnał, który należy przeanalizować na podstawie liczby lub czasu trwania wystąpienia ograniczonego zestawu zdefiniowanych wartości.

Nazwa Typ Opis
categories

TimeSeriesAggregateCategory[]

Kategoria używana w zmiennych kategorii. Kategoria jest definiowana przez etykietę i "wartości", do których przypisano tę etykietę.
defaultCategory

TimeSeriesDefaultCategory

Reprezentuje kategorię domyślną.
filter

Tsx

Filtruj według zdarzeń, które ograniczają liczbę zdarzeń rozważanych do obliczeń. Przykład: "$event. Status.String='Good'". Opcjonalny.
interpolation

Interpolation

Zmienna kategoryczna obsługuje tylko interpolację "kroku".
kind string:

categorical

Dozwolone wartości "kind" to " numeryczne" lub "aggregate". Podczas gdy wyrażenie "numeryczne" umożliwia określenie wartości zrekonstruowanego sygnału i wyrażenia w celu ich agregowania, rodzaj "agregacji" umożliwia bezpośrednie agregowanie właściwości zdarzenia bez określania wartości.
value

Tsx

Wyrażenie szeregu czasowego wartości służy do reprezentowania wartości sygnału, który ma zostać skategoryzowany. Może on obliczyć tylko typ "Ciąg" lub "Long" dla zmiennych kategorii.

Interpolation

Operacja interpolacji, która ma być wykonywana na nieprzetworzonych punktach danych. Obecnie dozwolone jest tylko próbkowanie interpolowanych szeregów czasowych. Dozwolona funkcja agregacji — np. left($value). Może mieć wartość null, jeśli nie trzeba stosować interpolacji.

Nazwa Typ Opis
boundary

Boundary

Zakres czasu po lewej i prawej stronie zakresu wyszukiwania, który ma być używany do interpolacji. Jest to przydatne w scenariuszach, w których brakuje punktów danych blisko początku lub końca zakresu wyszukiwania wejściowego. Może mieć wartość null.
kind

InterpolationKind

Typ techniki interpolacji: "Liniowy" lub "Krok".

InterpolationKind

Typ techniki interpolacji: "Liniowy" lub "Krok".

Nazwa Typ Opis
Linear

string

Step

string

NumericVariable

Zmienna liczbowa reprezentuje pojedynczy ciągły sygnał liczbowy, który można odtworzyć przy użyciu interpolacji.

Nazwa Typ Opis
aggregation

Tsx

Wyrażenie agregacji szeregów czasowych, gdy rodzaj jest "liczbowy", służy do reprezentowania agregacji, która musi zostać wykonana na wyrażeniu $value. Wymaga to określenia $value i może używać tylko $value wewnątrz funkcji agregujących. Na przykład agregacja do obliczania minimum $value jest zapisywana jako: "min($value)".
filter

Tsx

Filtruj według zdarzeń, które ograniczają liczbę zdarzeń rozważanych do obliczeń. Przykład: "$event. Status.String='Good'". Opcjonalny.
interpolation

Interpolation

Operacja interpolacji, która ma być wykonywana na nieprzetworzonych punktach danych. Obecnie dozwolone jest tylko próbkowanie interpolowanych szeregów czasowych. Dozwolona funkcja agregacji — np. left($value). Może mieć wartość null, jeśli nie trzeba stosować interpolacji.
kind string:

numeric

Dozwolone wartości "kind" to " numeryczne" lub "aggregate". Podczas gdy wyrażenie "numeryczne" umożliwia określenie wartości zrekonstruowanego sygnału i wyrażenia w celu ich agregowania, rodzaj "agregacji" umożliwia bezpośrednie agregowanie właściwości zdarzenia bez określania wartości.
value

Tsx

Wyrażenie szeregu czasowego wartości służy do reprezentowania wartości sygnału, który ma być agregowany lub interpolowany. Na przykład wartości temperatury ze zdarzenia są reprezentowane w następujący sposób: "$event. Temperature.Double".

TimeSeriesAggregateCategory

Kategoria używana w zmiennych kategorii. Kategoria jest definiowana przez etykietę i "wartości", do których przypisano tę etykietę.

Nazwa Typ Opis
label

string

Nazwa kategorii, która będzie używana w konstruowaniu nazw zmiennych wyjściowych.
values

object[]

Lista wartości, do których jest mapowana kategoria. Może to być unikatowa lista ciągów lub lista długa.

TimeSeriesDefaultCategory

Reprezentuje kategorię domyślną.

Nazwa Typ Opis
label

string

Nazwa kategorii domyślnej, która zostanie przypisana do wartości, które nie są zgodne z żadną z kategorii zdefiniowanych w kategorii.

TimeSeriesType

Typ szeregów czasowych definiuje zmienne lub formuły do wykonywania obliczeń na zdarzeniach skojarzonych z wystąpieniami szeregów czasowych. Każde wystąpienie szeregów czasowych jest skojarzone z dokładnie jednym typem. Typ może mieć co najmniej jedną zmienną. Na przykład wystąpienie szeregów czasowych może mieć typ Czujnik temperatury, który składa się ze zmiennych średniej temperatury, temperatury minimalnej i maksymalnej temperatury.

Nazwa Typ Opis
description

string

Opis typu. Może mieć wartość null.
id

string

Unikatowy identyfikator typu uwzględniający wielkość liter, który jest niezmienny. Może mieć wartość null dla żądań tworzenia lub aktualizowania, a następnie serwer generuje identyfikator. Nie ma wartości null w operacjach pobierania i usuwania.
name

string

Nadana użytkownikowi unikatowa nazwa typu. Modyfikowalne, a nie null.
variables

object

Różne zmienne skojarzone z typem. Nie jest pusty, a nie null.

TimeSeriesTypeOrError

Wynik operacji wsadowej dla określonego typu szeregów czasowych. Obiekt typu jest ustawiany, gdy operacja zakończy się pomyślnie, a obiekt błędu jest ustawiany, gdy operacja nie powiedzie się.

Nazwa Typ Opis
error

TsiErrorBody

Obiekt error — ustawiany, gdy operacja nie powiedzie się.
timeSeriesType

TimeSeriesType

Obiekt typu szeregów czasowych — ustawiany, gdy operacja zakończy się pomyślnie.

TsiError

Informacje o błędzie interfejsu API.

Nazwa Typ Opis
error

TsiErrorBody

Określony błąd interfejsu API z kodem błędu i komunikatem.

TsiErrorBody

Określony błąd interfejsu API z kodem błędu i komunikatem.

Nazwa Typ Opis
code

string

Ciąg czytelny dla języka, który definiuje kod błędu specyficzny dla usługi. Ten kod służy jako bardziej szczegółowy wskaźnik dla kodu błędu HTTP określonego w odpowiedzi. Może służyć do programowego obsługi określonych przypadków błędów.
details

TsiErrorDetails[]

Zawiera dodatkowe informacje o błędzie. Może mieć wartość null.
innerError

TsiErrorBody

Zawiera bardziej szczegółowy błąd, który zawęża przyczynę. Może mieć wartość null.
message

string

Czytelna dla człowieka, niezależna od języka reprezentacja błędu. Jest ona przeznaczona jako pomoc dla deweloperów i nie jest odpowiednia dla użytkowników końcowych.
target

string

Element docelowy określonego błędu (na przykład nazwa właściwości w błędzie). Może mieć wartość null.

TsiErrorDetails

Dodatkowe informacje o błędzie.

Nazwa Typ Opis
code

string

Ciąg czytelny dla języka, który definiuje kod błędu specyficzny dla usługi. Ten kod służy jako bardziej szczegółowy wskaźnik dla kodu błędu HTTP określonego w odpowiedzi. Może służyć do programowego obsługi określonych przypadków błędów.
message

string

Czytelna dla człowieka, niezależna od języka reprezentacja błędu. Jest ona przeznaczona jako pomoc dla deweloperów i nie jest odpowiednia dla użytkowników końcowych.

Tsx

Wyrażenie szeregów czasowych (TSX) napisane jako pojedynczy ciąg. Przykłady: "$event. Status.String='Good'", "avg($event. Temperatura)". Zapoznaj się z dokumentacją dotyczącą pisania wyrażeń szeregów czasowych.

Nazwa Typ Opis
tsx

string

Wyrażenie szeregów czasowych (TSX) napisane jako pojedynczy ciąg. Przykłady: "$event. Status.String='Good'", "avg($event. Temperatura)". Zapoznaj się z dokumentacją dotyczącą pisania wyrażeń szeregów czasowych.

TypesBatchRequest

Żądanie wykonania pojedynczej operacji na partii typów szeregów czasowych. Należy ustawić dokładnie jedną z wartości "get", "put" lub "delete".

Nazwa Typ Opis
delete

TypesRequestBatchGetOrDelete

Definicja typów szeregów czasowych do usunięcia.
get

TypesRequestBatchGetOrDelete

Definicja typów szeregów czasowych, które mają być zwracane.
put

TimeSeriesType[]

Definicja typów szeregów czasowych do zaktualizowania lub utworzenia.

TypesBatchResponse

Odpowiedź pojedynczej operacji na partii typów szeregów czasowych. Zostanie ustawiona dokładnie jedna z opcji "get", "put" lub "delete".

Nazwa Typ Opis
delete

TsiErrorBody[]

Lista obiektów błędów odpowiadających pozycji tablicy "delete" w żądaniu — null, gdy operacja zakończy się pomyślnie.
get

TimeSeriesTypeOrError[]

Lista typów lub obiektów błędów odpowiadających pozycji tablicy "get" w żądaniu. Obiekt typu jest ustawiany, gdy operacja zakończy się pomyślnie, a obiekt błędu jest ustawiany, gdy operacja nie powiedzie się.
put

TimeSeriesTypeOrError[]

Lista typów lub obiektów błędów odpowiadających pozycji tablicy "put" w żądaniu. Obiekt typu jest ustawiany, gdy operacja zakończy się pomyślnie, a obiekt błędu jest ustawiany, gdy operacja nie powiedzie się.

TypesRequestBatchGetOrDelete

Żądanie pobrania lub usunięcia typów szeregów czasowych według identyfikatorów lub nazw typów. Należy ustawić dokładnie jedną z wartości "typeId" lub "names".

Nazwa Typ Opis
names

string[]

Lista nazw typów szeregów czasowych do zwrócenia lub usunięcia.
typeIds

string[]

Lista identyfikatorów typów szeregów czasowych do zwrócenia lub usunięcia.