审批流接口

class dingtalk.client.api.Bpms(client=None)

dingtalk_oapi_process_gettodonum(userid)

获取待我审批数量 获取用户待审批数量

参数:userid – 用户id

process_copy(agent_id, process_code, biz_category_id=None, process_name=None, description=None)

复制审批流

参数:

• agent_id – 企业微应用标识
• process_code – 审批流的唯一码
• biz_category_id – 业务分类标识
• process_name – 审批流名称
• description – 审批流描述

返回:

process_instance_terminate(process_instance_id, remark='', is_system=True, operating_userid='')

调用本接口通过实例id终止当前企业下发起的审批实例。 终止审批实例后，审批状态为“已撤销”。 :param process_instance_id: 审批实例ID :param remark: 终止说明 :param is_system: 是否通过系统操作：true：由系统直接终止false：由指定的操作者终止 :param operating_userid: 操作人的userid, 当is_system为false时，该参数必传 :return:

process_listbyuserid(userid, offset=0, size=100)

根据用户id获取可见审批模板列表

参数:

• userid – 用户id
• offset – 分页游标，从0开始。根据返回结果中next_cursor是否为空判断是否有下一页，且再次调用offset设置成next_cursor的值
• size – 分页大小，最大可设置成100

返回:

process_sync(agent_id, src_process_code, target_process_code, biz_category_id=None, process_name=None)

更新审批流

参数:

• agent_id – 企业微应用标识
• src_process_code – 源审批流的唯一码
• target_process_code – 目标审批流的唯一码
• biz_category_id – 业务分类标识
• process_name – 审批流名称

返回:

processinstance_create(process_code, originator_user_id, dept_id, approvers=None, form_component_values=None, agent_id=None, cc_list=(), cc_start=False, cc_finish=False, approvers_v2=None)

发起审批实例

参数:

• process_code – 审批流的唯一码
• originator_user_id – 审批实例发起人的userid
• dept_id – 发起人所在的部门
• approvers – 审批人userid列表
• form_component_values – 审批流表单参数 name: 表单每一栏的名称 value: 表单每一栏的值, ext_value: 扩展值 例：OrderedDict({name1: value1, name2: (value2, ext_value2), name3: (value3, )})
• agent_id –
• cc_list – 抄送人userid列表
• cc_start – 开始时抄送
• cc_finish – 结束时抄送
• approvers_v2 – 审批人列表，支持会签/或签，优先级高于approvers变量

返回:

processinstance_get(process_instance_id)

获取单个审批实例详情

参数:process_instance_id – 审批实例id 返回:

processinstance_list(process_code, start_time, end_time=None, cursor=0, size=10, userid_list=())

获取审批实例列表

参数:

• process_code – 流程模板唯一标识，可在oa后台编辑审批表单部分查询
• start_time – 审批实例开始时间
• end_time – 审批实例结束时间，默认取当前值
• cursor – 每页大小，最多传10
• size – 分页查询的游标，最开始传0，后续传返回参数中的next_cursor值
• userid_list – 发起人用户id列表

返回:

processinstance_listids(process_code, start_time, end_time, size='10', cursor='0', userid_list=())

分页获取审批实例id列表 企业可以根据审批流的唯一标识，分页获取该审批流对应的审批实例id。只能取到权限范围内的相关部门的审批实例

参数:

• process_code – 流程模板唯一标识，可在oa后台编辑审批表单部分查询
• start_time – 审批实例开始时间，毫秒级
• end_time – 审批实例结束时间，毫秒级，默认取当前值
• size – 分页参数，每页大小，最多传10
• cursor – 分页查询的游标，最开始传0，后续传返回参数中的next_cursor值
• userid_list – 发起人用户id列表