Time Series Hierarchies - Execute Batch

Wykonuje operację Get, Create, Update i DELETE dla wielu serii czasowych.

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

Parametry identyfikatora URI

Name In Required Type Description
environmentFqdn
path True
  • string

Według nazwy 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 Azure Resource Manager.

api-version
query True
  • string

Wersja interfejsu API, która ma być używana z żądaniem klienta. Obecnie obsługiwana wersja to "2020-07-31".

Nagłówek żądania

Name Required Type Description
x-ms-client-request-id
  • string

Opcjonalny identyfikator żądania klienta. Usługa rejestruje tę wartość. Umożliwia usłudze śledzenie operacji w ramach usług i pozwala klientowi na kontaktowanie się z pomocą techniczną dotyczącą określonego żą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 ramach usług i pozwala klientowi na kontaktowanie się z pomocą techniczną w odniesieniu do określonej grupy żądań.

Treść żądania

Name Type Description
delete

podczas pobierania określonych hierarchii według identyfikatorów lub nazw należy ustawić wartość "Delete".

get

podczas pobierania określonych hierarchii według identyfikatorów lub nazw należy ustawić wartość "Get".

put

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

Odpowiedzi

Name Type Description
200 OK

Operacja zakończona pomyślnie.

Headers

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

Nieoczekiwany błąd.

Headers

  • x-ms-request-id: string

Zabezpieczenia

azure_auth

Azure Active Directory przepływ OAuth2

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

Scopes

Name Description
user_impersonation Personifikuj konto użytkownika

Przykłady

HierarchiesBatchDeleteByIds
HierarchiesBatchDeleteByNames
HierarchiesBatchGetByIds
HierarchiesBatchGetByNames
HierarchiesBatchPut

HierarchiesBatchDeleteByIds

Sample Request

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

Sample Response

{
  "delete": [
    null
  ]
}

HierarchiesBatchDeleteByNames

Sample Request

POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/hierarchies/$batch?api-version=2020-07-31
{
  "delete": {
    "names": [
      "WindFarm"
    ]
  }
}

Sample Response

{
  "delete": [
    null
  ]
}

HierarchiesBatchGetByIds

Sample Request

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

Sample Response

{
  "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

Sample Request

POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/hierarchies/$batch?api-version=2020-07-31
{
  "get": {
    "names": [
      "Location",
      "ManufactureDate"
    ]
  }
}

Sample Response

{
  "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

Sample Request

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

Sample Response

{
  "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

HierarchiesBatchRequest

Żądanie wykonania pojedynczej operacji na partii hierarchii. Należy ustawić dokładnie jeden z elementów "Get", "Put" lub "Delete".

HierarchiesBatchResponse

Odpowiedź jednej operacji na partii hierarchii szeregów czasowych. Zostanie ustawiony tylko jeden z elementów "Get", "Put" lub "Delete".

HierarchiesRequestBatchGetDelete

Żądanie pobrania lub usunięcia wielu hierarchii szeregów czasowych. Należy ustawić dokładnie jedną z wartości "hierarchyIds" 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 drzewie.

TimeSeriesHierarchyOrError

Wynik operacji wsadowych w określonej hierarchii szeregów czasowych. Hierarchia jest ustawiona, gdy operacja jest pomyślna, a obiekt błędu jest ustawiony, gdy operacja nie powiedzie się.

TsiError

Informacje o błędzie interfejsu API.

TsiErrorBody

Konkretny błąd interfejsu API z kodem błędu i komunikatem.

TsiErrorDetails

Dodatkowe informacje o błędzie.

HierarchiesBatchRequest

Żądanie wykonania pojedynczej operacji na partii hierarchii. Należy ustawić dokładnie jeden z elementów "Get", "Put" lub "Delete".

Name Type Description
delete

podczas pobierania określonych hierarchii według identyfikatorów lub nazw należy ustawić wartość "Delete".

get

podczas pobierania określonych hierarchii według identyfikatorów lub nazw należy ustawić wartość "Get".

put

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

HierarchiesBatchResponse

Odpowiedź jednej operacji na partii hierarchii szeregów czasowych. Zostanie ustawiony tylko jeden z elementów "Get", "Put" lub "Delete".

Name Type Description
delete

Lista obiektów błędów odpowiadających położeniu do tablicy "Delete" w żądaniu-NULL, gdy operacja zakończy się pomyślnie.

get

Lista obiektów hierarchii lub błędów odpowiadających pozycji do tablicy "Get" w żądaniu. Obiekt hierarchii jest ustawiany, gdy operacja jest pomyślna, a obiekt błędu jest ustawiony, gdy operacja nie powiedzie się.

put

Lista obiektów hierarchii lub błędów odpowiadająca pozycji tablicy "Put" w żądaniu. Obiekt hierarchii jest ustawiany, gdy operacja jest pomyślna, a obiekt błędu jest ustawiony, 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 "hierarchyIds" lub "names".

Name Type Description
hierarchyIds
  • string[]

Lista identyfikatorów hierarchii.

names
  • string[]

Lista nazw hierarchii.

Source

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

Name Type Description
instanceFieldNames
  • string[]

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

TimeSeriesHierarchy

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

Name Type Description
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 w operacjach get i DELETE.

name
  • string

Określona przez użytkownika unikatowa nazwa dla tego typu. Jest on modyfikowalny i nie ma wartości null.

source

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

TimeSeriesHierarchyOrError

Wynik operacji wsadowych w określonej hierarchii szeregów czasowych. Hierarchia jest ustawiona, gdy operacja jest pomyślna, a obiekt błędu jest ustawiony, gdy operacja nie powiedzie się.

Name Type Description
error

Obiekt Error — ustawiany, gdy operacja nie powiedzie się.

hierarchy

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

TsiError

Informacje o błędzie interfejsu API.

Name Type Description
error

Konkretny błąd interfejsu API z kodem błędu i komunikatem.

TsiErrorBody

Konkretny błąd interfejsu API z kodem błędu i komunikatem.

Name Type Description
code
  • string

Niezależny od języka, czytelny dla użytkownika ciąg, 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 programistycznego obsługi konkretnych przypadków błędów.

details

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

innerError

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

message
  • string

Czytelne dla człowieka niezależne od języka Reprezentacja błędu. Jest ona przeznaczona dla deweloperów i nie jest odpowiednia do narażenia użytkownikom końcowym.

target
  • string

Obiekt docelowy konkretnego błędu (na przykład nazwa właściwości w błąd). Może mieć wartość null.

TsiErrorDetails

Dodatkowe informacje o błędzie.

Name Type Description
code
  • string

Niezależny od języka, czytelny dla użytkownika ciąg, 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 programistycznego obsługi konkretnych przypadków błędów.

message
  • string

Czytelne dla człowieka niezależne od języka Reprezentacja błędu. Jest ona przeznaczona dla deweloperów i nie jest odpowiednia do narażenia użytkownikom końcowym.