API REST do Process Studio — projetos, definições de processo, diagrama e publicação — com a base, a autenticação e exemplos reais.
O process-studio-api guarda os projetos e os rascunhos BPMN e publica-os no Process Management. É usado pelo Process Studio e pelo separador BPMN do Studio IDE — normalmente através do SDK TypeScript.
| Base (workspace) | http://<slug>:2575/gateway-api/<serviço>-process-studio-api |
| Prefixo | /api/v1 (está no caminho dos recursos) |
| Stack | Spring Boot 3.5 · Java 26 · PostgreSQL |
| Referência | Gerada do OpenAPI do serviço (springdoc em /v3/api-docs) |
O <serviço> é o nome com que o serviço está registado no Eureka.
Autenticação
Authorization: Bearer <token>O token é o do utilizador (Access Management). Ao publicar, o Process Studio reencaminha-o ao Process Management.
Referência
Cada operação, com parâmetros, corpo do pedido, respostas e exemplos em várias linguagens, está na referência gerada a partir do OpenAPI do serviço:
Projetos
Definições de processo
Parametrização
Testar no playground
O botão Testar no playground envia o pedido a partir do browser para o servidor indicado (por omissão, o gateway do workspace em localhost:2575). Preenche o host e o servico do teu ambiente e um token em Autorização. O gateway tem de aceitar pedidos (CORS) vindos da origem da documentação; se não aceitar, usa os exemplos curl.
Exemplos
Criar um projeto e um processo
curl -X POST "$PS/api/v1/projects" \
-H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" \
-d '{ "code": "REGISTOS", "name": "Registos", "description": "Processos de registo de entidades" }'
curl -X POST "$PS/api/v1/projects/$PROJECT_ID/process-definitions" \
-H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" \
-d '{ "title": "Registo de Entidade", "processKey": "registo-entidade" }'Guardar o diagrama e publicar
curl -X PUT "$PS/api/v1/projects/process-definitions/registo-entidade/diagram" \
-H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" \
-d "{\"content\": $(jq -Rs . < registo-entidade.bpmn)}"
curl -X POST "$PS/api/v1/projects/process-definitions/registo-entidade/deploy" \
-H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" \
-d "{\"content\": $(jq -Rs . < registo-entidade.bpmn)}"O XML tem de começar por <?xml
O diagrama é validado ao guardar; conteúdo que não seja XML bem formado devolve 500 — SAXException … Content is not allowed in prolog.
Última atualização: