Workflow

Method & Permission

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

GET Workflow List

Endpoint: /tables/workflow/list/{level}/{sid}/{serializer}/

This endpoint allows you to get a list of workflows.

Parameter: level (path, string)

organization

Parameter: sid (path, string)

organization sid

Parameter: serializer (path, string)

name, list, detail

Parameter: token (header, string)

Authentication token

Parameter: table__sid (query, boolean)

The workflow is table specific, provide table__sid to query the workflow specific to a table

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

POST Workflow List

Endpoint: /tables/workflow/list/{level}/{sid}/{serializer}/

This endpoint allows you to create a list of workflows

Parameter: level (path, string)

organization

Parameter: sid (path, string)

organization sid

Parameter: serializer (path, string)

detail

Parameter: token (header, string)

Authentication token

Parameter: table__sid (query, string)

Parameter: parent (body, number)

Parameter: name (body, string)

Parameter: description (body, string)

Response: 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
}

Response: 406

Missing table__sid in get parameters

GET Workflow Detail

Endpoint: /tables/workflow/detail/{sid}/

Parameter: sid (path, string)

Parameter: token (header, string)

Response: 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
}

PATCH Workflow Detail

Endpoint: /tables/workflow/detail/{sid}/

Operation level: Admin

Parameter: sid (path, string)

Parameter: token (header, string)

Parameter: parent (body, number)

Parameter: name (body, string)

Parameter: description (body, string)

Parameter: is_archived (body, boolean)

Parameter: trigger__sid (query, string)

pass trigger__sid in query as the row sid to trigger the workflow and update variable

Parameter: event (query, string)

pass event in query to update execution log, work together with trigger__sid

Parameter: workflow_data (body, object)

additional data to update the execution, work together with trigger__sid

Parameter: variables (body, object)

additional variable to parse the workflow data, work together with trigger__sid

Response: 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
}

DELETE Workflow Detail

Endpoint: /tables/workflow/detail/{sid}/

Parameter: sid (path, string)

Parameter: token (header, string)

Response: 204

{}