Time Series Instances - Execute Batch

Referenz

Dienst:: Time Series Insights

API-Version:: 2020-07-31

Führt einen Batchvorgang zum Abrufen, Erstellen, Aktualisieren und Löschen für mehrere Zeitreiheninstanzen aus.

POST https://{environmentFqdn}/timeseries/instances/$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	InstancesRequestBatchGetOrDelete	Zu löschende Zeitreiheninstanzen. Die Zeitreihen-ID oder der Name kann angegeben werden.
get	InstancesRequestBatchGetOrDelete	Zeitreihen-IDs oder Namen von zurückzugebenden Zeitreiheninstanzen.
put	TimeSeriesInstance[]	Zu erstellende oder zu aktualisierende Zeitreiheninstanzen.
update	TimeSeriesInstance[]	Zeitreihen instance aktualisiert werden. Wenn instance nicht vorhanden ist, wird ein Fehler zurückgegeben.

Antworten

Name	Typ	Beschreibung
200 OK	InstancesBatchResponse	Erfolgreiche Ausführung Header x-ms-request-id: string
Other Status Codes	TsiError	Unerwarteter Fehler. Header x-ms-request-id: string

Name

Typ

Beschreibung

200 OK

InstancesBatchResponse

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

InstancesBatchDeleteByIds

InstancesBatchDeleteByNames

InstancesBatchGetByIds

InstancesBatchGetByNames

InstancesBatchPut

InstancesBatchUpdate

InstancesBatchDeleteByIds

Beispielanforderung

HTTP

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

{
  "delete": {
    "timeSeriesIds": [
      [
        "2da181d7-8346-4cf2-bd94-a17742237429",
        "T1"
      ],
      [
        "18672e3d-2beb-4007-9846-042b09ef3c72",
        "T2"
      ]
    ]
  }
}

Beispiel für eine Antwort

Statuscode:: 200

{
  "delete": [
    null,
    {
      "code": "InvalidInput",
      "message": "Time series instance with ID '[\"18672e3d-2beb-4007-9846-042b09ef3c72\", \"T2\"]' cannot be deleted. There are already ingested events associated with this time series ID.",
      "innerError": {
        "code": "CannotDeleteInstance"
      }
    }
  ]
}

InstancesBatchDeleteByNames

Beispielanforderung

HTTP

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

{
  "delete": {
    "names": [
      "F2W6.GF",
      "F1W7.GS1"
    ]
  }
}

Beispiel für eine Antwort

Statuscode:: 200

{
  "delete": [
    null,
    {
      "code": "InvalidInput",
      "message": "Time series instance with ID '[\"18672e3d-2beb-4007-9846-042b09ef3c72\", \"T2\"]' cannot be deleted. There are already ingested events associated with this time series ID.",
      "innerError": {
        "code": "CannotDeleteInstance"
      }
    }
  ]
}

InstancesBatchGetByIds

Beispielanforderung

HTTP

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

{
  "get": {
    "timeSeriesIds": [
      [
        "006dfc2d-0324-4937-998c-d16f3b4f1952",
        "T1"
      ]
    ]
  }
}

Beispiel für eine Antwort

Statuscode:: 200

{
  "get": [
    {
      "instance": {
        "typeId": "9b84e946-7b36-4aa0-9d26-71bf48cb2aff",
        "name": "F1W7.GS1",
        "timeSeriesId": [
          "006dfc2d-0324-4937-998c-d16f3b4f1952",
          "T1"
        ],
        "description": "ContosoFarm1W7_GenSpeed1",
        "hierarchyIds": [
          "33d72529-dd73-4c31-93d8-ae4e6cb5605d"
        ],
        "instanceFields": {
          "Name": "GeneratorSpeed",
          "Plant": "Contoso Plant 1",
          "Unit": "W7",
          "System": "Generator System",
          "Status": false,
          "Version": 1.3,
          "Code": 28
        }
      }
    }
  ]
}

InstancesBatchGetByNames

Beispielanforderung

HTTP

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

