Workflows

Workflow

List workflows of a base

GET /api/v2.1/workflows/

Request parameters

workspace_id: id of workspace, required, int
name: name of base, required, string

Sample request

curl -L -X GET 'https://cloud.seatable.cn/api/v2.1/workflows/?workspace_id=2&name=flow' \
-H 'Authorization: Token 5c333d6f00fcb280b25703caba6c47b45d8a8d62'

Sample response

{
    "workflow_list": [
        {
            "id": 29,
            "token": "4fa2c20b-d42c-4e54-a7ef-868176a3df7c",
            "dtable_uuid": "6aa76830fb5c49858dd2850e79d330da",
            "workflow_config": ...,
            "created_at": "2022-01-11T10:00:04+08:00",
            "visit_times": 0,
            "creator": "d984c4d1b72a47b3b3a350a01e0d4026@auth.local",
            "owner": "1@seafile_group",
            "workflow_edit_link": "https://cloud.seatable.cn/dtable/workflows/4fa2c20b-d42c-4e54-a7ef-868176a3df7c/edit/",
            "workflow_view_link": "https://cloud.seatable.cn/dtable/workflows/4fa2c20b-d42c-4e54-a7ef-868176a3df7c/view/"
        }
    ]
}

Create a workflow

POST /api/v2.1/workflows/

Request parameters

workspace_id: id of workspace, required, int
name: name of base, required, string
workflow_config: config of workflow, required, a JSON str,

Sample request

curl -L -X POST 'https://cloud.seatable.cn/api/v2.1/workflows/' \
-H 'Authorization: Token 0a4d115d8b0d3871e1cfb3444e0b8d97e623c759' \
-F 'workspace_id="2"' \
-F 'name="flow"' \
-F 'workflow_config="{
  \"workflow_name\": \"flow\",
  \"table_id\": \"0000\",
  \"state_column_key\": \"biUw\",
  \"nodes\": [{
    \"_id\": \"init\",
    \"type\": \"init\",
    \"name\": \"Start\",
    \"state\": \"\",
    \"participants\": [],
    \"next_node_id\": \"746343\",
    \"other_node_ids\": [],
    \"node_form\": {
      \"columns\": [{
        \"key\": \"0000\",
        \"permission\": \"rw\",
        \"is_required\": false
      }, {
        \"key\": \"En90\",
        \"permission\": \"rw\",
        \"is_required\": false
      }]
    }
  }, {
    \"_id\": \"1\",
    \"type\": \"completed\",
    \"name\": \"Finished\",
    \"state\": \"\",
    \"is_notify_applicant\": true,
    \"notify_message\": \"\",
    \"state_option_id\": \"487218\"
  }, {
    \"_id\": \"746343\",
    \"type\": \"normal\",
    \"name\": \"Node 1\",
    \"state\": \"\",
    \"participants\": [\"b535e5e74bfc4928bfae1bcc68483101@auth.local\"],
    \"next_node_id\": \"1\",
    \"other_node_ids\": [],
    \"node_form\": {
      \"columns\": []
    },
    \"state_option_id\": \"367507\"
  }]
}"'

Sample response

{
    "workflow": {
        "id": 29,
        "token": "4fa2c20b-d42c-4e54-a7ef-868176a3df7c",
        "dtable_uuid": "6aa76830fb5c49858dd2850e79d330da",
        "workflow_config": ...,
        "created_at": "2022-01-11T10:00:04+08:00",
        "visit_times": 0,
        "creator": "d984c4d1b72a47b3b3a350a01e0d4026@auth.local",
        "owner": "1@seafile_group",
        "workflow_edit_link": "https://cloud.seatable.cn/dtable/workflows/4fa2c20b-d42c-4e54-a7ef-868176a3df7c/edit/",
        "workflow_view_link": "https://cloud.seatable.cn/dtable/workflows/4fa2c20b-d42c-4e54-a7ef-868176a3df7c/view/"
    }
}

Get a workflow

GET /api/v2.1/workflows/:token/

Request parameters

token: required, string

Sample request

curl -L -X GET 'https://cloud.seatable.cn/api/v2.1/workflows/4fa2c20b-d42c-4e54-a7ef-868176a3df7c/' \
-H 'Authorization: Token 5c333d6f00fcb280b25703caba6c47b45d8a8d62'

Sample response

{
    "workflow": {
        "id": 29,
        "token": "4fa2c20b-d42c-4e54-a7ef-868176a3df7c",
        "dtable_uuid": "6aa76830fb5c49858dd2850e79d330da",
        "workflow_config": ...,
        "created_at": "2022-01-11T10:00:04+08:00",
        "visit_times": 0,
        "creator": "d984c4d1b72a47b3b3a350a01e0d4026@auth.local",
        "owner": "1@seafile_group",
        "workflow_edit_link": "https://cloud.seatable.cn/dtable/workflows/4fa2c20b-d42c-4e54-a7ef-868176a3df7c/edit/",
        "workflow_view_link": "https://cloud.seatable.cn/dtable/workflows/4fa2c20b-d42c-4e54-a7ef-868176a3df7c/view/"
    }
}

Update a workflow

PUT /api/v2.1/workflows/:token/

