complete_task_by_id

async AsyncWorkFlow.complete_task_by_id(task_id, comment=None, file_path=None, outcome=None, extra_res_params=None, attachments=None)

完成任务实例

参数
  • task_id (str) – 任务实例id

  • comment (Optional[str]) – 备注

  • file_path (Optional[str]) – 附件路径(工作流版本在V3.0.4.0后弃用,后续版本请使用attachments参数)

  • outcome (Optional[str]) – 结果选项,在任务可选结果不唯一时,必须提供

  • extra_res_params (Optional[Dict[str, Any]]) – 完成参数

  • attachments (Optional[List[Union[Dict[str, str], FileUplodRes]]]) – 附件信息列表, 内容一般来自文件管理的/files/upload或/files/upload/content响应值

返回

成功 False: 失败

返回类型

True

示例

from deepfos.api.platform import PlatformAPI
from deepfos.element.workflow import WorkFlow

# 上传附件't.txt'
upload_resp = PlatformAPI().file.upload(
    file_type='DL', file_name='t.txt', file='some text'
)

# 以动作approve,参数{"a": 1, "b": "42"}完成任务实例,
# 并提供附件信息为上传的't.txt'文件,备注为"Completed by SDK"
test_task = WorkFlow('test_task')
test_task.complete_task_by_id(
    task_id='fd94f6a7-3467-47f9-8a3c-ff626e68dcf5',
    outcome='approve',
    extra_res_params={'a': 1, 'b': '42'},
    comment='Completed by SDK',
    attachments=[upload_resp]
)