Time Series Hierarchies - Execute Batch

參考

Service:: Time Series Insights

API Version:: 2020-07-31

在多個時間序列階層定義上執行批次取得、建立、更新、刪除作業。

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

URI 參數

名稱	位於	必要	類型	Description
environmentFqdn	path	True	string	每個環境 FQDN，例如 10000000-0000-0000-0000-100000000109.env.timeseries.azure.com。您可以從取得環境 API、Azure 入口網站或 Azure Resource Manager 的回應中取得此功能變數名稱。
api-version	query	True	string	要與用戶端要求搭配使用的 API 版本。目前支援的版本是「2020-07-31」。

要求標頭

名稱	必要	類型	Description
x-ms-client-request-id		string	選擇性用戶端要求識別碼。服務會記錄此值。允許服務跨服務追蹤作業，並允許客戶連絡有關特定要求的支持人員。
x-ms-client-session-id		string	選擇性用戶端會話識別碼。服務會記錄此值。允許服務追蹤跨服務的相關作業群組，並允許客戶連絡支持人員，以取得特定要求群組的相關信息。

要求本文

名稱	類型	Description
delete	HierarchiesRequestBatchGetDelete	在依標識碼或名稱擷取特定階層時，應該設定「刪除」。
get	HierarchiesRequestBatchGetDelete	在依標識碼或名稱擷取特定階層時，應該設定「get」。。
put	TimeSeriesHierarchy[]	建立或更新階層時，應該設定「put」。

回應

名稱	類型	Description
200 OK	HierarchiesBatchResponse	成功的作業。 Headers x-ms-request-id: string
Other Status Codes	TsiError	非預期的錯誤。 Headers x-ms-request-id: string

名稱

類型

Description

200 OK

HierarchiesBatchResponse

成功的作業。

Headers

x-ms-request-id: string

Other Status Codes

TsiError

非預期的錯誤。

Headers

x-ms-request-id: string

安全性

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

HierarchiesBatchDeleteByIds

HierarchiesBatchDeleteByNames

HierarchiesBatchGetByIds

HierarchiesBatchGetByNames

HierarchiesBatchPut

HierarchiesBatchDeleteByIds

Sample Request

HTTP

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

Sample Response

Status code:: 200

{
  "delete": [
    null
  ]
}

HierarchiesBatchDeleteByNames

Sample Request

HTTP

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

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

Sample Response

Status code:: 200

{
  "delete": [
    null
  ]
}

HierarchiesBatchGetByIds

Sample Request

HTTP

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

Sample Response

Status code:: 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

Sample Request

HTTP

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

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

Sample Response

Status code:: 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

Sample Request

HTTP

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

Sample Response

Status code:: 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
    }
  ]
}

定義

名稱	Description
HierarchiesBatchRequest	要求在階層批次上執行單一作業。必須設定「get」、「put」或「刪除」的其中一個。
HierarchiesBatchResponse	一批時間序列階層上單一作業的回應。只會設定其中一個「get」、“put” 或「delete」。
HierarchiesRequestBatchGetDelete	要求取得或刪除多個時間序列階層。必須設定「hierarchyIds」或「名稱」的其中一個。
Source	定義建立時間序列階層樹狀目錄層級的方式。
TimeSeriesHierarchy	時間序列階層會將時間序列實例組織成樹狀結構。
TimeSeriesHierarchyOrError	特定時間序列階層上的批次作業結果。當作業成功時，就會設定階層，並在作業失敗時設定錯誤物件。
TsiError	API 錯誤的相關信息。
TsiErrorBody	具有錯誤碼和訊息的特定 API 錯誤。
TsiErrorDetails	其他錯誤資訊。

HierarchiesBatchRequest

要求在階層批次上執行單一作業。必須設定「get」、「put」或「刪除」的其中一個。

名稱	類型	Description
delete	HierarchiesRequestBatchGetDelete	在依標識碼或名稱擷取特定階層時，應該設定「刪除」。
get	HierarchiesRequestBatchGetDelete	在依標識碼或名稱擷取特定階層時，應該設定「get」。。
put	TimeSeriesHierarchy[]	建立或更新階層時，應該設定「put」。

