GET /api/flows
Returns all flows available in the XIBLE installation.
Responses
Code | Reason | Response |
---|---|---|
200 | Success | See example |
500 | Server failure | None |
Example response
{
"flowName": ... /api/flows/{name}
}
GET /api/flows/{name}
Returns only the flow by the given name.
Path parameters
name | description |
---|---|
name | The name of the flow. |
Responses
Code | Reason | Response |
---|---|---|
200 | Success | See example |
404 | Flow not found | None |
500 | Server failure | None |
Example response
{
"_id": "test flow",
"name": "test flow",
"runnable": true,
"viewState": {},
"nodes": [],
"connectors": []
}
POST /api/flows/{name}/instances
Creates a new instance on the flow.
Path parameters
name | description |
---|---|
name | The name of the flow. |
Body parameters
name | type | default | description |
---|---|---|---|
start | Boolean | false | Indicates whether or not to start the flow immediately after creation. |
params | Object | {} | An object of which the key-value pairs can be used from the flow (instance). |
Responses
Code | Reason | Response |
---|---|---|
200 | Success | See example |
404 | Flow not found | None |
500 | Server failure | None |
Example response
{
"_id": "...",
"state": 5,
"directed": false,
"params": {},
"usage": null,
"timing": {}
}
PATCH /api/flows/{name}/stop
Stops all instances on the flow.
Path parameters
name | description |
---|---|
name | The name of the flow. |
Responses
Code | Reason | Response |
---|---|---|
200 | Success | None |
404 | Flow not found | None |
500 | Server failure | None |