Request parameters

workflow_config: config of workflow, required, a JSON string
token: required, string

Sample request

curl -L -X PUT 'https://cloud.seatable.cn/api/v2.1/workflows/bb10076a-0dd4-4069-88f1-079024de152b/' \
-H 'Authorization: Token 0a4d115d8b0d3871e1cfb3444e0b8d97e623c759' \
-F 'workflow_config="{
  \"workflow_name\": \"flow\",
  \"table_id\": \"0000\",
  \"state_column_key\": \"biUw\",
  \"nodes\": [{
    \"_id\": \"init\",
    \"type\": \"init\",
    \"name\": \"Start\",
    \"state\": \"\",
    \"participants\": [],
    \"next_node_id\": \"746343\",
    \"other_node_ids\": [],
    \"node_form\": {
      \"columns\": [{
        \"key\": \"0000\",
        \"permission\": \"rw\",
        \"is_required\": false
      }, {
        \"key\": \"En90\",
        \"permission\": \"rw\",
        \"is_required\": false
      }]
    }
  }, {
    \"_id\": \"1\",
    \"type\": \"completed\",
    \"name\": \"Finishedddddd\",
    \"state\": \"\",
    \"is_notify_applicant\": true,
    \"notify_message\": \"\",
    \"state_option_id\": \"487218\"
  }, {
    \"_id\": \"746343\",
    \"type\": \"normal\",
    \"name\": \"Node 1\",
    \"state\": \"\",
    \"participants\": [\"b535e5e74bfc4928bfae1bcc68483101@auth.local\"],
    \"next_node_id\": \"1\",
    \"other_node_ids\": [],
    \"node_form\": {
      \"columns\": []
    },
    \"state_option_id\": \"367507\"
  }]
}"'

Sample response

{
    "workflow": {
        "id": 29,
        "token": "4fa2c20b-d42c-4e54-a7ef-868176a3df7c",
        "dtable_uuid": "6aa76830fb5c49858dd2850e79d330da",
        "workflow_config": ...,
        "created_at": "2022-01-11T10:00:04+08:00",
        "visit_times": 0,
        "creator": "d984c4d1b72a47b3b3a350a01e0d4026@auth.local",
        "owner": "1@seafile_group",
        "workflow_edit_link": "https://cloud.seatable.cn/dtable/workflows/4fa2c20b-d42c-4e54-a7ef-868176a3df7c/edit/",
        "workflow_view_link": "https://cloud.seatable.cn/dtable/workflows/4fa2c20b-d42c-4e54-a7ef-868176a3df7c/view/"
    }
}

Delete a workflow

DELETE /api/v2.1/workflows/:token/

Request parameters

token: required, string

Sample request

curl -L -X DELETE 'https://cloud.seatable.cn/api/v2.1/workflows/de216bc7-6584-403b-bf22-0fd1bcf2684d/' \
-H 'Authorization: Token 5c333d6f00fcb280b25703caba6c47b45d8a8d62'

Sample response

{
    "success": true
}

Get a upload link by a workflow

GET /api/v2.1/workflows/:token/upload-link/

Request parameters

token: required, string

Sample request

curl -L -X GET 'https://cloud.seatable.cn/api/v2.1/workflows/f65624e9-5406-4151-8fe2-8e6c6d6baf8f/upload-link/' \
-H 'Authorization: Token 5c333d6f00fcb280b25703caba6c47b45d8a8d62'

Sample response

{
    "upload_link": "https://cloud.seatable.cn/seaf-http/upload-api/6a3c02f8-2dd5-43d0-9580-8f8e997b9c43",
    "parent_path": "/asset/6aa76830-fb5c-4985-8dd2-850e79d330da",
    "img_relative_path": "forms",
    "file_relative_path": "files/2022-01"
}

List shared workflows

GET /api/v2.1/workflows/shared/

Sample request

curl -L -X GET 'https://cloud.seatable.cn/api/v2.1/workflows/shared/' \
-H 'Authorization: Token 5c333d6f00fcb280b25703caba6c47b45d8a8d62'

Sample response

{
    "my_managed_workflows": [
        {
            "id": 42,
            "token": "8dc6b0f3-82a1-45d5-946a-211493bef819",
            "dtable_uuid": "6aa76830fb5c49858dd2850e79d330da",
            "workflow_config":...,
            "created_at": "2022-03-12T11:38:02+08:00",
            "visit_times": 0,
            "creator": "d984c4d1b72a47b3b3a350a01e0d4026@auth.local",
            "owner": "1@seafile_group",
            "workflow_edit_link": "https://cloud.seatable.cn/dtable/workflows/8dc6b0f3-82a1-45d5-946a-211493bef819/edit/",
            "workflow_form_link": "https://cloud.seatable.cn/dtable/workflows/8dc6b0f3-82a1-45d5-946a-211493bef819/form/",
            "group_id": 1,
            "group_name": "group-1",
            "group_owner": "d984c4d1b72a47b3b3a350a01e0d4026@auth.local",
            "is_shared": false,
            "is_admin": true,
            "workspace_id": 2,
            "dtable_name": "flow",
            "ongoing_tasks_count": 0
        }
    ],
    "can_use_workflows": [
        {
            "id": 47,
            "token": "6cb85681-e9f2-44c7-adee-167fb873b359",
            "dtable_uuid": "0e4c82e544914a64b3a35129a3bde2a6",
            "workflow_config": ...,
            "created_at": "2022-03-24T17:15:07+08:00",
            "visit_times": 0,
            "creator": "c4b61614cf2a413f97155fd4db3c7ed2@auth.local",
            "owner": "3@seafile_group",
            "workflow_edit_link": "https://cloud.seatable.cn/dtable/workflows/6cb85681-e9f2-44c7-adee-167fb873b359/edit/",
            "workflow_form_link": "https://cloud.seatable.cn/dtable/workflows/6cb85681-e9f2-44c7-adee-167fb873b359/form/",
            "is_admin": false,
            "is_shared": true,
            "group_id": 3,
            "group_name": "group-of-test",
            "group_owner": "c4b61614cf2a413f97155fd4db3c7ed2@auth.local",
            "initiated_tasks_count": 0
        }
    ]
}

