跳到主要内容

@ones-op/node-third-import

要求​

ONES
v3.11.39+

安装​

进入插件工程的/backend目录,执行以下命令进行依赖安装:

npm i @ones-op/node-third-import

API​

startImport​

开始三方数据导入

Params​

参数类型说明必填默认值
userUUIDstring用户 uuid是-
abilityIdstring插件能力配置中的能力 id是-
passwordstring首次登录时导入用户的默认密码(默认密码需要是字母数字组合)是-
serverIdstring如果导入的是同一批数据需要保证有相同的 server_id是-
teamUUIDstring团队唯一标识,仅为组织插件时需要否-

Example​

import { startImport } from '@ones-op/node-third-import'

await startImport(user_uuid, abilityId, password, server_id, teamUUID)

Type​

ThirdNotification​

参数说明类型必填
project_id项目 IDstring是
value_type值类型ThirdNotificationValueTypeEnum是
value值string是
config_type配置类型ThirdNotificationConfigTypeEnum是

ThirdTaskWorkLog​

参数说明类型必填
resource_id资源 IDstring是
task_id工作项 IDstring是
user_id用户 IDstring是
start_time创建时间number是
hours工时number是
type类型ThirdTaskWorkLogTypeEnum是
create_time创建时间number是

ThirdTaskAttachment​

ONES
v3.14.0+

附件导入在本地调试方式已支持,但是要求文件不超过 100MB。

参数说明类型必填
resource_id资源 IDstring是
task_id工作项 IDstring是
full_file_path附件文件地址string是
file_name文件名称string否
参数说明类型必填
resource_id关联类型string是
link_type_id工作项关联类型 IDstring是
source_task_id源工作项 IDstring是
target_task_id目标工作项 IDstring是

ThirdTaskComment​

参数说明类型必填
resource_id资源 IDstring是
task_id工作项 IDstring是
user_id用户 IDstring是
body内容string是
create_time创建时间number是

ThirdGlobalPermission​

参数说明类型必填
resource_id资源 IDstring是
permission权限点ThirdGlobalPermissionEnum是
group_id用户组 IDstring是

ThirdProjectPermission​

参数说明类型必填
resource_id资源 IDstring是
project_id项目 IDstring是
user_domain_type用户域类型ThirdProjectPermissionUserDomainTypeEnum是
context_typeContext 类型ThirdProjectPermissionContextTypeEnum是
permission权限点ThirdProjectPermissionPermissionEnum是
user_domain_param用户域参数string是

ThirdTaskWatcher​

参数说明类型必填
resource_id资源 IDstring是
task_id工作项 IDstring是
user_id用户 IDstring是

ThirdSprint​

参数说明类型必填
resource_id资源 IDstring是
name名称string是
status状态ThirdSprintStatusEnum是
project_id项目 IDstring是
start_time开始时间number是
end_time结束时间number是
assign_id负责人 IDstring是
owner_id所属人 IDstring是

ThirdProjectIssueTypeLayout​

参数说明类型必填
project_id项目 IDstring是
scope_configs视图配置ScopeConfigItem[]是
ScopeConfigItem​
参数说明类型必填
issue_type_id工作项 IDstring是
field_config_id字段配置 IDstring是
screen_scheme_id视图 IDstring是

ThirdProjectIssueTypeWithFields​

参数说明类型必填
project_id项目 IDstring是
issue_type_with_fields属性配置IssueTypeWithFields[]是
IssueTypeWithFields​
参数说明类型必填
issue_type_id工作项 IDstring是
issue_type_detail_typeONES 内置工作项类型ThirdIssueTypeDetailTypeEnum是
fields属性列表Field[]是
Field​
参数说明类型必填
field_identifier字段标识string是
required是否必填boolean是
is_customized是否是自定义属性boolean是

ThirdIssueTypeField​

参数说明类型必填
resource_id资源 IDstring是
issue_type_id工作项 IDstring是
field_id属性 IDstring是

ThirdChangeItem​

参数说明类型必填
resource_id资源 IDstring是
task_id工作项 IDstring是
field_type属性类型string是
field属性ThirdChangeItemFieldEnum是
old_value旧值string是
new_value新值string是
old_string旧字符串string是
new_string新字符串string是
user_id用户 IDstring是
create_time创建时间number是

ThirdIssueTypeLayout​

参数说明类型必填
issue_type_id工作项类型 IDstring是
field_config_id属性配置 IDstring是
field_config_name属性配置名称string是
screen_scheme_id视图 IDstring是
screen_scheme_name视图名称string是
create_issue_config创建工作项视图Field[]是
view_issue_config查看工作项视图Field[]是

