Consultar execução da vigilância

GET

/v1/vigilancias/{id}

curl --request GET \
  --url https://api.cotejar.com.br/v1/vigilancias/0198d000-0000-7000-8000-000000000001 \
  --header 'Authorization: Bearer <token>'

• Produção

Exige catalogo:ler. Histórico disponível após suspensão. Resultado publicado pode coexistir com relatório pendente ou falho; consulte estado e fase.

Autorizações

• bearerAuth

Parâmetros

Parâmetros de caminho

id

obrigatório

Exemplo sintético; substitua pelo UUID obtido na consulta do seu recurso.

string

/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$/

Exemplo

0198d000-0000-7000-8000-000000000001

Respostas

200

Response for status 200

Tipo de mídiaapplication/json

object

id

obrigatório

Exemplo sintético; substitua pelo UUID obtido na consulta do seu recurso.

string

/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$/

estado

obrigatório

string

Valores permitidos: pendente executando concluido falhou

fase

obrigatório

string

Valores permitidos: avaliacao publicacao relatorio

criada_em

obrigatório

string

terminada_em

obrigatório

Qualquer um de:

string

string

null

null

codigo_falha

obrigatório

Qualquer um de:

string

string

null

null

resultado

obrigatório

Qualquer um de:

object

object

executada_em

obrigatório

string

snapshot_id

obrigatório

string

modo

obrigatório

Qualquer um de:

string

string

Valor permitido: completa

string

string

Valor permitido: incremental

produtos_verificados

obrigatório

Qualquer um de:

string

string formato: integer

0

integer

integer

produtos_avaliados

obrigatório

Qualquer um de:

string

string formato: integer

0

integer

integer

produtos_cadastrados

obrigatório

Qualquer um de:

string

string formato: integer

0

integer

integer

total_achados

obrigatório

Qualquer um de:

string

string formato: integer

0

integer

integer

regulamento_degradado

obrigatório

boolean

ultima_coleta_util_em

obrigatório

Qualquer um de:

string

string

null

null

novas

obrigatório

Qualquer um de:

string

string formato: integer

0

integer

integer

reabertas

obrigatório

Qualquer um de:

string

string formato: integer

0

integer

integer

resolvidas

obrigatório

Qualquer um de:

string

string formato: integer

0

integer

integer

null

null

Exemplo

{
  "id": "0198d000-0000-7000-8000-000000000001",
  "estado": "pendente",
  "fase": "avaliacao",
  "resultado": {
    "modo": "completa",
    "produtos_verificados": 0,
    "produtos_avaliados": 0,
    "produtos_cadastrados": 0,
    "total_achados": 0,
    "novas": 0,
    "reabertas": 0,
    "resolvidas": 0
  }
}

401

Response for status 401

Tipo de mídiaapplication/json

object

erro

obrigatório

object

codigo

obrigatório

string

mensagem

obrigatório

string

request_id

obrigatório

string

caminho

string

Exemplo^gerado

{
  "erro": {
    "codigo": "example",
    "mensagem": "example",
    "request_id": "example",
    "caminho": "example"
  }
}

403

Response for status 403

Tipo de mídiaapplication/json

object

erro

obrigatório

object

codigo

obrigatório

string

mensagem

obrigatório

string

request_id

obrigatório

string

caminho

string

Exemplo^gerado

{
  "erro": {
    "codigo": "example",
    "mensagem": "example",
    "request_id": "example",
    "caminho": "example"
  }
}

404

Response for status 404

Tipo de mídiaapplication/json

object

erro

obrigatório

object

codigo

obrigatório

string

mensagem

obrigatório

string

request_id

obrigatório

string

caminho

string

Exemplo^gerado

{
  "erro": {
    "codigo": "example",
    "mensagem": "example",
    "request_id": "example",
    "caminho": "example"
  }
}

422

Response for status 422

Tipo de mídiaapplication/json

object

erro

obrigatório

object

codigo

obrigatório

string

mensagem

obrigatório

string

request_id

obrigatório

string

caminho

string

Exemplo^gerado

{
  "erro": {
    "codigo": "example",
    "mensagem": "example",
    "request_id": "example",
    "caminho": "example"
  }
}

429

Response for status 429

Tipo de mídiaapplication/json

object

erro

obrigatório

object

codigo

obrigatório

string

mensagem

obrigatório

string

request_id

obrigatório

string

caminho

string

Exemplo^gerado

{
  "erro": {
    "codigo": "example",
    "mensagem": "example",
    "request_id": "example",
    "caminho": "example"
  }
}

503

Response for status 503

Tipo de mídiaapplication/json

object

erro

obrigatório

object

codigo

obrigatório

string

mensagem

obrigatório

string

request_id

obrigatório

string

caminho

string

Exemplo^gerado

{
  "erro": {
    "codigo": "example",
    "mensagem": "example",
    "request_id": "example",
    "caminho": "example"
  }
}