Saltar al contenido

Cria um PDI (rascunho)

POST/api/development-plans

Auth
Requiere token
Quién puede:
owner
admin
Clave de API:
No acepta clave de API
X-CommunityId
X-CommunityId Envía el X-CommunityId de la comunidad en la que ocurre la operación.
Las descripciones de los endpoints vienen de la especificación de la API y, por ahora, están en portugués. La interfaz alrededor está traducida.

Sem `memberId` (ou com o próprio), o PDI é de quem pede, que precisa abrir o espaço (403 `spaceDenied`). Com o `memberId` de outra pessoa, quem pede precisa poder aprovar por ela (líder direto, owner ou admin; os outros: 403 `createDenied`) e a pessoa precisa abrir o espaço (422 `personNoAccess`); a pessoa recebe, pela fila, o e-mail "seu líder criou um PDI para você" (categoria `developmentPlan`, sem o conteúdo do plano). Uma pessoa tem um PDI ativo por espaço: outro ativo é 409 `activeExists`. `spaceId` é opcional enquanto a comunidade tem um só espaço de PDI (com vários: 422 `spaceRequired`). Dias `AAAA-MM-DD`, no fuso da comunidade; `endsOn` antes de `startsOn`: 422 `periodInvalid`. Sem `title`, "PDI {ano}" no idioma de quem pede. Até 50 ações.

Headers

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

Cuerpo de la solicitud application/json

NombreTipoDescripción
spaceIdopcionalstring (uuid)
memberIdopcionalstring (uuid)A pessoa do PDI, quando quem cria é o líder direto, owner ou admin.
titleopcionalstringmax 120
startsOnobligatoriostring (date)
endsOnobligatoriostring (date)
actionsopcionalobject[]
actions[].titleobligatoriostringmax 200
actions[].descriptionopcionalstringmax 2000
actions[].dueOnobligatoriostring (date)

Respuestas

CódigoDescripción
201O 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.
422Dia inválido, período invertido, ação sem título ou prazo, texto longo demais, pessoa de outra comunidade ou sem acesso ao espaço, `spaceRequired`.
500Erro interno do servidor.

Ejemplo con curl

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