ThirdProjectFieldValue​

参数说明类型必填
resource_id资源 IDstring是
project_id项目 IDstring是
project_field_id项目属性 IDstring是
type类型ThirdProjectFieldValueTypeEnum是
value类型值any是

ThirdGlobalProjectFieldOption​

参数说明类型必填
resource_id资源 IDstring是
value属性值string是
desc描述string是
color颜色string是
background_color背景色string是

ThirdGlobalProjectField​

参数说明类型必填
resource_id资源 IDstring是
name名称string是
type属性类型ThirdGlobalProjectFieldTypeEnum是
options属性选项值ThirdGlobalProjectFieldOption[]是

ThirdProject​

参数说明类型必填
resource_id资源 IDstring是
name名称string是
assign_id负责人 IDstring是
create_time创建时间number是
type类型ThirdProjectTypeEnum是
status项目状态ThirdProjectStatusEnum是
status_uuid状态描述ThirdProjectStatusUUIDEnum是
announcement公告string是

ThirdUserGroupMember​

参数说明类型必填
resource_id资源 IDstring是
resource_group_id用户组 IDstring是
resource_user_id用户 IDstring是

ThirdProjectCategory​

参数说明类型必填
resource_id资源 IDstring是
name名称string是

ThirdProjectRoleMember​

参数说明类型必填
resource_id资源 IDstring是
resource_role_id角色 IDstring是
resource_project_id项目 IDstring是
resource_user_id用户 IDstring是

ThirdProjectRole​

参数说明类型必填
resource_id资源 IDstring是
resource_role_id角色 IDstring是
resource_project_id项目 IDstring是
create_time创建时间number是

ThirdGlobalProjectRole​

参数说明类型必填
resource_id资源 IDstring是
name名称string是
create_time创建时间number是
status状态ThirdGlobalProjectRoleStatusEnum是

ThirdProjectIssueType​

参数说明类型必填
resource_id资源 IDstring是
project_id项目 IDstring是
issue_type_id工作项类型 IDstring是

ThirdIssueType​

参数说明类型必填
resource_id资源 IDstring是
name名称string是
status状态ThirdIssueTypeStatusEnum是
type类型ThirdIssueTypeEnum是
create_time创建时间number是
icon图标ThirdTaskIconEnum是

ThirdUserGroup​

参数说明类型必填
resource_id资源 IDstring是
name名称string是
desc描述string是
create_time创建时间number是
status状态number是

ThirdUser​

参数说明类型必填
resource_id资源 IDstring是
name名称string是
email邮箱string是
phone手机string是
title头衔string是
company公司string是
create_time创建时间number是
modify_time更新时间number是
status状态ThirdUserStatusEnum是

ThirdTaskLinkType​

参数说明类型必填
resource_id资源 IDstring是
name名称string是
desc_out链出描述string是
desc_in链入描述string是
type类型ThirdTaskLinkTypeEnum是

ThirdConfig​

参数说明类型必填
workdays工作日WorkdayEnum[]是
work_hours每日工时number是
fixed_fields_mapping第三方字段映射系统字段map是
custom_fields_mapping属性映射map是
custom_fields属性string[]是
tab_fieldstab 属性tab_fields是

ThirdPriority​

参数说明类型必填
resource_id资源 IDstring是
name名称string是
desc描述string是
color颜色string是
background_color背景颜色string是

ThirdTaskFieldOption​

参数说明类型必填
resource_id资源 IDstring是
resource_task_field_id第三方工作项属性 IDstring是
name名称string是
desc描述string是
color颜色string是
background_color背景颜色string是

ThirdTaskField​

参数说明类型必填
resource_id资源 IDstring是
name属性名称string是
type属性类型ThirdTaskFieldTypeEnum是

ThirdUserDomain​

参数说明类型必填
user_domain_type用户域类型ThirdUserDomainTypeEnum是
user_domain_param用户域参数string是

ThirdTransition​

参数说明类型必填
project_id项目 IDstring是
issue_type_id工作项类型 IDstring是
start_status_id开始的状态 IDstring是
name名称string是
end_status_id结束的状态 IDstring是
user_domains用户域列表ThirdUserDomain[]是

ThirdWorkflow​

参数说明类型必填
project_id项目 IDstring是
issue_type_statuses工作项类型状态配置ThirdTaskStatusConfig[]是
transitions工作流配置ThirdTransition[]是

ThirdTaskStatusConfig​

