Async

POST/big-data/enrichment/async

Last modified: 8 hours ago

A rota Sync oferece uma consulta síncrona que fornece os resultados completos da pesquisa realizada.

Request

Header Params

Authorization

string

required

Token de autorização obtido no método user/authenticate.

Example:

Bearer {{bearer_token}}

query

string

required

Nome identificador da consulta, como por exemplo pf, pf full, pj ou pj full (consultas padronizadas) ou nome definido pelo suporte conforme cliente/contexto aplicável para consultas personalizadas.

parameters

object

required

Parâmetro necessário para o dataset que compõe a query a ser consultada. Veja aqui a lista de datasets e os respectivos parâmetros necessários (coluna G).

string

optional

webhook

object

optional

url

string

optional

Endpoint para o qual o mostQI Enrichment fará uma requisição enviando o resultado da consulta.

fallbackUrl

string

optional

Parâmetro que possibilita a especificação de uma URL alternativa em caso de falha na comunicação durante a chamada da URL indicada no parâmetro "webhook.url".

authorization

object

optional

{
  "query": "",
  "parameters": {
    "": ""
  },
  "webhook": {
    "url": "",
    "fallbackUrl": "",
    "authorization": {
      "headers": [
        {
          "name": "nomeCabecalho1",
          "value": "valorCabecalho1"
        },
        {
          "name": "nomeCabecalho2",
          "value": "valorCabecalho2"
        }
      ],
      "queryStrings": [
        {
          "name": "nomeQs1",
          "value": "valorQs1"
        },
        {
          "name": "nomeQs2",
          "value": "valorQs2"
        }
      ]
    }
  }
}

Request samples

Responses

OK(200)

HTTP Code: 200

Content Type : JSONapplication/json

result

object

required

Lista contendo o resultado do método (consulte na documentação específica de cada um).

processId

string

required

ID referente ao processo assíncrono de requisição ao Enrichment, denominado "processId". Este id será utilizado para verificar o status do processo e acessar o resultado da consulta, o qual é composto por datasets de um contexto específico em relação ao parâmetro de entrada.

requestId

string

required

Código único de identificação da solicitação ao servidor, que será registrado no histórico de consumo dos serviços.

elapsedMilliseconds

integer

required

Tempo de duração do processamento em milissegundos.

status

object

required

Objeto contendo o código de status e a mensagem de resposta.

message

string | null

required

Mensagem de retorno de status. Veja os valores possíveis nas mensagens de erro do mostQI.

code

string

required

Código de status interno. Veja os valores possíveis nas mensagens de erro do mostQI.

errors

array [object {2}] | null

required

Lista de objetos do tipo Error, o formato é variável.

{
  "result": {
    "processId": "45d6O70c-54a7-5fab-xxxe-a3b7a0c2a06d"
  },
  "requestId": "tZfL59xpzkWXE3uk95t9U",
  "elapsedMilliseconds": 38,
  "status": {
    "message": "OK",
    "code": "200",
    "errors": []
  }
}

Last modified: 8 hours ago