Time Series Instances - Execute Batch

Referência

Serviço:: Time Series Insights

Versão da API:: 2020-07-31

Executa uma operação get, create, update, delete em várias instâncias de série temporal.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
environmentFqdn	path	True	string	Por FQDN de ambiente, por exemplo, 10000000-0000-0000-0000-100000000109.env.timeseries.azure.com. Você pode obter esse nome de domínio da resposta da API Obter Ambientes, portal do Azure ou Resource Manager do Azure.
api-version	query	True	string	Versão da API a ser usada com a solicitação do cliente. Atualmente, a versão com suporte é "2020-07-31".

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
x-ms-client-request-id		string	ID de solicitação de cliente opcional. O serviço registra esse valor. Permite que o serviço rastreie a operação entre os serviços e permite que o cliente entre em contato com o suporte em relação a uma solicitação específica.
x-ms-client-session-id		string	ID opcional da sessão do cliente. O serviço registra esse valor. Permite que o serviço rastreie um grupo de operações relacionadas entre serviços e permite que o cliente entre em contato com o suporte em relação a um grupo específico de solicitações.

Corpo da solicitação

Nome	Tipo	Description
delete	InstancesRequestBatchGetOrDelete	Instâncias de série temporal a serem excluídas. A ID ou o nome da série temporal pode ser especificado.
get	InstancesRequestBatchGetOrDelete	IDs de série temporal ou nomes de instâncias de série temporal a serem retornados.
put	TimeSeriesInstance[]	Instâncias de série temporal a serem criadas ou atualizadas.
update	TimeSeriesInstance[]	Instância de série temporal a ser atualizada. Se a instância não existir, um erro será retornado.

Respostas

Nome	Tipo	Description
200 OK	InstancesBatchResponse	Operação com êxito. Cabeçalhos x-ms-request-id: string
Other Status Codes	TsiError	Erro inesperado. Cabeçalhos x-ms-request-id: string

Nome

Tipo

Description

200 OK

InstancesBatchResponse

Operação com êxito.

Cabeçalhos

x-ms-request-id: string

Other Status Codes

TsiError

Erro inesperado.

Cabeçalhos

x-ms-request-id: string

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

InstancesBatchDeleteByIds

InstancesBatchDeleteByNames

InstancesBatchGetByIds

InstancesBatchGetByNames

InstancesBatchPut

InstancesBatchUpdate

InstancesBatchDeleteByIds

Solicitação de exemplo

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

Resposta de exemplo

Código de status:: 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

Solicitação de exemplo

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

Resposta de exemplo

Código de status:: 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

Solicitação de exemplo

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

Resposta de exemplo

Código de status:: 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

Solicitação de exemplo

HTTP

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

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

Resposta de exemplo

Código de status:: 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

Solicitação de exemplo

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

Resposta de exemplo

Código de status:: 200

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

InstancesBatchUpdate

Solicitação de exemplo

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

Resposta de exemplo

Código de status:: 200

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

Definições

Nome	Description
InstanceOrError	Resultado de uma operação em lote em uma instância de série temporal específica. O objeto de instância é definido quando a operação é bem-sucedida (exceto a operação put) e o objeto de erro é definido quando a operação não é bem-sucedida.
InstancesBatchRequest	Solicitação para executar uma única operação em um lote de instâncias. Exatamente um de "get", "put", "update" ou "delete" deve ser definido.
InstancesBatchResponse	Resposta de uma única operação em um lote de instâncias. Apenas um de "get", "put", "update" ou "delete" será definido com base na solicitação.
InstancesRequestBatchGetOrDelete	Solicite a obtenção ou exclusão de instâncias por IDs de série temporal ou nomes de série temporal. Exatamente um dos "timeSeriesIds" ou "names" deve ser definido.
TimeSeriesInstance	As instâncias de série temporal são a própria série temporal. Na maioria dos casos, o deviceId ou assetId é o identificador exclusivo do ativo no ambiente. As instâncias têm informações descritivas associadas a elas chamadas campos de instância. No mínimo, os campos de instância incluem informações de hierarquia. Elas também podem incluir dados úteis e descritivos, como fabricante, operador ou última data de serviço.
TsiError	Informações sobre um erro de API.
TsiErrorBody	Um erro de API específico com um código de erro e uma mensagem.
TsiErrorDetails	Informações adicionais de erro.

InstanceOrError

Resultado de uma operação em lote em uma instância de série temporal específica. O objeto de instância é definido quando a operação é bem-sucedida (exceto a operação put) e o objeto de erro é definido quando a operação não é bem-sucedida.

Nome	Tipo	Description
error	TsiErrorBody	Objeto error – definido quando a operação não for bem-sucedida.
instance	TimeSeriesInstance	Objeto de instância de série temporal – definido quando a operação for bem-sucedida (exceto a operação put).

InstancesBatchRequest

Solicitação para executar uma única operação em um lote de instâncias. Exatamente um de "get", "put", "update" ou "delete" deve ser definido.

Nome	Tipo	Description
delete	InstancesRequestBatchGetOrDelete	Instâncias de série temporal a serem excluídas. A ID ou o nome da série temporal pode ser especificado.
get	InstancesRequestBatchGetOrDelete	IDs de série temporal ou nomes de instâncias de série temporal a serem retornados.
put	TimeSeriesInstance[]	Instâncias de série temporal a serem criadas ou atualizadas.
update	TimeSeriesInstance[]	Instância de série temporal a ser atualizada. Se a instância não existir, um erro será retornado.

InstancesBatchResponse

Resposta de uma única operação em um lote de instâncias. Apenas um de "get", "put", "update" ou "delete" será definido com base na solicitação.

Nome	Tipo	Description
delete	TsiErrorBody[]	Lista de objetos de erro correspondentes por posição à matriz "delete" na solicitação. Nulo significa que a instância foi excluída ou não existe. O objeto error é definido quando a operação não é bem-sucedida (por exemplo, quando há eventos associados a essa instância de série temporal).
get	InstanceOrError[]	Lista de objetos de instância ou de erro correspondentes por posição à matriz "get" na solicitação. O objeto de instância é definido quando a operação é bem-sucedida e o objeto de erro é definido quando a operação não é bem-sucedida.
put	InstanceOrError[]	Lista de objetos de erro correspondentes por posição à matriz "put" na solicitação. O objeto error é definido quando a operação não é bem-sucedida.
update	InstanceOrError[]	Lista de objetos de erro correspondentes por posição à matriz de "atualização" na solicitação. O objeto de instância é definido quando a operação é bem-sucedida e o objeto de erro é definido quando a operação não é bem-sucedida.

InstancesRequestBatchGetOrDelete

Solicite a obtenção ou exclusão de instâncias por IDs de série temporal ou nomes de série temporal. Exatamente um dos "timeSeriesIds" ou "names" deve ser definido.

Nome	Tipo	Description
names	string[]	Lista de nomes das instâncias de série temporal a serem retornadas ou excluídas.
timeSeriesIds	TimeSeriesId[]	Lista de IDs de série temporal das instâncias de série temporal a serem retornadas ou excluídas.