文档目录

cloudpivot-openwebapi 依赖包详情：

引入依赖包

在使用端package.json中引入依赖包“cloudpivot-openwebapi”，并重新安装依赖

使用接口

引入接口方法集合、接口入参集合

在需要使用接口的文件中引入接口方法集合和对应的接口入参集合，集合名称如下：

接口方法集合：

listApi——应用/模型相关接口方法集合
bizObjectApi——业务数据（业务表单、流程）相关接口方法集合
organizationApi——组织/人员相关接口方法集合
permissionApi——权限相关接口方法集合（暂无接口）

接口入参集合：

Application——应用/模型相关接口入参集合
BizObject——业务数据（业务表单、流程）相关接口入参集合
Organization——组织/人员相关接口入参集合

查询可用接口

查询入参可选属性

使用被调用的接口方法对应的入参类型声明入参变量params，即可通过输入的字符查询可选的参数字段名。

示例：

import { Component, Vue, Provide } from 'vue-property-decorator';
import { bizObjectApi, BizObject } from 'cloudpivot-openwebapi';
@Component({
  name: 'ApplicationList',
  components: {},
})
export default class ApplicationList extends Vue {
  created() {
  	created() {
      const params: BizObject.BizObjectList = {
        // 入参定义
      }
      bizObjectApi.getBizObjectList(params);
    }
  }
}

Open Web API 依赖包说明

依赖包：cloudpivot-openwebapi（6.13版本新增）

依赖包结构

接口url管理文件——api-mappings.ts
应用/模型相关接口调用文件——application-api.ts
业务数据（业务表单、流程）相关接口调用文件——biz-object-api.ts
组织/人员相关接口调用文件——organization-api.ts
权限相关接口调用文件——permission-api.ts

接口功能

接口入参说明

应用/模型相关接口集合——listApi

查询应用列表接口调用方法——getApplicationList()

接口url：/api/v2/app/list
调用方式：POST

export interface ApplicationList {
  filterNoWorkflow: boolean;	// 过滤没有流程的应用
  isMobile: boolean; // 是否移动端
}

查询应用下模型列表接口调用方法——getModelList()

接口url：/api/v2/app/function/list
调用方式：POST

export interface ModelList {
  appCode: string; // 应用编码
  isMobile: boolean; // 是否移动端
}

业务数据（业务表单、流程）相关接口集合——bizObjectApi

视图

获取模型视图信息接口调用方法——getModelViewInfo()

接口url：/api/v2/query/header/list
调用方式：POST

export interface ModelViewInfo {
  currentAppCode: string;	// 应用编码
  schemaCode: string; // 模型编码
}

业务表单

获取视图列表业务/流程表单数据集接口调用方法——getBizObjectList()

接口url：/api/v2/bizobject/list
调用方式：POST

export interface BizObjectList {
  allObjectId?: Array<any>;	// 默认导出时传入的当前页的所有业务id
  bizObjectId?: string;	// 主表数据id
  childPageEnable?: boolean;	// 是否需要子表分页
  childSchemaCode?: string;	// 需要查询的子表模型编码
  columns?: Array<ColumnsItem>;	// 选择导出展示数据项
  condition?: string;	// 下拉框属性
  customized?: boolean;	// 是否是二次开发定制的方法
  customizedQuery?: boolean;	// (已废弃)是否自定义查询，自定义查询的话，会根据传入属性值查询
  display?: boolean;	// 是否是查詢关联表单显示字段内容	
  exportFieldsJson?: string;	// 导出字段JSON
  filters?: Array<FilterItem>;	// 查询对象
  filtersMap?: Array<any>;	// 查询对象Map接收参数
  filtersNewCondition?: Array<FilterItem>;	// 查询对象Map接收参数
  formCode?: string;	// 反向关联的表单编码
  groupByFields?: Array<any>;	// 分组字段
  isSheet?: boolean;	// 是否视图批量操作
  isUpdateExportFields?: boolean;	// 是否修改导出字段
  languageType?: string;	// 语言类别
  mobile?: boolean;	// 是否移动端
  objectIds?: Array<any>;	// 选择导出的数据的id,列表
  options?: FormOptions;	// 列表配置项
  orderByFields?: Array<any>;	// 排序字段
  orderType?: number;	// 排序类型
  ownerDeptId?: string;	// 拥有者部门id
  ownerId?: string;	// 拥有者id
  page?: number;	// 当前页
  queryCode?: string;	// 查询列表编码
  queryCondition?: any;	// 查询条件
  queryVersion?: number;	// 查询条件版本号
  reverseCode?: string;	// 反向关联控件编码
  reverseSchemaCode?: string;	// 反向关联的模型编码
  reverseSchemaParam?: ReverseSchemaParam;	// 关联表单展示字段视图配置查询参数
  reverseViewFlag?: boolean;	// 是否使用关联表单展示字段视图配置
  schemaCode?: string;	// 需要查询的数据模型编码
  sheet?: boolean;
  showParticipant?: boolean;	// 流程表单是否导出当前处理人
  showTotal?: boolean;	// 显示总条数
  size?: number;	// 数量
  tempAuthObjectId?: string;	// （临时授权）跳转前源表单的业务对象id
  tempAuthPropertyCode?: string;	// （临时授权）跳转前源表单 关联表单 数据项的编码
  tempAuthSheetId?: string;	// （临时授权）跳转前源表单的表单id
  userCommonQueryId?: string;	// 用户公用数据id-导出字段记录id
  view?: FormView;	// 模型参数（支持树形结构）
}

