Udostępnij za pośrednictwem

Time Series Hierarchies - Execute Batch

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

Wykonuje operację pobierania, tworzenia, aktualizowania, usuwania w wielu definicjach hierarchii szeregów czasowych.

POST https://{environmentFqdn}/timeseries/hierarchies/$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 skontaktowanie 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 między usługami i umożliwia klientowi kontaktowanie się z pomocą techniczną dotyczącą określonej grupy żądań.

Treść żądania

Nazwa Typ Opis
delete

HierarchiesRequestBatchGetDelete

Wartość "delete" powinna być ustawiana podczas pobierania określonych hierarchii według identyfikatorów lub nazw.
get

HierarchiesRequestBatchGetDelete

Wartość "get" powinna być ustawiana podczas pobierania określonych hierarchii według identyfikatorów lub nazw.
put

TimeSeriesHierarchy[]

"put" należy ustawić podczas tworzenia lub aktualizowania hierarchii.

Odpowiedzi

Nazwa Typ Opis
200 OK

HierarchiesBatchResponse

Operacja zakończona pomyślnie.

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

HierarchiesBatchDeleteByIds
HierarchiesBatchDeleteByNames
HierarchiesBatchGetByIds
HierarchiesBatchGetByNames
HierarchiesBatchPut

HierarchiesBatchDeleteByIds

Przykładowe żądanie

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

{
  "delete": {
    "hierarchyIds": [
      "a28fd14c-6b98-4ab5-9301-3840f142d30e"
    ]
  }
}

Przykładowa odpowiedź

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

HierarchiesBatchDeleteByNames

Przykładowe żądanie

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

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

Przykładowa odpowiedź

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

HierarchiesBatchGetByIds

Przykładowe żądanie

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

{
  "get": {
    "hierarchyIds": [
      "6e292e54-9a26-4be1-9034-607d71492707",
      "a28fd14c-6b98-4ab5-9301-3840f142d30e"
    ]
  }
}

Przykładowa odpowiedź

Kod stanu:
200 
{
  "get": [
    {
      "hierarchy": {
        "id": "6e292e54-9a26-4be1-9034-607d71492707",
        "name": "Location",
        "source": {
          "instanceFieldNames": [
            "state",
            "city"
          ]
        }
      }
    },
    {
      "hierarchy": {
        "id": "a28fd14c-6b98-4ab5-9301-3840f142d30e",
        "name": "ManufactureDate",
        "source": {
          "instanceFieldNames": [
            "year",
            "month"
          ]
        }
      }
    }
  ]
}

HierarchiesBatchGetByNames

Przykładowe żądanie

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

{
  "get": {
    "names": [
      "Location",
      "ManufactureDate"
    ]
  }
}

Przykładowa odpowiedź

Kod stanu:
200 
{
  "get": [
    {
      "hierarchy": {
        "id": "6e292e54-9a26-4be1-9034-607d71492707",
        "name": "Location",
        "source": {
          "instanceFieldNames": [
            "state",
            "city"
          ]
        }
      }
    },
    {
      "hierarchy": {
        "id": "a28fd14c-6b98-4ab5-9301-3840f142d30e",
        "name": "ManufactureDate",
        "source": {
          "instanceFieldNames": [
            "year",
            "month"
          ]
        }
      }
    }
  ]
}

HierarchiesBatchPut

Przykładowe żądanie

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

{
  "put": [
    {
      "id": "6e292e54-9a26-4be1-9034-607d71492707",
      "name": "Location",
      "source": {
        "instanceFieldNames": [
          "state",
          "city"
        ]
      }
    },
    {
      "id": "a28fd14c-6b98-4ab5-9301-3840f142d30e",
      "name": "ManufactureDate",
      "source": {
        "instanceFieldNames": [
          "year",
          "month"
        ]
      }
    }
  ]
}

Przykładowa odpowiedź

Kod stanu:
200 
{
  "put": [
    {
      "hierarchy": {
        "id": "6e292e54-9a26-4be1-9034-607d71492707",
        "name": "Location",
        "source": {
          "instanceFieldNames": [
            "state",
            "city"
          ]
        }
      },
      "error": null
    },
    {
      "hierarchy": {
        "id": "a28fd14c-6b98-4ab5-9301-3840f142d30e",
        "name": "ManufactureDate",
        "source": {
          "instanceFieldNames": [
            "year",
            "month"
          ]
        }
      },
      "error": null
    }
  ]
}

Definicje

Nazwa Opis
HierarchiesBatchRequest

