Cria um ciclo de avaliação (rascunho)
POST/api/performance-reviews/cycles
- 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 (os outros: 403 `teamOnly`). Nasce em `DRAFT`, no modelo 180° (autoavaliação + gestor), com a escala de 5 e as quatro perguntas padrão no idioma da comunidade (ou as `questions` enviadas). Período avaliado (`periodStartsOn`–`periodEndsOn`) separado da janela de respostas (`opensOn`–`closesOn`); invertidos: 422 `periodInvalid` / `windowInvalid`. Num espaço "um ciclo" (`moduleConfig.mode = single`) que já tem um: 409 `singleModeHasCycle`. Mexer no rascunho não envia e-mail.
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 |
|---|---|---|
spaceIdoptional | string (uuid) | |
titlerequired | string | max 120 |
instructionsoptional | string | |
periodStartsOnrequired | string (date) | |
periodEndsOnrequired | string (date) | |
opensOnrequired | string (date) | |
closesOnrequired | string (date) | |
modeloptional | DEGREES_90 | DEGREES_180 | DEGREES_360 | |
relationshipsoptional | SELF | MANAGER | PEER | REPORT[] | Padrão: todas as do modelo; enviar só as que ficam ligadas. |
finalRatingRuleoptional | MANAGER | AVERAGE_WITHOUT_SELF | |
weightsoptional | object | De 0 a 10. |
weights.MANAGERoptional | number | |
weights.PEERoptional | number | |
weights.REPORToptional | number | |
scaleLabelsoptional | string[] | Os rótulos da escala, do pior ao melhor: de 2 a 10, preenchidos e sem repetir (422 `scaleInvalid` / `scaleDuplicate`); o valor de cada nível é a posição (1 a N). Vazio ou null = os 5 padrão. |
audienceoptional | ALL | GROUP | TAG | |
groupIdoptional | string (uuid) | |
tagoptional | string | max 80 |
reminderDaysoptional | integer[] | |
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`). |
questionsoptional | object[] | |
questions[].idoptional | string (uuid) | |
questions[].topicoptional | string | Agrupa as perguntas nos passos do formulário. · max 80 |
questions[].textoptional | string | max 500 |
questions[].kindoptional | RATING | TEXT | RATING usa a escala de 5 do ciclo; TEXT nunca entra na média. |
questions[].appliesTooptional | SELF | MANAGER | PEER | REPORT[] | As relações que respondem; vazio = todas. |
questions[].requiredoptional | boolean | |
questions[].orderoptional | integer |
Responses
| Status | Description |
|---|---|
201 | 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 | Dia inválido, período ou janela invertidos, modelo, relações, escala, pesos, grupo ou tag inválidos. |
500 | Erro interno do servidor. |
curl example
curl -X POST "https://api.memberfy.net/api/performance-reviews/cycles" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID" \
-H "Content-Type: application/json" \
-d '{"title":"string","periodStartsOn":"string","periodEndsOn":"string","opensOn":"string","closesOn":"string"}'