Time Series Instances - Execute Batch

Ссылка

Service:: Time Series Insights

API Version:: 2020-07-31

Выполняет пакетную операцию получения, создания, обновления, удаления для нескольких экземпляров временных рядов.

POST https://{environmentFqdn}/timeseries/instances/$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	InstancesRequestBatchGetOrDelete	Удаляемых экземпляров временных рядов. Можно указать идентификатор или имя временных рядов.
get	InstancesRequestBatchGetOrDelete	Идентификаторы временных рядов или имена возвращаемых экземпляров временных рядов.
put	TimeSeriesInstance[]	Экземпляры временных рядов для создания или обновления.
update	TimeSeriesInstance[]	Обновляемый экземпляр временных рядов. Если экземпляр не существует, возвращается ошибка.

Ответы

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

Name

Type

Description

200 OK

InstancesBatchResponse

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

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

Name	Description
user_impersonation	олицетворения учетной записи пользователя

Примеры

InstancesBatchDeleteByIds

InstancesBatchDeleteByNames

InstancesBatchGetByIds

InstancesBatchGetByNames

InstancesBatchPut

InstancesBatchUpdate

InstancesBatchDeleteByIds

Sample Request

HTTP

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

{
  "delete": {
    "timeSeriesIds": [
      [
        "2da181d7-8346-4cf2-bd94-a17742237429",
        "T1"
      ],
      [
        "18672e3d-2beb-4007-9846-042b09ef3c72",
        "T2"
      ]
    ]
  }
}

Sample Response

Status code:: 200

{
  "delete": [
    null,
    {
      "code": "InvalidInput",
      "message": "Time series instance with ID '[\"18672e3d-2beb-4007-9846-042b09ef3c72\", \"T2\"]' cannot be deleted. There are already ingested events associated with this time series ID.",
      "innerError": {
        "code": "CannotDeleteInstance"
      }
    }
  ]
}

InstancesBatchDeleteByNames

Sample Request

HTTP

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

{
  "delete": {
    "names": [
      "F2W6.GF",
      "F1W7.GS1"
    ]
  }
}

Sample Response

Status code:: 200

{
  "delete": [
    null,
    {
      "code": "InvalidInput",
      "message": "Time series instance with ID '[\"18672e3d-2beb-4007-9846-042b09ef3c72\", \"T2\"]' cannot be deleted. There are already ingested events associated with this time series ID.",
      "innerError": {
        "code": "CannotDeleteInstance"
      }
    }
  ]
}

InstancesBatchGetByIds

Sample Request

HTTP

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

{
  "get": {
    "timeSeriesIds": [
      [
        "006dfc2d-0324-4937-998c-d16f3b4f1952",
        "T1"
      ]
    ]
  }
}

Sample Response

Status code:: 200

{
  "get": [
    {
      "instance": {
        "typeId": "9b84e946-7b36-4aa0-9d26-71bf48cb2aff",
        "name": "F1W7.GS1",
        "timeSeriesId": [
          "006dfc2d-0324-4937-998c-d16f3b4f1952",
          "T1"
        ],
        "description": "ContosoFarm1W7_GenSpeed1",
        "hierarchyIds": [
          "33d72529-dd73-4c31-93d8-ae4e6cb5605d"
        ],
        "instanceFields": {
          "Name": "GeneratorSpeed",
          "Plant": "Contoso Plant 1",
          "Unit": "W7",
          "System": "Generator System",
          "Status": false,
          "Version": 1.3,
          "Code": 28
        }
      }
    }
  ]
}

InstancesBatchGetByNames

Sample Request

HTTP

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

{
  "get": {
    "names": [
      "F1W7.GS1"
    ]
  }
}

Sample Response

Status code:: 200

{
  "get": [
    {
      "instance": {
        "typeId": "9b84e946-7b36-4aa0-9d26-71bf48cb2aff",
        "name": "F1W7.GS1",
        "timeSeriesId": [
          "006dfc2d-0324-4937-998c-d16f3b4f1952",
          "T1"
        ],
        "description": "ContosoFarm1W7_GenSpeed1",
        "hierarchyIds": [
          "33d72529-dd73-4c31-93d8-ae4e6cb5605d"
        ],
        "instanceFields": {
          "Name": "GeneratorSpeed",
          "Plant": "Contoso Plant 1",
          "Unit": "W7",
          "System": "Generator System",
          "Status": false,
          "Version": 1.3,
          "Code": 28
        }
      }
    }
  ]
}

InstancesBatchPut

Sample Request

HTTP

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

{
  "put": [
    {
      "typeId": "9b84e946-7b36-4aa0-9d26-71bf48cb2aff",
      "name": "F1W7.GS1",
      "timeSeriesId": [
        "006dfc2d-0324-4937-998c-d16f3b4f1952",
        "T1"
      ],
      "description": "ContosoFarm1W7_GenSpeed1",
      "hierarchyIds": [
        "33d72529-dd73-4c31-93d8-ae4e6cb5605d"
      ],
      "instanceFields": {
        "Name": "GeneratorSpeed",
        "Plant": "Contoso Plant 1",
        "Unit": "W7",
        "System": "Generator System",
        "Status": false,
        "Version": 1.3,
        "Code": 28
      }
    }
  ]
}

