Skip to main content

@ones-op/node-third-import

Require​

ONES
v3.11.39+

Install​

Enter the /backend directory of the plugin project, and execute the following command to install dependencies:

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

API​

startImport​

Start third-party data import

Params​

ParamTypeDescriptionRequiredDefault
userUUIDstringuser uuidY-
abilityIdstringability id in the plugin ability configurationY-
passwordstringImport user's default password when logging in for the first time (the default password needs to be a combination of alphanumerics)Y-
serverIdstringIf you import the same batch of data, you need to ensure the same server_idY-
teamUUIDstringThe unique ID of the team, only required for organization pluginsN-

Example​

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

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

Type​

ThirdNotification​

ParamDescriptionTypeRequired
project_idproject IDstringY
value_typevalue typeThirdNotificationValueTypeEnumY
valuevaluestringY
config_typeconfiguration typeThirdNotificationConfigTypeEnumY

ThirdTaskWorkLog​

ParamDescriptionTypeRequired
resource_idresource IDstringY
task_idissue IDstringY
user_iduser IDstringY
start_timecreation timenumberY
hourshours of worknumberY
typetypeThirdTaskWorkLogTypeEnumY
create_timecreation timenumberY

ThirdTaskAttachment​

ONES
v3.14.0+

The local debugging mode now supports importing attachments, but files must less than 100MB in this mode.

ParamDescriptionTypeRequired
resource_idresource IDstringY
task_idissue IDstringY
full_file_pathattachment file addressstringY
file_namefile namestringN
ParamDescriptionTypeRequired
resource_idassociation typestringY
link_type_idissue link type IDstringY
source_task_idsource issue IDstringY
target_task_idtarget issue IDstringY

ThirdTaskComment​

ParamDescriptionTypeRequired
resource_idresource IDstringY
task_idissue IDstringY
user_iduser IDstringY
bodycontentstringY
create_timecreation timenumberY

ThirdGlobalPermission​

ParamDescriptionTypeRequired
resource_idresource IDstringY
permissionpermission pointThirdGlobalPermissionEnumY
group_iduser group IDstringY

ThirdProjectPermission​

ParamDescriptionTypeRequired
resource_idresource IDstringY
project_idproject IDstringY
user_domain_typeuser domain typeThirdProjectPermissionUserDomainTypeEnumY
context_typeContext typeThirdProjectPermissionContextTypeEnumY
permissionpermission pointThirdProjectPermissionPermissionEnumY
user_domain_paramuser domain parameterstringY

ThirdTaskWatcher​

ParamDescriptionTypeRequired
resource_idresource IDstringY
task_idissue IDstringY
user_iduser IDstringY

ThirdSprint​

ParamDescriptionTypeRequired
resource_idresource IDstringY
namenamestringY
statusstatusThirdSprintStatusEnumY
project_idproject IDstringY
start_timestart timenumberY
end_timeend timenumberY
assign_idResponsible IDstringY
owner_idowner IDstringY

ThirdProjectIssueTypeLayout​

ParamDescriptionTypeRequired
project_idproject IDstringY
scope_configsview configurationScopeConfigItem[]Y
ScopeConfigItem​
ParamDescriptionTypeRequired
issue_type_idissue IDstringY
field_config_idfield configuration idstringY
screen_scheme_idview IDstringY

ThirdProjectIssueTypeWithFields​

ParamDescriptionTypeRequired
project_idproject IDstringY
issue_type_with_fieldsfield configurationIssueTypeWithFields[]Y
IssueTypeWithFields​
ParamDescriptionTypeRequired
issue_type_idissue IDstringY
issue_type_detail_typeONES built-in issue typeThirdIssueTypeDetailTypeEnumY
fieldsfield listField[]Y
Field​
ParamDescriptionTypeRequired
field_identifierfield identifierstringY
requiredY requiredbooleanY
is_customizedWhether it is a custom attributebooleanY

ThirdIssueTypeField​

