Поделиться через

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

Полное доменное имя среды, например 10000000-0000-0000-0000-100000000109.env.timeseries.azure.com. Это доменное имя можно получить из ответа API получения сред, портал Azure или azure Resource Manager.
api-version
 query True

string

Версия API для использования с клиентским запросом. В настоящее время поддерживается версия 2020-07-31.

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

Имя Обязательно Тип Описание
x-ms-client-request-id

string

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

string

Необязательный идентификатор сеанса клиента. Служба записывает это значение. Позволяет службе отслеживать группу связанных операций между службами и позволяет клиенту обращаться в службу поддержки по поводу определенной группы запросов.

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

Имя Тип Описание
delete

HierarchiesRequestBatchGetDelete

Параметр "delete" следует задать при выборке определенных иерархий по идентификаторам или именам.
get

HierarchiesRequestBatchGetDelete

"get" следует задать при выборке определенных иерархий по идентификаторам или именам.
put

TimeSeriesHierarchy[]

Параметр put должен быть задан при создании или обновлении иерархий.

Ответы

Имя Тип Описание
200 OK

HierarchiesBatchResponse

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

Заголовки

x-ms-request-id: string
Other Status Codes

TsiError

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

Заголовки

x-ms-request-id: string

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

azure_auth

Поток OAuth2 в Azure Active Directory

Тип: oauth2
Flow: implicit
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

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

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

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

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

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

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

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

Определенная ошибка API с кодом ошибки и сообщением.
TsiErrorDetails

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

HierarchiesBatchRequest

Object

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

Имя Тип Описание
delete

HierarchiesRequestBatchGetDelete

Параметр "delete" следует задать при выборке определенных иерархий по идентификаторам или именам.
get

HierarchiesRequestBatchGetDelete

"get" следует задать при выборке определенных иерархий по идентификаторам или именам.
put

TimeSeriesHierarchy[]

Параметр put должен быть задан при создании или обновлении иерархий.

HierarchiesBatchResponse

Object

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

Имя Тип Описание
delete

TsiErrorBody[]

Список объектов ошибок, соответствующих по позиции массиву "delete" в запросе — null при успешном выполнении операции.
get

TimeSeriesHierarchyOrError[]

Список объектов иерархии или ошибок, соответствующих по позиции массиву get в запросе. Объект иерархии задается при успешном выполнении операции, а объект ошибки — при неудачной операции.
put

TimeSeriesHierarchyOrError[]

Список объектов иерархии или ошибки, соответствующих по позиции массиву put в запросе. Объект иерархии задается при успешном выполнении операции, а объект ошибки — при неудачной операции.

HierarchiesRequestBatchGetDelete

Object

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

Имя Тип Описание
hierarchyIds

string[]

Список идентификаторов иерархии.
names

string[]

Список имен иерархий.

Source

Object

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

Имя Тип Описание
instanceFieldNames

string[]

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

TimeSeriesHierarchy

Object

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

Имя Тип Описание
id

string

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

string

Уникальное имя типа, заданное пользователем. Он является изменяемым и не имеет значения NULL.
source

Source

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

TimeSeriesHierarchyOrError

Object

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

Имя Тип Описание
error

TsiErrorBody

Объект ошибки — устанавливается при неудачном выполнении операции.
hierarchy

TimeSeriesHierarchy

Объект иерархии временных рядов — устанавливается при успешном выполнении операции.

TsiError

Object

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

Имя Тип Описание
error

TsiErrorBody

Определенная ошибка API с кодом ошибки и сообщением.

TsiErrorBody

Object

Определенная ошибка API с кодом ошибки и сообщением.

Имя Тип Описание
code

string

Независимая от языка, читаемая человеком строка, определяющая код ошибки для конкретной службы. Этот код служит более конкретным индикатором для кода ошибки HTTP, указанного в ответе. Может использоваться для программной обработки конкретных случаев ошибок.
details

TsiErrorDetails[]

Содержит дополнительные сведения об ошибке. Может принимать значение NULL.
innerError

TsiErrorBody

Содержит более конкретную ошибку, которая сужает причину. Может принимать значение NULL.
message

string

Удобочитаемое, независимое от языка представление ошибки. Он предназначен для разработчиков и не подходит для воздействия на конечных пользователей.
target

string

Целевой объект конкретной ошибки (например, имя свойства в ошибке). Может принимать значение NULL.

TsiErrorDetails

Object

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

Имя Тип Описание
code

string

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

string

Удобочитаемое, независимое от языка представление ошибки. Он предназначен для разработчиков и не подходит для воздействия на конечных пользователей.