Documentação Técnica

Obter Metadado

Este método permite que os clientes que realizam chamadas assíncronas verifiquem o status de uma requisição que ainda está em andamento, verificando se a consulta ainda está em execução ou se ocorreu alguma falha no processo de consulta.

Funcionamento

Para consultar o status atual de uma requisição assíncrona da API de Hooks, é necessário passar o QueryId retornado pela chamada original. A resposta é um objeto que descreve o status atual da requisição da consulta em processamento, e o tempo decorrido para cada etapa do processo.

A tabela abaixo descreve os valores de retorno possíveis para o campo de status da requisição.

Status do HookDescrição
RegistrationFailedO registro in-flight da requisição assíncrona falhou
RegisteredO registro in-flight da requisição assíncrona foi realizado com sucesso
DispatchedO despacho da requisição assíncrona nas APIs da Plataforma de Dados foi realizado com sucesso
DispatchmentFailedO despacho da requisição assíncrona nas APIs da Plataforma de Dados falhou

Campos do corpo da requisição

CampoDescrição
QueryIdID retornado pela criação do hook / requisição assíncrona

Campos do objeto da resposta

CampoDescrição
HookMetadata.StatusO status atual da requisição assíncrona associada
HookMetadata.RegistrationElapsedTimeO tempo decorrido na etapa de registro
HookMetadata.DispatchmentElapsedTimeO tempo decorrido na etapa de despacho
Language
Credentials
Click Try It! to start a request and see the response here!