Edita um ciclo
PATCH/api/performance-reviews/cycles/{cycleId}
- Auth
- Jeton requis
- Clé d’API:
- Clé d’API non acceptée
- X-CommunityId
X-CommunityIdEnvoyez le X-CommunityId de la communauté où l’opération a lieu.
Les descriptions des endpoints viennent directement de la spécification de l’API et sont en portugais pour l’instant. L’interface autour est traduite.
Owner e admin. Em rascunho tudo edita (trocar `model` repõe as relações do modelo, a menos que `relationships` venha junto). Aberto, só título, instruções, `closesOn`, lembretes, regra da nota e pesos; modelo, relações, escala, público, `excludedMemberIds` e datas do período e da abertura dão 409 `cycleNotDraft` (com o campo em `errors[0].param`). Fechado ou liberado: 409 `cycleLocked`. `excludedMemberIds` remove pessoas do ciclo antes de abrir (por exemplo quem aparece em "sem gestor").
Paramètres
| Nom | Emplacement | Type | Description |
|---|---|---|---|
cycleIdobligatoire | path | string (uuid) |
En-têtes
| Nom | Type | Description |
|---|---|---|
X-CommunityIdfacultatif | string (uuid) | ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade. |
Corps de la requête application/json
| Nom | Type | Description |
|---|---|---|
titlefacultatif | string | max 120 |
instructionsfacultatif | string | |
periodStartsOnfacultatif | string (date) | |
periodEndsOnfacultatif | string (date) | |
opensOnfacultatif | string (date) | |
closesOnfacultatif | string (date) | |
modelfacultatif | DEGREES_90 | DEGREES_180 | DEGREES_360 | |
relationshipsfacultatif | SELF | MANAGER | PEER | REPORT[] | |
finalRatingRulefacultatif | MANAGER | AVERAGE_WITHOUT_SELF | |
weightsfacultatif | object | |
scaleLabelsfacultatif | string[] | Só em rascunho (aberto: 409 `cycleNotDraft`). De 2 a 10 rótulos, do pior ao melhor, sem repetir; o valor de cada nível é a posição (1 a N). [] ou null = os 5 padrão. |
audiencefacultatif | ALL | GROUP | TAG | |
groupIdfacultatif | string (uuid) | |
tagfacultatif | string | |
reminderDaysfacultatif | integer[] | |
excludedMemberIdsfacultatif | string (uuid)[] | |
nominationEnabledfacultatif | boolean | Fase 1b: com PEER ligado, cada participante indica os pares e o líder direto valida (só em rascunho). |
nineBoxEnabledfacultatif | boolean | Fase 2: a avaliação do gestor pergunta o potencial (Baixo, Médio, Alto) e o ciclo fechado tem a 9-box (só em rascunho). |
nominationMinfacultatif | integer | ≥ 1, ≤ 10 |
nominationMaxfacultatif | integer | ≥ 1, ≤ 10 |
nominationEndsOnfacultatif | string (date) | Último dia para indicar. |
validationEndsOnfacultatif | string (date) | Último dia para o líder validar (entre `nominationEndsOn` e `closesOn`; sem as duas datas, abrir dá 409 `nominationDatesRequired`). |
Réponses
| Statut | Description |
|---|---|
200 | O ciclo. |
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 | Sem permissão (`teamOnly`: só owner e admin; `progressDenied`/`resultsDenied`: quem não lidera ninguém; `supportSession`). |
404 | Recurso não encontrado. |
409 | Conflito com o estado atual do recurso. |
422 | Campo inválido. |
500 | Erro interno do servidor. |
Exemple curl
curl -X PATCH "https://api.memberfy.net/api/performance-reviews/cycles/<cycleId>" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID" \
-H "Content-Type: application/json" \
-d '{}'