Aller au contenu

Devolve o PDI com uma nota

POST/api/development-plans/{id}/return

Auth
Jeton requis
Clé d’API:
Clé d’API non acceptée
X-CommunityId
X-CommunityId Envoyez 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.

Quem pode aprovar (veja aprovar). Nota obrigatória (422 `noteRequired`, até 2000 caracteres); o PDI volta a rascunho, a pessoa vê a nota (`returnNote`), edita e reenvia. A pessoa recebe o e-mail "PDI devolvido" (sem a nota).

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring (uuid)

En-têtes

NomTypeDescription
X-CommunityIdfacultatifstring (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

NomTypeDescription
noteobligatoirestringmax 2000

Réponses

StatutDescription
200O PDI.
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 nota ou nota longa demais.
500Erro interno do servidor.

Exemple curl

curl -X POST "https://api.memberfy.net/api/development-plans/<id>/return" \
  -H "Authorization: Bearer $TOKEN" \
  -H "X-CommunityId: $COMMUNITY_ID" \
  -H "Content-Type: application/json" \
  -d '{"note":"string"}'