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	10000000-0000-0000-0000-100000000109.env.timeseries.azure.com など、環境ごとの FQDN。このドメイン名は、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[]	更新する時系列インスタンス。インスタンスが存在しない場合は、エラーが返されます。

応答

名前	型	説明
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" のいずれか 1 つだけです。
InstancesRequestBatchGetOrDelete	時系列 ID または時系列名によるインスタンスの取得または削除を要求します。 "timeSeriesIds" または "names" のいずれかを設定する必要があります。
TimeSeriesInstance	時系列インスタンスは、時系列自体です。ほとんどの場合、deviceId または assetId が、環境内での資産の一意識別子となります。インスタンスには、インスタンスフィールドと呼ばれる説明情報が関連付けられています。少なくとも、インスタンスフィールドには階層情報が含まれます。製造元、運用者、最終保守日など、有用な説明データを含めることもできます。
TsiError	API エラーに関する情報。
TsiErrorBody	エラーコードとメッセージを含む特定の API エラー。
TsiErrorDetails	その他のエラー情報。

InstanceOrError

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

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

InstancesBatchRequest

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

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

InstancesBatchResponse

インスタンスのバッチに対する 1 つの操作の応答。要求に基づいて設定されるのは、"get"、"put"、"update"、または "delete" のいずれか 1 つだけです。

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

InstancesRequestBatchGetOrDelete

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

名前	型	説明
names	string[]	取得または削除する時系列インスタンスの名前の一覧。
timeSeriesIds	TimeSeriesId[]	取得または削除する時系列インスタンスの時系列 ID の一覧。