ParamDescriptionTypeRequired
resource_idresource IDstringY
issue_type_idissue IDstringY
field_idattribute IDstringY

ThirdChangeItem​

ParamDescriptionTypeRequired
resource_idresource IDstringY
task_idissue IDstringY
field_typeattribute typestringY
fieldfieldThirdChangeItemFieldEnumY
old_valueold valuestringY
new_valuenew valuestringY
old_stringold stringstringY
new_stringnew stringstringY
user_iduser IDstringY
create_timecreation timenumberY

ThirdIssueTypeLayout​

ParamDescriptionTypeRequired
issue_type_idissue type IDstringY
field_config_idfield configuration IDstringY
field_config_namefield configuration namestringY
screen_scheme_idview IDstringY
screen_scheme_nameview namestringY
create_issue_configCreate issue viewField[]Y
view_issue_configView issue ViewField[]Y

ThirdProjectFieldValue​

ParamDescriptionTypeRequired
resource_idresource IDstringY
project_idproject IDstringY
project_field_idproject field IDstringY
typetypeThirdProjectFieldValueTypeEnumY
valuetype valueanyY

ThirdGlobalProjectFieldOption​

ParamDescriptionTypeRequired
resource_idresource IDstringY
valueattribute valuestringY
descdescriptionstringY
colorcolorstringY
background_colorbackground colorstringY

ThirdGlobalProjectField​

ParamDescriptionTypeRequired
resource_idresource IDstringY
namenamestringY
typeattribute typeThirdGlobalProjectFieldTypeEnumY
optionsfield option valueThirdGlobalProjectFieldOption[]Y

ThirdProject​

ParamDescriptionTypeRequired
resource_idresource IDstringY
namenamestringY
assign_idResponsible IDstringY
create_timecreation timenumberY
typetypeThirdProjectTypeEnumY
statusproject statusThirdProjectStatusEnumY
status_uuidstatus descriptionThirdProjectStatusUUIDEnumY
announcementannouncementstringY

ThirdUserGroupMember​

ParamDescriptionTypeRequired
resource_idresource IDstringY
resource_group_iduser group IDstringY
resource_user_iduser IDstringY

ThirdProjectCategory​

ParamDescriptionTypeRequired
resource_idresource IDstringY
namenamestringY

ThirdProjectRoleMember​

ParamDescriptionTypeRequired
resource_idresource IDstringY
resource_role_idrole idstringY
resource_project_idproject IDstringY
resource_user_iduser IDstringY

ThirdProjectRole​

ParamDescriptionTypeRequired
resource_idresource IDstringY
resource_role_idrole idstringY
resource_project_idproject IDstringY
create_timecreation timenumberY

ThirdGlobalProjectRole​

ParamDescriptionTypeRequired
resource_idresource IDstringY
namenamestringY
create_timecreation timenumberY
statusstatusThirdGlobalProjectRoleStatusEnumY

ThirdProjectIssueType​

ParamDescriptionTypeRequired
resource_idresource IDstringY
project_idproject IDstringY
issue_type_idissue type IDstringY

ThirdIssueType​

ParamDescriptionTypeRequired
resource_idresource IDstringY
namenamestringY
statusstatusThirdIssueTypeStatusEnumY
typetypeThirdIssueTypeEnumY
create_timecreation timenumberY
iconiconThirdTaskIconEnumY

ThirdUserGroup​

ParamDescriptionTypeRequired
resource_idresource IDstringY
namenamestringY
descdescriptionstringY
create_timecreation timenumberY
statusstatusnumberY

ThirdUser​

ParamDescriptionTypeRequired
resource_idresource IDstringY
namenamestringY
emailemailstringY
phonephonestringY
titletitlestringY
companycompanystringY
create_timecreation timenumberY
modify_timeupdate timenumberY
statusstatusThirdUserStatusEnumY

ThirdTaskLinkType​

