@ones-op/node-third-import
要求
| ONES |
|---|
| v3.11.39+ |
安装
进入插件工程的/backend目录,执行以下命令进行依赖安装:
npm i @ones-op/node-third-import
API
startImport
开始三方数据导入
Params
| 参数 | 类型 | 说明 | 必填 | 默认值 |
|---|---|---|---|---|
| userUUID | string | 用户 uuid | 是 | - |
| abilityId | string | 插件能力配置中的能力 id | 是 | - |
| password | string | 首次登录时导入用户的默认密码(默认密码需要是字母数字组合) | 是 | - |
| serverId | string | 如果导入的是同一批数据需要保证有相同的 server_id | 是 | - |
| teamUUID | string | 团队唯一标识,仅为组织插件时需要 | 否 | - |
Example
import { startImport } from '@ones-op/node-third-import'
await startImport(user_uuid, abilityId, password, server_id, teamUUID)
Type
ThirdNotification
| 参数 | 说明 | 类型 | 必填 |
|---|---|---|---|
| project_id | 项目 ID | string | 是 |
| value_type | 值类型 | ThirdNotificationValueTypeEnum | 是 |
| value | 值 | string | 是 |
| config_type | 配置类型 | ThirdNotificationConfigTypeEnum | 是 |
ThirdTaskWorkLog
| 参数 | 说明 | 类型 | 必填 |
|---|---|---|---|
| resource_id | 资源 ID | string | 是 |
| task_id | 工作项 ID | string | 是 |
| user_id | 用户 ID | string | 是 |
| start_time | 创建时间 | number | 是 |
| hours | 工时 | number | 是 |
| type | 类型 | ThirdTaskWorkLogTypeEnum | 是 |
| create_time | 创建时间 | number | 是 |
ThirdTaskAttachment
| ONES |
|---|
| v3.14.0+ |
附件导入在本地调试方式已支持,但是要求文件不超过 100MB。
| 参数 | 说明 | 类型 | 必填 |
|---|---|---|---|
| resource_id | 资源 ID | string | 是 |
| task_id | 工作项 ID | string | 是 |
| full_file_path | 附件文件地址 | string | 是 |
| file_name | 文件名称 | string | 否 |
ThirdTaskLink
| 参数 | 说明 | 类型 | 必填 |
|---|---|---|---|
| resource_id | 关联类型 | string | 是 |
| link_type_id | 工作项关联类型 ID | string | 是 |
| source_task_id | 源工作项 ID | string | 是 |
| target_task_id | 目标工作项 ID | string | 是 |
ThirdTaskComment
| 参数 | 说明 | 类型 | 必填 |
|---|---|---|---|
| resource_id | 资源 ID | string | 是 |
| task_id | 工作项 ID | string | 是 |
| user_id | 用户 ID | string | 是 |
| body | 内容 | string | 是 |
| create_time | 创建时间 | number | 是 |
ThirdGlobalPermission
| 参数 | 说明 | 类型 | 必填 |
|---|---|---|---|
| resource_id | 资源 ID | string | 是 |
| permission | 权限点 | ThirdGlobalPermissionEnum | 是 |
| group_id | 用户组 ID | string | 是 |
ThirdProjectPermission
| 参数 | 说明 | 类型 | 必填 |
|---|---|---|---|
| resource_id | 资源 ID | string | 是 |
| project_id | 项目 ID | string | 是 |
| user_domain_type | 用户域类型 | ThirdProjectPermissionUserDomainTypeEnum | 是 |
| context_type | Context 类型 | ThirdProjectPermissionContextTypeEnum | 是 |
| permission | 权限点 | ThirdProjectPermissionPermissionEnum | 是 |
| user_domain_param | 用户域参数 | string | 是 |
ThirdTaskWatcher
| 参数 | 说明 | 类型 | 必填 |
|---|---|---|---|
| resource_id | 资源 ID | string | 是 |
| task_id | 工作项 ID | string | 是 |
| user_id | 用户 ID | string | 是 |
ThirdSprint
| 参数 | 说明 | 类型 | 必填 |
|---|---|---|---|
| resource_id | 资源 ID | string | 是 |
| name | 名称 | string | 是 |
| status | 状态 | ThirdSprintStatusEnum | 是 |
| project_id | 项目 ID | string | 是 |
| start_time | 开始时间 | number | 是 |
| end_time | 结束时间 | number | 是 |
| assign_id | 负责人 ID | string | 是 |
| owner_id | 所属人 ID | string | 是 |
ThirdProjectIssueTypeLayout
| 参数 | 说明 | 类型 | 必填 |
|---|---|---|---|
| project_id | 项目 ID | string | 是 |
| scope_configs | 视图配置 | ScopeConfigItem[] | 是 |
ScopeConfigItem
| 参数 | 说明 | 类型 | 必填 |
|---|---|---|---|
| issue_type_id | 工作项 ID | string | 是 |
| field_config_id | 字段配置 ID | string | 是 |
| screen_scheme_id | 视图 ID | string | 是 |
ThirdProjectIssueTypeWithFields
| 参数 | 说明 | 类型 | 必填 |
|---|---|---|---|
| project_id | 项目 ID | string | 是 |
| issue_type_with_fields | 属性配置 | IssueTypeWithFields[] | 是 |
IssueTypeWithFields
| 参数 | 说明 | 类型 | 必填 |
|---|---|---|---|
| issue_type_id | 工作项 ID | string | 是 |
| issue_type_detail_type | ONES 内置工作项类型 | ThirdIssueTypeDetailTypeEnum | 是 |
| fields | 属性列表 | Field[] | 是 |
Field
| 参数 | 说明 | 类型 | 必填 |
|---|---|---|---|
| field_identifier | 字段标识 | string | 是 |
| required | 是否必填 | boolean | 是 |
| is_customized | 是否是自定义属性 | boolean | 是 |
ThirdIssueTypeField
| 参数 | 说明 | 类型 | 必填 |
|---|---|---|---|
| resource_id | 资源 ID | string | 是 |
| issue_type_id | 工作项 ID | string | 是 |
| field_id | 属性 ID | string | 是 |
ThirdChangeItem
| 参数 | 说明 | 类型 | 必填 |
|---|---|---|---|
| resource_id | 资源 ID | string | 是 |
| task_id | 工作项 ID | string | 是 |
| field_type | 属性类型 | string | 是 |
| field | 属性 | ThirdChangeItemFieldEnum | 是 |
| old_value | 旧值 | string | 是 |
| new_value | 新值 | string | 是 |
| old_string | 旧字符串 | string | 是 |
| new_string | 新字符串 | string | 是 |
| user_id | 用户 ID | string | 是 |
| create_time | 创建时间 | number | 是 |
ThirdIssueTypeLayout
| 参数 | 说明 | 类型 | 必填 |
|---|---|---|---|
| issue_type_id | 工作项类型 ID | string | 是 |
| field_config_id | 属性配置 ID | string | 是 |
| field_config_name | 属性配置名称 | string | 是 |
| screen_scheme_id | 视图 ID | string | 是 |
| screen_scheme_name | 视图名称 | string | 是 |
| create_issue_config | 创建工作项视图 | Field[] | 是 |
| view_issue_config | 查看工作项视图 | Field[] | 是 |
ThirdProjectFieldValue
| 参数 | 说明 | 类型 | 必填 |
|---|---|---|---|
| resource_id | 资源 ID | string | 是 |
| project_id | 项目 ID | string | 是 |
| project_field_id | 项目属性 ID | string | 是 |
| type | 类型 | ThirdProjectFieldValueTypeEnum | 是 |
| value | 类型值 | any | 是 |
ThirdGlobalProjectFieldOption
| 参数 | 说明 | 类型 | 必填 |
|---|---|---|---|
| resource_id | 资源 ID | string | 是 |
| value | 属性值 | string | 是 |
| desc | 描述 | string | 是 |
| color | 颜色 | string | 是 |
| background_color | 背景色 | string | 是 |
ThirdGlobalProjectField
| 参数 | 说明 | 类型 | 必填 |
|---|---|---|---|
| resource_id | 资源 ID | string | 是 |
| name | 名称 | string | 是 |
| type | 属性类型 | ThirdGlobalProjectFieldTypeEnum | 是 |
| options | 属性选项值 | ThirdGlobalProjectFieldOption[] | 是 |
ThirdProject
| 参数 | 说明 | 类型 | 必填 |
|---|---|---|---|
| resource_id | 资源 ID | string | 是 |
| name | 名称 | string | 是 |
| assign_id | 负责人 ID | string | 是 |
| create_time | 创建时间 | number | 是 |
| type | 类型 | ThirdProjectTypeEnum | 是 |
| status | 项目状态 | ThirdProjectStatusEnum | 是 |
| status_uuid | 状态描述 | ThirdProjectStatusUUIDEnum | 是 |
| announcement | 公告 | string | 是 |
ThirdUserGroupMember
| 参数 | 说明 | 类型 | 必填 |
|---|---|---|---|
| resource_id | 资源 ID | string | 是 |
| resource_group_id | 用户组 ID | string | 是 |
| resource_user_id | 用户 ID | string | 是 |
ThirdProjectCategory
| 参数 | 说明 | 类型 | 必填 |
|---|---|---|---|
| resource_id | 资源 ID | string | 是 |
| name | 名称 | string | 是 |
ThirdProjectRoleMember
| 参数 | 说明 | 类型 | 必填 |
|---|---|---|---|
| resource_id | 资源 ID | string | 是 |
| resource_role_id | 角色 ID | string | 是 |
| resource_project_id | 项目 ID | string | 是 |
| resource_user_id | 用户 ID | string | 是 |