Pular para o conteúdo

Edita um ciclo

PATCH/api/performance-reviews/cycles/{cycleId}

Auth
Exige token
Chave de API:
Não aceita chave de API
X-CommunityId
X-CommunityId Envie o X-CommunityId da comunidade em que a operação acontece.

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

NomeOndeTipoDescrição
cycleIdobrigatóriopathstring (uuid)

Headers

NomeTipoDescrição
X-CommunityIdopcionalstring (uuid)ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade.

Corpo da requisição application/json

NomeTipoDescrição
titleopcionalstringmax 120
instructionsopcionalstring
periodStartsOnopcionalstring (date)
periodEndsOnopcionalstring (date)
opensOnopcionalstring (date)
closesOnopcionalstring (date)
modelopcionalDEGREES_90 | DEGREES_180 | DEGREES_360
relationshipsopcionalSELF | MANAGER | PEER | REPORT[]
finalRatingRuleopcionalMANAGER | AVERAGE_WITHOUT_SELF
weightsopcionalobject
scaleLabelsopcionalstring[]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.
audienceopcionalALL | GROUP | TAG
groupIdopcionalstring (uuid)
tagopcionalstring
reminderDaysopcionalinteger[]
excludedMemberIdsopcionalstring (uuid)[]
nominationEnabledopcionalbooleanFase 1b: com PEER ligado, cada participante indica os pares e o líder direto valida (só em rascunho).
nineBoxEnabledopcionalbooleanFase 2: a avaliação do gestor pergunta o potencial (Baixo, Médio, Alto) e o ciclo fechado tem a 9-box (só em rascunho).
nominationMinopcionalinteger≥ 1, ≤ 10
nominationMaxopcionalinteger≥ 1, ≤ 10
nominationEndsOnopcionalstring (date)Último dia para indicar.
validationEndsOnopcionalstring (date)Último dia para o líder validar (entre `nominationEndsOn` e `closesOn`; sem as duas datas, abrir dá 409 `nominationDatesRequired`).

Respostas

CódigoDescrição
200O ciclo.
400Requisição inválida — falha de validação.
401Token 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`).
403Sem permissão (`teamOnly`: só owner e admin; `progressDenied`/`resultsDenied`: quem não lidera ninguém; `supportSession`).
404Recurso não encontrado.
409Conflito com o estado atual do recurso.
422Campo inválido.
500Erro interno do servidor.

Exemplo com 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 '{}'