Cria um ciclo de avaliação (rascunho)
POST/api/performance-reviews/cycles
- 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 (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.
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 |
|---|---|---|
spaceIdfacultatif | string (uuid) | |
titleobligatoire | string | max 120 |
instructionsfacultatif | string | |
periodStartsOnobligatoire | string (date) | |
periodEndsOnobligatoire | string (date) | |
opensOnobligatoire | string (date) | |
closesOnobligatoire | string (date) | |
modelfacultatif | DEGREES_90 | DEGREES_180 | DEGREES_360 | |
relationshipsfacultatif | SELF | MANAGER | PEER | REPORT[] | Padrão: todas as do modelo; enviar só as que ficam ligadas. |
finalRatingRulefacultatif | MANAGER | AVERAGE_WITHOUT_SELF | |
weightsfacultatif | object | De 0 a 10. |
weights.MANAGERfacultatif | number | |
weights.PEERfacultatif | number | |
weights.REPORTfacultatif | number | |
scaleLabelsfacultatif | 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. |
audiencefacultatif | ALL | GROUP | TAG | |
groupIdfacultatif | string (uuid) | |
tagfacultatif | string | max 80 |
reminderDaysfacultatif | integer[] | |
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`). |
questionsfacultatif | object[] | |
questions[].idfacultatif | string (uuid) | |
questions[].topicfacultatif | string | Agrupa as perguntas nos passos do formulário. · max 80 |
questions[].textfacultatif | string | max 500 |
questions[].kindfacultatif | RATING | TEXT | RATING usa a escala de 5 do ciclo; TEXT nunca entra na média. |
questions[].appliesTofacultatif | SELF | MANAGER | PEER | REPORT[] | As relações que respondem; vazio = todas. |
questions[].requiredfacultatif | boolean | |
questions[].orderfacultatif | integer |
Réponses
| Statut | 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. |
Exemple curl
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"}'