ParamDescriptionTypeRequired
resource_idresource IDstringY
namenamestringY
desc_outlink out descriptionstringY
desc_inlink-in descriptionstringY
typetypeThirdTaskLinkTypeEnumY

ThirdConfig​

ParamDescriptionTypeRequired
workdaysworkdaysWorkdayEnum[]Y
work_hoursdaily working hoursnumberY
fixed_fields_mappingthird-party field mapping system fieldsmapY
custom_fields_mappingattribute mappingmapY
custom_fieldspropertiesstring[]Y
tab_fieldstab attributetab_fieldsY

ThirdPriority​

ParamDescriptionTypeRequired
resource_idresource IDstringY
namenamestringY
descdescriptionstringY
colorcolorstringY
background_colorbackground colorstringY

ThirdTaskFieldOption​

ParamDescriptionTypeRequired
resource_idresource IDstringY
resource_task_field_id3rd party issue attribute IDstringY
namenamestringY
descdescriptionstringY
colorcolorstringY
background_colorbackground colorstringY

ThirdTaskField​

ParamDescriptionTypeRequired
resource_idresource IDstringY
namefield namestringY
typeattribute typeThirdTaskFieldTypeEnumY

ThirdUserDomain​

ParamDescriptionTypeRequired
user_domain_typeuser domain typeThirdUserDomainTypeEnumY
user_domain_paramuser domain parameterstringY

ThirdTransition​

ParamDescriptionTypeRequired
project_idproject IDstringY
issue_type_idissue type IDstringY
start_status_idstart status idstringY
namenamestringY
end_status_idend status idstringY
user_domainslist of user domainsThirdUserDomain[]Y

ThirdWorkflow​

ParamDescriptionTypeRequired
project_idproject IDstringY
issue_type_statusesissue Type Status ConfigurationThirdTaskStatusConfig[]Y
transitionsworkflow configurationThirdTransition[]Y

ThirdTaskStatusConfig​

ParamDescriptionTypeRequired
issue_type_idissue type IDstringY
status_idsissue status IDsstring[]Y
init_status_idinitial status idstringY
workflow_nameworkflow namestringY

ThirdTaskStatus​

ParamDescriptionTypeRequired
resource_idresource IDstringY
namenamestringY
categoryissue status categoryThirdTaskStatusCategoryEnumY

ThirdTaskFieldValue​

ParamDescriptionTypeRequired
resource_idresource IDstringY
task_idissue IDstringY
field_idattribute IDstringY
field_typeattribute typeThirdTaskFieldValueFieldTypeEnumY
valueattribute value, when the value is null, the value of value should be null or ignore the field, not the empty stringanyY

ThirdTask​

ParamDescriptionTypeRequired
resource_idresource IDstringY
summarytitlestringY
descdescriptionstringY
owner_idCreator IDstringY
assign_idResponsible IDstringY
deadlinefinal completion datenumberN
priority_idpriority IDstringY
status_idstatus idstringY
project_idproject IDstringY
issue_type_idissue type IDstringY
sprint_iditeration IDstringN
parent_idparent issue IDstringN
created_timecreation timenumberY
updated_timeupdated timenumberY

ThirdTaskRelease​

ParamDescriptionTypeRequired
task_idissue type IDstringY
release_idpublish issue type IDstringY

ThirdSprintFieldValue​

ParamDescriptionTypeRequired
resource_idresource IDstringY
project_idproject IDstringY
sprint_idsprint IDstringY
field_idfield IDstringY
field_typefield type IDThirdProjectSprintFieldTypeEnumY
valuevalueanyY

ThirdSprintFieldOption​

ParamDescriptionTypeRequired
resource_idresource IDstringY
valuevaluestringY

ThirdProjectSprintField​

ParamDescriptionTypeRequired
resource_idresource IDstringY
project_idproject IDstringY
namenamestringY
typetypeThirdProjectSprintFieldTypeEnumY
optionsoptionsThirdSprintFieldOptionY

Enum​

WorkdayEnum​

working day

