Skip to content

Confere o que abrir o ciclo vai criar

GET/api/performance-reviews/cycles/{cycleId}/preflight

Auth
Requires a token
API key:
No API key accepted
X-CommunityId
X-CommunityId Send 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. Quantos participantes, a lista "sem gestor" (quem não tem líder numa relação que exige gestor: enquanto houver alguém nela, abrir dá 409) e quantas atribuições por relação. Líder direto que não abre o espaço (por exemplo, membro sem plano numa comunidade paga) não conseguiria fazer a avaliação: o liderado entra em `withoutManager` e o líder em `managersWithoutAccess`, e `canOpen` fica `false`.

Parameters

NameInTypeDescription
cycleIdrequiredpathstring (uuid)

Headers

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

Responses

StatusDescription
200`{ participants, withoutManager: [perfil], managersWithoutAccess: [perfil], assignments: { SELF, MANAGER, PEER, REPORT }, canOpen }`.
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.
500Erro interno do servidor.

curl example

curl -X GET "https://api.memberfy.net/api/performance-reviews/cycles/<cycleId>/preflight" \
  -H "Authorization: Bearer $TOKEN" \
  -H "X-CommunityId: $COMMUNITY_ID"