POST /api/v2.1/workflows/:token/shares/

Request parameters

group_id: id of group which you want to share worklfow to, required, int
token: required

Sample request

curl -L -X POST 'https://cloud.seatable.cn/api/v2.1/workflows/f65624e9-5406-4151-8fe2-8e6c6d6baf8f/shares/' \
-H 'Authorization: Token 5c333d6f00fcb280b25703caba6c47b45d8a8d62' \
-F 'group_id="1"' \
-F 'group_id="2"'

Sample response

{
    "success_list": [
        {
            "group_id": 1,
            "group_info": {
                "group_name": "group-1",
                "group_id": 1
            }
        },
        {
            "group_id": 2,
            "group_info": {
                "group_name": "group-2",
                "group_id": 2
            }
        }
    ],
    "failed_list": []
}

Get shares of a workflow

GET /api/v2.1/workflows/:token/shares/

Request parameters

token: required, string

Sample request

curl -L -X GET 'https://cloud.seatable.cn/api/v2.1/workflows/f65624e9-5406-4151-8fe2-8e6c6d6baf8f/shares/' \
-H 'Authorization: Token 5c333d6f00fcb280b25703caba6c47b45d8a8d62'

Sample response

{
    "share_list": [
        {
            "group_id": 1,
            "group_name": "group-1"
        },
        {
            "group_id": 2,
            "group_name": "group-2"
        }
    ]
}

DELETE /api/v2.1/workflows/:token/shares/:group_id/

Request parameters

group_id: required, int
token: required, string

Sample request

curl -L -X DELETE 'https://cloud.seatable.cn/api/v2.1/workflows/f65624e9-5406-4151-8fe2-8e6c6d6baf8f/shares/2/' \
-H 'Authorization: Token 5c333d6f00fcb280b25703caba6c47b45d8a8d62'

Sample response

{
    "success": true
}

Workflow task

Submit a workflow task

POST /api/v2.1/workflows/:token/task-submit/

Request parameters

token: required, string

Request parameters

row_data: submit data of workflow init node form, optional, a JSON string
row_id: optional, if row_id provided, row_data is not required
replace: true/false, string, optional

Sample request

curl -L -X POST 'https://cloud.seatable.cn/api/v2.1/workflows/4fa2c20b-d42c-4e54-a7ef-868176a3df7c/task-submit/' \
-H 'Authorization: Token 5c333d6f00fcb280b25703caba6c47b45d8a8d62' \
-F 'row_data="{\"initiator\": \"me\", \"days\": 20}"'

Sample response

{
    "task": {
        "id": 80,
        "row_id": "EdfYy8ANTxCNQfoCFctVoA",
        "initiator": "d984c4d1b72a47b3b3a350a01e0d4026@auth.local",
        "node_id": "730963",
        "dtable_workflow": {
            "id": 29,
            "token": "4fa2c20b-d42c-4e54-a7ef-868176a3df7c",
            "dtable_uuid": "6aa76830fb5c49858dd2850e79d330da",
            "workflow_config": ...,
            "created_at": "2022-01-11T10:00:04+08:00",
            "visit_times": 0,
            "creator": "d984c4d1b72a47b3b3a350a01e0d4026@auth.local",
            "owner": "1@seafile_group",
            "workflow_edit_link": "https://cloud.seatable.cn/dtable/workflows/4fa2c20b-d42c-4e54-a7ef-868176a3df7c/edit/",
            "workflow_view_link": "https://cloud.seatable.cn/dtable/workflows/4fa2c20b-d42c-4e54-a7ef-868176a3df7c/view/"
        },
        "transfer_url": "https://cloud.seatable.cn/dtable/workflows/4fa2c20b-d42c-4e54-a7ef-868176a3df7c/tasks/80/transfer/",
        "submitted_url": "https://cloud.seatable.cn/dtable/workflows/4fa2c20b-d42c-4e54-a7ef-868176a3df7c/submitted-tasks/80/",
        "state": "test-1"
    }
}

Sample request

with row_id