EnumDescription
WorkdayEnum.MonMonday
WorkdayEnum.TueTuesday
WorkdayEnum.WedWednesday
WorkdayEnum.ThuThursday
WorkdayEnum.FriFriday
WorkdayEnum.SatSaturday
WorkdayEnum.SunSunday

ThirdProjectFieldValueTypeEnum​

item field type

EnumDescription
ThirdProjectFieldValueTypeEnum.FieldTypeOptionSingle
ThirdProjectFieldValueTypeEnum.FieldTypeTextSingle line of text

ThirdTaskFieldTypeEnum​

issue field type enumeration

EnumDescription
ThirdTaskFieldTypeEnum.FieldTypeOptionSingle Choice
ThirdTaskFieldTypeEnum.FieldTypeMultiOptionMultiple choice
ThirdTaskFieldTypeEnum.FieldTypeTextSingle line of text
ThirdTaskFieldTypeEnum.FieldTypeMultiLineTextMulti-line text
ThirdTaskFieldTypeEnum.FieldTypeUserSingle user
ThirdTaskFieldTypeEnum.FieldTypeUserListMultiple user selection
ThirdTaskFieldTypeEnum.FieldTypeFloatFloat
ThirdTaskFieldTypeEnum.FieldTypeDatedate
ThirdTaskFieldTypeEnum.FieldTypeTimeTime

ThirdTaskLinkTypeEnum​

issue link type

EnumDescription
ThirdTaskLinkTypeEnum.LinkModelTwoWayManyInterrelated, two-way many-to-many
ThirdTaskLinkTypeEnum.LinkModelManyToManyOne-way many-to-many

ThirdGlobalProjectFieldTypeEnum​

Global Project field Type

EnumDescription
ThirdGlobalProjectFieldTypeEnum.FieldTypeOptionSingle
ThirdGlobalProjectFieldTypeEnum.FieldTypeTextSingle line of text
ThirdGlobalProjectFieldTypeEnum.FieldTypeMultiLineTextMultiline Text

ThirdGlobalPermissionEnum​

global permissions

EnumDescription
ThirdGlobalPermissionEnum.AdministerTeamTeam Administration
ThirdGlobalPermissionEnum.AdministerProjectProject Administration
ThirdGlobalPermissionEnum.AdministerWikiKnowledge Base Administration
ThirdGlobalPermissionEnum.InviteMemberInvite team members

ThirdIssueTypeEnum​

issue type

EnumDescription
ThirdIssueTypeEnum.IssueTypeStandardTaskTypeStandard task type
ThirdIssueTypeEnum.IssueTypeSubTaskTypeSubtask type

ThirdTaskIconEnum​

issue icon

EnumDescription
ThirdTaskIconEnum.StandardTaskIconStandard task item icon
ThirdTaskIconEnum.SubTaskIconsub task item icon

ThirdUserStatusEnum​

user status

EnumDescription
ThirdUserStatusEnum.UserStatusNormalNormal
ThirdUserStatusEnum.UserStatusDeletedDeleted
ThirdUserStatusEnum.UserStatusPendingInactive
ThirdUserStatusEnum.UserStatusDisableDisabled

UserGroupStatusEnum​

user group status

EnumDescription
UserGroupStatusEnum.UserGroupStatusNormalNormal
UserGroupStatusEnum.UserGroupStatusDeletedDeleted

ThirdProjectTypeEnum​

project type

EnumDescription
ThirdProjectTypeEnum.ProjectTypeAgileEnumAgile type

ThirdProjectStatusEnum​

project status

EnumDescription
ThirdProjectStatusEnum.ProjectStatusNormalNormal
ThirdProjectStatusEnum.ProjectStatusDeletedDeleted

ThirdProjectStatusUUIDEnum​

item status type

EnumDescription
ThirdProjectStatusUUIDEnum.ProjectStatusCategoryTodoNot started
ThirdProjectStatusUUIDEnum.ProjectStatusCategoryInProgressIn Progress
ThirdProjectStatusUUIDEnum.ProjectStatusCategoryDoneCompleted