export interface ColumnsItem {
  childColumns?: Array<ColumnsItem>;	// 选择导出子表展示数据项
  clientType?: string;	// 客户端类型,可用值:APP,OTHER,PC
  createdBy?: string;	// 创建人id
  createdTime?: string;	// 创建时间
  deleted?: boolean;	// 逻辑删除标识，启用状态为false， 禁用状态为true
  displayFields?: Array<any>;	// 数据项类型为关联表单时，展示其他模型数据项
  displayFormat?: number;	// 显示格式
  id?: string;	// id标识
  isDefaultProperty?: boolean;	// 是否系统数据项
  modifiedBy?: string;	// 修改人id
  modifiedTime?: string;	// 最近更新时间
  name?: string;	// 字段名称
  name_i18n?: string;	// 双语名称
  options?: string;	// 数据项值
  propertyAlias?: string;	// 展示字段编码别名
  propertyCode?: string;	// 字段编码
  propertyType?: string;	// 数据项目类型,可用值:0,1,10,11,12,13,14,15,2,20,3,4,5,50,51,6,60,61,7,8,9
  queryId?: string;	// 列表ID
  queryLevel?: number;	// 查询批次 1-主表 2-子表
  relativeSchemaCode?: string;	// 关联的模型编码
  remarks?: string;	// 备注
  schemaAlias?: string;	// 模型编码别名
  schemaCode?: string;	// 模型编码
  sortKey?: number;	// 排序号
  sumType?: string;	// 数值类型有效 求和 平均值 最大值 计数,可用值:0,1,2,3,4,5
  syncDefaultFormat?: boolean;	// 是否同步默认格式
  unit?: number;	// 单位0:px,1:%
  visible?: boolean;	// 是否显示
  width?: string;	// 宽度px,%
}

export interface FilterItem {
  op?: string;	// 匹配类型,可用值:Between,Eq,Gt,Gte,In,IsNotNull,IsNull,Like,Lt,Lte,NotBetween,NotEq,NotIn,NotLike
  operatorType?: string;	// 关联查询配置查询条件类型,可用值:1,10,11,12,13,14,15,16,17,18,2,3,4,5,6,7,8,9
  propertyCode?: string;	// 条件编码
  propertyType?: string;	// 条件类型,可用值:0,1,10,11,12,13,14,15,2,20,3,4,5,50,51,6,60,61,7,8,9
  propertyValue?: string;	// 查询条件值,多值情况以分号隔开
  queryFilterType?: string;	// 匹配类型,可用值:Between,Eq,Gt,Gte,In,IsNotNull,IsNull,Like,Lt,Lte,NotBetween,NotEq,NotIn,NotLike,NotOf,Of
}

export interface FormOptions {
	customDisplayColumns?: Array<any>; // 自定义显示的字段（数据项编码）	
  queryDisplayType?: string;	// 查询列表显示类型。\nDEFAULT 默认展示查询列表配置的显示字段；\nOVERRIDE 覆盖展示查询列表配置的显示字段；\nAPPEND 在查询列表配置的显示字段的基础上新增显示字段。,可用值:0,1,2
}

