Freigeben über

Time Series Hierarchies - Execute Batch

  • Referenz
Dienst:
Time Series Insights
API-Version:
2020-07-31

Führt einen Batchvorgang zum Abrufen, Erstellen, Aktualisieren und Löschen von Hierarchiedefinitionen mit mehreren Zeitreihen aus.

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
environmentFqdn
 path True

string

FQDN pro Umgebung, z. B. 10000000-0000-0000-0000-100000000109.env.timeseries.azure.com. Sie können diesen Domänennamen aus der Antwort der Get Environments-API, Azure-Portal oder azure Resource Manager abrufen.
api-version
 query True

string

Version der API, die mit der Clientanforderung verwendet werden soll. Die derzeit unterstützte Version ist "2020-07-31".

Anforderungsheader

Name Erforderlich Typ Beschreibung
x-ms-client-request-id

string

Optionale Clientanforderungs-ID. Der Dienst zeichnet diesen Wert auf. Ermöglicht dem Dienst die dienstübergreifende Ablaufverfolgung des Vorgangs und ermöglicht es dem Kunden, sich bezüglich einer bestimmten Anforderung an den Support zu wenden.
x-ms-client-session-id

string

Optionale Clientsitzungs-ID. Der Dienst zeichnet diesen Wert auf. Ermöglicht dem Dienst, eine Gruppe verwandter Vorgänge dienstübergreifend nachzuverfolgen, und ermöglicht es dem Kunden, den Support bezüglich einer bestimmten Gruppe von Anforderungen zu kontaktieren.

Anforderungstext

Name Typ Beschreibung
delete

HierarchiesRequestBatchGetDelete

"delete" sollte beim Abrufen bestimmter Hierarchien entweder durch IDs oder Namen festgelegt werden.
get

HierarchiesRequestBatchGetDelete

"get" sollte beim Abrufen bestimmter Hierarchien durch IDs oder Namen festgelegt werden.
put

TimeSeriesHierarchy[]

"put" sollte beim Erstellen oder Aktualisieren von Hierarchien festgelegt werden.

Antworten

Name Typ Beschreibung
200 OK

HierarchiesBatchResponse

Erfolgreiche Ausführung

Header

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

TsiError

Unerwarteter Fehler.

Header

x-ms-request-id: string

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name Beschreibung
user_impersonation Identitätswechsel Ihres Benutzerkontos

Beispiele

HierarchiesBatchDeleteByIds
HierarchiesBatchDeleteByNames
HierarchiesBatchGetByIds
HierarchiesBatchGetByNames
HierarchiesBatchPut

HierarchiesBatchDeleteByIds

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:
200 
{
  "delete": [
    null
  ]
}

HierarchiesBatchDeleteByNames

Beispielanforderung

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

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

Beispiel für eine Antwort

Statuscode:
200 
{
  "delete": [
    null
  ]
}

HierarchiesBatchGetByIds

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:
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

Beispielanforderung

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

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

Beispiel für eine Antwort

Statuscode:
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

Beispielanforderung

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

Beispiel für eine Antwort

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

Definitionen

Name Beschreibung
HierarchiesBatchRequest

Anforderung zum Ausführen eines einzelnen Vorgangs für einen Batch von Hierarchien. Genau eine von "get", "put" oder "delete" muss festgelegt werden.
HierarchiesBatchResponse

Antwort eines einzelnen Vorgangs für einen Batch von Zeitreihenhierarchien. Es wird nur eine von "get", "put" oder "delete" festgelegt.
HierarchiesRequestBatchGetDelete

Anforderung zum Abrufen oder Löschen mehrerer Zeitreihenhierarchien. Genau einer der "hierarchyIds" oder "names" muss festgelegt werden.
Source

Definition, wie Zeitreihenhierarchiestrukturebenen erstellt werden.
TimeSeriesHierarchy

Die Zeitreihenhierarchie organisiert Zeitreiheninstanzen in einer Struktur.
TimeSeriesHierarchyOrError

Ergebnis eines Batchvorgangs für eine bestimmte Zeitreihenhierarchie. Die Hierarchie wird festgelegt, wenn der Vorgang erfolgreich ist und das Fehlerobjekt festgelegt wird, wenn der Vorgang nicht erfolgreich ist.
TsiError

Informationen zu einem API-Fehler.
TsiErrorBody

Ein bestimmter API-Fehler mit einem Fehlercode und einer Meldung.
TsiErrorDetails

Zusätzliche Fehlerinformationen.

HierarchiesBatchRequest

Anforderung zum Ausführen eines einzelnen Vorgangs für einen Batch von Hierarchien. Genau eine von "get", "put" oder "delete" muss festgelegt werden.

Name Typ Beschreibung
delete

HierarchiesRequestBatchGetDelete

"delete" sollte beim Abrufen bestimmter Hierarchien entweder durch IDs oder Namen festgelegt werden.
get

HierarchiesRequestBatchGetDelete

"get" sollte beim Abrufen bestimmter Hierarchien durch IDs oder Namen festgelegt werden.
put

TimeSeriesHierarchy[]

