Workflow

API for workflow

Method & Permission

API	GET	POST	PUT	PATCH	DELETE
Workflow List	Admin, Member	Admin	-	-	-
Workflow Detail	Admin, Member	-	-	Admin	Admin

Workflow List

GET /tables/workflow/list/{level}/{sid}/{serializer}/

This endpoint allows you to get a list of workflows.

Path Parameters

Name	Type	Description
level	string	organization
sid	string	organization sid
serializer	string	name, list, detail

Query Parameters

Name	Type	Description
table__sid	boolean	The workflow is table specific, provide table__sid to query the workflow specific to a table

Headers

Name	Type	Description
token	string	Authentication token

200 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
        },
        ...
    ]
}

Workflow List

POST /tables/workflow/list/{level}/{sid}/{serializer}/

This endpoint allows you to create a list of workflows

Path Parameters

Name	Type	Description
level	string	organization
sid	string	organization sid
serializer	string	detail

Query Parameters

Name	Type	Description
table__sid	string

Headers

Name	Type	Description
token	string	Authentication token

Request Body

Name	Type	Description
parent	number
name	string
description	string

201

{
    "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

Workflow Detail

GET /tables/workflow/detail/{sid}/

Path Parameters

Name	Type	Description
sid	string

Headers

Name	Type	Description
token	string

200

{
    "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
}

Workflow Detail

PATCH /tables/workflow/detail/{sid}/

Operation level: Admin

Path Parameters

Name	Type	Description
sid	string

Query Parameters

Name	Type	Description
trigger__sid	string	pass trigger__sid in query as the row sid to trigger the workflow and update variable
event	string	pass event in query to update execution log, work together with trigger__sid

Headers

Name	Type	Description
token	string

Request Body

Name	Type	Description
parent	number
name	string
description	string
is_archived	boolean
workflow_data	object	additional data to update the execution, work together with trigger__sid
variables	object	additional variable to parse the workflow data, work together with trigger__sid

200

{
    "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
}

Workflow Detail

DELETE /tables/workflow/detail/{sid}/

Path Parameters

Name	Type	Description
sid	string

Headers

Name	Type	Description
token	string

204

{}