-
Notifications
You must be signed in to change notification settings - Fork 39
Home
Juha Syrjälä edited this page Aug 29, 2014
·
39 revisions
- User guide for getting started with nFlow can be found here.
- Frequently Asked Questions can be found in FAQ.
- Details on how to configure your nFlow can be found here.
- JavaDocs are available at http://nitorcreations.github.io/nflow/apidocs/ .
nFlow uses Semantic Versioning Specification (SemVer). Currently nFlow is in initial development phase, and API may change and features may be added or removed. Once API becames stable, we will release version 1.0.0.
CHANGELOG.md contains the version history.
nFlow REST API supports currently following operations:
GET /v1/workflow-definition- Get definition of a workflow: all possible states, transitions between states, and other setting related to the workflow.
GET /v1/workflow-instance- Query list of workflow instances with different query criterias
GET /v1/workflow-instance/{id}- Fetch full state and history of single workflow instance
PUT /v1/workflow-instance- Create a new workflow instance that will be processed as soon as there are free WorkflowExecutors.
PUT /v1/workflow-instance/{id}- Update existing workflow instance. This is typically used in manual step via some UI.
nFlow REST API is described in more detail via Swagger documentation system. Swagger documentation is included automatically in nflow-jetty.
nFlow is licenced under European Union Public Licence v1.1.