export interface ReverseSchemaParam {
  reverseQueryCode?: string;	// 反向关联表单queryCode
  reverseRelevanceFormCode?: string;	// 反向关联表单编码
  reverseSchemaCode?: string;	// 反向关联表单模型编码
  reverseSheetCode?: string;	// 反向关联表单列表编码
}

export interface FormView {
	depth?: number;	// 深度（默认1）,示例值(1)
  displayField?: string;	// 展示路径所用字段（若不指定使用关联单选的显示字段）
  parentRef?: string;	// 父节点（为#时查根节点）
  showPath?: boolean;	// 展示路径（默认不返回）
  type?: string;	// 视图类型：list/tree (默认list),可用值:LIST,TREE,示例值(list)
}

获取单个表单数据接口调用方法——getBizObjectDetail()

接口url：/api/v2/bizobject/load
调用方式：POST

export interface BizObjectDetail {
  childPageEnable?: boolean; // 是否子表分页
  from?: string;	// 标识打开的页面位置
  objectId?: string; // 业务数据ID
  perms?: BizObjectPerms; // 标识查看编辑权限
  relevanceInfo?: string; // 需要自动加载的关联信息
  schemaCode?: string; // 数据模型编码
  sheetCode?: string; // 表单编码
  simulative?: boolean; // 是否模拟
  ssc?: string; // 表单短码——sheetShortCode
  startWorkflowCode?: string; // 发起流程编码
  temAuthObjectId?: string; // （临时授权）跳转前源表单的业务对象id
  tempAuthPropertyCode?: string; // （临时授权）跳转前源表单 关联表单 数据项的编码
  tempAuthSheetId?: string; // （临时授权）跳转前源表单的表单id
  workflowInstanceId?: string; // 流程实例ID
  workitemId?: string; // 当前任务ID
}

export enum BizObjectPerms {
  /**
   * 编辑
   */
  Edit = 'edit',
  /**
   * 查看
   */
  Check = 'check',
}

触发自定义业务规则接口调用方法——invokeBusinessRule()

接口url：/api/v2/businessRule/invoke
调用方式：POST

export interface InvokeBusinessRule {
  appCode?: string;	// 应用编码
  businessRuleCode?: string;	// 业务规则编码
  data?: any;	// 业务规则参数
  schemaCode?: string;	// 模型编码
}

提交表单——submitBizObject()

接口url：/api/v2/bizobject/submit
调用方式：POST

export interface SubmitBizObjectParams {
  bizObject?: BizObject;	// 运行时业务数据对象
  depatmentId?: string;	// 用户选择部门id
  owner?: string;	// 拥有者
  replayToken?: string;	// 重放验证码
}

export interface BizObject {
  childPageInfo?: any;
  createdTime?: string;	// 创建时间
  data?: any;	// 业务数据对象，数据格式与对应的业务模型一致
  extendInfo?: ExtendInfo; // 业务数据对象扩展信息
  id?: string;	// 业务对象ID
  loadedFromDb?: boolean;	// 是否是从数据库加载的对象
  modifiedTime?: string;	// 修改时间
  name?: string;	// 名称
  ownerDeptQueryCode?: string;	// 部门查询编码
  ownerId?: string;	// 拥有者
  participants?: string;
  schemaCode?: string;	// 业务模型编码
  sequenceNo?: string;	// 单据号
  sequenceStatus?: string;	// 单据状态
  sheetCode?: string;
  status?: string;	// 业务数据对象状态,可用值:UPDATE},{NEW
  workflowInstanceId?: string;	// 流程实例ID
}

export interface ExtendInfo {
  creatorId?: string;
  sourceBizObjectId?: string;
  sourceBizObjectName?: string;
  sourceSchemaCode?: string;
  sourceSchemaName?: string;
}

保存/暂存表单接口调用方法——saveBizObject()

接口url：/api/v2/bizobject/save
调用方式：POST

export interface SaveBizObjectParams {
  approval?: Approval;	// 审批意见
  bizObject?: BizObject;	// 业务数据对象
  latestSign?: Resource;	// 最近的签名信息
  queryId?: string; // 视图queryId
  replayToken?: string;	// 重放验证码
  saveBizObject?: boolean; // 是否保存BizObject
  workItemId?: string; // 任务id
  workflowCode?: string; // 流程编码
  workflowInstanceId?: string; // 流程实例ID
}

