API :: Excluir linha de conteúdo no Roteiro

Nota

O arquivo de origem desta especificação se chama “PATCH Excluir linha de conteúdo no Roteiro”, mas o método descrito no corpo do documento é DELETE. Usei o método declarado no corpo (DELETE) nesta página — confirmar com o autor qual dos dois está correto.

Endpoint: DELETE /api/v1/producao/roteiro/{codigoRoteiro}/linha/{lineId}

Parâmetros de rota (path)

Campo	Tipo	Obrigatório	Descrição / validação
codigoRoteiro	integer¹	Sim	Código do roteiro. Deve aceitar valores alfanuméricos.
lineId	integer	Sim	Identificador da linha a ser excluída. Apenas valores numéricos inteiros.

Nota

¹ Mesma inconsistência de tipo observada nos outros endpoints desta página: declarado como integer, mas com validação alfanumérica.

Regras de negócio

Tipo de linha	Comportamento na exclusão
Operação	A exclusão abrange todas as linhas relacionadas àquela operação, eliminando a sequência completa.
Componente ou Recurso	Apenas a linha específica informada é excluída, sem impactar outras linhas.

Nota

O comportamento deve ser consistente com o funcionamento atual do add-on BR One.

Erros

Condição	Mensagem
codigoRoteiro não cadastrado	BR One :: Erro roteiro não encontrado para o código informado.
lineId não existe no roteiro	BR One :: Erro favor informar um lineId válido.
lineId não é um número inteiro válido	BR One :: Erro o campo lineId deve conter apenas números inteiros.
codigoRoteiro ou lineId não informados	BR One :: Erro código do roteiro e lineId são obrigatórios

Autenticação, headers, response e códigos HTTP

Importante

[INFORMAÇÃO NÃO ENCONTRADA] — não definidos na especificação de origem.

Veja também

• api-roteiro-consultar

• api-roteiro-adicionar-linha

• api-roteiro-atualizar