{
  "get": {
    "names": [
      "F1W7.GS1"
    ]
  }
}

Beispiel für eine Antwort

Statuscode:: 200

{
  "get": [
    {
      "instance": {
        "typeId": "9b84e946-7b36-4aa0-9d26-71bf48cb2aff",
        "name": "F1W7.GS1",
        "timeSeriesId": [
          "006dfc2d-0324-4937-998c-d16f3b4f1952",
          "T1"
        ],
        "description": "ContosoFarm1W7_GenSpeed1",
        "hierarchyIds": [
          "33d72529-dd73-4c31-93d8-ae4e6cb5605d"
        ],
        "instanceFields": {
          "Name": "GeneratorSpeed",
          "Plant": "Contoso Plant 1",
          "Unit": "W7",
          "System": "Generator System",
          "Status": false,
          "Version": 1.3,
          "Code": 28
        }
      }
    }
  ]
}

InstancesBatchPut

Beispielanforderung

HTTP

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

{
  "put": [
    {
      "typeId": "9b84e946-7b36-4aa0-9d26-71bf48cb2aff",
      "name": "F1W7.GS1",
      "timeSeriesId": [
        "006dfc2d-0324-4937-998c-d16f3b4f1952",
        "T1"
      ],
      "description": "ContosoFarm1W7_GenSpeed1",
      "hierarchyIds": [
        "33d72529-dd73-4c31-93d8-ae4e6cb5605d"
      ],
      "instanceFields": {
        "Name": "GeneratorSpeed",
        "Plant": "Contoso Plant 1",
        "Unit": "W7",
        "System": "Generator System",
        "Status": false,
        "Version": 1.3,
        "Code": 28
      }
    }
  ]
}

Beispiel für eine Antwort

Statuscode:: 200

{
  "put": [
    {
      "error": null
    }
  ]
}

InstancesBatchUpdate

Beispielanforderung

HTTP

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

{
  "update": [
    {
      "typeId": "9b84e946-7b36-4aa0-9d26-71bf48cb2aff",
      "name": "F1W7.GS1",
      "timeSeriesId": [
        "006dfc2d-0324-4937-998c-d16f3b4f1952",
        "T1"
      ],
      "description": "ContosoFarm1W7_GenSpeed1",
      "hierarchyIds": [
        "33d72529-dd73-4c31-93d8-ae4e6cb5605d"
      ],
      "instanceFields": {
        "Name": "GeneratorSpeed",
        "Plant": "Contoso Plant 1",
        "Unit": "W7",
        "System": "Generator System",
        "Status": false,
        "Version": 1.3,
        "Code": 28
      }
    }
  ]
}

Beispiel für eine Antwort

Statuscode:: 200

{
  "update": [
    {
      "error": null
    }
  ]
}

Definitionen

Name	Beschreibung
InstanceOrError	Ergebnis eines Batchvorgangs für eine bestimmte Zeitreihe instance. Das Instanzobjekt wird festgelegt, wenn der Vorgang erfolgreich ist (mit Ausnahme des Put-Vorgangs), und das Fehlerobjekt wird festgelegt, wenn der Vorgang nicht erfolgreich ist.
InstancesBatchRequest	Anforderung zum Ausführen eines einzelnen Vorgangs für einen Batch von Instanzen. Genau eine von "get", "put", "update" oder "delete" muss festgelegt werden.
InstancesBatchResponse	Antwort eines einzelnen Vorgangs für einen Batch von Instanzen. Nur eine von "get", "put", "update" oder "delete" wird basierend auf der Anforderung festgelegt.
InstancesRequestBatchGetOrDelete	Anforderung zum Abrufen oder Löschen von Instanzen nach Zeitreihen-IDs oder Zeitreihennamen. Genau einer von "timeSeriesIds" oder "name" muss festgelegt werden.
TimeSeriesInstance	Zeitreiheninstanzen sind die Zeitreihen selbst. In den meisten Fällen ist die deviceId oder die assetId der eindeutige Bezeichner des Objekts in der Umgebung. Instanzen verfügen über beschreibende Informationen, die als instance Felder bezeichnet werden. Mindestens instance Felder enthalten Hierarchieinformationen. Sie können auch nützliche, beschreibende Daten enthalten wie Hersteller, Bediener oder letztes Wartungsdatum.
TsiError	Informationen zu einem API-Fehler.
TsiErrorBody	Ein bestimmter API-Fehler mit einem Fehlercode und einer Meldung.
TsiErrorDetails	Zusätzliche Fehlerinformationen.

