Cancelamento da Análise

Cancele uma análise de cadastro de fornecedor que ainda esteja em andamento. Após o cancelamento, nenhuma alteração adicional pode ser feita nessa análise.

Quando é possível cancelar

O cancelamento está disponível enquanto a análise estiver nos status pending_submission ou pending_adm_approval. Análises já approved, rejected ou canceled não podem ser canceladas.

---

Request

ENDPOINT

/vendor_registry/analysis/{analysis_key}/cancel

MÉTODO

PUT

Path params

Parâmetro	Tipo	Descrição
analysis_key	string	Chave única da análise (UUID)

Este endpoint não requer body.

Response

STATUS

202

Response Body

{
    "analysis_key": "c3d4e5f6-a7b8-9012-cdef-345678901234",
    "status": "canceled"
}

Atributos da resposta

Campo	Tipo	Descrição
analysis_key	string	Chave única da análise.
status	string	Novo status da análise. Sempre retorna canceled.

---

Possíveis erros

STATUS

409

Transição de status não permitida

A análise está em um status que não permite cancelamento (por exemplo, já foi aprovada ou rejeitada).

{
  "title": "Analysis Status Transition Denied",
  "description": "Analysis with key {analysis_key} is not allowed to switch status from {current_status} to canceled.",
  "translation": "Análise com chave {analysis_key} não pode trocar de status de {current_status} para canceled.",
  "code": "VRG000008"
}

STATUS

404

Análise não encontrada

A analysis_key informada na URL não corresponde a nenhuma análise cadastrada.

{
  "title": "Analysis not found",
  "description": "Analysis with the key {analysis_key} was not found.",
  "translation": "A análise com a chave {analysis_key} não foi encontrada.",
  "code": "VRG000007"
}

---

Próximos passos

Para cadastrar o fornecedor novamente, inicie um novo processo via:

Criação de análise — submeta os dados do fornecedor novamente.