curl -L -X POST 'https://cloud.seatable.cn/api/v2.1/workflows/4fa2c20b-d42c-4e54-a7ef-868176a3df7c/task-submit/' \
-H 'Authorization: Token 5c333d6f00fcb280b25703caba6c47b45d8a8d62' \
-F 'row_id="IBUP3R61QYeyCQsvDfgFRQ"'
-F 'replace=true'

Sample response

{
    "task": {
        "id": 80,
        "row_id": "IBUP3R61QYeyCQsvDfgFRQ",
        "initiator": "d984c4d1b72a47b3b3a350a01e0d4026@auth.local",
        "node_id": "730963",
        "dtable_workflow": {
            "id": 29,
            "token": "4fa2c20b-d42c-4e54-a7ef-868176a3df7c",
            "dtable_uuid": "6aa76830fb5c49858dd2850e79d330da",
            "workflow_config": ...,
            "created_at": "2022-01-11T10:00:04+08:00",
            "visit_times": 0,
            "creator": "d984c4d1b72a47b3b3a350a01e0d4026@auth.local",
            "owner": "1@seafile_group",
            "workflow_edit_link": "https://cloud.seatable.cn/dtable/workflows/4fa2c20b-d42c-4e54-a7ef-868176a3df7c/edit/",
            "workflow_view_link": "https://cloud.seatable.cn/dtable/workflows/4fa2c20b-d42c-4e54-a7ef-868176a3df7c/view/"
        },
        "transfer_url": "https://cloud.seatable.cn/dtable/workflows/4fa2c20b-d42c-4e54-a7ef-868176a3df7c/tasks/80/transfer/",
        "submitted_url": "https://cloud.seatable.cn/dtable/workflows/4fa2c20b-d42c-4e54-a7ef-868176a3df7c/submitted-tasks/80/",
        "state": "test-1"
    }
}

Transfer a workflow task

POST /api/v2.1/workflows/:token/tasks/:task_id/transfer/

Request parameters

row_data: submit data of workflow node form, optional, a JSON string
next_node_id: which node you want to transfer task to, optional, string
node_id: task's current node id, required, string
token: required, string
task_id: required, int

Sample request

curl -L -X POST 'https://cloud.seatable.cn/api/v2.1/workflows/f65624e9-5406-4151-8fe2-8e6c6d6baf8f/tasks/43/transfer/' \
-H 'Authorization: Token 5c333d6f00fcb280b25703caba6c47b45d8a8d62' \
-F 'row_data="{\"Advise\": \"Okay\"}"'

Sample response

{
    "success": true
}

List ongoing workflow tasks

GET /api/v2.1/workflows/ongoing-tasks/

Request parameters

page: which page, optional, default 1, int
per_page: number of per page, optional, default 25, int

Sample request

curl -L -X GET 'https://cloud.seatable.cn/api/v2.1/workflows/ongoing-tasks/' \
-H 'Authorization: Token 5c333d6f00fcb280b25703caba6c47b45d8a8d62'

Sample response

{
    "task_list": [
        {
            "id": 80,
            "row_id": "EdfYy8ANTxCNQfoCFctVoA",
            "initiator": "d984c4d1b72a47b3b3a350a01e0d4026@auth.local",
            "node_id": "730963",
            "dtable_workflow": {
                "id": 29,
                "token": "4fa2c20b-d42c-4e54-a7ef-868176a3df7c",
                "dtable_uuid": "6aa76830fb5c49858dd2850e79d330da",
                "workflow_config": ...,
                "created_at": "2022-01-11T10:00:04+08:00",
                "visit_times": 0,
                "creator": "d984c4d1b72a47b3b3a350a01e0d4026@auth.local",
                "owner": "1@seafile_group",
                "workflow_edit_link": "https://cloud.seatable.cn/dtable/workflows/4fa2c20b-d42c-4e54-a7ef-868176a3df7c/edit/",
                "workflow_view_link": "https://cloud.seatable.cn/dtable/workflows/4fa2c20b-d42c-4e54-a7ef-868176a3df7c/view/"
            },
            "transfer_url": "https://cloud.seatable.cn/dtable/workflows/4fa2c20b-d42c-4e54-a7ef-868176a3df7c/tasks/80/transfer/",
            "submitted_url": "https://cloud.seatable.cn/dtable/workflows/4fa2c20b-d42c-4e54-a7ef-868176a3df7c/submitted-tasks/80/",
            "state": {
                "color": "#EAA775",
                "name": "Finished-1",
                "text_color": "#FFFFFF"
            },
            "initiator_name": "admin",
            "submitted_values": [
                {
                    "column_key": "0000",
                    "column_name": "Applicant",
                    "column_type": "text",
                    "column_data": null,
                    "value": "Alex"
                }
            ],
            "initiator_avatar_url": "https://cloud.seatable.cn/media/avatars/default.png"
        }
    ],
    "count": 1
}

List submitted workflow tasks

GET /api/v2.1/workflows/submitted-tasks/

Request parameters

page: which page, optional, default 1
per_page: number of per page, optional, default 25

Sample request

curl -L -X GET 'https://cloud.seatable.cn/api/v2.1/workflows/submitted-tasks/' \
-H 'Authorization: Token 5c333d6f00fcb280b25703caba6c47b45d8a8d62'

Sample response

