@gct-paas/api 0.1.6-dev.0 → 0.1.6-dev.10

package/lib/apaas/service/apis/online-form-instance.service.d.ts

@@ -0,0 +1,803 @@
+import type { AxiosRequestConfig } from 'axios';
+import type {
+  OnlineFormInstanceRequest,
+  OnlineFormInstanceResponse,
+  OnlineFormInstanceTmplRelationResponse,
+  OnlineFormInstance,
+  OnlineFormInstanceRelationInfoResponse,
+  FormInstLockResponse,
+  AppendRelatedInstRequest,
+  BindRelatedIndstRequest,
+  OnlineFormInsTaskRequest,
+  FormTaskGetDTO,
+  OnlineFormInsTaskTransmit,
+  SimpleOnlineFormInstanceRequest,
+} from '../entities';
+
+export interface deleteQuery {
+  /**
+   * 删除的id，多个按','分割
+   */
+  ids: string;
+}
+export interface getAppendixFormListQuery {
+  /**
+   * Lot/SN 编号
+   */
+  materialNo: string;
+  /**
+   * 工单ID
+   */
+  mfgOrderId?: string;
+}
+export interface getDataIdsQuery {
+  /**
+   * 物料编号/或批次ID
+   */
+  materialNo: string;
+  /**
+   * 在线表单ID
+   */
+  tmplId: string;
+}
+export interface getDetailQuery {
+  /**
+   * containerId
+   */
+  containerId?: string;
+  /**
+   * id
+   */
+  id: string;
+  /**
+   * routingOperationId
+   */
+  routingOperationId?: string;
+  /**
+   * snId
+   */
+  snId?: string;
+}
+export interface getDhrFormListQuery {
+  /**
+   * Lot/SN 编号
+   */
+  materialNo: string;
+  /**
+   * 工单ID
+   */
+  mfgOrderId?: string;
+  /**
+   * 类型（production/rework)
+   */
+  taskType: string;
+}
+export interface getFindByMaterialNoQuery {
+  /**
+   * 物料号
+   */
+  materialNo: string;
+  /**
+   * mfgOrderId
+   */
+  mfgOrderId?: string;
+}
+export interface getFindByMaterialNoAndDocOutlineIdQuery {
+  /**
+   * docOutlineId
+   */
+  docOutlineId: string;
+  /**
+   * materialNo
+   */
+  materialNo: string;
+}
+export interface getFindByOfTmplIdAndEdhrInstanceIdQuery {
+  /**
+   * edhr实例id
+   */
+  edhrInstanceId: string;
+  /**
+   * 在线表单模板id
+   */
+  ofTmplId: string;
+}
+export interface getFindByTmplIdAndMaterialNoQuery {
+  /**
+   * 物料号
+   */
+  materialNo: string;
+  /**
+   * 在线表单模板id
+   */
+  ofTmplId: string;
+}
+export interface getFindOfTaskBySerialNo4ChangeQuery {
+  /**
+   * 流程号
+   */
+  serialNo: string;
+}
+export interface getFindPage4EdhrInstanceQuery {
+  /**
+   * 业务id
+   */
+  businessId?: string;
+  /**
+   * 描述
+   */
+  description?: string;
+  /**
+   * 文档行id
+   */
+  docOutlineId?: string;
+  /**
+   * edhr实例id
+   */
+  edhrInstanceId: string;
+  /**
+   * 是否忽略作废表单
+   */
+  ignoreAbandon?: boolean;
+  /**
+   * 在线表单模板id
+   */
+  ofTmplId: string;
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 分页大小
+   */
+  pageSize?: number;
+  /**
+   * 排序字段
+   */
+  sortField?: string;
+  /**
+   * 排序方式：ASC/DESC， 不传默认 ASC
+   */
+  sortType?: string;
+}
+export interface getFindRelationInfoByIdQuery {
+  /**
+   * 表单实例id
+   */
+  id: string;
+}
+export interface getFormPageListQuery {
+  /**
+   * 更新结束时间
+   */
+  endModifyTime?: string;
+  /**
+   * 表单类型：BASE 基础表单、PROCESS 流程表单、VIEW视图表单、TEXT文本表单
+   */
+  formType?: string;
+  /**
+   * 单据来源(LOT_SN_APPEND:附录创建表单/FORM:单据任务/PRODUCT_RELEASE)
+   */
+  materialStatus?: string;
+  /**
+   * 在线表单模板名称
+   */
+  ofTmplName?: string;
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 分页大小
+   */
+  pageSize?: number;
+  /**
+   * 流水号
+   */
+  serialNo?: string;
+  /**
+   * 排序字段
+   */
+  sortField?: string;
+  /**
+   * 排序方式：ASC/DESC， 不传默认 ASC
+   */
+  sortType?: string;
+  /**
+   * 更新开始时间
+   */
+  startModifyTime?: string;
+  /**
+   * 标题
+   */
+  title?: string;
+}
+export interface getGetOneQuery {
+  /**
+   * 单据实例类型(单据任务:FORM ,放行单:PRODUCT_RELEASE 批次:LOT)多个值逗号拼接
+   */
+  materialStatus?: string;
+  /**
+   * 记录单号
+   */
+  recordNo?: string;
+  /**
+   * 序列号
+   */
+  serialNo?: string;
+}
+export interface getGetRelatedProductQuery {
+  /**
+   * 在线表单实例id
+   */
+  id: string;
+}
+export interface getHoldLockUserQuery {
+  /**
+   * 表单实例ID
+   */
+  formInstanceId: string;
+}
+export interface postHoldUnlockQuery {
+  /**
+   * 表单实例ID
+   */
+  formInstanceId: string;
+}
+export interface getInfoQuery {
+  /**
+   * id
+   */
+  id: string;
+}
+export interface getInfoByRecordNoQuery {
+  /**
+   * 记录单号
+   */
+  recordNo: string;
+}
+export interface getPageListQuery {
+  /**
+   * 任务完成结束时间
+   */
+  endCompletedTime?: string;
+  /**
+   * 任务创建结束时间
+   */
+  endCreateTime?: string;
+  /**
+   * 状态
+   */
+  instanceStatus?: string;
+  /**
+   * 更新人id
+   */
+  modifyUserId?: string;
+  /**
+   * 在线表单模板名称
+   */
+  ofTmplName?: string;
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 分页大小
+   */
+  pageSize?: number;
+  /**
+   * 排序字段
+   */
+  sortField?: string;
+  /**
+   * 排序方式：ASC/DESC， 不传默认 ASC
+   */
+  sortType?: string;
+  /**
+   * 任务完成开始时间
+   */
+  startCompletedTime?: string;
+  /**
+   * 任务创建开始时间
+   */
+  startCreateTime?: string;
+  /**
+   * 提交人名称
+   */
+  submitterName?: string;
+  /**
+   * 标题
+   */
+  title?: string;
+}
+export interface getQueryQuery {
+  /**
+   * 描述
+   */
+  description?: string;
+  /**
+   * 扩展字段8
+   */
+  ext8?: string;
+  /**
+   * 是否忽略废弃表单
+   */
+  ignoreAbandon?: boolean;
+  /**
+   * materialNo
+   */
+  materialNo: string;
+  /**
+   * 在线表单模板id
+   */
+  ofTmplId?: string;
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 分页大小
+   */
+  pageSize?: number;
+  /**
+   * 排序字段
+   */
+  sortField?: string;
+  /**
+   * 排序方式：ASC/DESC， 不传默认 ASC
+   */
+  sortType?: string;
+}
+export interface postRefreshSnapshotQuery {
+  /**
+   * 表单实例ids
+   */
+  instIds: string;
+}
+export interface getRelateFormPageListQuery {
+  /**
+   * Lot/SN 编号
+   */
+  materialNo: string;
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 每页数据条数
+   */
+  pageSize?: number;
+}
+export interface deleteRelatedInstRemoveQuery {
+  /**
+   * 需要移除的表单实例id
+   */
+  instId: string;
+}
+export interface getReverseTracePageListQuery {
+  /**
+   * 设备名称
+   */
+  deviceId?: string;
+  /**
+   * 日期结束
+   */
+  endTraceDate?: string;
+  /**
+   * lot/sn
+   */
+  materialNo?: string;
+  /**
+   * 工单号
+   */
+  mfgOrderId?: string;
+  /**
+   * 填报人
+   */
+  operatorId?: string;
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 分页大小
+   */
+  pageSize?: number;
+  /**
+   * 物料名称
+   */
+  productId?: string;
+  /**
+   * 物料名称
+   */
+  productIds?: string[];
+  /**
+   * 记录单号
+   */
+  recordNo?: string;
+  /**
+   * 排序字段
+   */
+  sortField?: string;
+  /**
+   * 排序方式：ASC/DESC， 不传默认 ASC
+   */
+  sortType?: string;
+  /**
+   * 日期开始
+   */
+  startTraceDate?: string;
+  /**
+   * 表单模板
+   */
+  tmplId?: string;
+}
+export interface postTaskPageListQuery {
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 每页数据条数
+   */
+  pageSize?: number;
+}
+export interface deleteTaskRemoveOfInstIdPathParams {
+  ofInstId: string;
+}
+export interface getTaskResendOfInstIdPathParams {
+  ofInstId: string;
+}
+export interface putTaskIdPathParams {
+  id: string;
+}
+export interface getTracePageListQuery {
+  /**
+   * 业务类型
+   */
+  businessType?: string;
+  /**
+   * 创建人id
+   */
+  createUserId?: string;
+  /**
+   * 任务创建结束时间-结束
+   */
+  endTaskCompletedTime?: string;
+  /**
+   * 任务创建时间-结束
+   */
+  endTaskCreateTime?: string;
+  /**
+   * 表单类型：BASE 基础表单、PROCESS 流程表单、VIEW视图表单、TEXT文本表单
+   */
+  formType?: string;
+  /**
+   * 表单状态
+   */
+  instanceStatus?: string;
+  /**
+   * 表单记录来源:LOT 批次、SN、PRODUCT_RELEASE 放行单、FORM 单据任务、LOT_SN_APPEND 批次或SN临时追加的，一般作为附录呈现
+   */
+  materialStatus?: string;
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 分页大小
+   */
+  pageSize?: number;
+  /**
+   * 是否关联批次 1 是、0 否
+   */
+  relatedMaterialNo?: number;
+  /**
+   * 关联批次/SN
+   */
+  relatedMaterialNoValue?: string;
+  /**
+   * 在线表单流水号
+   */
+  serialNo?: string;
+  /**
+   * 排序字段
+   */
+  sortField?: string;
+  /**
+   * 排序方式：ASC/DESC， 不传默认 ASC
+   */
+  sortType?: string;
+  /**
+   * 任务创建结束时间-开始
+   */
+  startTaskCompletedTime?: string;
+  /**
+   * 任务创建时间-开始
+   */
+  startTaskCreateTime?: string;
+  /**
+   * 任务标题
+   */
+  title?: string;
+  /**
+   * 表单模板
+   */
+  tmplId?: string;
+}
+export interface OnlineFormInstanceService {
+  /**
+   * 保存表单实例
+   */
+  post(
+    data: OnlineFormInstanceRequest,
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 删除
+   */
+  delete(
+    query: deleteQuery,
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 查询EDHR 关联的 表单列表(DHR附录)
+   */
+  getAppendixFormList(
+    query: getAppendixFormListQuery,
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<OnlineFormInstanceResponse[]>;
+  /**
+   * (EDHR 查询sheet数据Id) 根据在线表单id,业务标志ID(批次)查询填报数据ID 集合
+   */
+  getDataIds(
+    query: getDataIdsQuery,
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string[]>;
+  /**
+   * 根据实例ID获取在线表单实例详情信息
+   */
+  getDetail(
+    query: getDetailQuery,
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<OnlineFormInstanceResponse>;
+  /**
+   * 查询DHR表单实例（包括待填报/附录）
+   */
+  getDhrFormList(
+    query: getDhrFormListQuery,
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<OnlineFormInstanceResponse[]>;
+  /**
+   * 查询Edhr下在线表单实例
+   */
+  getFindByMaterialNo(
+    query: getFindByMaterialNoQuery,
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<OnlineFormInstanceResponse[]>;
+  /**
+   * 查询在线表单实例-根据批次号和edhr目录id
+   */
+  getFindByMaterialNoAndDocOutlineId(
+    query: getFindByMaterialNoAndDocOutlineIdQuery,
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<OnlineFormInstanceResponse[]>;
+  /**
+   * 查询在线表单实例根据表单id和edhr实例id
+   */
+  getFindByOfTmplIdAndEdhrInstanceId(
+    query: getFindByOfTmplIdAndEdhrInstanceIdQuery,
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<OnlineFormInstanceResponse[]>;
+  /**
+   * 查询Edhr下在线表单模板和其关联之实例
+   */
+  getFindByTmplIdAndMaterialNo(
+    query: getFindByTmplIdAndMaterialNoQuery,
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<OnlineFormInstanceTmplRelationResponse>;
+  /**
+   * 查询单据任务表单根据流程号 - 给记录变更使用
+   */
+  getFindOfTaskBySerialNo4Change(
+    query: getFindOfTaskBySerialNo4ChangeQuery,
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<OnlineFormInstance>;
+  /**
+   * 分页查询edhr实例下的表单实例列表
+   */
+  getFindPage4EdhrInstance(
+    query: getFindPage4EdhrInstanceQuery,
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<IPage<OnlineFormInstanceResponse>>;
+  /**
+   * 查询在线表单实例之关联信息
+   */
+  getFindRelationInfoById(
+    query: getFindRelationInfoByIdQuery,
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<OnlineFormInstanceRelationInfoResponse>;
+  /**
+   * 表单放行工作台分页列表
+   */
+  getFormPageList(
+    query: getFormPageListQuery,
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<IPage<OnlineFormInstanceResponse>>;
+  /**
+   * 查询表单实例-附录追加表单使用
+   */
+  getGetOne(
+    query: getGetOneQuery,
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<OnlineFormInstanceResponse>;
+  /**
+   * 获取表单实例上关联的产品信息
+   */
+  getGetRelatedProduct(
+    query: getGetRelatedProductQuery,
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<IObject>;
+  /**
+   * 获取持有表单实例锁的用户
+   */
+  getHoldLockUser(
+    query: getHoldLockUserQuery,
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<FormInstLockResponse>;
+  /**
+   * 表单实例解锁
+   */
+  postHoldUnlock(
+    query: postHoldUnlockQuery,
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<FormInstLockResponse>;
+  /**
+   * 根据实例ID获取在线表单实例详情
+   */
+  getInfo(
+    query: getInfoQuery,
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<OnlineFormInstanceResponse>;
+  /**
+   * 根据记录单号获取在线表单实例详情
+   */
+  getInfoByRecordNo(
+    query: getInfoByRecordNoQuery,
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<OnlineFormInstanceResponse>;
+  /**
+   * eDHR根据实例ID集合获取在线表单实例详情
+   */
+  postInfos(
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<OnlineFormInstanceResponse[]>;
+  /**
+   * 分页列表
+   */
+  getPageList(
+    query: getPageListQuery,
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<IPage<OnlineFormInstanceResponse>>;
+  /**
+   * 分页查询表单实例
+   */
+  getQuery(
+    query: getQueryQuery,
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<IPage<OnlineFormInstanceResponse>>;
+  /**
+   * 刷新表单实例快照
+   */
+  postRefreshSnapshot(
+    query: postRefreshSnapshotQuery,
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 分页查询查询EDHR 填报关联的 表单填报任务列表
+   */
+  getRelateFormPageList(
+    query: getRelateFormPageListQuery,
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<IPage<OnlineFormInstanceResponse>>;
+  /**
+   * 追加关联实例
+   */
+  postRelatedInstAppend(
+    data: AppendRelatedInstRequest,
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 绑定已有实例
+   */
+  postRelatedInstBind(
+    data: BindRelatedIndstRequest,
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 移除关联实例
+   */
+  deleteRelatedInstRemove(
+    query: deleteRelatedInstRemoveQuery,
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 解绑已有实例
+   */
+  postRelatedInstUnbind(
+    data: BindRelatedIndstRequest,
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 反向追溯-分页列表
+   */
+  getReverseTracePageList(
+    query: getReverseTracePageListQuery,
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<IPage<OnlineFormInstanceResponse>>;
+  /**
+   * 创建单据填报任务
+   */
+  postTask(
+    data: OnlineFormInsTaskRequest,
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<OnlineFormInstanceResponse>;
+  /**
+   * 获取我的单据任务
+   */
+  postTaskPageList(
+    query: postTaskPageListQuery,
+    data: FormTaskGetDTO,
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<IPage<OnlineFormInstanceResponse>>;
+  /**
+   * 单据填报任务移除
+   */
+  deleteTaskRemoveOfInstId(
+    path: deleteTaskRemoveOfInstIdPathParams,
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<boolean>;
+  /**
+   * 单据填报任务重新发送
+   */
+  getTaskResendOfInstId(
+    path: getTaskResendOfInstIdPathParams,
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<boolean>;
+  /**
+   * 单据填报任务更新
+   */
+  putTaskUpdate(
+    data: OnlineFormInsTaskRequest,
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<boolean>;
+  /**
+   * 单据填报任务转发
+   */
+  putTaskId(
+    path: putTaskIdPathParams,
+    data: OnlineFormInsTaskTransmit,
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 创建单据填报任务
+   */
+  postTaskForm(
+    data: OnlineFormInsTaskRequest,
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<OnlineFormInstanceResponse>;
+  /**
+   * 正向追溯-分页列表
+   */
+  getTracePageList(
+    query: getTracePageListQuery,
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<IPage<OnlineFormInstanceResponse>>;
+  /**
+   * 修改表单实例描述字段
+   */
+  putUpdateDescription(
+    data: SimpleOnlineFormInstanceRequest,
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<boolean>;
+}