export interface Approval {
  actionType?: string;	// 审批对应操作类型. 1 审批 2 协办 3 加签 4 转办 5 作废 6 结束流程 7: 系统自动添加. 其中2, 3不需要审批结果,可用值:1,10,11,12,2,3,4,5,6,7,8,9	
  activityCode?: string;	// 节点编码
  activityName?: string;	// 节点名称
  bizObjectId?: string;	// 业务对象id
  bizPropertyCode?: string;	// 数据项编码
  commentTime?: string;	// 审批时间
  commonSet?: boolean;	// 是否设置为常用意见
  content?: string;	// 审批意见内容
  createdBy?: string;	// 创建人id
  createdTime?: string;	// 创建时间
  creater?: any;	// 创建人
  deleted?: boolean;	// 逻辑删除标识，启用状态为false， 禁用状态为true
  id?: string;	// id标识
  lastAttachment?: Resource;	// 上一次签名信息
  modifiedBy?: string;	// 修改人id
  modifiedTime?: string;	// 最近更新时间
  relUsers?: Array<any>;	// 协办、加签关联用户. 格式同选人控件的存储值: [{id: "xxx", type: 3}]
  remarks?: string;	// 备注
  resources?: Array<Resource>;	// 关联的附件资源
  result?: string;	// 审批结果. 1: 同意, 2: 不同意, 3: 转办, 0或null: 空(无意义的值)',,可用值:1,2,3,4
  schemaCode?: string;	// 数据模型编码
  tokenId?: number;	// TokenNumber
  workItemId?: string;	// 任务id
  workflowInstanceId?: string;	// 流程实例id
  workflowTokenId?: string;	// 任务的TokenId
}

export interface BizObject {
  childPageInfo?: any;
  createdTime?: string;	// 创建时间
  data?: any;	// 业务数据对象，数据格式与对应的业务模型一致
  extendInfo?: ExtendInfo; // 业务数据对象扩展信息
  id?: string;	// 业务对象ID
  loadedFromDb?: boolean;	// 是否是从数据库加载的对象
  modifiedTime?: string;	// 修改时间
  name?: string;	// 名称
  ownerDeptQueryCode?: string;	// 部门查询编码
  ownerId?: string;	// 拥有者
  participants?: string;
  schemaCode?: string;	// 业务模型编码
  sequenceNo?: string;	// 单据号
  sequenceStatus?: string;	// 单据状态
  sheetCode?: string;
  status?: string;	// 业务数据对象状态,可用值:UPDATE},{NEW
  workflowInstanceId?: string;	// 流程实例ID
}

export interface Resource {
  base64ImageStr?: string;	// base64图片改造
  createdBy?: string;	// 	创建人id
  createdTime?: string;	// 创建时间
  deleted?: boolean;	// 逻辑删除标识，启用状态为false， 禁用状态为true
  fileExtension?: string;	// 资源文件扩展名
  fileSize?: number;	// 资源大小
  id?: string;	// 资源id
  mimeType?: string;	// 资源mime type
  modifiedBy?: string;	// 修改人id
  modifiedTime?: string;	// 最近更新时间
  name?: string;	// 资源名称
  refId?: string;	// 资源关联id
  remarks?: string;	// 备注
  schemaCode?: string;	// 模型编码
}

export interface ExtendInfo {
  creatorId?: string;
  sourceBizObjectId?: string;
  sourceBizObjectName?: string;
  sourceSchemaCode?: string;
  sourceSchemaName?: string;
}

删除表单数据接口调用方法——deleteBizObject()

接口url：/api/v2/bizobject/delete
调用方式：POST

export interface DeleteBizObjectParams {
  objectId?: string;	// 业务数据ID
  schemaCode?: string;	// 数据模型编码
}

流程表单

审批流程接口调用方法——submitWorkflow()

接口url：/api/v2/workItem/submit
调用方式：POST