{
    "task_list": [
        {
            "id": 83,
            "row_id": "FBGFQpscRBOt4nTirx2Xqg",
            "initiator": "d984c4d1b72a47b3b3a350a01e0d4026@auth.local",
            "node_id": "1",
            "dtable_workflow": {
                "id": 29,
                "token": "4fa2c20b-d42c-4e54-a7ef-868176a3df7c",
                "dtable_uuid": "6aa76830fb5c49858dd2850e79d330da",
                "workflow_config": ...,
                "visit_times": 0,
                "creator": "d984c4d1b72a47b3b3a350a01e0d4026@auth.local",
                "owner": "1@seafile_group",
                "workflow_edit_link": "https://cloud.seatable.cn/dtable/workflows/4fa2c20b-d42c-4e54-a7ef-868176a3df7c/edit/",
                "workflow_view_link": "https://cloud.seatable.cn/dtable/workflows/4fa2c20b-d42c-4e54-a7ef-868176a3df7c/view/"
            },
            "transfer_url": "https://cloud.seatable.cn/dtable/workflows/4fa2c20b-d42c-4e54-a7ef-868176a3df7c/tasks/83/transfer/",
            "submitted_url": "https://cloud.seatable.cn/dtable/workflows/4fa2c20b-d42c-4e54-a7ef-868176a3df7c/submitted-tasks/83/",
            "state": {
                "color": "#EAA775",
                "name": "Finished-1",
                "text_color": "#FFFFFF"
            },
            "initiator_name": "admin",
            "submitted_values": [
                {
                    "column_key": "0000",
                    "column_name": "Applicant",
                    "column_type": "text",
                    "column_data": null,
                    "value": "Alex"
                }
            ],
            "initiator_avatar_url": "https://cloud.seatable.cn/media/avatars/default.png"
        }
    ],
    "count": 1
}

Cancel a task

POST /api/v2.1/workflows/:token/tasks/:task_id/cancel/

Request parameters

task_id: required, int
token: required, string

Sample request

curl -L -X POST 'https://cloud.seatable.cn/api/v2.1/workflows/8dc6b0f3-82a1-45d5-946a-211493bef819/tasks/393/cancel/' \
-H 'Authorization: Token 5c333d6f00fcb280b25703caba6c47b45d8a8d62' \
-H 'Cookie: dtable_csrftoken=F2TF8caiukNTCPEkssuqs2fOpuESsozCWm6zeHWxrGaEto5aZIDxoQWv1fymLuxK'

Sample response

{
    "success": true
}

Get a task by row id

GET /api/v2.1/workflows/:token/task-row-id/:row_id/

Request parameters

row_id: required, string
token: required, string

Sample request

curl -L -X GET 'https://cloud.seatable.cn/api/v2.1/workflows/8dc6b0f3-82a1-45d5-946a-211493bef819/task-row-id/VD2VMsVXRN2HylCnkVg-bg/' \
-H 'Authorization: Token 5c333d6f00fcb280b25703caba6c47b45d8a8d62'

Sample response

{
    "task": {
        "id": 523,
        "row_id": "VD2VMsVXRN2HylCnkVg-bg",
        "initiator": "d984c4d1b72a47b3b3a350a01e0d4026@auth.local",
        "node_id": "339357",
        "dtable_workflow": {
            "id": 42,
            "token": "8dc6b0f3-82a1-45d5-946a-211493bef819",
            "dtable_uuid": "6aa76830fb5c49858dd2850e79d330da",
            "workflow_config":...,
            "visit_times": 0,
            "creator": "d984c4d1b72a47b3b3a350a01e0d4026@auth.local",
            "owner": "1@seafile_group",
            "workflow_edit_link": "https://cloud.seatable.cn/dtable/workflows/8dc6b0f3-82a1-45d5-946a-211493bef819/edit/",
            "workflow_form_link": "https://cloud.seatable.cn/dtable/workflows/8dc6b0f3-82a1-45d5-946a-211493bef819/form/"
        },
        "transfer_url": "https://cloud.seatable.cn/dtable/workflows/8dc6b0f3-82a1-45d5-946a-211493bef819/tasks/523/transfer/",
        "submitted_url": "https://cloud.seatable.cn/dtable/workflows/8dc6b0f3-82a1-45d5-946a-211493bef819/submitted-tasks/523/",
        "state": "Node 3",
        "created_at": "2022-08-04T15:16:32+08:00",
        "task_state": "processing",
        "finished_at": "",
        "is_valid": true
    },
    "current_node": {
        "_id": "339357",
        "type": "normal",
        "name": "Node 3",
        "state": "",
        "participants": [
            "d984c4d1b72a47b3b3a350a01e0d4026@auth.local"
        ],
        "next_node_id": "722540",
        "other_node_ids": [],
        "node_form": {
            "readonly_columns": [
                {
                    "key": "8sig"
                },
                {
                    "key": "0000"
                }
            ],
            "readwrite_columns": [
                {
                    "key": "3WPf",
                    "is_required": false
                }
            ]
        },
        "state_option_id": "924535",
        "participants_type": "static",
        "node_participants_column_key": "J7A4",
    },
    "the_other_nodes": []
}

Delete a task by row id

