Compartilhar via

Time Series Hierarchies - Execute Batch

  • Referência
Service:
Time Series Insights
API Version:
2020-07-31

Executa uma operação 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 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

HierarchiesRequestBatchGetDelete

"delete" deve ser definido ao buscar hierarquias específicas por IDs ou nomes.
get

HierarchiesRequestBatchGetDelete

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

TimeSeriesHierarchy[]

"put" deve ser definido durante a criação ou atualização de hierarquias.

Respostas

Nome Tipo Description
200 OK

HierarchiesBatchResponse

Operação com êxito.

Headers

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

TsiError

Erro inesperado.

Headers

x-ms-request-id: string

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nome Description
user_impersonation representar sua conta de usuário

Exemplos

HierarchiesBatchDeleteByIds
HierarchiesBatchDeleteByNames
HierarchiesBatchGetByIds
HierarchiesBatchGetByNames
HierarchiesBatchPut

HierarchiesBatchDeleteByIds

Sample Request

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

Sample Response

Status code:
200 
{
  "delete": [
    null
  ]
}

HierarchiesBatchDeleteByNames

Sample Request

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

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

Sample Response

Status code:
200 
{
  "delete": [
    null
  ]
}

HierarchiesBatchGetByIds

Sample Request

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

Sample Response

Status code:
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

Sample Request

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

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

Sample Response

Status code:
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

Sample Request

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

Sample Response

Status code:
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

Nome Description
HierarchiesBatchRequest

Solicite a execução de uma única operação em um lote de hierarquias. Exatamente um de "get", "put" ou "delete" deve ser definido.
HierarchiesBatchResponse

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

Solicite a obtenção ou exclusão de várias hierarquias de série temporal. Exatamente um dos "hierarchyIds" ou "names" deve ser definido.
Source

Definição de como os níveis de árvore de hierarquia de série temporal são criados.
TimeSeriesHierarchy

A hierarquia de série temporal organiza instâncias de série temporal em uma árvore.
TimeSeriesHierarchyOrError

Resultado de uma operação em lote em uma 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 de API específico com um código de erro e uma mensagem.
TsiErrorDetails

Informações adicionais de erro.

HierarchiesBatchRequest

Solicite a execução de uma única operação em um lote de hierarquias. Exatamente um de "get", "put" ou "delete" deve ser definido.

Nome Tipo Description
delete

HierarchiesRequestBatchGetDelete

"delete" deve ser definido ao buscar hierarquias específicas por IDs ou nomes.
get

HierarchiesRequestBatchGetDelete

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

TimeSeriesHierarchy[]

"put" deve ser definido durante a criação ou atualização de hierarquias.

HierarchiesBatchResponse

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

Nome Tipo Description
delete

TsiErrorBody[]

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

TimeSeriesHierarchyOrError[]

Lista de objetos de hierarquia ou de erro correspondentes por posição à matriz "get" na solicitação. O objeto Hierarchy é 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 hierarquia ou objeto de erro correspondente por posição à matriz "put" na solicitação. O objeto Hierarchy é definido quando a operação é bem-sucedida e o objeto de erro é definido quando a operação não é bem-sucedida.

HierarchiesRequestBatchGetDelete

Solicite a obtenção ou exclusão de várias hierarquias de série temporal. Exatamente um dos "hierarchyIds" ou "names" deve ser definido.

Nome 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 de hierarquia de série temporal são criados.

Nome Tipo Description
instanceFieldNames

string[]

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

TimeSeriesHierarchy

A hierarquia de série temporal organiza instâncias de série temporal em uma árvore.

Nome Tipo Description
id

string

Identificador de hierarquia exclusivo que diferencia maiúsculas de minúsculas. Pode ser nulo ao criar objetos de hierarquia e, em seguida, o servidor gera a ID, não nulo em operações get e delete.
name

string

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

Source

Definição de como os níveis de árvore de hierarquia de série temporal são criados.

TimeSeriesHierarchyOrError

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

Nome Tipo Description
error

TsiErrorBody

Objeto error – definido quando a operação não for bem-sucedida.
hierarchy

TimeSeriesHierarchy

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

TsiError

Informações sobre um erro de API.

Nome Tipo Description
error

TsiErrorBody

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

TsiErrorBody

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

Nome Tipo Description
code

string

Cadeia de caracteres legível e independente de linguagem que define um código de erro específico do serviço. Esse código serve como um indicador mais específico para o código de erro HTTP especificado na resposta. Pode ser usado para lidar programaticamente com 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 restringe a causa. Pode ser nulo.
message

string

Representação independente de idioma e legível por humanos do erro. Ele se destina como um auxílio aos desenvolvedores e não é adequado para exposição aos usuários finais.
target

string

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

TsiErrorDetails

Informações adicionais de erro.

Nome Tipo Description
code

string

Cadeia de caracteres legível e independente de linguagem que define um código de erro específico do serviço. Esse código serve como um indicador mais específico para o código de erro HTTP especificado na resposta. Pode ser usado para lidar programaticamente com casos de erro específicos.
message

string

Representação independente de idioma e legível por humanos do erro. Ele se destina como um auxílio aos desenvolvedores e não é adequado para exposição aos usuários finais.