"put" sollte beim Erstellen oder Aktualisieren von Hierarchien festgelegt werden.

HierarchiesBatchResponse

Antwort eines einzelnen Vorgangs für einen Batch von Zeitreihenhierarchien. Es wird nur eine von "get", "put" oder "delete" festgelegt.

Name Typ Beschreibung
delete

TsiErrorBody[]

Liste der Fehlerobjekte, die der Position des Arrays "delete" in der Anforderung entsprechen – null, wenn der Vorgang erfolgreich ist.
get

TimeSeriesHierarchyOrError[]

Liste der Hierarchie- oder Fehlerobjekte, die dem "get"-Array in der Anforderung entsprechen. Das Hierarchieobjekt wird festgelegt, wenn der Vorgang erfolgreich ist, und das Fehlerobjekt wird festgelegt, wenn der Vorgang nicht erfolgreich ist.
put

TimeSeriesHierarchyOrError[]

Liste der Hierarchie- oder Fehlerobjekte, die dem Array "put" in der Anforderung entsprechen. Das Hierarchieobjekt wird festgelegt, wenn der Vorgang erfolgreich ist, und das Fehlerobjekt wird festgelegt, wenn der Vorgang nicht erfolgreich ist.

HierarchiesRequestBatchGetDelete

Anforderung zum Abrufen oder Löschen mehrerer Zeitreihenhierarchien. Genau einer der "hierarchyIds" oder "names" muss festgelegt werden.

Name Typ Beschreibung
hierarchyIds

string[]

Liste der Hierarchie-IDs.
names

string[]

Liste der Hierarchienamen.

Source

Definition, wie Zeitreihenhierarchiestrukturebenen erstellt werden.

Name Typ Beschreibung
instanceFieldNames

string[]

Liste der instance Feldnamen, die in allen Zeitreiheninstanzen festgelegt werden müssen, die zu dieser Hierarchie gehören. Die Reihenfolge der instance Feldern definiert die Ebenen in der Hierarchie.

TimeSeriesHierarchy

Die Zeitreihenhierarchie organisiert Zeitreiheninstanzen in einer Struktur.

Name Typ Beschreibung
id

string

Bei eindeutiger Hierarchiebezeichner muss die Groß-/Kleinschreibung beachtet werden. Kann beim Erstellen von Hierarchieobjekten null sein, und dann generiert der Server die ID, nicht NULL bei Get- und Löschvorgängen.
name

string

Benutzerspezifischer eindeutiger Name für den Typ. Es ist veränderlich und nicht NULL.
source

Source

Definition, wie Zeitreihenhierarchiestrukturebenen erstellt werden.

TimeSeriesHierarchyOrError

Ergebnis eines Batchvorgangs für eine bestimmte Zeitreihenhierarchie. Die Hierarchie wird festgelegt, wenn der Vorgang erfolgreich ist und das Fehlerobjekt festgelegt wird, wenn der Vorgang nicht erfolgreich ist.

Name Typ Beschreibung
error

TsiErrorBody

Fehlerobjekt: Legt fest, wenn der Vorgang nicht erfolgreich ist.
hierarchy

TimeSeriesHierarchy

Zeitreihenhierarchieobjekt: Legen Sie fest, wenn der Vorgang erfolgreich ist.

TsiError

Informationen zu einem API-Fehler.

Name Typ Beschreibung
error

TsiErrorBody

Ein bestimmter API-Fehler mit einem Fehlercode und einer Meldung.

TsiErrorBody

Ein bestimmter API-Fehler mit einem Fehlercode und einer Meldung.

Name Typ Beschreibung
code

string

Sprachunabhängige, lesbare Zeichenfolge, die einen dienstspezifischen Fehlercode definiert. Dieser Code dient als spezifischer Indikator für den in der Antwort angegebenen HTTP-Fehlercode. Kann verwendet werden, um bestimmte Fehlerfälle programmgesteuert zu behandeln.
details

TsiErrorDetails[]

Enthält zusätzliche Fehlerinformationen. Ist möglicherweise NULL.
innerError

TsiErrorBody

Enthält einen spezifischeren Fehler, der die Ursache eingrenzt. Ist möglicherweise NULL.
message

string

Menschenlesbare, sprachunabhängige Darstellung des Fehlers. Es ist als Hilfe für Entwickler gedacht und eignet sich nicht für die Exposition gegenüber Endbenutzern.
target

string

Ziel des bestimmten Fehlers (z. B. der Name der -Eigenschaft im Fehler). Ist möglicherweise NULL.

TsiErrorDetails

Zusätzliche Fehlerinformationen.

Name Typ Beschreibung
code

string

Sprachunabhängige, lesbare Zeichenfolge, die einen dienstspezifischen Fehlercode definiert. Dieser Code dient als spezifischer Indikator für den in der Antwort angegebenen HTTP-Fehlercode. Kann verwendet werden, um bestimmte Fehlerfälle programmgesteuert zu behandeln.
message

string

Menschenlesbare, sprachunabhängige Darstellung des Fehlers. Es ist als Hilfe für Entwickler gedacht und eignet sich nicht für die Exposition gegenüber Endbenutzern.