CLI命令参考
Scrum项目的工作项
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 创建工作项类型自定义字段 | hcloud ProjectMan CreateCustomfields | 创建工作项类型自定义字段 | |
| 上传图片 | hcloud ProjectMan UploadIssueImg | 上传图片 | |
| 获取工作项完成率 | hcloud ProjectMan ShowIssueCompletionRate | 获取工作项的完成率 | |
| 获取指定工作项的评论列表 | hcloud ProjectMan ListIssueCommentsV4 | 获取工作项的评论 | |
| 按用户查询工时（单项目） | hcloud ProjectMan ShowProjectWorkHours | 按用户查询工时（单项目） | |
| 按用户查询工时（多项目） | hcloud ProjectMan ListProjectWorkHours | 按用户查询工时（多项目） | |
| 添加指定工作项工时 | hcloud ProjectMan AddIssueWorkHours | 添加指定工作项工时 | |
| 查询项目下的工时类型 | hcloud ProjectMan ListProjectWorkHoursType | 查询项目下的工时类型 | |
| 获取工作项历史记录 | hcloud ProjectMan ListIssueRecordsV4 | 获取工作项历史记录 | |
| 创建工作项 | hcloud ProjectMan CreateIssueV4 | 创建工作项 | |
| 查询项目的工作项 | hcloud ProjectMan ListIssuesSfV4 | 工作项类型id, 分页参数，创建时间查询项目的工作项 | |
| 高级查询工作项 | hcloud ProjectMan ListIssuesV4 | 根据筛选条件查询工作项 | |
| 批量删除工作项 | hcloud ProjectMan BatchDeleteIssuesV4 | 批量删除工作项 | |
| 查询工作项详情 | hcloud ProjectMan ShowIssueV4 | 查询工作项详情 | |
| 更新工作项 | hcloud ProjectMan UpdateIssueV4 | 更新工作项 | |
| 删除工作项 | hcloud ProjectMan DeleteIssueV4 | 删除工作项 | |
| 获取子工作项 | hcloud ProjectMan ListChildIssuesV4 | 获取子工作项 | |
| 查询项目下所有工作项的历史记录 | hcloud ProjectMan ListProjectIssuesRecordsV4 | 查询项目下所有工作项的历史记录 | |
| 查询Scrum项目的工作项流转配置 | hcloud ProjectMan ShowIssuesWrokFlowConfig | 查询Scrum项目的工作项流转配置 | |
| 细粒度权限用户创建工作项 | hcloud ProjectMan CreateSystemIssueV4 | 拥有IAM细粒度权限（projectmanConfig:systemSettingField:set）且在devcloud项目中有创建工作项的权限的用户可以设置工作项的创建者 | |
| 查询当前工作项已经关联的工作项 | hcloud ProjectMan ListAssociatedIssues | 查询当前工作项已经关联的工作项 | |
| 查询当前项目下已经关联的工作项 | hcloud ProjectMan BatchListAssociatedIssues | 查询当前项目下已经关联的工作项 | |
| 查询当前工作项已经关联的关联Wiki | hcloud ProjectMan ListAssociatedWikis | 查询当前工作项已经关联的关联Wiki | |
| 查询当前工作项已经关联的代码提交记录 / 分支创建记录 | hcloud ProjectMan ListIssueAssociatedCommits | 查询当前工作项已经关联的代码提交记录 / 分支创建记录 | |
| 查询关联用例 | hcloud ProjectMan ListAssociatedTestCases | 查询关联用例 | |
| 查询Scrum工作项自定义字段 | hcloud ProjectMan ListIssueCustomFields | 查询Scrum工作项自定义字段的可选列表,符合custom_fields或者names条件的都返回,2个值都不传，返回所有的自定义字段列表 | |
| 下载图片 | hcloud ProjectMan DownloadImageFile | 下载图片 | |
| 上传工作项附件 | hcloud ProjectMan UploadAttachments | 上传工作项附件 | |
| 获取指定工作项停留时间 | hcloud ProjectMan ListSpecIssueStayTimes | 获取指定工作项停留时间 | |
| 高级查询我的待办工作项 | hcloud ProjectMan SearchIssues | 高级查询我的待办工作项 |
Scrum项目的迭代
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 获取指定项目的迭代列表 | hcloud ProjectMan ListProjectIterationsV4 | 获取项目迭代 | |
| 批量删除项目的迭代 | hcloud ProjectMan BatchDeleteIterationsV4 | 批量删除项目的迭代 | |
| 查看迭代详情 | hcloud ProjectMan ShowIterationV4 | 查看迭代详情 | |
| 创建Scrum项目迭代 | hcloud ProjectMan CreateIterationV4 | 创建Scrum项目迭代 | |
| 更新Scrum项目迭代 | hcloud ProjectMan UpdateIterationV4 | 更新Scrum项目迭代 | |
| 删除项目迭代 | hcloud ProjectMan DeleteIterationV4 | 删除项目迭代 | |
| 查看迭代历史记录 | hcloud ProjectMan ListIterationHistories | 查看迭代历史记录 |
用户信息
项目成员
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 主动退出项目 | hcloud ProjectMan RemoveProject | 项目成员主动退出项目，项目创建者不能退出 | |
| 获取指定项目的成员用户列表 | hcloud ProjectMan ListProjectMembersV4 | 获取项目成员列表 | |
| 批量添加项目成员 | hcloud ProjectMan BatchAddMembersV4 | 批量添加项目成员，只能添加和项目创建者同一租户下的成员，不正确的用户id会略过，添加的用户超过权限的，默认角色设置为7 | |
| 批量删除项目成员 | hcloud ProjectMan BatchDeleteMembersV4 | 批量删除项目成员 | |
| 更新成员在项目中的角色 | hcloud ProjectMan UpdateMembesRoleV4 | 更新成员在项目中的角色 | |
| 添加项目成员 | hcloud ProjectMan AddMemberV4 | 添加项目成员,可以添加跨租户成员 | |
| AGC调用 当前用户申请加入项目 | hcloud ProjectMan AddApplyJoinProjectForAgc | AGC调用 当前用户申请加入项目, 申请的用户id写在header中 |
项目信息
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 获取项目详情 | hcloud ProjectMan ShowProjectInfoV4 | 获取项目详情 | |
| 更新项目 | hcloud ProjectMan UpdateProjectV4 | 更新项目 | |
| 删除项目 | hcloud ProjectMan DeleteProjectV4 | 删除项目 | |
| 查询项目列表 | hcloud ProjectMan ListProjectsV4 | 查询项目列表 | |
| 获取租户没有加入的项目 | hcloud ProjectMan ListDomainNotAddedProjectsV4 | 获取租户没有加入的项目 | |
| 创建项目 | hcloud ProjectMan CreateProjectV4 | 创建项目 | |
| 检查项目名称是否存在 | hcloud ProjectMan CheckProjectNameV4 | 检查项目名称是否存在 | |
| 查询项目模板 | hcloud ProjectMan ListTemplates | 查询项目模板 |
项目指标
项目统计
Scrum项目的模块
Scrum项目的领域
IPD工作项
IPD工作项状态
IPD工作流
Scrum项目的状态
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 查询项目的状态列表 | hcloud ProjectMan ListScrumProjectStatuses | 查询项目的状态列表 |
Severity
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 查询所有的严重程度 | hcloud ProjectMan ShowScrumIssueSeverities | 查询所有的严重程度 |
Plan
IPD项目接口
IPD字段管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 查询工作项实例字段列表 | hcloud ProjectMan ShowIpdFieldsV2 | 查询创建工作项实例时可用的字段配置信息，包含系统字段和项目自定义字段。 |
IPD评审单管理
IPD标签管理
IPD计划快照管理
IPD工作项关联外部链接
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 查询外部链接 | hcloud ProjectMan ShowIpdThirdPartyAssociated | 需要获取IPD项目下工作项对应的外部链接列表时，可调用此接口，用户可以通过项目ID和工作项ID查询该工作项关联的所有外部链接。 | |
| 新建并关联外部链接 | hcloud ProjectMan AssociateIpdThirdParty | 需要给IPD项目下的工作项关联外部链接时，可调用此接口，用户可以通过项目ID和工作项ID，传入需要绑定的外部链接的名称和地址，给该工作项关联外部链接。 | |
| 修改外部链接 | hcloud ProjectMan UpdateIpdThirdParty | 需要修改IPD项目下的工作项对应的外部链接时，可调用此接口，用户可以通过项目ID和工作项ID确定工作项，传入需要修改的外部链接唯一标识ID，此ID可以通过查询外部链接接口获得，以及修改后的名称和地址，修改该工作项的某条外部链接的名称和地址。 | |
| 删除外部链接 | hcloud ProjectMan DeleteIpdThirdParty | 需要删除IPD项目下的工作项对应的外部链接时，可调用此接口，用户可以通过项目ID和工作项ID确定工作项，传入需要删除的外部链接唯一标识ID，此ID可以通过查询外部链接获得，删除该工作项的某条外部链接。 |
IPD工作项管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 查询工作项关联项 | hcloud ProjectMan QueryIssueAssociatedItem | 根据项目ID和工作项ID，查询该工作项的所有关联关系（包括父子关系、协同上下游、普通关联等），支持分页查询、关系字段过滤和跨项目关联查询。 | |
| 工作项关联/取消关联 | hcloud ProjectMan AssociateIssues | 支持动态关联或取消工作项间的父子层级及其他关联关系，用户可以根据不同的参数明确是关联或者取消，也可以根据参数明确关联的类型，比如关联父、子工作项或者关联其他工作项。 | |
| 批量基线工作项 | hcloud ProjectMan BatchBaselineIpdIssues | 需要批量基线IPD项目下的工作项时，可调用此接口。用户可以根据待基线的工作项ID数组对工作项进行批量基线。 |