ThirdUserDomainTypeEnum​

user domain type

EnumDescription
ThirdUserDomainTypeEnum.TaskOwnerissue creator
ThirdUserDomainTypeEnum.TaskAssignTaskAssign
ThirdUserDomainTypeEnum.RoleUser role ID
ThirdUserDomainTypeEnum.GroupUser Group ID

ThirdSprintStatusEnum​

iteration status

EnumDescription
ThirdSprintStatusEnum.SprintStatusCategoryToDoNot started
ThirdSprintStatusEnum.SprintStatusCategoryInProgressIn Progress
ThirdSprintStatusEnum.SprintStatusCategoryDoneCompleted

ThirdTaskStatusCategoryEnum​

issue status Classification

EnumDescription
ThirdTaskStatusCategoryEnum.ProjectStatusCategoryTodoNot started
ThirdTaskStatusCategoryEnum.ProjectStatusCategoryInProgressIn Progress
ThirdTaskStatusCategoryEnum.ProjectStatusCategoryDoneCompleted

ThirdTaskWorkLogTypeEnum​

type of hours

EnumDescription
ThirdTaskWorkLogTypeEnum.ThirdTaskWorkLogTypeEstimateEstimated Work
ThirdTaskWorkLogTypeEnum.ThirdTaskWorkLogTypeRemainingRemaining Work
ThirdTaskWorkLogTypeEnum.ThirdTaskWorkLogTypeLogRegister working hours

ThirdTaskFieldValueFieldTypeEnum​

issue field value type

EnumDescription
ThirdTaskFieldValueFieldTypeEnum.FieldTypeOptionSingle Choice
ThirdTaskFieldValueFieldTypeEnum.FieldTypeMultiOptionMultiple choice
ThirdTaskFieldValueFieldTypeEnum.FieldTypeTextSingle line of text
ThirdTaskFieldValueFieldTypeEnum.FieldTypeMultiLineTextMulti-line text
ThirdTaskFieldValueFieldTypeEnum.FieldTypeUserSingle user
ThirdTaskFieldValueFieldTypeEnum.FieldTypeUserListMultiple user selection
ThirdTaskFieldValueFieldTypeEnum.FieldTypeFloatFloat
ThirdTaskFieldValueFieldTypeEnum.FieldTypeDatedate
ThirdTaskFieldValueFieldTypeEnum.FieldTypeTimeTime

ThirdNotificationValueTypeEnum​

notification value type

EnumDescription
ThirdNotificationValueTypeEnum.NotificationValueTypeUserIDUser ID
ThirdNotificationValueTypeEnum.NotificationValueTypeUserGroupIDUser Group
ThirdNotificationValueTypeEnum.NotificationValueTypeGlobalProjectRoleIDGlobal Project Role ID
ThirdNotificationValueTypeEnum.NotificationValueTypeRoleRole

ThirdNotificationConfigTypeEnum​

notification configuration type

EnumDescription
ThirdNotificationConfigTypeEnum.NoticeTypeCreateTaskCreate issue
ThirdNotificationConfigTypeEnum.NoticeTypeUpdateTaskAssignUpdate issue assignment
ThirdNotificationConfigTypeEnum.NoticeTypeUpdateTaskStatusUpdate issue status

ThirdProjectPermissionUserDomainTypeEnum​

authorized user domain type

EnumDescription
ThirdProjectPermissionUserDomainTypeEnum.SingleUserLabelUser
ThirdProjectPermissionUserDomainTypeEnum.GroupLabelUser Group
ThirdProjectPermissionUserDomainTypeEnum.RoleLabelRole

ThirdProjectPermissionPermissionEnum​

permission point name

