LBHM Tasks

Erros e respostas da API

Quando uma chamada dá certo, a API responde 200 OK — ou 201 Created quando uma tarefa nova é criada. Quando não dá, a resposta traz o código HTTP e uma mensagem curta dizendo o que impediu:

{ "error": "tipo_id 7 não pertence ao processo_id 3" }

Use a tabela abaixo para tratar cada caso na sua integração.

Autenticação

Código Mensagem O que significa O que fazer
401 unauthorized A chamada chegou sem token, ou com um token que não vale mais. Envie o cabeçalho Authorization: Bearer SEU_TOKEN. Se o token foi revogado, gere outro em Tokens de API e atualize a integração.

Vale para todas as rotas sob /api/v1.

Ao criar uma tarefa

Recusas de POST /api/v1/tasks.

Código Mensagem O que significa O que fazer
422 titulo e origem são obrigatórios Um dos dois veio vazio. Envie titulo com o texto que a equipe verá e origem com o identificador do sistema que gerou a tarefa.
422 processo_id é obrigatório (veja GET /api/v1/processos) A tarefa chegou sem processo. Consulte a lista de processos e envie o processo_id escolhido. Veja Processos e tipos.
422 processo_id N não existe nesta instância O número enviado não corresponde a nenhum processo cadastrado. Confira a lista de processos. Se o processo ainda não existe, cadastre-o e use o identificador devolvido.
422 tipo_id é obrigatório (os tipos vêm em GET /api/v1/processos) A tarefa chegou sem tipo. Escolha um dos tipos ativos do processo e envie o tipo_id.
422 tipo_id N não pertence ao processo_id M O tipo existe, mas é de outro processo. Use um tipo listado dentro do processo que você informou. Ao trocar o processo, escolha o tipo de novo.

O processo e o tipo são cobrados na criação. Ao reenviar uma tarefa que já existe (mesma origem e mesma referencia_externa), a classificação atual é preservada.

Ao atualizar ou encerrar uma tarefa

Recusas de PATCH /api/v1/tasks/by-ref, PATCH /api/v1/tasks/{id}/status e GET /api/v1/tasks/{id}.

Código Mensagem O que significa O que fazer
404 tarefa não encontrada Nenhuma tarefa corresponde ao identificador, ou ao par origem + referencia_externa. Confira os valores. Ao atualizar pela referência, use exatamente a mesma origem da criação.
422 origem e referencia_externa são obrigatórios A atualização pela referência chegou sem um dos dois. Envie os dois campos, ou atualize a tarefa pelo identificador dela.
422 status inválido O status enviado não é um dos aceitos. Use aberta, em_andamento, bloqueada, concluida, cancelada, resolvido ou nao_se_aplica.
422 motivo é obrigatório ao encerrar a tarefa O status escolhido encerra a tarefa, e o registro do porquê não veio. Envie também motivo com uma frase explicando o desfecho. Ele fica no histórico da tarefa.

Encerram a tarefa os status concluida, cancelada, resolvido e nao_se_aplica — todos exigem motivo.

Ao cadastrar processos e tópicos

Código Mensagem O que significa O que fazer
422 nome obrigatório O cadastro de processo chegou sem nome. Envie nome com o texto que aparecerá na tela.
422 slug obrigatório O cadastro de tópico chegou sem identificação. Envie slug (ou nome, de onde o identificador é derivado). Veja Tópicos.

Continue por aqui