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

Name	In	Required	Type	Description
environmentFqdn	path	True	string	Полное доменное имя среды, например 10000000-0000-0000-0000-100000000109.env.timeseries.azure.com. Это доменное имя можно получить из ответа API get Environments, портал Azure или Azure Resource Manager.
api-version	query	True	string	Версия API, используемая с клиентским запросом. В настоящее время поддерживается версия 2020-07-31.

Заголовок запроса

Name	Required	Type	Description
x-ms-client-request-id		string	Необязательный идентификатор запроса клиента. Служба записывает это значение. Позволяет службе отслеживать операции между службами и позволяет клиенту обращаться в службу поддержки в отношении конкретного запроса.
x-ms-client-session-id		string	Необязательный идентификатор сеанса клиента. Служба записывает это значение. Позволяет службе отслеживать группу связанных операций между службами и позволяет клиенту обращаться в службу поддержки в отношении определенной группы запросов.

Текст запроса

Name	Type	Description
delete	HierarchiesRequestBatchGetDelete	При выборе определенных иерархий по идентификаторам или именам необходимо задать значение delete.
get	HierarchiesRequestBatchGetDelete	Параметр get должен быть задан при выборе определенных иерархий по идентификаторам или именам.
put	TimeSeriesHierarchy[]	При создании или обновлении иерархий должно быть задано значение put.

Ответы

Name	Type	Description
200 OK	HierarchiesBatchResponse	Успешная операция. Headers x-ms-request-id: string
Other Status Codes	TsiError	Непредвиденная ошибка. Headers x-ms-request-id: string

Name

Type

Description

200 OK

HierarchiesBatchResponse

Успешная операция.

Headers

x-ms-request-id: string

Other Status Codes

TsiError

Непредвиденная ошибка.

Headers

x-ms-request-id: string

Безопасность

azure_auth

Flow OAuth2 Azure Active Directory

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

Scopes

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

Определения

HierarchiesBatchRequest	Запрос на выполнение одной операции в пакете иерархий. Необходимо задать только один из "get", "put" или "delete".
HierarchiesBatchResponse	Ответ одной операции на пакет иерархий временных рядов. Будет задано только одно из "get", "put" или "delete".
HierarchiesRequestBatchGetDelete	Запрос на получение или удаление нескольких иерархий временных рядов. Необходимо задать именно один из hierarchyIds или "names".
Source	Определение способа создания уровней дерева иерархии временных рядов.
TimeSeriesHierarchy	Иерархия временных рядов упорядочивает экземпляры временных рядов в дерево.
TimeSeriesHierarchyOrError	Результат пакетной операции в определенной иерархии временных рядов. Иерархия задается, если операция выполнена успешно, а объект ошибки устанавливается при неудачной операции.
TsiError	Сведения об ошибке API.
TsiErrorBody	Конкретная ошибка API с кодом ошибки и сообщением.
TsiErrorDetails	Дополнительные сведения об ошибке.

HierarchiesBatchRequest

Запрос на выполнение одной операции в пакете иерархий. Необходимо задать только один из "get", "put" или "delete".

Name	Type	Description
delete	HierarchiesRequestBatchGetDelete	При выборе определенных иерархий по идентификаторам или именам необходимо задать значение delete.
get	HierarchiesRequestBatchGetDelete	Параметр get должен быть задан при выборе определенных иерархий по идентификаторам или именам.
put	TimeSeriesHierarchy[]	При создании или обновлении иерархий должно быть задано значение put.

HierarchiesBatchResponse

Ответ одной операции на пакет иерархий временных рядов. Будет задано только одно из "get", "put" или "delete".

Name	Type	Description
delete	TsiErrorBody[]	Список объектов ошибок, соответствующих по позиции массива delete в запросе, — null при успешном выполнении операции.
get	TimeSeriesHierarchyOrError[]	Список объектов иерархии или ошибок, соответствующих по позиции массива get в запросе. Объект Hierarchy задается, если операция выполнена успешно, а объект ошибки устанавливается при неудачной операции.
put	TimeSeriesHierarchyOrError[]	Список иерархии или объекта ошибки, соответствующих по позиции массива put в запросе. Объект Hierarchy задается, если операция выполнена успешно, а объект ошибки устанавливается при неудачной операции.

HierarchiesRequestBatchGetDelete

Запрос на получение или удаление нескольких иерархий временных рядов. Необходимо задать именно один из hierarchyIds или "names".

Name	Type	Description
hierarchyIds	string[]	Список идентификаторов иерархии.
names	string[]	Список имен иерархии.

Source

Определение способа создания уровней дерева иерархии временных рядов.

Name	Type	Description
instanceFieldNames	string[]	Список имен полей экземпляров, которые должны быть заданы во всех экземплярах временных рядов, принадлежащих этой иерархии. Порядок полей экземпляра определяет уровни иерархии.

TimeSeriesHierarchy

Иерархия временных рядов упорядочивает экземпляры временных рядов в дерево.

Name	Type	Description
id	string	Уникальный идентификатор иерархии с учетом регистра. Может иметь значение NULL при создании объектов иерархии, а затем сервер создает идентификатор, а не null при операциях получения и удаления.
name	string	Уникальное имя типа, заданное пользователем. Он является изменяемым и не имеет значения NULL.
source	Source	Определение способа создания уровней дерева иерархии временных рядов.

TimeSeriesHierarchyOrError

Результат пакетной операции в определенной иерархии временных рядов. Иерархия задается, если операция выполнена успешно, а объект ошибки устанавливается при неудачной операции.

Name	Type	Description
error	TsiErrorBody	Объект ошибки — устанавливается, если операция завершается неудачно.
hierarchy	TimeSeriesHierarchy	Объект иерархии временных рядов — устанавливается при успешном выполнении операции.

TsiError

Сведения об ошибке API.

Name	Type	Description
error	TsiErrorBody	Конкретная ошибка API с кодом ошибки и сообщением.

TsiErrorBody

Конкретная ошибка API с кодом ошибки и сообщением.

Name	Type	Description
code	string	Независимая от языка строка, читаемая человеком, которая определяет код ошибки, относящуюся к конкретной службе. Этот код служит более конкретным индикатором для кода ошибки HTTP, указанного в ответе. Можно использовать для программной обработки конкретных случаев ошибок.
details	TsiErrorDetails[]	Содержит дополнительные сведения об ошибке. Может принимать значение NULL.
innerError	TsiErrorBody	Содержит более конкретную ошибку, которая сужает причину. Может принимать значение NULL.
message	string	Удобочитаемое, независимое от языка представление ошибки. Она предназначена для разработчиков и не подходит для воздействия на конечных пользователей.
target	string	Целевой объект конкретной ошибки (например, имя свойства в ошибке). Может принимать значение NULL.

TsiErrorDetails

Дополнительные сведения об ошибке.

Name	Type	Description
code	string	Независимая от языка строка, читаемая человеком, которая определяет код ошибки, относящуюся к конкретной службе. Этот код служит более конкретным индикатором для кода ошибки HTTP, указанного в ответе. Можно использовать для программной обработки конкретных случаев ошибок.
message	string	Удобочитаемое, независимое от языка представление ошибки. Она предназначена для разработчиков и не подходит для воздействия на конечных пользователей.