export interface SubmitWorkflowParams {
  actionCode?: string;	// 操作按钮编码，提交submit，同意agree，不同意disAgree
  agree?: boolean;	// 是否同意, true:同意。false:不同意	
  approval?: Approval;	// 审批意见
  bizObject?: BizObject;	// 运行时业务数据对象
  depatmentId?: string;	// 用户选择部门id
  isSimulative?: boolean;	// 是否模拟
  latestSign?: Resource;	// 最近的签名信息
  owner?: string;	// 拥有者
  participantInfos?: Array<ParticipantInfo>;	// 下节点参与人信息
  replayToken?: string;	// 重放验证码
  runMode?: string;	// 运行模式，0：自动；1：手动,可用值:AUTO,MANUAL
  trustor?: string;	// 委托人id
  workItemId?: string;	// 任务id
  workflowCode?: string;	// 流程编码
  workflowInstanceId?: string;	// 流程实列id
}

export interface Approval {
  actionType?: string;	// 审批对应操作类型. 1 审批 2 协办 3 加签 4 转办 5 作废 6 结束流程 7: 系统自动添加. 其中2, 3不需要审批结果,可用值:1,10,11,12,2,3,4,5,6,7,8,9	
  activityCode?: string;	// 节点编码
  activityName?: string;	// 节点名称
  bizObjectId?: string;	// 业务对象id
  bizPropertyCode?: string;	// 数据项编码
  commentTime?: string;	// 审批时间
  commonSet?: boolean;	// 是否设置为常用意见
  content?: string;	// 审批意见内容
  createdBy?: string;	// 创建人id
  createdTime?: string;	// 创建时间
  creater?: any;	// 创建人
  deleted?: boolean;	// 逻辑删除标识，启用状态为false， 禁用状态为true
  id?: string;	// id标识
  lastAttachment?: Resource;	// 上一次签名信息
  modifiedBy?: string;	// 修改人id
  modifiedTime?: string;	// 最近更新时间
  relUsers?: Array<any>;	// 协办、加签关联用户. 格式同选人控件的存储值: [{id: "xxx", type: 3}]
  remarks?: string;	// 备注
  resources?: Array<Resource>;	// 关联的附件资源
  result?: string;	// 审批结果. 1: 同意, 2: 不同意, 3: 转办, 0或null: 空(无意义的值)',,可用值:1,2,3,4
  schemaCode?: string;	// 数据模型编码
  tokenId?: number;	// TokenNumber
  workItemId?: string;	// 任务id
  workflowInstanceId?: string;	// 流程实例id
  workflowTokenId?: string;	// 任务的TokenId
}

export interface Resource {
  base64ImageStr?: string;	// base64图片改造
  createdBy?: string;	// 	创建人id
  createdTime?: string;	// 创建时间
  deleted?: boolean;	// 逻辑删除标识，启用状态为false， 禁用状态为true
  fileExtension?: string;	// 资源文件扩展名
  fileSize?: number;	// 资源大小
  id?: string;	// 资源id
  mimeType?: string;	// 资源mime type
  modifiedBy?: string;	// 修改人id
  modifiedTime?: string;	// 最近更新时间
  name?: string;	// 资源名称
  refId?: string;	// 资源关联id
  remarks?: string;	// 备注
  schemaCode?: string;	// 模型编码
}

export interface BizObject {
  childPageInfo?: any;
  createdTime?: string;	// 创建时间
  data?: any;	// 业务数据对象，数据格式与对应的业务模型一致
  extendInfo?: ExtendInfo; // 业务数据对象扩展信息
  id?: string;	// 业务对象ID
  loadedFromDb?: boolean;	// 是否是从数据库加载的对象
  modifiedTime?: string;	// 修改时间
  name?: string;	// 名称
  ownerDeptQueryCode?: string;	// 部门查询编码
  ownerId?: string;	// 拥有者
  participants?: string;
  schemaCode?: string;	// 业务模型编码
  sequenceNo?: string;	// 单据号
  sequenceStatus?: string;	// 单据状态
  sheetCode?: string;
  status?: string;	// 业务数据对象状态,可用值:UPDATE},{NEW
  workflowInstanceId?: string;	// 流程实例ID
}

export interface ExtendInfo {
  creatorId?: string;
  sourceBizObjectId?: string;
  sourceBizObjectName?: string;
  sourceSchemaCode?: string;
  sourceSchemaName?: string;
}