DELETE /api/v2.1/workflows/:token/task-row-id/:row_id/

Request parameters

row_id: required, string
token: required, string

Sample request

curl -L -X DELETE 'https://cloud.seatable.cn/api/v2.1/workflows/8dc6b0f3-82a1-45d5-946a-211493bef819/task-row-id/VD2VMsVXRN2HylCnkVg-bg/' \
-H 'Authorization: Token 5c333d6f00fcb280b25703caba6c47b45d8a8d62'

Sample response

{
    "success": true
}

Delete tasks by several row ids

DELETE /api/v2.1/workflows/:token/task-row-ids/

Request parameters

row_ids: a list of row ids, required
token: required, string

Sample request

curl -L -X DELETE 'https://cloud.seatable.cn/api/v2.1/workflows/8dc6b0f3-82a1-45d5-946a-211493bef819/task-row-ids/' \
-H 'Authorization: Token 5c333d6f00fcb280b25703caba6c47b45d8a8d62' \
-H 'Content-Type: application/json' \
--data-raw '{
    "row_ids": [
        "VD2VMsVXRN2HylCnkVg-bg",
        "UqITEMgzRx27Dn7iQnTV7g"
    ]
}'

Sample response

{
    "success": true
}

Get an admin view of a specific task

GET /api/v2.1/workflows/:token/tasks/:task_id/admin-view/

Request parameters

task_id: required, int
token: required, string

Sample request

curl -L -X GET 'https://cloud.seatable.cn/api/v2.1/workflows/8dc6b0f3-82a1-45d5-946a-211493bef819/tasks/185/admin-view/' \
-H 'Authorization: Token 5c333d6f00fcb280b25703caba6c47b45d8a8d62' \
-H 'Cookie: dtable_csrftoken=F2TF8caiukNTCPEkssuqs2fOpuESsozCWm6zeHWxrGaEto5aZIDxoQWv1fymLuxK'

Sample response

{
    "table": {
        "_id": "0000",
        "name": "Table1",
        "columns": [...],
        "views": [...]
    },
    "row": {
      "0000": "test-4"
    },
    "show_columns": [...],
    "nodes": [...],
    "current_node": {
        "_id": "722540",
        "type": "normal",
        "name": "Node 2",
        "state": "",
        "participants": [
            "d984c4d1b72a47b3b3a350a01e0d4026@auth.local"
        ],
        "next_node_id": "1",
        "other_node_ids": [],
        "node_form": {
            "readonly_columns": [
                {
                    "key": "0000"
                }
            ],
            "readwrite_columns": [
                {
                    "key": "Lrc0"
                }
            ]
        },
        "state_option_id": "623734"
    },
    "workspace_id": 2,
    "dtable_name": "flow"
}

Errors

400: Bad Request
403: Permission denied
404: Base not found / Workflow not found / Task not found
500: Internal Server Error

Get a participant view of a specific task

GET /api/v2.1/workflows/:token/tasks/:task_id/participant-view/

Request parameters

task_id: required, int
token: required, string

Sample request

curl -L -X GET 'https://cloud.seatable.cn/api/v2.1/workflows/8dc6b0f3-82a1-45d5-946a-211493bef819/tasks/185/participant-view/' \
-H 'Authorization: Token 5c333d6f00fcb280b25703caba6c47b45d8a8d62' \
-H 'Cookie: dtable_csrftoken=F2TF8caiukNTCPEkssuqs2fOpuESsozCWm6zeHWxrGaEto5aZIDxoQWv1fymLuxK'

Sample response

{
    "table": {
        "_id": "0000",
        "name": "Table1",
        "columns": [...],
        "views": [...]
    },
    "row": {
        "0000": "test-4"
    },
    "readonly_columns": [
        {
            "key": "0000",
            "name": "initiator",
            "type": "text",
            "width": 300,
            "editable": true,
            "resizable": true
        }
    ],
    "readwrite_columns": [
        {
            "key": "Lrc0",
            "type": "image",
            "name": "pics",
            "editable": true,
            "width": 200,
            "resizable": true,
            "draggable": true,
            "data": null,
            "permission_type": "",
            "permitted_users": [],
            "description": null
        }
    ],
    "nodes": [...],
    "current_node": {
        "_id": "722540",
        "type": "normal",
        "name": "Node 2",
        "state": "",
        "participants": [
            "d984c4d1b72a47b3b3a350a01e0d4026@auth.local"
        ],
        "next_node_id": "1",
        "other_node_ids": [],
        "node_form": {
            "readonly_columns": [
                {
                    "key": "0000"
                }
            ],
            "readwrite_columns": [
                {
                    "key": "Lrc0"
                }
            ]
        },
        "state_option_id": "623734"
    },
    "workspace_id": 2,
    "dtable_name": "flow"
}

Errors

400: Bad Request
403: Permission denied
404: Base not found / Workflow not found / Task not found
500: Internal Server Error

Get a initiator view of a specific task

GET /api/v2.1/workflows/:token/tasks/:task_id/initiator-view/

Request parameters

task_id: required, int
token: required, string

Sample request

