Time Series Hierarchies - Execute Batch

服務:: Time Series Insights

API 版本:: 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	在通過ID或名稱獲取特定層次結構時應設置「delete」。
get	HierarchiesRequestBatchGetDelete	在通過ID或名稱獲取特定層次結構時應設置「get」。
put	TimeSeriesHierarchy[]	在創建或更新層次結構時應設置“put”。

回應

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

名稱

類型

Description

200 OK

HierarchiesBatchResponse

作業成功。

標題

x-ms-request-id: string

Other Status Codes

TsiError

非預期的錯誤。

標題

x-ms-request-id: string

安全性

azure_auth

Azure Active Directory OAuth2 流

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

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

範例

HierarchiesBatchDeleteByIds

HierarchiesBatchDeleteByNames

HierarchiesBatchGetByIds

HierarchiesBatchGetByNames

HierarchiesBatchPut

HierarchiesBatchDeleteByIds

範例要求

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

範例回覆

狀態碼:: 200

{
  "delete": [
    null
  ]
}

HierarchiesBatchDeleteByNames

範例要求

HTTP

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

範例要求

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

範例回覆

狀態碼:: 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

範例要求

HTTP

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

範例要求

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

範例回覆

狀態碼:: 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」或「names」中的一個。
Source	定義如何創建時序層次結構樹級別。
TimeSeriesHierarchy	時序層次結構將時序實例組織到樹中。
TimeSeriesHierarchyOrError	對特定時間序列層次結構進行批處理作的結果。作成功時設置層次結構，作不成功時設置錯誤物件。
TsiError	API 錯誤的相關信息。
TsiErrorBody	具有錯誤碼和訊息的特定 API 錯誤。
TsiErrorDetails	其他錯誤資訊。

HierarchiesBatchRequest

Object

請求對一批層次結構執行單個作。必須設定「get」、「put」或「刪除」的其中一個。

名稱	類型	Description
delete	HierarchiesRequestBatchGetDelete	在通過ID或名稱獲取特定層次結構時應設置「delete」。
get	HierarchiesRequestBatchGetDelete	在通過ID或名稱獲取特定層次結構時應設置「get」。
put	TimeSeriesHierarchy[]	在創建或更新層次結構時應設置“put”。

HierarchiesBatchResponse

Object

對一批時間序列層次結構的單個作的回應。僅設置“get”、“put”或“delete”之一。

名稱	類型	Description
delete	TsiErrorBody[]	在作業成功時，依要求中「delete」陣列位置對應的錯誤物件清單 - Null。
get	TimeSeriesHierarchyOrError[]	按位置對應於請求中「get」陣列的層次結構或錯誤對象的清單。作成功時設置層次結構物件，作失敗時設置錯誤物件。
put	TimeSeriesHierarchyOrError[]	按位置對應於請求中「put」陣列的層次結構或錯誤對象的清單。作成功時設置層次結構物件，作失敗時設置錯誤物件。

HierarchiesRequestBatchGetDelete

Object

請求獲取或刪除多個時序層次結構。必須設置「hierarchyIds」或「names」中的一個。

名稱	類型	Description
hierarchyIds	string[]	層次結構ID清單。
names	string[]	層次結構名稱清單。

Source

Object

定義如何創建時序層次結構樹級別。

名稱	類型	Description
instanceFieldNames	string[]	必須在屬於此層次結構的所有時序實例中設置的實例欄位名稱清單。實例欄位的順序定義了層次結構中的級別。

TimeSeriesHierarchy

Object

時序層次結構將時序實例組織到樹中。

名稱	類型	Description
id	string	區分大小寫的唯一層次結構標識碼。在創建層次結構物件時可以為 null，然後伺服器在獲取和刪除作時生成 id，而不是 null。
name	string	型別的使用者指定唯一名稱。它是可變的，不是空的。
source	Source	定義如何創建時序層次結構樹級別。

TimeSeriesHierarchyOrError

Object

對特定時間序列層次結構進行批處理作的結果。作成功時設置層次結構，作不成功時設置錯誤物件。

名稱	類型	Description
error	TsiErrorBody	錯誤物件 - 當作業失敗時設定。
hierarchy	TimeSeriesHierarchy	時序層次結構物件 - 在作成功時設置。

TsiError

Object

API 錯誤的相關信息。

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

TsiErrorBody

Object

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

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

TsiErrorDetails

Object

其他錯誤資訊。

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

共用方式為

Time Series Hierarchies - Execute Batch

URI 參數

要求標頭

要求本文

回應

安全性

azure_auth

範圍

範例

HierarchiesBatchDeleteByIds

範例要求

範例回覆

HierarchiesBatchDeleteByNames

範例要求

範例回覆

HierarchiesBatchGetByIds

範例要求

範例回覆

HierarchiesBatchGetByNames

範例要求

範例回覆

HierarchiesBatchPut

範例要求

範例回覆

定義

HierarchiesBatchRequest

HierarchiesBatchResponse

HierarchiesRequestBatchGetDelete

Source

TimeSeriesHierarchy

TimeSeriesHierarchyOrError

TsiError

TsiErrorBody

TsiErrorDetails