Workflow
API for workflow
API | GET | POST | PUT | PATCH | DELETE |
Workflow List | Admin, Member | Admin | - | - | - |
Workflow Detail | Admin, Member | - | - | Admin | Admin |
getWorkflow List
get
/tables/workflow/list/{level}/{sid}/{serializer}/
This endpoint allows you to get a list of workflows.
Request
Response
Request
Path Parameters
level
required
string
organization
sid
required
string
organization sid
serializer
required
string
name, list, detail
Headers
token
required
string
Authentication token
Query Parameters
table__sid
required
boolean
The workflow is table specific, provide table__sid to query the workflow specific to a table
Response
200: OK
Cake successfully retrieved.
# serializer = name{"page_size": 10,"page_number": 1,"page_count": 1,"count": 3,"next": null,"previous": null,"add_permission": true,"results": [{"sid": "xxx","name": "Plan an experiment"},...]}# serializer = list{"page_size": 10,"page_number": 1,"page_count": 1,"count": 3,"next": null,"previous": null,"add_permission": true,"results": [{"sid": "xxx","name": "Plan an experiment","parent": null,"number_of_steps": 5,"is_archived": false,"table": {"sid": "xxx","name": "experiments"},"change_permission": true},...]}# serializer = detail{"page_size": 10,"page_number": 1,"page_count": 1,"count": 3,"next": null,"previous": null,"add_permission": true,"results": [{"sid": "xxx","table": {"sid": "xxx","name": "experiments"},"parent": null,"name": "Plan an experiment","description": "This workflow describes what you need to do before start an experiment.","number_of_steps": 5,"is_archived": false,"updated_by": "xxx","date_updated": "2020-02-10T03:02:27.172051Z","date_created": "2020-02-10T03:02:27.171200Z","change_permission": true},...]}
postWorkflow List
post
/tables/workflow/list/{level}/{sid}/{serializer}/
This endpoint allows you to create a list of workflows
Request
Response
Request
Path Parameters
level
required
string
organization
sid
required
string
organization sid
serializer
required
string
detail
Headers
token
required
string
Authentication token
Query Parameters
table__sid
required
string
​
Body Parameters
parent
optional
number
​
name
required
string
​
description
optional
string
​
Response
201: Created
{"sid": "xxx","table": {"sid": "xxx","name": "experiments"},"parent": null,"name": "Plan an experiment","description": "This workflow describes what you need to do before start an experiment.","number_of_steps": 5,"is_archived": false,"updated_by": "xxx","date_updated": "2020-02-10T03:02:27.172051Z","date_created": "2020-02-10T03:02:27.171200Z","change_permission": true}
406: Not Acceptable
Missing table__sid in get parameters
getWorkflow Detail
get
/tables/workflow/detail/{sid}/
Request
Response
Request
Path Parameters
sid
required
string
​
Headers
token
required
string
​
Response
200: OK
{"sid": "xxx","table": {"name": "xxx","sid": "xxx"},"parent": null,"name": "xxx","description": "xxx","number_of_steps": 4,"is_archived": false,"updated_by": "xxx","date_updated": "2019-07-03T06:15:01.667876Z","date_created": "2019-06-29T07:31:31.706125Z","change_permission": true}
patchWorkflow Detail
patch
/tables/workflow/detail/{sid}/
Operation level: Admin
Request
Response
Request
Path Parameters
sid
required
string
​
Headers
token
required
string
​
Body Parameters
parent
optional
number
​
name
optional
string
​
description
optional
string
​
is_archived
optional
boolean
​
Response
200: OK
{"sid": "xxx","table": {"name": "xxx","sid": "xxx"},"parent": null,"name": "xxx","description": "xxx","number_of_steps": 4,"is_archived": false,"updated_by": "xxx","date_updated": "2019-07-03T06:15:01.667876Z","date_created": "2019-06-29T07:31:31.706125Z","change_permission": true}
deleteWorkflow Detail
delete
/tables/workflow/detail/{sid}/
Request
Response
Request
Path Parameters
sid
required
string
​
Headers
token
required
string
​
Response
204: No Content
{}