curl -L -X GET 'https://cloud.seatable.cn/api/v2.1/workflows/8dc6b0f3-82a1-45d5-946a-211493bef819/tasks/185/initiator-view/' \
-H 'Authorization: Token 5c333d6f00fcb280b25703caba6c47b45d8a8d62' \
-H 'Cookie: dtable_csrftoken=F2TF8caiukNTCPEkssuqs2fOpuESsozCWm6zeHWxrGaEto5aZIDxoQWv1fymLuxK'

Sample response

{
    "table": {
        "_id": "0000",
        "name": "Table1",
        "columns": [...],
        "views": [...]
    },
    "row": {
      "0000": "test-4"
    },
    "show_columns": [...],
    "nodes": [...],
    "current_node": {
        "_id": "722540",
        "type": "normal",
        "name": "Node 2",
        "state": "",
        "participants": [
            "d984c4d1b72a47b3b3a350a01e0d4026@auth.local"
        ],
        "next_node_id": "1",
        "other_node_ids": [],
        "node_form": {
            "readonly_columns": [
                {
                    "key": "0000"
                }
            ],
            "readwrite_columns": [
                {
                    "key": "Lrc0"
                }
            ]
        },
        "state_option_id": "623734"
    },
    "workspace_id": 2,
    "dtable_name": "flow"
}

Errors

400: Bad Request
403: Permission denied
404: Base not found / Workflow not found / Task not found
500: Internal Server Error

List tasks of a specific workflow

GET /api/v2.1/workflows/:token/tasks/

Request parameters

token: required, string

Request parameters

filter_type: one of 'all', 'initiated', which type of tasks you want to list, required, default initiated
page: default 1
per_page: default 25

Sample request

curl -L -X GET 'https://cloud.seatable.cn/api/v2.1/workflows/8dc6b0f3-82a1-45d5-946a-211493bef819/tasks/?filter_type=initiated' \
-H 'Authorization: Token 5c333d6f00fcb280b25703caba6c47b45d8a8d62' \
-H 'Cookie: dtable_csrftoken=F2TF8caiukNTCPEkssuqs2fOpuESsozCWm6zeHWxrGaEto5aZIDxoQWv1fymLuxK'

Sample response

{
    "task_list": [
        {
            "id": 181,
            "row_id": "IWOm67Z2RSmaLsToJotJUA",
            "initiator": "d984c4d1b72a47b3b3a350a01e0d4026@auth.local",
            "node_id": "1",
            "dtable_workflow": {...},
            "transfer_url": "https://cloud.seatable.cn/dtable/workflows/8dc6b0f3-82a1-45d5-946a-211493bef819/tasks/181/transfer/",
            "submitted_url": "https://cloud.seatable.cn/dtable/workflows/8dc6b0f3-82a1-45d5-946a-211493bef819/submitted-tasks/181/",
            "created_at": "2022-03-23T18:27:16+08:00",
            "task_state": "finished",
            "finished_at": "2022-03-24T10:12:17+08:00",
            "initiator_name": "admin",
            "submitted_values": [
                {
                    "column_key": "0000",
                    "column_name": "Alex",
                    "column_type": "text",
                    "column_data": null,
                    "value": "234"
                }
            ],
            "state": {
                "color": "#F4667C",
                "name": "Finished",
                "textColor": "#FFFFFF"
            },
            "initiator_avatar_url": "https://cloud.seatable.cn/media/avatars/1/e/1081af45ce7fbff294138b6179ebb3/resized/80/e871e2254de343fc77f4fa6e600be454.png"
        }
    ],
    "count": 1
}

Errors

400: Bad Request
403: Permission denied
404: Base not found / Workflow not found
500: Internal Server Error

Workflow task logs

List logs of a workflow task

GET /api/v2.1/workflows/:token/tasks/:task_id/logs/

Request parameters

task_id: required, int
token: required, string

Sample request

curl -L -X GET 'https://cloud.seatable.cn/api/v2.1/workflows/8dc6b0f3-82a1-45d5-946a-211493bef819/task/180/logs/?page=1' \
-H 'Authorization: Token 5c333d6f00fcb280b25703caba6c47b45d8a8d62' \
-H 'Cookie: dtable_csrftoken=F2TF8caiukNTCPEkssuqs2fOpuESsozCWm6zeHWxrGaEto5aZIDxoQWv1fymLuxK'

Sample response

