Cria um objetivo com os resultados-chave
POST/api/goals/objectives
- 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.
Com o ciclo aberto (fechado: 409 `cycleClosed`). `COMPANY`: owner e admin (os outros: 403 `companyDenied`). `GROUP`: o líder do grupo (`MemberGroup.leaderMemberId`) ou de um grupo acima dele, ou owner/admin (outro líder: 403 `groupDenied`). `PERSONAL`: a própria pessoa, o líder direto dela (`ownerId`) ou owner/admin (403 `personalDenied`). Alinhamento (`parentId`): GROUP a um da empresa, PERSONAL a um do grupo ou da empresa, no mesmo ciclo (422 `parentLevelInvalid`); o dono do objetivo de cima recebe "um objetivo foi alinhado ao seu" (categoria `goalsOkrs`). De 1 a 20 KRs; responsável = qualquer pessoa com acesso ao espaço (padrão: quem cria). Alvo incoerente com o tipo: 422 `targetInvalid` (aumentar: alvo > inicial; diminuir: alvo < inicial; manter: mínimo ≤ máximo).
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 |
|---|---|---|
cycleIdobligatorio | string (uuid) | |
levelobligatorio | COMPANY | GROUP | PERSONAL | |
groupIdopcional | string (uuid) | |
ownerIdopcional | string (uuid) | O dono (a pessoa de um PERSONAL; padrão: quem cria). |
parentIdopcional | string (uuid) | |
titleobligatorio | string | max 200 |
descriptionopcional | string | max 5000 |
visibilityopcional | OPEN | RESTRICTED | |
keyResultsobligatorio | object[] | |
keyResults[].titleobligatorio | string | max 200 |
keyResults[].ownerIdopcional | string (uuid) | |
keyResults[].unitopcional | PERCENT | NUMBER | CURRENCY | |
keyResults[].directionopcional | INCREASE | DECREASE | MAINTAIN | DELIVERABLE | |
keyResults[].initialValueopcional | number | |
keyResults[].targetValueopcional | number | |
keyResults[].minValueopcional | number | |
keyResults[].maxValueopcional | number | |
keyResults[].weightopcional | number | ≥ 0, ≤ 100 |
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 | Nível, grupo, dono, alinhamento, KR ou alvo inválidos. |
500 | Erro interno do servidor. |
Ejemplo con curl
curl -X POST "https://api.memberfy.net/api/goals/objectives" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID" \
-H "Content-Type: application/json" \
-d '{"cycleId":"00000000-0000-0000-0000-000000000000","level":"COMPANY","title":"string","keyResults":[{}]}'