Edita um ciclo
PATCH/api/performance-reviews/cycles/{cycleId}
- Auth
- Requires a token
- API key:
- No API key accepted
- X-CommunityId
X-CommunityIdSend the X-CommunityId of the community the operation happens in.
Endpoint descriptions come straight from the API specification and are in Portuguese for now. The interface around them is translated.
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").
Parameters
| Name | In | Type | Description |
|---|---|---|---|
cycleIdrequired | path | string (uuid) |
Headers
| Name | Type | Description |
|---|---|---|
X-CommunityIdoptional | string (uuid) | ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade. |
Request body application/json
| Name | Type | Description |
|---|---|---|
titleoptional | string | max 120 |
instructionsoptional | string | |
periodStartsOnoptional | string (date) | |
periodEndsOnoptional | string (date) | |
opensOnoptional | string (date) | |
closesOnoptional | string (date) | |
modeloptional | DEGREES_90 | DEGREES_180 | DEGREES_360 | |
relationshipsoptional | SELF | MANAGER | PEER | REPORT[] | |
finalRatingRuleoptional | MANAGER | AVERAGE_WITHOUT_SELF | |
weightsoptional | object | |
scaleLabelsoptional | 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. |
audienceoptional | ALL | GROUP | TAG | |
groupIdoptional | string (uuid) | |
tagoptional | string | |
reminderDaysoptional | integer[] | |
excludedMemberIdsoptional | string (uuid)[] | |
nominationEnabledoptional | boolean | Fase 1b: com PEER ligado, cada participante indica os pares e o líder direto valida (só em rascunho). |
nineBoxEnabledoptional | 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). |
nominationMinoptional | integer | ≥ 1, ≤ 10 |
nominationMaxoptional | integer | ≥ 1, ≤ 10 |
nominationEndsOnoptional | string (date) | Último dia para indicar. |
validationEndsOnoptional | string (date) | Último dia para o líder validar (entre `nominationEndsOn` e `closesOn`; sem as duas datas, abrir dá 409 `nominationDatesRequired`). |
Responses
| Status | 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. |
curl example
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 '{}'