REST API

Everything is accessible programmatically wherever the Orkovia API exposes the capability. All endpoints live under /api/v1 and take a bearer token. Typical operations include:

• Deploy, list, suspend and undeploy processes
• Start, inspect, cancel, suspend, migrate and delete process instances
• Read and edit variables; correlate messages and broadcast signals
• Activate, complete and fail jobs from a worker
• List, claim, delegate and complete human tasks
• List incidents and recover them (retry, skip, restart, rollback)
• Deploy and evaluate DMN decisions; evaluate FEEL expressions
• Manage forms, connections, templates, projects and models
• Get insights and read the audit log

Example: sign in

curl -X POST http://localhost:8080/api/v1/auth/login \
  -H "Content-Type: application/json" \
  -d '{"username": "<username>", "password": "<password>"}'

The response's data.token is the bearer token for every other call.

Example: start a process instance

curl -X POST http://localhost:8080/api/v1/process-instances \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"deploymentId": "<id from the deploy response>", "variables": {"orderId": "O1001"}}'

An instance is started from a deployment id — the id returned by POST /deployments, or listed by GET /deployments — not from a process key.