参数说明类型必填
issue_type_id工作项类型 IDstring是
status_ids工作项状态 IDsstring[]是
init_status_id初始状态 IDstring是
workflow_name工作流名称string是

ThirdTaskStatus​

参数说明类型必填
resource_id资源 IDstring是
name名称string是
category工作项状态分类ThirdTaskStatusCategoryEnum是

ThirdTaskFieldValue​

参数说明类型必填
resource_id资源 IDstring是
task_id工作项 IDstring是
field_id属性 IDstring是
field_type属性类型ThirdTaskFieldValueFieldTypeEnum是
value属性值, 当值为空时,value的值应该为null或者不传该字段,不能为空字符串any是

ThirdTask​

参数说明类型必填
resource_id资源 IDstring是
summary标题string是
desc描述string是
owner_id创建者 IDstring是
assign_id负责人 IDstring是
deadline最后完成日期number否
priority_id优先级 IDstring是
status_id状态 IDstring是
project_id项目 IDstring是
issue_type_id工作项类型 IDstring是
sprint_id迭代 IDstring否
parent_id父工作项 IDstring否
created_time创建时间number是
updated_time更新时间number是

ThirdTaskRelease​

参数说明类型必填
task_id工作项 IDstring是
release_id发布的工作项 IDstring是

ThirdSprintFieldValue​

参数说明类型必填
resource_id资源 IDstring是
project_id项目 IDstring是
sprint_id迭代 IDstring是
field_id属性 IDstring是
field_type属性类型 IDThirdProjectSprintFieldTypeEnum是
value属性值any是

ThirdSprintFieldOption​

参数说明类型必填
resource_id资源 IDstring是
value属性选项值string是

ThirdProjectSprintField​

参数说明类型必填
resource_id资源 IDstring是
project_id项目 IDstring是
name属性名称string是
type属性类型ThirdProjectSprintFieldTypeEnum是
options属性选项值ThirdSprintFieldOption是

Enum​

WorkdayEnum​

工作日

可选值说明
WorkdayEnum.Mon周一
WorkdayEnum.Tue周二
WorkdayEnum.Wed周三
WorkdayEnum.Thu周四
WorkdayEnum.Fri周五
WorkdayEnum.Sat周六
WorkdayEnum.Sun周日

ThirdProjectFieldValueTypeEnum​

项目属性类型

可选值说明
ThirdProjectFieldValueTypeEnum.FieldTypeOption单选
ThirdProjectFieldValueTypeEnum.FieldTypeText单行文本

ThirdTaskFieldTypeEnum​

工作项属性类型枚举

可选值说明
ThirdTaskFieldTypeEnum.FieldTypeOption单选
ThirdTaskFieldTypeEnum.FieldTypeMultiOption多选
ThirdTaskFieldTypeEnum.FieldTypeText单行文本
ThirdTaskFieldTypeEnum.FieldTypeMultiLineText多行文本
ThirdTaskFieldTypeEnum.FieldTypeUser单选用户
ThirdTaskFieldTypeEnum.FieldTypeUserList多选用户
ThirdTaskFieldTypeEnum.FieldTypeFloat浮点数
ThirdTaskFieldTypeEnum.FieldTypeDate日期
ThirdTaskFieldTypeEnum.FieldTypeTime时间

ThirdTaskLinkTypeEnum​

工作项链接类型

可选值说明
ThirdTaskLinkTypeEnum.LinkModelTwoWayMany相互关联,双向多对多
ThirdTaskLinkTypeEnum.LinkModelManyToMany单向多对多

ThirdGlobalProjectFieldTypeEnum​

全局项目属性类型

可选值说明
ThirdGlobalProjectFieldTypeEnum.FieldTypeOption单选
ThirdGlobalProjectFieldTypeEnum.FieldTypeText单行文本
ThirdGlobalProjectFieldTypeEnum.FieldTypeMultiLineText多行文本

ThirdGlobalPermissionEnum​

全局权限

可选值说明
ThirdGlobalPermissionEnum.AdministerTeam团队管理
ThirdGlobalPermissionEnum.AdministerProject项目管理
ThirdGlobalPermissionEnum.AdministerWiki知识库管理
ThirdGlobalPermissionEnum.InviteMember邀请团队成员

ThirdIssueTypeEnum​

工作项类型

可选值说明
ThirdIssueTypeEnum.IssueTypeStandardTaskType标准任务类型
ThirdIssueTypeEnum.IssueTypeSubTaskType子任务类型

ThirdTaskIconEnum​

工作项图标