export interface ParticipantInfo {
  activityCode?: string;	// 节点编码
  activityName?: string;	// 节点名
  participantList?: Array<any>;	// 手动指定的参与者
  participantType?: string;	// 参与者类型,可用值:MULTI_PARTICIPANT,SINGLE_PARTICIPANT
  participants?: Array<Participant>;	// 参与者列表
}

export interface Participant {
  departmentId?: string;
  departmentName?: string;
  id?: string;
  name?: string;
}

发起流程接口调用方法——startWorkflow()

接口url：/api/v2/workflow/start
调用方式：POST

export interface StartWorkflowParams {
  actionCode?: string;	// 操作按钮编码，提交submit，同意agree，不同意disAgree
  agree?: boolean;	// 是否同意, true:同意。false:不同意	
  approval?: Approval;	// 审批意见
  bizObject?: BizObject;	// 运行时业务数据对象
  depatmentId?: string;	// 用户选择部门id
  isSimulative?: boolean;	// 是否模拟
  latestSign?: Resource;	// 最近的签名信息
  owner?: string;	// 拥有者
  participantInfos?: Array<ParticipantInfo>;	// 下节点参与人信息
  replayToken?: string;	// 重放验证码
  runMode?: string;	// 运行模式，0：自动；1：手动,可用值:AUTO,MANUAL
  trustor?: string;	// 委托人id
  workItemId?: string;	// 任务id
  workflowCode?: string;	// 流程编码
  workflowInstanceId?: string;	// 流程实列id
}

export interface Approval {
  actionType?: string;	// 审批对应操作类型. 1 审批 2 协办 3 加签 4 转办 5 作废 6 结束流程 7: 系统自动添加. 其中2, 3不需要审批结果,可用值:1,10,11,12,2,3,4,5,6,7,8,9	
  activityCode?: string;	// 节点编码
  activityName?: string;	// 节点名称
  bizObjectId?: string;	// 业务对象id
  bizPropertyCode?: string;	// 数据项编码
  commentTime?: string;	// 审批时间
  commonSet?: boolean;	// 是否设置为常用意见
  content?: string;	// 审批意见内容
  createdBy?: string;	// 创建人id
  createdTime?: string;	// 创建时间
  creater?: any;	// 创建人
  deleted?: boolean;	// 逻辑删除标识，启用状态为false， 禁用状态为true
  id?: string;	// id标识
  lastAttachment?: Resource;	// 上一次签名信息
  modifiedBy?: string;	// 修改人id
  modifiedTime?: string;	// 最近更新时间
  relUsers?: Array<any>;	// 协办、加签关联用户. 格式同选人控件的存储值: [{id: "xxx", type: 3}]
  remarks?: string;	// 备注
  resources?: Array<Resource>;	// 关联的附件资源
  result?: string;	// 审批结果. 1: 同意, 2: 不同意, 3: 转办, 0或null: 空(无意义的值)',,可用值:1,2,3,4
  schemaCode?: string;	// 数据模型编码
  tokenId?: number;	// TokenNumber
  workItemId?: string;	// 任务id
  workflowInstanceId?: string;	// 流程实例id
  workflowTokenId?: string;	// 任务的TokenId
}

export interface Resource {
  base64ImageStr?: string;	// base64图片改造
  createdBy?: string;	// 	创建人id
  createdTime?: string;	// 创建时间
  deleted?: boolean;	// 逻辑删除标识，启用状态为false， 禁用状态为true
  fileExtension?: string;	// 资源文件扩展名
  fileSize?: number;	// 资源大小
  id?: string;	// 资源id
  mimeType?: string;	// 资源mime type
  modifiedBy?: string;	// 修改人id
  modifiedTime?: string;	// 最近更新时间
  name?: string;	// 资源名称
  refId?: string;	// 资源关联id
  remarks?: string;	// 备注
  schemaCode?: string;	// 模型编码
}