{
    "task_log_list": [
        {
            "id": 63,
            "task_id": 181,
            "operator": "d984c4d1b72a47b3b3a350a01e0d4026@auth.local",
            "log_type": "transfer",
            "node_id": "722540",
            "next_node_id": "1",
            "created_at": "2022-03-24T10:12:17+08:00",
            "start_at": "2022-03-24T10:12:13.710901",
            "duration": 3,
            "node": ...,
            "operator_name": "admin",
            "operator_avatar_url": "http://127.0.0.1:8000/media/avatars/1/e/1081af45ce7fbff294138b6179ebb3/resized/80/e871e2254de343fc77f4fa6e600be454.png"
        },
        {
            "id": 62,
            "task_id": 181,
            "operator": "d984c4d1b72a47b3b3a350a01e0d4026@auth.local",
            "log_type": "transfer",
            "node_id": "965936",
            "next_node_id": "722540",
            "created_at": "2022-03-24T10:12:13+08:00",
            "start_at": "2022-03-23T18:27:16.779329",
            "duration": 56696,
            "node": ...,
            "operator_name": "admin",
            "operator_avatar_url": "http://127.0.0.1:8000/media/avatars/1/e/1081af45ce7fbff294138b6179ebb3/resized/80/e871e2254de343fc77f4fa6e600be454.png"
        },
        {
            "id": 61,
            "task_id": 181,
            "operator": "d984c4d1b72a47b3b3a350a01e0d4026@auth.local",
            "log_type": "init",
            "node_id": "init",
            "next_node_id": "965936",
            "created_at": "2022-03-23T18:27:16+08:00",
            "start_at": "2022-03-23T18:27:16.778894",
            "duration": 0,
            "node": ...,
            "operator_name": "admin",
            "operator_avatar_url": "http://127.0.0.1:8000/media/avatars/1/e/1081af45ce7fbff294138b6179ebb3/resized/80/e871e2254de343fc77f4fa6e600be454.png"
        }
    ],
    "finished_at": "2022-03-24T10:12:17+08:00",
    "is_finished": true,
    "count": 3
}

Errors

400: Bad Request
403: Permission denied
404: Base not found / Workflow not found / Task not found
500: Internal Server Error

Workflow task participants

List current participants of a task

GET /api/v2.1/workflows/:token/tasks/:task_id/participants/

Request parameters

task_id: required, int
token: required, string

Sample request

curl -L -X GET 'https://cloud.seatable.cn/api/v2.1/workflows/8dc6b0f3-82a1-45d5-946a-211493bef819/tasks/272/participants/' \
-H 'Authorization: Token 5c333d6f00fcb280b25703caba6c47b45d8a8d62' \
-H 'Cookie: dtable_csrftoken=F2TF8caiukNTCPEkssuqs2fOpuESsozCWm6zeHWxrGaEto5aZIDxoQWv1fymLuxK'

Sample response

{
    "participants": [
        {
            "name": "org-1-admin-1",
            "avatar_url": "https://cloud.seatable.cn/media/avatars/0/c/ce5513fc721b73a379eb62dcf95af9/resized/80/d6caff87fc8f5533484a0013aeeacfde.png",
            "email": "4e8fc2cc775b4244b220c19f8b6dabd9@auth.local"
        },
        {
            "name": "admin",
            "avatar_url": "https://cloud.seatable.cn/media/avatars/1/e/1081af45ce7fbff294138b6179ebb3/resized/80/e871e2254de343fc77f4fa6e600be454.png",
            "email": "d984c4d1b72a47b3b3a350a01e0d4026@auth.local"
        }
    ]
}

Errors

400: Bad Request
403: Permission denied
404: Base not found / Workflow not found
500: Internal Server Error

Update current participants of a task

PUT /api/v2.1/workflows/:token/tasks/:task_id/participants/

Request parameters

participants: a list of participants, comma seperated, string, required
task_id: required, int
token: required, string

Sample request

curl -L -X PUT 'https://cloud.seatable.cn/api/v2.1/workflows/8dc6b0f3-82a1-45d5-946a-211493bef819/tasks/272/participants/' \
-H 'Authorization: Token 5c333d6f00fcb280b25703caba6c47b45d8a8d62' \
-H 'Cookie: dtable_csrftoken=F2TF8caiukNTCPEkssuqs2fOpuESsozCWm6zeHWxrGaEto5aZIDxoQWv1fymLuxK' \
-F 'participants="d984c4d1b72a47b3b3a350a01e0d4026@auth.local,4e8fc2cc775b4244b220c19f8b6dabd9@auth.local"'

Sample response

{
    "participants": [
        {
            "name": "org-1-admin-1",
            "avatar_url": "https://cloud.seatable.cn/media/avatars/0/c/ce5513fc721b73a379eb62dcf95af9/resized/80/d6caff87fc8f5533484a0013aeeacfde.png",
            "email": "4e8fc2cc775b4244b220c19f8b6dabd9@auth.local"
        },
        {
            "name": "admin",
            "avatar_url": "https://cloud.seatable.cn/media/avatars/1/e/1081af45ce7fbff294138b6179ebb3/resized/80/e871e2254de343fc77f4fa6e600be454.png",
            "email": "d984c4d1b72a47b3b3a350a01e0d4026@auth.local"
        }
    ]
}

Errors

400: Bad Request
403: Permission denied
404: Base not found / Workflow not found
500: Internal Server Error

Last modified by seatable, 2023-05-18

Workflows

Workflow

List workflows of a base

Create a workflow

Get a workflow

Update a workflow

Delete a workflow

Get a upload link by a workflow

Workflow share

List shared workflows

Share a workflow

Get shares of a workflow

Delete a share of a workflow

Workflow task

Submit a workflow task

Transfer a workflow task

List ongoing workflow tasks

List submitted workflow tasks

Cancel a task

Get a task by row id

Delete a task by row id

Delete tasks by several row ids

Get an admin view of a specific task

Get a participant view of a specific task

Get a initiator view of a specific task

List tasks of a specific workflow

Workflow task logs

List logs of a workflow task

Workflow task participants

List current participants of a task

Update current participants of a task