HierarchiesBatchResponse

一批時間序列階層上單一作業的回應。只會設定其中一個「get」、“put” 或「delete」。

名稱	類型	Description
delete	TsiErrorBody[]	在作業成功時，依位置對應至要求中「delete」陣列的錯誤物件清單 - Null。
get	TimeSeriesHierarchyOrError[]	依位置對應至要求中「get」陣列的階層或錯誤物件清單。當作業成功且在作業失敗時設定錯誤物件時，就會設定階層物件。
put	TimeSeriesHierarchyOrError[]	依位置對應至要求中「put」陣列的階層或錯誤物件清單。當作業成功且在作業失敗時設定錯誤物件時，就會設定階層物件。

HierarchiesRequestBatchGetDelete

要求取得或刪除多個時間序列階層。必須設定「hierarchyIds」或「名稱」的其中一個。

名稱	類型	Description
hierarchyIds	string[]	階層識別碼的清單。
names	string[]	階層名稱的清單。

Source

定義建立時間序列階層樹狀目錄層級的方式。

名稱	類型	Description
instanceFieldNames	string[]	必須在屬於這個階層的所有時間序列實例中設定的實例域名清單。實例欄位的順序會定義階層中的層級。

TimeSeriesHierarchy

時間序列階層會將時間序列實例組織成樹狀結構。

名稱	類型	Description
id	string	區分大小寫的唯一階層標識碼。在建立階層物件時可以是 Null，然後伺服器會產生標識碼，而不是在取得和刪除作業時為 Null。
name	string	使用者指定之類型的唯一名稱。它是可變動的，而不是 Null。
source	Source	定義建立時間序列階層樹狀目錄層級的方式。

TimeSeriesHierarchyOrError

特定時間序列階層上的批次作業結果。當作業成功時，就會設定階層，並在作業失敗時設定錯誤物件。

名稱	類型	Description
error	TsiErrorBody	錯誤物件 - 當作業失敗時設定。
hierarchy	TimeSeriesHierarchy	時間序列階層物件 - 當作業成功時設定。

TsiError

API 錯誤的相關信息。

名稱	類型	Description
error	TsiErrorBody	具有錯誤碼和訊息的特定 API 錯誤。

TsiErrorBody

具有錯誤碼和訊息的特定 API 錯誤。

名稱	類型	Description
code	string	與語言無關、人類可讀取的字串，可定義服務特定的錯誤碼。此程式代碼可作為回應中指定的 HTTP 錯誤碼更明確的指標。可用來以程式設計方式處理特定錯誤案例。
details	TsiErrorDetails[]	包含其他錯誤資訊。可能是 Null。
innerError	TsiErrorBody	包含更明確的錯誤，可縮小原因範圍。可能是 Null。
message	string	人類可讀、與語言無關的錯誤表示法。它是開發人員的協助，不適合公開給終端使用者。
target	string	例如，特定錯誤的目標 (，錯誤) 的屬性名稱。可能是 Null。

TsiErrorDetails

其他錯誤資訊。

名稱	類型	Description
code	string	與語言無關、人類可讀取的字串，可定義服務特定的錯誤碼。此程式代碼可作為回應中指定的 HTTP 錯誤碼更明確的指標。可用來以程式設計方式處理特定錯誤案例。
message	string	人類可讀、與語言無關的錯誤表示法。它是開發人員的協助，不適合公開給終端使用者。

Share via

Time Series Hierarchies - Execute Batch

URI 參數

要求標頭

要求本文

回應

安全性

azure_auth

Scopes

範例

HierarchiesBatchDeleteByIds

Sample Request

Sample Response

HierarchiesBatchDeleteByNames

Sample Request

Sample Response

HierarchiesBatchGetByIds

Sample Request

Sample Response

HierarchiesBatchGetByNames

Sample Request

Sample Response

HierarchiesBatchPut

Sample Request

Sample Response

定義

HierarchiesBatchRequest

HierarchiesBatchResponse

HierarchiesRequestBatchGetDelete

Source

TimeSeriesHierarchy

TimeSeriesHierarchyOrError

TsiError

TsiErrorBody

TsiErrorDetails

其他資源