Consultar execução e resumo da análise

GET

/v1/analises/{id}

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

• Produção

Exige catalogo:ler. Retorna falha, pendência e degradação explicitamente.

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 concluida falhou

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

snapshot_id

obrigatório

string

versao_portal

obrigatório

string

versao_avaliador

obrigatório

Qualquer um de:

string

string

Valor permitido: 1

string

string

Valor permitido: 2

executada_em

obrigatório

string

regras_coletadas_em

obrigatório

string

ultima_coleta_util_em

obrigatório

Qualquer um de:

string

string

null

null

regulamento_degradado

obrigatório

boolean

assinante

obrigatório

boolean

franquia_consumida

obrigatório

boolean

produtos_avaliados

obrigatório

Qualquer um de:

string

string formato: integer

0

integer

integer

divergencias

obrigatório

object

orfao

obrigatório

Qualquer um de:

string

string formato: integer

0

integer

integer

bloqueante

obrigatório

Qualquer um de:

string

string formato: integer

0

integer

integer

deriva

obrigatório

Qualquer um de:

string

string formato: integer

0

integer

integer

anvisa

obrigatório

Qualquer um de:

string

string formato: integer

0

integer

integer

catalogos

obrigatório

Array<object>

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}$/

versao

obrigatório

Qualquer um de:

string

string formato: integer

0

integer

integer

paginas_resultado

obrigatório

Qualquer um de:

string

string formato: integer

0

integer

integer

null

null

Exemplo

{
  "id": "0198d000-0000-7000-8000-000000000001",
  "estado": "pendente",
  "resultado": {
    "versao_avaliador": "1",
    "produtos_avaliados": 0,
    "divergencias": {
      "orfao": 0,
      "bloqueante": 0,
      "deriva": 0,
      "anvisa": 0
    },
    "catalogos": [
      {
        "id": "0198d000-0000-7000-8000-000000000001",
        "versao": 0
      }
    ],
    "paginas_resultado": 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"
  }
}