可选值说明
ThirdTaskIconEnum.StandardTaskIcon标准工作项图标
ThirdTaskIconEnum.SubTaskIcon子工作项图标

ThirdUserStatusEnum​

用户状态

可选值说明
ThirdUserStatusEnum.UserStatusNormal正常
ThirdUserStatusEnum.UserStatusDeleted已删除
ThirdUserStatusEnum.UserStatusPending未激活
ThirdUserStatusEnum.UserStatusDisable已经禁用

UserGroupStatusEnum​

用户组状态

可选值说明
UserGroupStatusEnum.UserGroupStatusNormal正常
UserGroupStatusEnum.UserGroupStatusDeleted已经删除

ThirdProjectTypeEnum​

项目类型

可选值说明
ThirdProjectTypeEnum.ProjectTypeAgileEnum敏捷类型

ThirdProjectStatusEnum​

项目状态

可选值说明
ThirdProjectStatusEnum.ProjectStatusNormal正常
ThirdProjectStatusEnum.ProjectStatusDeleted删除

ThirdProjectStatusUUIDEnum​

项目状态类型

可选值说明
ThirdProjectStatusUUIDEnum.ProjectStatusCategoryTodo未开始
ThirdProjectStatusUUIDEnum.ProjectStatusCategoryInProgress进行中
ThirdProjectStatusUUIDEnum.ProjectStatusCategoryDone已完成

ThirdUserDomainTypeEnum​

用户域类型

可选值说明
ThirdUserDomainTypeEnum.TaskOwner工作项创建人
ThirdUserDomainTypeEnum.TaskAssign工作项负责人
ThirdUserDomainTypeEnum.Role用户角色 ID
ThirdUserDomainTypeEnum.Group用户组 ID

ThirdSprintStatusEnum​

迭代状态

可选值说明
ThirdSprintStatusEnum.SprintStatusCategoryToDo未开始
ThirdSprintStatusEnum.SprintStatusCategoryInProgress进行中
ThirdSprintStatusEnum.SprintStatusCategoryDone已完成

ThirdTaskStatusCategoryEnum​

工作项状态类型分类

可选值说明
ThirdTaskStatusCategoryEnum.ProjectStatusCategoryTodo未开始
ThirdTaskStatusCategoryEnum.ProjectStatusCategoryInProgress进行中
ThirdTaskStatusCategoryEnum.ProjectStatusCategoryDone已完成

ThirdTaskWorkLogTypeEnum​

工时类型

可选值说明
ThirdTaskWorkLogTypeEnum.ThirdTaskWorkLogTypeEstimate预估工时
ThirdTaskWorkLogTypeEnum.ThirdTaskWorkLogTypeRemaining剩余工时
ThirdTaskWorkLogTypeEnum.ThirdTaskWorkLogTypeLog登记工时

ThirdTaskFieldValueFieldTypeEnum​

工作项属性值类型

可选值说明
ThirdTaskFieldValueFieldTypeEnum.FieldTypeOption单选
ThirdTaskFieldValueFieldTypeEnum.FieldTypeMultiOption多选
ThirdTaskFieldValueFieldTypeEnum.FieldTypeText单行文本
ThirdTaskFieldValueFieldTypeEnum.FieldTypeMultiLineText多行文本
ThirdTaskFieldValueFieldTypeEnum.FieldTypeUser单选用户
ThirdTaskFieldValueFieldTypeEnum.FieldTypeUserList多选用户
ThirdTaskFieldValueFieldTypeEnum.FieldTypeFloat浮点数
ThirdTaskFieldValueFieldTypeEnum.FieldTypeDate日期
ThirdTaskFieldValueFieldTypeEnum.FieldTypeTime时间

ThirdNotificationValueTypeEnum​

通知值类型

可选值说明
ThirdNotificationValueTypeEnum.NotificationValueTypeUserID用户 ID
ThirdNotificationValueTypeEnum.NotificationValueTypeUserGroupID用户组
ThirdNotificationValueTypeEnum.NotificationValueTypeGlobalProjectRoleID全局项目角色 ID
ThirdNotificationValueTypeEnum.NotificationValueTypeRole角色

ThirdNotificationConfigTypeEnum​

通知配置类型

可选值说明
ThirdNotificationConfigTypeEnum.NoticeTypeCreateTask创建工作项
ThirdNotificationConfigTypeEnum.NoticeTypeUpdateTaskAssign更新工作项分配
ThirdNotificationConfigTypeEnum.NoticeTypeUpdateTaskStatus更新工作项状态

