Pular para o conteúdo
CotejarCotejarCotejar para desenvolvedores

Consultar o impacto da exclusão do catálogo

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

Exige catalogo:gerenciar. Projeta cadastro e seleção, sem executar análise ou varredura. Use o ETag desta prévia no DELETE.

Autorizações

Seção intitulada “Autorizações”

Parâmetros

Seção intitulada “Parâmetros”

Parâmetros de caminho

Seção intitulada “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

Seção intitulada “Respostas”

200

Seção intitulada “200”

Response for status 200

Tipo de mídiaapplication/json
object
catalogo_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 formato: integer
0
produtos
obrigatório
Qualquer um de:
string formato: integer
0
exclusivos
obrigatório
Qualquer um de:
string formato: integer
0
compartilhados
obrigatório
Qualquer um de:
string formato: integer
0
produtos_desativados
obrigatório
Qualquer um de:
string formato: integer
0
selecoes_removidas
obrigatório
Qualquer um de:
string formato: integer
0
selecoes_adicionadas
obrigatório
Qualquer um de:
string formato: integer
0
vigilancia
obrigatório
object
modo
obrigatório
string
Valores permitidos: selecao todos
versao
obrigatório
Qualquer um de:
string formato: integer
0
capacidade
obrigatório
Qualquer um de:
string formato: integer
0
direito_ativo
obrigatório
boolean
antes
obrigatório
object
cadastrados
obrigatório
Qualquer um de:
string formato: integer
0
selecionados
obrigatório
Qualquer um de:
string formato: integer
0
elegiveis
obrigatório
Qualquer um de:
string formato: integer
0
vagas
obrigatório
Qualquer um de:
string formato: integer
0
cobertura
obrigatório
string
Valores permitidos: indisponivel sem_selecao parcial integral capacidade_excedida
exige_selecao
obrigatório
boolean
depois
obrigatório
object
cadastrados
obrigatório
Qualquer um de:
string formato: integer
0
selecionados
obrigatório
Qualquer um de:
string formato: integer
0
elegiveis
obrigatório
Qualquer um de:
string formato: integer
0
vagas
obrigatório
Qualquer um de:
string formato: integer
0
cobertura
obrigatório
string
Valores permitidos: indisponivel sem_selecao parcial integral capacidade_excedida
exige_selecao
obrigatório
boolean
Exemplo
{
  "catalogo_id": "0198d000-0000-7000-8000-000000000001",
  "versao": 0,
  "produtos": 0,
  "exclusivos": 0,
  "compartilhados": 0,
  "produtos_desativados": 0,
  "selecoes_removidas": 0,
  "selecoes_adicionadas": 0,
  "vigilancia": {
    "modo": "selecao",
    "versao": 0,
    "capacidade": 0,
    "antes": {
      "cadastrados": 0,
      "selecionados": 0,
      "elegiveis": 0,
      "vagas": 0,
      "cobertura": "indisponivel"
    },
    "depois": {
      "cadastrados": 0,
      "selecionados": 0,
      "elegiveis": 0,
      "vagas": 0,
      "cobertura": "indisponivel"
    }
  }
}

Cabeçalhos

Seção intitulada “Cabeçalhos”
ETag
string

Versão opaca do recurso, incluindo aspas. Preserve o valor completo ao enviar If-Match.

401

Seção intitulada “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
Exemplogerado
{
  "erro": {
    "codigo": "example",
    "mensagem": "example",
    "request_id": "example",
    "caminho": "example"
  }
}

403

Seção intitulada “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
Exemplogerado
{
  "erro": {
    "codigo": "example",
    "mensagem": "example",
    "request_id": "example",
    "caminho": "example"
  }
}

404

Seção intitulada “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
Exemplogerado
{
  "erro": {
    "codigo": "example",
    "mensagem": "example",
    "request_id": "example",
    "caminho": "example"
  }
}

422

Seção intitulada “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
Exemplogerado
{
  "erro": {
    "codigo": "example",
    "mensagem": "example",
    "request_id": "example",
    "caminho": "example"
  }
}

429

Seção intitulada “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
Exemplogerado
{
  "erro": {
    "codigo": "example",
    "mensagem": "example",
    "request_id": "example",
    "caminho": "example"
  }
}

503

Seção intitulada “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
Exemplogerado
{
  "erro": {
    "codigo": "example",
    "mensagem": "example",
    "request_id": "example",
    "caminho": "example"
  }
}