EnumDescription
ThirdProjectPermissionPermissionEnum.ManageSprintsManage Sprints
ThirdProjectPermissionPermissionEnum.BeAssignedToSprintBecome Sprint Owner
ThirdProjectPermissionPermissionEnum.ManageProjectManage Projects
ThirdProjectPermissionPermissionEnum.BrowseProjectView Project
ThirdProjectPermissionPermissionEnum.ViewProjectReportsView Project Reports
ThirdProjectPermissionPermissionEnum.ManagePipelinesManage Project Pipelines
ThirdProjectPermissionPermissionEnum.ViewTasksView issues
ThirdProjectPermissionPermissionEnum.ExportTasksExport issue list
ThirdProjectPermissionPermissionEnum.CreateTasksCreate issues
ThirdProjectPermissionPermissionEnum.DeleteTasksDelete issues
ThirdProjectPermissionPermissionEnum.UpdateTasksEditing issues
ThirdProjectPermissionPermissionEnum.BeAssignedBecome Responsible
ThirdProjectPermissionPermissionEnum.TransitTasksUpdate issue status
ThirdProjectPermissionPermissionEnum.UpdateTaskWatchersEdit Followers

ThirdProjectPermissionContextTypeEnum​

permission context type

EnumDescription
ThirdProjectPermissionContextTypeEnum.ProjectContextProject
ThirdProjectPermissionContextTypeEnum.IssueTypeContextissue Type

ThirdChangeItemFieldEnum​

issue dynamic type

EnumDescription
ThirdChangeItemFieldEnum.ChangeItemFieldAttachmentAttachment
ThirdChangeItemFieldEnum.ChangeItemFieldDescriptionDescription
ThirdChangeItemFieldEnum.ChangeItemFieldPriorityPriority
ThirdChangeItemFieldEnum.ChangeItemFieldStatusStatus
ThirdChangeItemFieldEnum.ChangeItemFieldIssueTypeissue type
ThirdChangeItemFieldEnum.ChangeItemFieldAssigneeResponsible
ThirdChangeItemFieldEnum.ChangeItemFieldSprintIterations
ThirdChangeItemFieldEnum.ChangeItemFieldLinkLink
ThirdChangeItemFieldEnum.ChangeItemFieldEpicChild
ThirdChangeItemFieldEnum.ChangeItemFieldTimeOriginalEstimateEstimated working hours
ThirdChangeItemFieldEnum.ChangeItemFieldTimeEstimateRemaining Work Hours
ThirdChangeItemFieldEnum.ChangeItemFieldTimeSpentRegister working hours

ThirdGlobalProjectRoleStatusEnum​

project role status

EnumDescription
ThirdGlobalProjectRoleStatusEnum.RoleStatusNormalNormal

ThirdIssueTypeStatusEnum​

issue status

EnumDescription
ThirdIssueTypeStatusEnum.IssueTypeStatusNormalNormal

ThirdIssueTypeDetailTypeEnum​

ONES built-in issue type

EnumDescription
ThirdIssueTypeDetailTypeEnum.DetailTypeCustomdefault, custom type
ThirdIssueTypeDetailTypeEnum.DetailTypeDemanddemand
ThirdIssueTypeDetailTypeEnum.DetailTypeTasktask
ThirdIssueTypeDetailTypeEnum.DetailTypeDefectdefect
ThirdIssueTypeDetailTypeEnum.DetailTypePublishpublish

ThirdProjectSprintFieldTypeEnum​

project sprint field type

EnumDescription
ThirdProjectSprintFieldTypeEnum.FieldTypeOptionSingle Choice
ThirdProjectSprintFieldTypeEnum.FieldTypeTextSingle line of text
ThirdProjectSprintFieldTypeEnum.FieldTypeMultiLineTextMulti-line text
ThirdProjectSprintFieldTypeEnum.FieldTypeUserSingle user
ThirdProjectSprintFieldTypeEnum.FieldTypeFloatFloat
ThirdProjectSprintFieldTypeEnum.FieldTypeDatedate
ThirdProjectSprintFieldTypeEnum.FieldTypeTimeTime
ThirdProjectSprintFieldTypeEnum.FieldTypeIntegerInteger