Errors
Todos los errores devolverán el código de respuesta HTTP más específico y apropiado de la siguiente tabla:
Códigos de devolución
Código | Error | Descripción |
---|---|---|
400 | Mala petición | Se ha recibido una solicitud malformada del cliente. Esta es la respuesta más genérica dada por la API |
401 | Sin autorización | No está autorizado y no puede acceder al recurso solicitado |
403 | Prohibido | No tiene permiso para acceder al recurso solicitado |
404 | No se ha encontrado | El recurso solicitado no se encuentra. Es posible que esté disponible más adelante |
405 | Método no permitido | Se ha utilizado un método HTTP no compatible para el recurso solicitado |
406 | No aceptable | El tipo Accept o Accept-Encoding solicitado por el cliente no está disponible. |
409 | Conflicto | La solicitud no puede completarse porque hay un conflicto con el recurso existente |
410 | Gone | El recurso solicitado ya no está disponible y nunca lo estará en el futuro |
411 | Longitud requerida | El recurso solicitado espera que el cliente proporcione una longitud de contenido (Content-Length). |
413 | Entidad solicitante demasiado grande | El cuerpo de la solicitud suministrado por el cliente era demasiado grande, el recurso se niega a procesarlo |
415 | Tipo de soporte no compatible | El cliente ha proporcionado un tipo de contenido incorrecto (o no ha proporcionado ninguno). |
422 | Entidad no procesable | La solicitud no está malformada y el tipo de medio es aceptable, pero el recurso no puede procesar la solicitud. |
429 | Demasiadas solicitudes | Se ha alcanzado el límite de tarifa. Consulte la sección Limitación de tarifa para obtener más información |
500 | Error interno del servidor | El servidor no ha podido procesar su solicitud debido a un error interno inesperado del servidor. |
501 | No aplicado | El recurso solicitado no se ha implementado |
503 | Servicio no disponible | El servicio solicitado no está disponible temporalmente |
Formato estándar de respuesta
Todos los errores tendrán un cuerpo de respuesta estándar con dos campos, código y mensaje. Se pueden utilizar más campos, pero son opcionales.
Ejemplos
Esta es la forma más simple del cuerpo de retorno de un error, los clientes pueden confiar en que estos campos estén presentes en cada error.
Respuestas de error - Ejemplo 1 (Línea de base)
{
"code": 429,
"message": "You have exceeded your number of requests. Please try again later"
}
El siguiente ejemplo tiene, además de los campos estándar, para los errores asociados con esta solicitud específica.
Respuestas a errores - Ejemplo 2 (más complejo)
{
"code": 422,
"message": "Unprocessable entity",
"cause": "Validation failed",
"errors": [
{
"resource": "Issue",
"field": "title",
"code": "missing_field"
},
...
]
}