InstanceOrError

Ergebnis eines Batchvorgangs für eine bestimmte Zeitreihe instance. Das Instanzobjekt wird festgelegt, wenn der Vorgang erfolgreich ist (mit Ausnahme des Put-Vorgangs), und das Fehlerobjekt wird festgelegt, wenn der Vorgang nicht erfolgreich ist.

Name	Typ	Beschreibung
error	TsiErrorBody	Fehlerobjekt: Legt fest, wenn der Vorgang nicht erfolgreich ist.
instance	TimeSeriesInstance	Zeitreihen instance -Objekt : Legen Sie fest, wenn der Vorgang erfolgreich ist (mit Ausnahme des Put-Vorgangs).

InstancesBatchRequest

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

Name	Typ	Beschreibung
delete	InstancesRequestBatchGetOrDelete	Zu löschende Zeitreiheninstanzen. Die Zeitreihen-ID oder der Name kann angegeben werden.
get	InstancesRequestBatchGetOrDelete	Zeitreihen-IDs oder Namen von zurückzugebenden Zeitreiheninstanzen.
put	TimeSeriesInstance[]	Zu erstellende oder zu aktualisierende Zeitreiheninstanzen.
update	TimeSeriesInstance[]	Zeitreihen instance aktualisiert werden. Wenn instance nicht vorhanden ist, wird ein Fehler zurückgegeben.

InstancesBatchResponse

Antwort eines einzelnen Vorgangs für einen Batch von Instanzen. Nur eine von "get", "put", "update" oder "delete" wird basierend auf der Anforderung festgelegt.

Name	Typ	Beschreibung
delete	TsiErrorBody[]	Liste der Fehlerobjekte, die dem Array "delete" in der Anforderung entsprechen. Null bedeutet, dass der instance gelöscht wurde oder nicht vorhanden ist. Das Fehlerobjekt wird festgelegt, wenn der Vorgang nicht erfolgreich ist (z. B. wenn dieser Zeitreihen instance Ereignisse zugeordnet sind).
get	InstanceOrError[]	Liste der instance- oder Fehlerobjekte, die nach Position zum "get"-Array in der Anforderung entsprechen. Das Instanzobjekt wird festgelegt, wenn der Vorgang erfolgreich ist, und das Fehlerobjekt wird festgelegt, wenn der Vorgang nicht erfolgreich ist.
put	InstanceOrError[]	Liste der Fehlerobjekte, die der Position des Arrays "put" in der Anforderung entsprechen. Fehlerobjekt wird festgelegt, wenn der Vorgang nicht erfolgreich ist.
update	InstanceOrError[]	Liste der Fehlerobjekte, die der Position des Arrays "update" in der Anforderung entsprechen. Das Instanzobjekt wird festgelegt, wenn der Vorgang erfolgreich ist, und das Fehlerobjekt wird festgelegt, wenn der Vorgang nicht erfolgreich ist.

InstancesRequestBatchGetOrDelete

Anforderung zum Abrufen oder Löschen von Instanzen nach Zeitreihen-IDs oder Zeitreihennamen. Genau einer von "timeSeriesIds" oder "name" muss festgelegt werden.

Name	Typ	Beschreibung
names	string[]	Liste der Namen der zurückzugebenden oder zu löschenden Zeitreiheninstanzen.
timeSeriesIds	TimeSeriesId[]	Liste der Zeitreihen-IDs der zurückzugebenden oder zu löschenden Zeitreiheninstanzen.