export interface BizObject {
  childPageInfo?: any;
  createdTime?: string;	// 创建时间
  data?: any;	// 业务数据对象，数据格式与对应的业务模型一致
  extendInfo?: ExtendInfo; // 业务数据对象扩展信息
  id?: string;	// 业务对象ID
  loadedFromDb?: boolean;	// 是否是从数据库加载的对象
  modifiedTime?: string;	// 修改时间
  name?: string;	// 名称
  ownerDeptQueryCode?: string;	// 部门查询编码
  ownerId?: string;	// 拥有者
  participants?: string;
  schemaCode?: string;	// 业务模型编码
  sequenceNo?: string;	// 单据号
  sequenceStatus?: string;	// 单据状态
  sheetCode?: string;
  status?: string;	// 业务数据对象状态,可用值:UPDATE},{NEW
  workflowInstanceId?: string;	// 流程实例ID
}

export interface ExtendInfo {
  creatorId?: string;
  sourceBizObjectId?: string;
  sourceBizObjectName?: string;
  sourceSchemaCode?: string;
  sourceSchemaName?: string;
}

export interface ParticipantInfo {
  activityCode?: string;	// 节点编码
  activityName?: string;	// 节点名
  participantList?: Array<any>;	// 手动指定的参与者
  participantType?: string;	// 参与者类型,可用值:MULTI_PARTICIPANT,SINGLE_PARTICIPANT
  participants?: Array<Participant>;	// 参与者列表
}

export interface Participant {
  departmentId?: string;
  departmentName?: string;
  id?: string;
  name?: string;
}

流程中心

获取流程中心流程列表接口调用方法——getWorkflowList()

接口url：/api/v2/workflow/list
调用方式：POST

export interface WorkflowList {
  isMobile: boolean; // 是否是移动端
}

查询我发起的流程列表接口调用方法——queryMyTaskList()

接口url：/api/v2/workflow/instance/list
调用方式：POST

export interface MyTaskList {
  appCode?: string; // 应用编码
	endStatus?: string;	// 结束状态：APPROVAL(正常流转结束) ABORT_END(审批结束) OPERATION(运维结束) TIMEOUT_END(超时结束)
  endTime?: string; // 流程结束时间
  instanceState?: string;	// 流程实例状态
  isMobile?: boolean;	// 移动端请求
  page?: number; // 当前页码
  sequenceNo?: string; // 单据号
  size?: number; // 每页显示数量
  startTime?: string; // 流程开始时间
  workflowCode?: string; // 流程编码
  workflowName?: string; // 流程名称
}

查询我的待办任务列表接口调用方法——queryUnfinishedTaskList()

接口url：/api/v2/workItem/list
调用方式：POST

export interface UnfinishedTaskList {
  activityName?: string;	// 	节点名称
  appCode?: string; // 模型编码
  batchOperate?: boolean;	// 有批量处理权限的任务
  instanceState?: string;	// 流程实例状态,可用值:CANCELED,COMPLETED,DRAFT,EXCEPTION,PROCESSING
  originator?: string; // 发起人名称
  page?: number; // 当前页码
  participant?: string;	// 处理人id
  participantName?: string;	// 处理人
  sequenceNo?: string; // 单据号
  size?: number; // 每页显示数量
  source?: string;	// 环境来源
  state?: string;	// 任务状态,可用值:1,2,3,4,5,6,7
  unitType?: number | undefined; // 组织用户类型,1: 部门， 2：角色，3：用户
  wd?: string; // 关键字。流程名称或发起人名称
  workItemSource?: number;	// 任务来源：1 系统转交 其他所有
  workflowCode?: string; // 流程编码
  workflowName?: string; // 流程名称
}

查询我的已办任务列表接口调用方法——queryFinishedTaskList()

接口url：/api/v2/workItem/finished/list
调用方式：POST

export interface FinishedTaskList {
  activityName?: string;	// 	节点名称
  appCode?: string; // 模型编码
  batchOperate?: boolean;	// 有批量处理权限的任务
  instanceState?: string;	// 流程实例状态,可用值:CANCELED,COMPLETED,DRAFT,EXCEPTION,PROCESSING
  originator?: string; // 发起人名称
  page?: number; // 当前页码
  participant?: string;	// 处理人id
  participantName?: string;	// 处理人
  sequenceNo?: string; // 单据号
  size?: number; // 每页显示数量
  source?: string;	// 环境来源
  state?: string;	// 任务状态,可用值:1,2,3,4,5,6,7
  unitType?: number | undefined; // 组织用户类型,1: 部门， 2：角色，3：用户
  wd?: string; // 关键字。流程名称或发起人名称
  workItemSource?: number;	// 任务来源：1 系统转交 其他所有
  workflowCode?: string; // 流程编码
  workflowName?: string; // 流程名称
}

