Time Series Instances - Execute Batch

サービス:: Time Series Insights

API バージョン:: 2020-07-31

複数の時系列インスタンスでバッチの取得、作成、更新、削除操作を実行します。

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

URI パラメーター

名前	/	必須	型	説明
environmentFqdn	path	True	string	環境ごとの FQDN (たとえば、10000000-0000-0000-0000-100000000109.env.timeseries.azure.com)。このドメイン名は、Get Environments API、Azure portal、または Azure Resource Manager の応答から取得できます。
api-version	query	True	string	クライアント要求で使用する API のバージョン。現在サポートされているバージョンは "2020-07-31" です。

要求ヘッダー

名前	必須	型	説明
x-ms-client-request-id		string	オプションのクライアント要求 ID。サービスはこの値を記録します。サービスがサービス間で操作をトレースできるようにし、顧客が特定の要求に関してサポートに連絡できるようにします。
x-ms-client-session-id		string	オプションのクライアントセッション ID。サービスはこの値を記録します。サービスがサービス間で関連する操作のグループをトレースできるようにし、顧客が特定の要求グループに関するサポートに問い合わせることができます。

要求本文

名前	型	説明
delete	InstancesRequestBatchGetOrDelete	削除される時系列インスタンス。時系列 ID または名前を指定できます。
get	InstancesRequestBatchGetOrDelete	返す時系列インスタンスの時系列 ID または名前。
put	TimeSeriesInstance[]	作成または更新する時系列インスタンス。
update	TimeSeriesInstance[]	更新される時系列インスタンス。 instance が存在しない場合は、エラーが返されます。

応答

名前	型	説明
200 OK	InstancesBatchResponse	正常な操作。ヘッダー x-ms-request-id: string
Other Status Codes	TsiError	予期しないエラー。ヘッダー x-ms-request-id: string

名前

型

説明

200 OK

InstancesBatchResponse

正常な操作。

ヘッダー

x-ms-request-id: string

Other Status Codes

TsiError

予期しないエラー。

ヘッダー

x-ms-request-id: string

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザーアカウントを偽装する

例

InstancesBatchDeleteByIds

InstancesBatchDeleteByNames

InstancesBatchGetByIds

InstancesBatchGetByNames

InstancesBatchPut

InstancesBatchUpdate

InstancesBatchDeleteByIds

要求のサンプル

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

応答のサンプル

状態コード:: 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

要求のサンプル

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

応答のサンプル

状態コード:: 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

要求のサンプル

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

応答のサンプル

状態コード:: 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

要求のサンプル

HTTP

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

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

応答のサンプル

状態コード:: 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

要求のサンプル

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

応答のサンプル

状態コード:: 200

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

InstancesBatchUpdate

要求のサンプル

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

応答のサンプル

状態コード:: 200

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

定義

名前	説明
InstanceOrError	特定の時系列インスタンスに対するバッチ操作の結果。インスタンスオブジェクトは、操作が成功した場合(put操作を除く)、エラーオブジェクトは、操作が失敗した場合に設定されます。
InstancesBatchRequest	インスタンスのバッチに対して 1 つの操作を実行するように要求します。「get」、「put」、「update」、または「delete」のいずれか正確に設定する必要があります。
InstancesBatchResponse	インスタンスのバッチに対する 1 つの操作の応答。リクエストに基づいて「get」、「put」、「update」、または「delete」のいずれかのみが設定されます。
InstancesRequestBatchGetOrDelete	時系列 ID または時系列名によるインスタンスの取得または削除を要求します。「timeSeriesIds」または「names」のいずれかを正確に設定する必要があります。
TimeSeriesInstance	時系列インスタンスは時系列そのものです。ほとんどの場合、deviceId または assetId は、環境内のアセットの一意の識別子です。インスタンスには、インスタンスフィールドと呼ばれる説明情報が関連付けられています。少なくとも、インスタンス・フィールドには階層情報が含まれます。また、製造元、オペレーター、最終サービス日などの有用な説明データを含めることもできます。
TsiError	API エラーに関する情報。
TsiErrorBody	エラーコードとメッセージを含む特定の API エラー。
TsiErrorDetails	その他のエラー情報。

InstanceOrError

Object

特定の時系列インスタンスに対するバッチ操作の結果。インスタンスオブジェクトは、操作が成功した場合(put操作を除く)、エラーオブジェクトは、操作が失敗した場合に設定されます。

名前	型	説明
error	TsiErrorBody	Error オブジェクト - 操作が失敗したときに設定されます。
instance	TimeSeriesInstance	時系列インスタンスオブジェクト - 操作が成功したときに設定されます(put操作を除く)。

InstancesBatchRequest

Object

インスタンスのバッチに対して 1 つの操作を実行するように要求します。「get」、「put」、「update」、または「delete」のいずれか正確に設定する必要があります。

名前	型	説明
delete	InstancesRequestBatchGetOrDelete	削除される時系列インスタンス。時系列 ID または名前を指定できます。
get	InstancesRequestBatchGetOrDelete	返す時系列インスタンスの時系列 ID または名前。
put	TimeSeriesInstance[]	作成または更新する時系列インスタンス。
update	TimeSeriesInstance[]	更新される時系列インスタンス。 instance が存在しない場合は、エラーが返されます。

InstancesBatchResponse

Object

インスタンスのバッチに対する 1 つの操作の応答。リクエストに基づいて「get」、「put」、「update」、または「delete」のいずれかのみが設定されます。

名前	型	説明
delete	TsiErrorBody[]	リクエスト内の「delete」配列に位置別に対応するエラーオブジェクトのリスト。 Null は、インスタンスが削除されたか、存在しなかったことを意味します。エラーオブジェクトは、操作が失敗した場合(たとえば、この時系列インスタンスに関連付けられたイベントがある場合)に設定されます。
get	InstanceOrError[]	リクエスト内の「get」配列に位置別に対応するインスタンスまたはエラーオブジェクトのリスト。インスタンスオブジェクトは、操作が成功すると設定され、エラーオブジェクトは、操作が失敗した場合に設定されます。
put	InstanceOrError[]	リクエスト内の「put」配列に位置別に対応するエラーオブジェクトのリスト。エラーオブジェクトは、操作が失敗した場合に設定されます。
update	InstanceOrError[]	リクエスト内の "update" 配列に位置別に対応するエラーオブジェクトのリスト。インスタンスオブジェクトは、操作が成功すると設定され、エラーオブジェクトは、操作が失敗した場合に設定されます。

InstancesRequestBatchGetOrDelete

Object

時系列 ID または時系列名によるインスタンスの取得または削除を要求します。「timeSeriesIds」または「names」のいずれかを正確に設定する必要があります。

名前	型	説明
names	string[]	返す、または削除する時系列インスタンスの名前のリスト。
timeSeriesIds	TimeSeriesId[]	返す、または削除する時系列インスタンスの時系列 ID のリスト。