Partilhar via

Time Series Instances - Execute Batch

  • Referência
Serviço:
Time Series Insights
Versão da API:
2020-07-31

Executa uma operação de obtenção, criação, atualização e eliminação em várias instâncias de série temporal.

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

Parâmetros do URI

Name Em Necessário Tipo Description
environmentFqdn
 path True

string

Por FQDN de ambiente, por exemplo, 10000000-0000-0000-0000-100000000109.env.timeseries.azure.com. Pode obter este nome de domínio a partir da resposta da API Get Environments, portal do Azure ou do Azure Resource Manager.
api-version
 query True

string

Versão da API a utilizar com o pedido de cliente. A versão atualmente suportada é "2020-07-31".

Cabeçalho do Pedido

Name Necessário Tipo Description
x-ms-client-request-id

string

ID de pedido de cliente opcional. O serviço regista este valor. Permite ao serviço rastrear a operação entre serviços e permite que o cliente contacte o suporte relativamente a um pedido específico.
x-ms-client-session-id

string

ID de sessão de cliente opcional. O serviço regista este valor. Permite ao serviço rastrear um grupo de operações relacionadas entre serviços e permite que o cliente contacte o suporte relativamente a um determinado grupo de pedidos.

Corpo do Pedido

Name Tipo Description
delete

InstancesRequestBatchGetOrDelete

Instâncias de série temporal a eliminar. O ID ou o nome da série temporal podem ser especificados.
get

InstancesRequestBatchGetOrDelete

IDs de série temporal ou nomes de instâncias de série temporal a devolver.
put

TimeSeriesInstance[]

Instâncias de série temporal a criar ou atualizar.
update

TimeSeriesInstance[]

Instância de série temporal a atualizar. Se a instância não existir, é devolvido um erro.

Respostas

Name Tipo Description
200 OK

InstancesBatchResponse

Operação bem-sucedida.

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 OAuth2 do Azure Active Directory

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

Âmbitos

Name Description
user_impersonation representar a sua conta de utilizador

Exemplos

InstancesBatchDeleteByIds
InstancesBatchDeleteByNames
InstancesBatchGetByIds
InstancesBatchGetByNames
InstancesBatchPut
InstancesBatchUpdate

InstancesBatchDeleteByIds

Pedido de amostra

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 da amostra

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

Pedido de amostra

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 da amostra

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

Pedido de amostra

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 da amostra

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

Pedido de amostra

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

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

Resposta da amostra

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

Pedido de amostra

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 da amostra

Código de estado:
200 
{
  "put": [
    {
      "error": null
    }
  ]
}

InstancesBatchUpdate

Pedido de amostra

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 da amostra

Código de estado:
200 
{
  "update": [
    {
      "error": null
    }
  ]
}

Definições

Name Description
InstanceOrError

Resultado de uma operação de lote numa 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

Pedido para efetuar uma única operação num lote de instâncias. É necessário definir exatamente um de "get", "put", "update" ou "delete".
InstancesBatchResponse

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

Pedido para obter ou eliminar instâncias por IDs de série temporal ou nomes de série temporal. Exatamente um dos "timeSeriesIds" ou "names" tem de ser definido.
TimeSeriesInstance

As instâncias de série temporal são as próprias séries temporizadores. Na maioria dos casos, deviceId ou assetId é o identificador exclusivo do recurso no ambiente. As instâncias têm informações descritivas associadas aos mesmos denominados campos de instância. No mínimo, os campos de instância incluem informações de hierarquia. Também podem incluir dados úteis e descritivos, como o fabricante, o operador ou a data do último serviço.
TsiError

Informações sobre um erro de API.
TsiErrorBody

Um erro específico da API com um código de erro e uma mensagem.
TsiErrorDetails

Informações de erro adicionais.

InstanceOrError

Resultado de uma operação de lote numa 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.

Name Tipo Description
error

TsiErrorBody

Objeto de erro – definido quando a operação não é bem-sucedida.
instance

TimeSeriesInstance

Objeto de instância de série temporal – defina quando a operação for bem-sucedida (exceto a operação put).

InstancesBatchRequest

Pedido para efetuar uma única operação num lote de instâncias. É necessário definir exatamente um de "get", "put", "update" ou "delete".

Name Tipo Description
delete

InstancesRequestBatchGetOrDelete