查询我的待阅任务列表接口调用方法——queryUnreadTaskList()

接口url：/api/v2/workItem/circulated/list
调用方式：POST

export interface UnreadTaskList {
  appCode?: string; // 应用编码
  originator?: string; // 发起人名称
  page?: number; // 当前页码
  sequenceNo?: string; // 单据号
  size?: number; // 每页显示数量
  unitType?: number | undefined; // 组织用户类型,1: 部门， 2：角色，3：用户
  wd?: string; // 关键字。流程名称或发起人名称
  workflowCode?: string; // 流程编码
  workflowName?: string; // 流程名称
}

查询我的已阅任务列表接口调用方法——queryReadTaskList()

接口url：/api/v2/workItem/circulated/finished/list
调用方式：POST

export interface ReadTaskList {
  appCode?: string; // 模型编码
  endTime?: string; // 结束-接收时间
  originator?: string; // 发起人名称
  page?: number; // 当前页码
  sequenceNo?: string; // 单据号
  size?: number; // 每页显示数量
  startTime?: string; // 开始-接收时间
  unitType?: string; // 组织用户类型
  workflowCode?: string; // 流程编码
  workflowName?: string; // 流程名称
}

组织/人员相关接口集合——organizationApi

查询组织树接口调用方法——queryOrganizationTree()

接口url：/api/v2/organization/tree
调用方式：POST

export interface OrganizationTree {
  corpId?: string;	// corpId
  deptIds?: string; // 部门ids
  excludeCorpId?: string; // 要过滤的企业id
  filterType?: QueryFilterType; // 过滤类型
  rootDeptIds?: string; // 表单根部门id
  selected?: string; // 选人控件中选中的用户id集合，逗号隔开，用来过滤其所在部门和兼职部门及其下子部门，和当前查询的应用管理员权限取交集
  sourceType?: QuerySourceType; // 来源类型
}

export enum QueryFilterType {
  Admin = 'admin',
  /**
   * 应用管理员相关
   */
  AdminCorp = 'admin_corp',
  Related = 'related',
  Main = 'main',
  /**
   * 只显示自维护部门
   */
  Self = 'self',
  /**
   * 直接返回deptIds指定的部门
   */
  RootDisplay = 'root_display',
}

export enum QuerySourceType {
  /**
   * admin-后台
   */
  Admin = 'admin',
  /**
   * portal-门户
   */
  Portal = 'portal',
}

根据名称查找部门或人员接口调用方法——queryUsersOrDeptsByName()

接口url：/api/v2/organization/search
调用方式：POST

export interface UsersOrDeptsByName {
  activityCode?: string; // 节点编码
  corpId?: string; // 关联组织编码，用“,”分割
  deptIds?: string; // 部门编码，用“,”分隔
  filterType?: string; // 过滤方式：admin  admin_corp-应用管理员 main-只显示主部门 self-只显示自维护组织；用“,”分隔
  name: string; // 搜索名称
  queryType?: string; // 查询类型
  roleIds?: string; // 角色编码，用“,”分隔
  rootDeptIds?: string; // 表单根部门id
  selectUserIds?: string; // 选人控件中选中的用户id集合，逗号隔开，用来过滤其所在部门和兼职部门及其下子部门，和当前查询的应用管理员权限取交集
  sourceType?: QuerySourceType; // 来源类型
  workflowInstanceId?: string; // 流程实例id
}

export enum QuerySourceType {
  /**
   * admin-后台
   */
  Admin = 'admin',
  /**
   * portal-门户
   */
  Portal = 'portal',
}

根据Id查找部门接口调用方法——queryDeptById()

接口url：/api/v2/organization/department
调用方式：POST

export interface DeptById {
  departmentId?: string;	// departmentId
}

根据Id查找人员调用方法——queryUserById()

接口url：/api/v2/organization/user
调用方式：POST

export interface UserById {
  id?: string;	// 用户 id
}

获取当前用户接口调用方法——getCurrentUser()

接口url：/api/v2/organization/user/current
调用方式：POST
无入参

权限相关接口集合——permissionApi

当前暂未开放权限相关的api

Open Web API 依赖包使用说明

Open Web API 依赖包说明