Żądanie wykonania pojedynczej operacji w partii hierarchii. Należy ustawić dokładnie jedną z opcji "get", "put" lub "delete".
HierarchiesBatchResponse

Odpowiedź pojedynczej operacji na partii hierarchii szeregów czasowych. Zostanie ustawiona tylko jedna z opcji "get", "put" lub "delete".
HierarchiesRequestBatchGetDelete

Żądanie pobrania lub usunięcia wielu hierarchii szeregów czasowych. Należy ustawić dokładnie jedną z wartości "hierarchyId" lub "names".
Source

Definicja sposobu tworzenia poziomów drzewa hierarchii szeregów czasowych.
TimeSeriesHierarchy

Hierarchia szeregów czasowych organizuje wystąpienia szeregów czasowych w drzewo.
TimeSeriesHierarchyOrError

Wynik operacji wsadowej w określonej hierarchii szeregów czasowych. Hierarchia jest ustawiana, gdy operacja zakończyła 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.

HierarchiesBatchRequest

Żądanie wykonania pojedynczej operacji w partii hierarchii. Należy ustawić dokładnie jedną z opcji "get", "put" lub "delete".

Nazwa Typ Opis
delete

HierarchiesRequestBatchGetDelete

Wartość "delete" powinna być ustawiana podczas pobierania określonych hierarchii według identyfikatorów lub nazw.
get

HierarchiesRequestBatchGetDelete

Wartość "get" powinna być ustawiana podczas pobierania określonych hierarchii według identyfikatorów lub nazw.
put

TimeSeriesHierarchy[]

"put" należy ustawić podczas tworzenia lub aktualizowania hierarchii.

HierarchiesBatchResponse

Odpowiedź pojedynczej operacji na partii hierarchii szeregów czasowych. Zostanie ustawiona tylko jedna z opcji "get", "put" lub "delete".

Nazwa Typ Opis
delete

TsiErrorBody[]

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

TimeSeriesHierarchyOrError[]

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

TimeSeriesHierarchyOrError[]

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

HierarchiesRequestBatchGetDelete

Żądanie pobrania lub usunięcia wielu hierarchii szeregów czasowych. Należy ustawić dokładnie jedną z wartości "hierarchyId" lub "names".

Nazwa Typ Opis
hierarchyIds

string[]

Lista identyfikatorów hierarchii.
names

string[]

Lista nazw hierarchii.

Source

Definicja sposobu tworzenia poziomów drzewa hierarchii szeregów czasowych.

Nazwa Typ Opis
instanceFieldNames

string[]

Lista nazw pól wystąpienia, które muszą być ustawione we wszystkich wystąpieniach szeregów czasowych należących do tej hierarchii. Kolejność pól wystąpienia definiuje poziomy w hierarchii.

TimeSeriesHierarchy

Hierarchia szeregów czasowych organizuje wystąpienia szeregów czasowych w drzewo.

Nazwa Typ Opis
id

string

Unikatowy identyfikator hierarchii z uwzględnieniem wielkości liter. Może mieć wartość null podczas tworzenia obiektów hierarchii, a następnie serwer generuje identyfikator, a nie null podczas operacji pobierania i usuwania.
name

string

Podana przez użytkownika unikatowa nazwa typu. Jest on modyfikowalny i nie ma wartości null.
source

Source

Definicja sposobu tworzenia poziomów drzewa hierarchii szeregów czasowych.

TimeSeriesHierarchyOrError

Wynik operacji wsadowej w określonej hierarchii szeregów czasowych. Hierarchia jest ustawiana, gdy operacja zakończyła się pomyślnie, a obiekt błędu jest ustawiany, gdy operacja nie powiedzie się.

Nazwa Typ Opis
error

TsiErrorBody

Obiekt błędu — ustawiany, gdy operacja nie powiedzie się.
hierarchy

TimeSeriesHierarchy

Obiekt hierarchii szeregów czasowych — ustawiany po pomyślnym wykonaniu operacji.

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

Niezależny od języka ciąg czytelny dla człowieka, który definiuje kod błędu specyficzny dla usługi. Ten kod służy jako bardziej szczegółowy wskaźnik 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 nadaje się do ujawnienia użytkownikom końcowym.
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

Niezależny od języka ciąg czytelny dla człowieka, który definiuje kod błędu specyficzny dla usługi. Ten kod służy jako bardziej szczegółowy wskaźnik 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 nadaje się do ujawnienia użytkownikom końcowym.