Time Series Hierarchies - Execute Batch

  • リファレンス
サービス:
Time Series Insights
API バージョン:
2020-07-31

複数の時系列階層定義に対してバッチ取得、作成、更新、削除操作を実行します。

POST https://{environmentFqdn}/timeseries/hierarchies/$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

HierarchiesRequestBatchGetDelete

特定の階層を ID または名前でフェッチするときに、"delete" を設定する必要があります。
get

HierarchiesRequestBatchGetDelete

"get" は、ID または名前によって特定の階層をフェッチするときに設定する必要があります。
put

TimeSeriesHierarchy[]

階層の作成または更新中は、"put" を設定する必要があります。

応答

名前 型 説明
200 OK

HierarchiesBatchResponse

操作は成功しました。

ヘッダー

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 ユーザー アカウントの借用

例

HierarchiesBatchDeleteByIds
HierarchiesBatchDeleteByNames
HierarchiesBatchGetByIds
HierarchiesBatchGetByNames
HierarchiesBatchPut

HierarchiesBatchDeleteByIds

要求のサンプル

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

応答のサンプル

状態コード:
200 
{
  "delete": [
    null
  ]
}

HierarchiesBatchDeleteByNames

要求のサンプル

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

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

応答のサンプル

状態コード:
200 
{
  "delete": [
    null
  ]
}

HierarchiesBatchGetByIds

要求のサンプル

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

応答のサンプル

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

要求のサンプル

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

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

応答のサンプル

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

要求のサンプル

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

応答のサンプル

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

定義

名前 説明
HierarchiesBatchRequest

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

時系列階層のバッチに対する 1 つの操作の応答。 設定されるのは、"get"、"put"、または "delete" のいずれか 1 つだけです。
HierarchiesRequestBatchGetDelete

複数の時系列階層の取得または削除を要求します。 "hierarchyIds" または "names" のいずれかを設定する必要があります。
Source

時系列階層ツリー レベルを作成する方法の定義。
TimeSeriesHierarchy

時系列階層は、時系列インスタンスをツリーに整理します。
TimeSeriesHierarchyOrError

特定の時系列階層でのバッチ操作の結果。 操作が成功すると階層が設定され、操作が失敗したときに error オブジェクトが設定されます。
TsiError

API エラーに関する情報。
TsiErrorBody

エラー コードとメッセージを含む特定の API エラー。
TsiErrorDetails

その他のエラー情報。

HierarchiesBatchRequest

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

名前 型 説明
delete

HierarchiesRequestBatchGetDelete

特定の階層を ID または名前でフェッチするときに、"delete" を設定する必要があります。
get

HierarchiesRequestBatchGetDelete

"get" は、ID または名前によって特定の階層をフェッチするときに設定する必要があります。
put

TimeSeriesHierarchy[]

階層の作成または更新中は、"put" を設定する必要があります。

HierarchiesBatchResponse

時系列階層のバッチに対する 1 つの操作の応答。 設定されるのは、"get"、"put"、または "delete" のいずれか 1 つだけです。

名前 型 説明
delete

TsiErrorBody[]

要求内の "delete" 配列への位置で対応するエラー オブジェクトの一覧 - 操作が成功した場合は null。
get

TimeSeriesHierarchyOrError[]

要求内の "get" 配列の位置によって対応する階層オブジェクトまたはエラー オブジェクトの一覧。 操作が成功すると Hierarchy オブジェクトが設定され、操作が失敗したときに error オブジェクトが設定されます。
put

TimeSeriesHierarchyOrError[]

要求内の "put" 配列の位置によって対応する階層またはエラー オブジェクトの一覧。 操作が成功すると Hierarchy オブジェクトが設定され、操作が失敗したときに error オブジェクトが設定されます。

HierarchiesRequestBatchGetDelete

複数の時系列階層の取得または削除を要求します。 "hierarchyIds" または "names" のいずれかを設定する必要があります。

名前 型 説明
hierarchyIds

string[]

階層 ID の一覧。
names

string[]

階層名の一覧。

Source

時系列階層ツリー レベルを作成する方法の定義。

名前 型 説明
instanceFieldNames

string[]

この階層に属するすべての時系列インスタンスで設定する必要があるインスタンス フィールド名の一覧。 インスタンス フィールドの順序によって、階層内のレベルが定義されます。

TimeSeriesHierarchy

時系列階層は、時系列インスタンスをツリーに整理します。

名前 型 説明
id

string

大文字と小文字を区別する一意の階層識別子。 階層オブジェクトの作成時に null を指定でき、サーバーは取得操作と削除操作で null ではなく ID を生成します。
name

string

型のユーザー指定の一意の名前。 これは変更可能であり、null ではありません。
source

Source

時系列階層ツリー レベルを作成する方法の定義。

TimeSeriesHierarchyOrError

特定の時系列階層でのバッチ操作の結果。 操作が成功すると階層が設定され、操作が失敗したときに error オブジェクトが設定されます。

名前 型 説明
error

TsiErrorBody

Error オブジェクト - 操作が失敗したときに設定されます。
hierarchy

TimeSeriesHierarchy

時系列階層オブジェクト - 操作が成功したときに設定されます。

TsiError

API エラーに関する情報。

名前 型 説明
error

TsiErrorBody

エラー コードとメッセージを含む特定の API エラー。

TsiErrorBody

エラー コードとメッセージを含む特定の API エラー。

名前 型 説明
code

string

サービス固有のエラー コードを定義する、言語に依存しない人間が判読できる文字列。 このコードは、応答で指定された HTTP エラー コードのより具体的なインジケーターとして機能します。 特定のエラー ケースをプログラムで処理するために使用できます。
details

TsiErrorDetails[]

追加のエラー情報が含まれています。 null も指定できます。
innerError

TsiErrorBody

原因を絞り込む、より具体的なエラーが含まれています。 null も指定できます。
message

string

エラーの人間が判読できる言語に依存しない表現。 これは開発者の支援を目的としており、エンド ユーザーへの公開には適していません。
target

string

特定のエラーのターゲット (たとえば、エラーのプロパティの名前)。 null も指定できます。

TsiErrorDetails

その他のエラー情報。

名前 型 説明
code

string

サービス固有のエラー コードを定義する、言語に依存しない人間が判読できる文字列。 このコードは、応答で指定された HTTP エラー コードのより具体的なインジケーターとして機能します。 特定のエラー ケースをプログラムで処理するために使用できます。
message

string

エラーの人間が判読できる言語に依存しない表現。 これは開発者の支援を目的としており、エンド ユーザーへの公開には適していません。