ThirdProjectPermissionUserDomainTypeEnum​

权限用户域类型

可选值说明
ThirdProjectPermissionUserDomainTypeEnum.SingleUserLabel用户
ThirdProjectPermissionUserDomainTypeEnum.GroupLabel用户组
ThirdProjectPermissionUserDomainTypeEnum.RoleLabel角色

ThirdProjectPermissionPermissionEnum​

权限点名称

可选值说明
ThirdProjectPermissionPermissionEnum.ManageSprints管理迭代
ThirdProjectPermissionPermissionEnum.BeAssignedToSprint成为迭代负责人
ThirdProjectPermissionPermissionEnum.ManageProject管理项目
ThirdProjectPermissionPermissionEnum.BrowseProject查看项目
ThirdProjectPermissionPermissionEnum.ViewProjectReports查看项目报表
ThirdProjectPermissionPermissionEnum.ManagePipelines管理项目 Pipeline
ThirdProjectPermissionPermissionEnum.ViewTasks查看工作项
ThirdProjectPermissionPermissionEnum.ExportTasks导出工作项列表
ThirdProjectPermissionPermissionEnum.CreateTasks创建工作项
ThirdProjectPermissionPermissionEnum.DeleteTasks删除工作项
ThirdProjectPermissionPermissionEnum.UpdateTasks编辑工作项
ThirdProjectPermissionPermissionEnum.BeAssigned成为负责人
ThirdProjectPermissionPermissionEnum.TransitTasks更新工作项状态
ThirdProjectPermissionPermissionEnum.UpdateTaskWatchers编辑关注者

ThirdProjectPermissionContextTypeEnum​

权限上下文类型

可选值说明
ThirdProjectPermissionContextTypeEnum.ProjectContext项目
ThirdProjectPermissionContextTypeEnum.IssueTypeContext工作项类型

ThirdChangeItemFieldEnum​

工作项动态类型

可选值说明
ThirdChangeItemFieldEnum.ChangeItemFieldAttachment附件
ThirdChangeItemFieldEnum.ChangeItemFieldDescription描述
ThirdChangeItemFieldEnum.ChangeItemFieldPriority优先级
ThirdChangeItemFieldEnum.ChangeItemFieldStatus状态
ThirdChangeItemFieldEnum.ChangeItemFieldIssueType工作项类型
ThirdChangeItemFieldEnum.ChangeItemFieldAssignee负责人
ThirdChangeItemFieldEnum.ChangeItemFieldSprint迭代
ThirdChangeItemFieldEnum.ChangeItemFieldLink关联
ThirdChangeItemFieldEnum.ChangeItemFieldEpicChild
ThirdChangeItemFieldEnum.ChangeItemFieldTimeOriginalEstimate预估工时
ThirdChangeItemFieldEnum.ChangeItemFieldTimeEstimate剩余工时
ThirdChangeItemFieldEnum.ChangeItemFieldTimeSpent登记工时

ThirdGlobalProjectRoleStatusEnum​

项目角色状态

可选值说明
ThirdGlobalProjectRoleStatusEnum.RoleStatusNormal正常

ThirdIssueTypeStatusEnum​

工作项状态

可选值说明
ThirdIssueTypeStatusEnum.IssueTypeStatusNormal正常

ThirdIssueTypeDetailTypeEnum​

ONES 内置工作项类型

可选值说明
ThirdIssueTypeDetailTypeEnum.DetailTypeCustom默认,自定义类型
ThirdIssueTypeDetailTypeEnum.DetailTypeDemand需求
ThirdIssueTypeDetailTypeEnum.DetailTypeTask任务
ThirdIssueTypeDetailTypeEnum.DetailTypeDefect缺陷
ThirdIssueTypeDetailTypeEnum.DetailTypePublish发布

ThirdProjectSprintFieldTypeEnum​

项目迭代属性的属性类型

可选值说明
ThirdProjectSprintFieldTypeEnum.FieldTypeOption单选
ThirdProjectSprintFieldTypeEnum.FieldTypeText单行文本
ThirdProjectSprintFieldTypeEnum.FieldTypeMultiLineText多行文本
ThirdProjectSprintFieldTypeEnum.FieldTypeUser单选用户
ThirdProjectSprintFieldTypeEnum.FieldTypeFloat浮点数
ThirdProjectSprintFieldTypeEnum.FieldTypeDate日期
ThirdProjectSprintFieldTypeEnum.FieldTypeTime时间
ThirdProjectSprintFieldTypeEnum.FieldTypeInteger整数