Partilhar via

Time Series Hierarchies - Execute Batch

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

Executa uma operação batch get, create, update, delete em várias definições de hierarquia de série temporal.

POST https://{environmentFqdn}/timeseries/hierarchies/$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

HierarchiesRequestBatchGetDelete

"eliminar" deve ser definido ao obter hierarquias específicas por IDs ou nomes.
get

HierarchiesRequestBatchGetDelete

"get" deve ser definido ao obter hierarquias específicas por IDs ou nomes.
put

TimeSeriesHierarchy[]

"put" deve ser definido ao criar ou atualizar hierarquias.

Respostas

Name Tipo Description
200 OK

HierarchiesBatchResponse

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

HierarchiesBatchDeleteByIds
HierarchiesBatchDeleteByNames
HierarchiesBatchGetByIds
HierarchiesBatchGetByNames
HierarchiesBatchPut

HierarchiesBatchDeleteByIds

Pedido de amostra

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

Resposta da amostra

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

HierarchiesBatchDeleteByNames

Pedido de amostra

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

{
  "delete": {
    "names": [
      "WindFarm"
    ]
  }
}

Resposta da amostra

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

HierarchiesBatchGetByIds

Pedido de amostra

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

Resposta da amostra

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

Pedido de amostra

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

{
  "get": {
    "names": [
      "Location",
      "ManufactureDate"
    ]
  }
}

Resposta da amostra

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

Pedido de amostra

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

Resposta da amostra

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

Definições

Name Description
HierarchiesBatchRequest

Pedido para executar uma única operação num lote de hierarquias. Exatamente um de "get", "put" ou "delete" tem de ser definido.
HierarchiesBatchResponse

Resposta de uma única operação num lote de hierarquias de série temporal. Apenas um de "get", "put" ou "delete" será definido.
HierarchiesRequestBatchGetDelete

Pedido para obter ou eliminar várias hierarquias de série temporal. É necessário definir exatamente um dos "hierarchyIds" ou "names".
Source

Definição de como os níveis de árvore da hierarquia de séries temporizadas são criados.
TimeSeriesHierarchy

A hierarquia de séries temporizadores organiza instâncias de série temporal numa árvore.
TimeSeriesHierarchyOrError

Resultado de uma operação de lote numa hierarquia de série temporal específica. A hierarquia é definida quando a operação é bem-sucedida e o objeto de erro é definido quando a operação não é bem sucedida.
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.

HierarchiesBatchRequest

Pedido para executar uma única operação num lote de hierarquias. Exatamente um de "get", "put" ou "delete" tem de ser definido.

Name Tipo Description
delete

HierarchiesRequestBatchGetDelete

"eliminar" deve ser definido ao obter hierarquias específicas por IDs ou nomes.
get

HierarchiesRequestBatchGetDelete

"get" deve ser definido ao obter hierarquias específicas por IDs ou nomes.
put

TimeSeriesHierarchy[]

"put" deve ser definido ao criar ou atualizar hierarquias.

HierarchiesBatchResponse

Resposta de uma única operação num lote de hierarquias de série temporal. Apenas um de "get", "put" ou "delete" será definido.

Name Tipo Description
delete

TsiErrorBody[]

Lista de objetos de erro correspondentes por posição à matriz "eliminar" no pedido – nulo quando a operação for bem-sucedida.
get

TimeSeriesHierarchyOrError[]

Lista de objetos de hierarquia ou erro correspondentes por posição à matriz "obter" no pedido. O objeto hierarquia é definido quando a operação é bem-sucedida e o objeto de erro é definido quando a operação não é bem sucedida.
put

TimeSeriesHierarchyOrError[]

Lista de objetos de hierarquia ou erro correspondentes por posição à matriz "put" no pedido. O objeto hierarquia é definido quando a operação é bem-sucedida e o objeto de erro é definido quando a operação não é bem sucedida.

HierarchiesRequestBatchGetDelete

Pedido para obter ou eliminar várias hierarquias de série temporal. É necessário definir exatamente um dos "hierarchyIds" ou "names".

Name Tipo Description
hierarchyIds

string[]

Lista de IDs de hierarquia.
names

string[]

Lista de nomes de hierarquia.

Source

Definição de como os níveis de árvore da hierarquia de séries temporizadas são criados.

Name Tipo Description
instanceFieldNames

string[]

Lista de nomes de campos de instâncias que têm de ser definidos em todas as instâncias de série temporal que pertencem a esta hierarquia. A ordem dos campos de instância define os níveis na hierarquia.

TimeSeriesHierarchy

A hierarquia de séries temporizadores organiza instâncias de série temporal numa árvore.

Name Tipo Description
id

string

Identificador de hierarquia exclusivo sensível a maiúsculas e minúsculas. Pode ser nulo ao criar objetos de hierarquia e, em seguida, o servidor gera o ID e não nulo nas operações de obtenção e eliminação.
name

string

Nome exclusivo fornecido pelo utilizador para o tipo. É mutável e não nulo.
source

Source

Definição de como os níveis de árvore da hierarquia de séries temporizadas são criados.

TimeSeriesHierarchyOrError

Resultado de uma operação de lote numa hierarquia de série temporal específica. A hierarquia é definida quando a operação é bem-sucedida 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.
hierarchy

TimeSeriesHierarchy

Objeto de hierarquia de série temporal - defina quando a operação for bem-sucedida.

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.