Workflow execution service “workflows”¶
workflows
- built-in service in the rest module, which provides the ability to control and manage workflows.
The service requires a connection in deploy.json
and a mandatory indication of options.dataRepo
, options.metaRepo
, options.auth
and options.workflow
, example:
"workflows": {
"module": "modules/rest/lib/impl/workflows",
"options": {
"auth": "ion://auth",
"dataRepo": "ion://dataRepo",
"metaRepo": "ion://metaRepo",
"workflow": "ion://workflow"
}
}
All : doc:authorization types <../authorization/index> are supported, by default - authorization with credentials.
The service includes three methods:
GET
- without parameters, returns information about the current status in the workflow (possible transitions)PUT
- transfers the object to the specified next stages of different workflowsPATCH
- performs a forced transfer of an object to the specified stages of different workflows
For all methods, requests are accepted along the path <server URL>/rest/<service name>/:class/: id
to identify the data object.