Registra um check-in
POST/api/goals/key-results/{keyResultId}/check-ins
- Auth
- Requiere token
- Clave de API:
- No acepta clave de API
- X-CommunityId
X-CommunityIdEnvía el X-CommunityId de la comunidad en la que ocurre la operación.
Las descripciones de los endpoints vienen de la especificación de la API y, por ahora, están en portugués. La interfaz alrededor está traducida.
O responsável do KR, o dono do objetivo, os líderes dele (diretos e indiretos; num objetivo de grupo, o líder do grupo) ou owner/admin; os outros: 403 `checkInDenied`. Ciclo fechado: 409 `cycleClosed`. `value` (o valor atual) ou, num entregável, `done`; `health` é o farol; `note` opcional. O progresso do KR e do objetivo é recalculado.
Parámetros
| Nombre | Dónde | Tipo | Descripción |
|---|---|---|---|
keyResultIdobligatorio | path | string (uuid) |
Headers
| Nombre | Tipo | Descripción |
|---|---|---|
X-CommunityIdopcional | string (uuid) | ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade. |
Cuerpo de la solicitud application/json
| Nombre | Tipo | Descripción |
|---|---|---|
valueopcional | number | |
doneopcional | boolean | |
healthobligatorio | ON_TRACK | AT_RISK | OFF_TRACK | |
noteopcional | string | max 2000 |
Respuestas
| Código | Descripción |
|---|---|
201 | O objetivo, com os KRs. |
400 | Requisição inválida — falha de validação. |
401 | Token ausente, inválido ou expirado; token de outra comunidade (o `X-CommunityId` ou o `communityId` do corpo não é o do token); token antigo ou de uma sessão encerrada (troca de senha, convite aceito). Nesses casos a mensagem pede para entrar de novo (`auth.signInAgain`). |
403 | Autenticado, mas sem permissão para esta operação. |
404 | Recurso não encontrado. |
409 | Conflito com o estado atual do recurso. |
422 | `valueRequired`, `doneRequired`, `healthInvalid`. |
500 | Erro interno do servidor. |
Ejemplo con curl
curl -X POST "https://api.memberfy.net/api/goals/key-results/<keyResultId>/check-ins" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID" \
-H "Content-Type: application/json" \
-d '{"health":"ON_TRACK"}'