Errors

Todos os erros devolverão o código de resposta HTTP mais específico e adequado da tabela seguinte:

Códigos de retorno

Código	Erro	Descrição
400	Mau pedido	Foi recebido um pedido malformado do cliente. Esta é a resposta mais genérica dada pela API
401	Não autorizado	Não está autorizado e não pode aceder ao recurso solicitado
403	Proibido	Não tem permissão para aceder ao recurso solicitado
404	Não encontrado	O recurso solicitado não pode ser encontrado. Poderá ficar disponível mais tarde
405	Método não permitido	Foi utilizado um método HTTP não suportado para o recurso solicitado
406	Não aceitável	O tipo Accept ou Accept-Encoding pedido pelo cliente não está disponível
409	Conflito	O pedido não pode ser concluído porque existe um conflito com o recurso existente
410	Já se foi	O recurso solicitado já não está disponível e nunca estará no futuro
411	Comprimento necessário	O recurso solicitado espera que um Content-Length seja fornecido pelo cliente
413	Entidade do pedido demasiado grande	O corpo do pedido fornecido pelo cliente era demasiado grande, o recurso recusa-se a processá-lo
415	Tipo de suporte não suportado	Um Content-Type incorreto (ou inexistente) foi fornecido pelo cliente
422	Entidade não processável	O pedido não está malformado e o tipo de suporte é aceitável, mas o recurso não pode processar o pedido
429	Demasiados pedidos	O limite de taxa foi atingido. Para mais informações, consulte a secção Limite de débito
500	Erro interno do servidor	O servidor não pôde processar o seu pedido devido a um erro interno inesperado do servidor
501	Não implementado	O recurso solicitado não foi implementado
503	Serviço indisponível	O serviço solicitado não está temporariamente disponível

Formato de resposta padrão

Todos os erros terão um corpo de resposta padrão com dois campos, código e mensagem. Podem ser utilizados mais campos, mas são opcionais.

Exemplos

Esta é a forma mais simples do corpo de retorno de um erro, os clientes podem confiar que estes campos estão presentes em todos os erros.

Respostas a erros - Exemplo 1 (Base)

{
        "code": 429,
        "message": "You have exceeded your number of requests. Please try again later"
}

O exemplo seguinte apresenta, para além dos campos padrão, os erros associados a este pedido específico.

Respostas a erros - Exemplo 2 (mais complexo)

{
        "code": 422,
        "message": "Unprocessable entity",
        "cause": "Validation failed",
        "errors": [
            {
                "resource": "Issue",
                "field": "title",
                "code": "missing_field"
            },
            ...
        ]
}