Skip to content

Abre um ciclo de PDI no espaço

POST/api/development-plans/cycles

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 (os demais, 403). Um ciclo aberto por espaço (409 `cycleOpenExists`). Prazo para aprovar no mesmo dia ou depois do prazo para enviar. Público: `ALL` (todos que abrem o espaço), `GROUP` (`groupId`) ou `TAG` (`tag`). Lembretes: até 5 dias antes de cada prazo (0 a 60; padrão 7 e 1), por e-mail na categoria PDI, pela fila: para quem do público ainda não enviou e para quem tem PDI do ciclo para aprovar; nunca dois no mesmo dia para a mesma pessoa. Os PDIs ativos que o público já tinha no espaço entram no ciclo.

Headers

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

Request body application/json

NameTypeDescription
spaceIdoptionalstring (uuid)
namerequiredstringmax 120
submitByrequiredstring (date)
approveByrequiredstring (date)
audienceoptionalALL | GROUP | TAG
groupIdoptionalstring (uuid)
tagoptionalstringmax 80
reminderDaysoptionalinteger[]

Responses

StatusDescription
201O ciclo (`DevelopmentCycle`).
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 para esta ação no PDI (ex.: líder indireto ou financeiro tentando aprovar, `developmentPlan.errors.approveDenied`), espaço fechado para quem cria o próprio PDI, ou sessão de suporte do SuperAdmin (`supportSession`).
404Recurso não encontrado.
409Conflito com o estado atual do recurso.
422Sem nome, dia inválido, prazo para aprovar antes do de enviar, grupo de outra comunidade, tag vazia, lembretes inválidos ou `spaceRequired`.

curl example

curl -X POST "https://api.memberfy.net/api/development-plans/cycles" \
  -H "Authorization: Bearer $TOKEN" \
  -H "X-CommunityId: $COMMUNITY_ID" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","submitBy":"string","approveBy":"string"}'