Edita um ciclo
PATCH/api/performance-reviews/cycles/{cycleId}
- 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.
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").
Parámetros
| Nombre | Dónde | Tipo | Descripción |
|---|---|---|---|
cycleIdobligatorio | 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 |
|---|---|---|
titleopcional | string | max 120 |
instructionsopcional | string | |
periodStartsOnopcional | string (date) | |
periodEndsOnopcional | string (date) | |
opensOnopcional | string (date) | |
closesOnopcional | string (date) | |
modelopcional | DEGREES_90 | DEGREES_180 | DEGREES_360 | |
relationshipsopcional | SELF | MANAGER | PEER | REPORT[] | |
finalRatingRuleopcional | MANAGER | AVERAGE_WITHOUT_SELF | |
weightsopcional | object | |
scaleLabelsopcional | 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. |
audienceopcional | ALL | GROUP | TAG | |
groupIdopcional | string (uuid) | |
tagopcional | string | |
reminderDaysopcional | integer[] | |
excludedMemberIdsopcional | string (uuid)[] | |
nominationEnabledopcional | boolean | Fase 1b: com PEER ligado, cada participante indica os pares e o líder direto valida (só em rascunho). |
nineBoxEnabledopcional | 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). |
nominationMinopcional | integer | ≥ 1, ≤ 10 |
nominationMaxopcional | integer | ≥ 1, ≤ 10 |
nominationEndsOnopcional | string (date) | Último dia para indicar. |
validationEndsOnopcional | string (date) | Último dia para o líder validar (entre `nominationEndsOn` e `closesOn`; sem as duas datas, abrir dá 409 `nominationDatesRequired`). |
Respuestas
| Código | Descripción |
|---|---|
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. |
Ejemplo con 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 '{}'