Sample Response

Status code:: 200

{
  "put": [
    {
      "error": null
    }
  ]
}

InstancesBatchUpdate

Sample Request

HTTP

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

{
  "update": [
    {
      "typeId": "9b84e946-7b36-4aa0-9d26-71bf48cb2aff",
      "name": "F1W7.GS1",
      "timeSeriesId": [
        "006dfc2d-0324-4937-998c-d16f3b4f1952",
        "T1"
      ],
      "description": "ContosoFarm1W7_GenSpeed1",
      "hierarchyIds": [
        "33d72529-dd73-4c31-93d8-ae4e6cb5605d"
      ],
      "instanceFields": {
        "Name": "GeneratorSpeed",
        "Plant": "Contoso Plant 1",
        "Unit": "W7",
        "System": "Generator System",
        "Status": false,
        "Version": 1.3,
        "Code": 28
      }
    }
  ]
}

Sample Response

Status code:: 200

{
  "update": [
    {
      "error": null
    }
  ]
}

Определения

InstanceOrError	Результат пакетной операции на определенном экземпляре временных рядов. Объект экземпляра задается, если операция выполнена успешно (за исключением операции put), а объект ошибки устанавливается при неудачной операции.
InstancesBatchRequest	Запрос на выполнение одной операции в пакете экземпляров. Необходимо задать ровно один из "get", "put", "update" или "delete".
InstancesBatchResponse	Ответ одной операции в пакете экземпляров. В запросе будет задано только одно из "get", "put", "update" или "delete".
InstancesRequestBatchGetOrDelete	Запрос на получение или удаление экземпляров по идентификаторам временных рядов или именам временных рядов. Необходимо задать ровно один из "timeSeriesIds" или "names".
TimeSeriesInstance	Экземпляры временных рядов — это сами временные ряды. В большинстве случаев они представляют собой DeviceID или AssetID — уникальный идентификатор ресурса в среде. Экземпляры содержат описательные сведения, связанные с ними, называемые полями экземпляров. Как минимум поля экземпляра включают сведения об иерархии. Они также могут содержать полезные, описательные данные, например сведения о производителе, операторе или дату последнего обновления.
TsiError	Сведения об ошибке API.
TsiErrorBody	Конкретная ошибка API с кодом ошибки и сообщением.
TsiErrorDetails	Дополнительные сведения об ошибке.

InstanceOrError

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

Name	Type	Description
error	TsiErrorBody	Объект ошибки — устанавливается, если операция завершается неудачно.
instance	TimeSeriesInstance	Объект экземпляра временных рядов — устанавливается при успешном выполнении операции (за исключением операции put).

InstancesBatchRequest

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

Name	Type	Description
delete	InstancesRequestBatchGetOrDelete	Удаляемых экземпляров временных рядов. Можно указать идентификатор или имя временных рядов.
get	InstancesRequestBatchGetOrDelete	Идентификаторы временных рядов или имена возвращаемых экземпляров временных рядов.
put	TimeSeriesInstance[]	Экземпляры временных рядов для создания или обновления.
update	TimeSeriesInstance[]	Обновляемый экземпляр временных рядов. Если экземпляр не существует, возвращается ошибка.

InstancesBatchResponse

Ответ одной операции в пакете экземпляров. В запросе будет задано только одно из "get", "put", "update" или "delete".

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

InstancesRequestBatchGetOrDelete

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

Name	Type	Description
names	string[]	Список имен экземпляров временных рядов для возврата или удаления.
timeSeriesIds	array[]	Список идентификаторов временных рядов экземпляров временных рядов для возврата или удаления.

TimeSeriesInstance

Экземпляры временных рядов — это сами временные ряды. В большинстве случаев они представляют собой DeviceID или AssetID — уникальный идентификатор ресурса в среде. Экземпляры содержат описательные сведения, связанные с ними, называемые полями экземпляров. Как минимум поля экземпляра включают сведения об иерархии. Они также могут содержать полезные, описательные данные, например сведения о производителе, операторе или дату последнего обновления.

Name	Type	Description
description	string	Это необязательное поле содержит описание экземпляра.
hierarchyIds	string[]	Набор идентификаторов иерархии временных рядов, к которым принадлежит экземпляр. Может принимать значение NULL.
instanceFields		Набор пар "ключ-значение", содержащих пользовательские свойства экземпляра. Значение может быть равно null. Поддерживаемые типы значений свойств: bool, string, long, double и не могут быть вложенными или пустыми.
name	string	Необязательное имя экземпляра, уникального в среде. Имена действуют как изменяемый псевдоним или отображаемое имя экземпляра временных рядов. Изменяемый, может иметь значение NULL.
timeSeriesId	TimeSeriesId[]	Идентификатор временного ряда, который однозначно идентифицирует экземпляр. Он соответствует свойствам идентификатора временных рядов в среде. Неизменяемый, никогда не допускающий значения NULL.
typeId	string	Представляет тип, к которому принадлежит данный экземпляр. Никогда не равно NULL.

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	Удобочитаемое, независимое от языка представление ошибки. Он предназначен как помощь разработчикам и не подходит для воздействия на конечных пользователей.