Instâncias de série temporal a eliminar. O ID ou o nome da série temporal podem ser especificados.
get

InstancesRequestBatchGetOrDelete

IDs de série temporal ou nomes de instâncias de série temporal a devolver.
put

TimeSeriesInstance[]

Instâncias de série temporal a criar ou atualizar.
update

TimeSeriesInstance[]

Instância de série temporal a atualizar. Se a instância não existir, é devolvido um erro.

InstancesBatchResponse

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

Name Tipo Description
delete

TsiErrorBody[]

Lista de objetos de erro correspondentes por posição à matriz "eliminar" no pedido. Nulo significa que a instância foi eliminada ou não existia. O objeto de erro é definido quando a operação não é bem sucedida (por exemplo, quando existem eventos associados a esta instância de série temporal).
get

InstanceOrError[]

Lista de objetos de instância ou erro correspondentes por posição à matriz "obter" no pedido. 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" no pedido. O objeto de erro é definido quando a operação não é bem sucedida.
update

InstanceOrError[]

Lista de objetos de erro correspondentes por posição à matriz "update" no pedido. 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

Pedido para obter ou eliminar instâncias por IDs de série temporal ou nomes de série temporal. Exatamente um dos "timeSeriesIds" ou "names" tem de ser definido.

Name Tipo Description
names

string[]

Lista de nomes das instâncias de série temporal a devolver ou eliminar.
timeSeriesIds

TimeSeriesId[]

Lista de IDs de série temporal das instâncias de série temporal para devolver ou eliminar.

TimeSeriesInstance

As instâncias de série temporal são as próprias séries temporizadores. Na maioria dos casos, deviceId ou assetId é o identificador exclusivo do recurso no ambiente. As instâncias têm informações descritivas associadas aos mesmos denominados campos de instância. No mínimo, os campos de instância incluem informações de hierarquia. Também podem incluir dados úteis e descritivos, como o fabricante, o operador ou a data do último serviço.

Name Tipo Description
description

string

Este campo opcional contém uma descrição sobre a instância.
hierarchyIds

string[]

Conjunto de IDs de hierarquia de série temporal aos quais a instância pertence. Pode ser nulo.
instanceFields

Conjunto de pares chave-valor que contêm propriedades de instância definidas pelo utilizador. Pode ser nulo. Os tipos de valor de propriedade suportados são: bool, cadeia, longo, duplo e não podem ser aninhados ou nulos.
name

string

Nome opcional da instância que é exclusiva num ambiente. Os nomes atuam como um alias mutável ou nome a apresentar da instância da série temporal. Mutable, pode ser nulo.
timeSeriesId

TimeSeriesId[]

ID da Série Temporal que identifica exclusivamente a instância. Corresponde às propriedades do ID do Time Series num ambiente. Imutável, nunca nulo.
typeId

string

Isto representa o tipo a que esta instância pertence. Nunca nulo.

TsiError

Informações sobre um erro de API.

Name Tipo Description
error

TsiErrorBody

Um erro específico da API com um código de erro e uma mensagem.

TsiErrorBody

Um erro específico da API com um código de erro e uma mensagem.

Name Tipo Description
code

string

Cadeia de carateres independente de linguagem e legível por humanos que define um código de erro específico do serviço. Este código serve como um indicador mais específico para o código de erro HTTP especificado na resposta. Pode ser utilizado para processar programaticamente casos de erro específicos.
details

TsiErrorDetails[]

Contém informações de erro adicionais. Pode ser nulo.
innerError

TsiErrorBody

Contém um erro mais específico que reduz a causa. Pode ser nulo.
message

string

Representação legível por humanos e independente da linguagem do erro. Destina-se a ajudar os programadores e não é adequado para exposição aos utilizadores finais.
target

string

Destino do erro específico (por exemplo, o nome da propriedade em erro). Pode ser nulo.

TsiErrorDetails

Informações de erro adicionais.

Name Tipo Description
code

string

Cadeia de carateres independente de linguagem e legível por humanos que define um código de erro específico do serviço. Este código serve como um indicador mais específico para o código de erro HTTP especificado na resposta. Pode ser utilizado para processar programaticamente casos de erro específicos.
message

string

Representação legível por humanos e independente da linguagem do erro. Destina-se a ajudar os programadores e não é adequado para exposição aos utilizadores finais.