CLI Command Reference
Work Items of the Scrum Project
| API Name | Command | Description | Operation |
|---|---|---|---|
| Creating a Customized Field for a Work Item Type | hcloud ProjectMan CreateCustomfields | Creating a Customized Field for a Work Item Type | |
| Uploading an image | hcloud ProjectMan UploadIssueImg | Uploading an image | |
| Obtaining Work Item Completion Rate | hcloud ProjectMan ShowIssueCompletionRate | Obtain the completion rate of work items. | |
| Obtaining Comments on a Specified Work Item | hcloud ProjectMan ListIssueCommentsV4 | Obtains comments on a work item. | |
| Querying Labor Hours by User (Single Project) | hcloud ProjectMan ShowProjectWorkHours | Querying Labor Hours by User (Single Project) | |
| Querying Labor Hours by User (Multi-Project) | hcloud ProjectMan ListProjectWorkHours | Querying Labor Hours by User (Multi-Project) | |
| Add work-hours record to an issue | hcloud ProjectMan AddIssueWorkHours | Add work-hours record to an issue | |
| Query work-hours types of a project | hcloud ProjectMan ListProjectWorkHoursType | Query work-hours types of a project | |
| Obtaining the Work Item History | hcloud ProjectMan ListIssueRecordsV4 | Obtaining the Work Item History | |
| Create work items. | hcloud ProjectMan CreateIssueV4 | Create work items. | |
| Querying Work Items of a Project | hcloud ProjectMan ListIssuesSfV4 | Work item type ID, which is a pagination parameter and is used to query work items of a project by creation time. | |
| Advanced Query Work Item | hcloud ProjectMan ListIssuesV4 | Queries work items based on filter criteria. | |
| Deleting Work Items in Batches | hcloud ProjectMan BatchDeleteIssuesV4 | Deleting Work Items in Batches | |
| Querying Work Item Details | hcloud ProjectMan ShowIssueV4 | Querying Work Item Details | |
| Updating a Work Item | hcloud ProjectMan UpdateIssueV4 | Updating a Work Item | |
| Deleting a Work Item | hcloud ProjectMan DeleteIssueV4 | Deleting a Work Item | |
| Obtains sub-work items. | hcloud ProjectMan ListChildIssuesV4 | Obtains sub-work items. | |
| Querying Historical Records of All Work Items in a Project | hcloud ProjectMan ListProjectIssuesRecordsV4 | Querying Historical Records of All Work Items in a Project | |
| Querying the Work Item Transfer Configuration of a Scrum Project | hcloud ProjectMan ShowIssuesWrokFlowConfig | Querying the Work Item Transfer Configuration of a Scrum Project | |
| Creating a Work Item as a Fine-grained Permission User | hcloud ProjectMan CreateSystemIssueV4 | Users with the IAM fine-grained permission (projectmanConfig:systemSettingField:set) and the permission to create work items in the devcloud project can set the creator of work items. | |
| Queries the work items associated with the current work item. | hcloud ProjectMan ListAssociatedIssues | Queries the work items associated with the current work item. | |
| Queries the work items associated in the current project. | hcloud ProjectMan BatchListAssociatedIssues | Queries the work items associated in the current project. | |
| Queries the associated Wikis associated with the current work item. | hcloud ProjectMan ListAssociatedWikis | Queries the associated Wikis associated with the current work item. | |
| Queries the code submission records or branch creation records associated with the current work item. | hcloud ProjectMan ListIssueAssociatedCommits | Queries the code submission records or branch creation records associated with the current work item. | |
| Querying Associated Wikis | hcloud ProjectMan ListAssociatedTestCases | Querying Associated Wikis | |
| Querying Customized Fields of Scrum Work Items | hcloud ProjectMan ListIssueCustomFields | Queries the optional list of customized fields of the Scrum work item. All fields that meet the custom_fields or names condition are returned. If neither of the two values is transferred, the list of all customized fields is returned. | |
| Download iamge | hcloud ProjectMan DownloadImageFile | Download iamge | |
| Queries the project status list. | hcloud ProjectMan ListScrumProjectStatuses | Queries the project status list. | |
| Upload Work Item Attachments | hcloud ProjectMan UploadAttachments | Upload Work Item Attachments | |
| Advanced Query My Work Item | hcloud ProjectMan SearchIssues | Queries my work items based on filter criteria. |
Iteration of the Scrum Project
| API Name | Command | Description | Operation |
|---|---|---|---|
| Obtaining Sprints of a Specified Project | hcloud ProjectMan ListProjectIterationsV4 | Obtain Project Iteration | |
| Deleting Iterations of Projects in Batches | hcloud ProjectMan BatchDeleteIterationsV4 | Deleting Iterations of Projects in Batches | |
| Viewing Iteration Details | hcloud ProjectMan ShowIterationV4 | Viewing Iteration Details | |
| Creating a Scrum Project Iteration | hcloud ProjectMan CreateIterationV4 | Creating a Scrum Project Iteration | |
| Update Scrum Project Iteration | hcloud ProjectMan UpdateIterationV4 | Update Scrum Project Iteration | |
| Delete Project Iteration | hcloud ProjectMan DeleteIterationV4 | Delete Project Iteration | |
| Viewing Historical Iteration Records | hcloud ProjectMan ListIterationHistories | Viewing Historical Iteration Records |
User information
Project members
| API Name | Command | Description | Operation |
|---|---|---|---|
| Quitting a Project | hcloud ProjectMan RemoveProject | If a project member proactively quits the project, the project creator cannot quit the project. | |
| Obtaining the Member List of a Specified Project | hcloud ProjectMan ListProjectMembersV4 | Obtaining the Project Member List | |
| Adding Project Members in Batches | hcloud ProjectMan BatchAddMembersV4 | When you add project members in batches, only members under the same tenant as the project creator can be added. Incorrect user IDs will be skipped. If the added users exceed the permission, the default role is set to 7. | |
| Deleting Project Members in Batches | hcloud ProjectMan BatchDeleteMembersV4 | Deleting Project Members in Batches | |
| Update the role of a member in the project. | hcloud ProjectMan UpdateMembesRoleV4 | Update the role of a member in the project. | |
| Add project members | hcloud ProjectMan AddMemberV4 | Add project members. Cross-tenant members can be added. | |
| AGC calls the current user to apply for joining in a project. | hcloud ProjectMan AddApplyJoinProjectForAgc | AGC calls the current user to apply for joining in the project. The applied user ID is written in the header. |
Project Information
| API Name | Command | Description | Operation |
|---|---|---|---|
| Updating a Project | hcloud ProjectMan UpdateProjectV4 | Updating a Project | |
| Deleting a Project | hcloud ProjectMan DeleteProjectV4 | Deleting a Project | |
| Querying Projects | hcloud ProjectMan ListProjectsV4 | Querying Projects | |
| Creating a Project | hcloud ProjectMan CreateProjectV4 | Creating a Project | |
| Check whether the project name exists. | hcloud ProjectMan CheckProjectNameV4 | Check whether the project name exists. | |
| Query Project Templates | hcloud ProjectMan ListTemplates | Query Project Templates |
Project Indicators
| API Name | Command | Description | Operation |
|---|---|---|---|
| Query Per Capita Bug | hcloud ProjectMan ShowBugsPerDeveloper | Query Per Capita Bug | |
| On-Time Completion Rate of Query Requirements | hcloud ProjectMan ShowCompletionRate | On-Time Completion Rate of Query Requirements | |
| Query Defect Density | hcloud ProjectMan ShowBugDensityV2 | Query Defect Density |
Project Statistics
| API Name | Command | Description | Operation |
|---|---|---|---|
| Obtains bug statistics. | hcloud ProjectMan ListProjectBugStaticsV4 | Obtains bug statistics by module. | |
| Obtaining Requirement Statistics | hcloud ProjectMan ListProjectDemandStaticV4 | Obtaining Requirement Statistics | |
| Obtaining the Project Overview | hcloud ProjectMan ShowProjectSummaryV4 | Obtaining the Project Overview |
Modules of the Scrum Project
| API Name | Command | Description | Operation |
|---|---|---|---|
| Module for Creating a Project | hcloud ProjectMan CreateProjectModule | Querying the Module List of a Project | |
| Querying the Module List of a Project | hcloud ProjectMan ListProjectModules | Querying the Module List of a Project | |
| Module for Updating a Project | hcloud ProjectMan UpdateProjectModule | Module for Updating a Project | |
| Module for Deleting a Project | hcloud ProjectMan DeleteProjectModule | Module for Deleting a Project |
Domain of the Scrum Project
| API Name | Command | Description | Operation |
|---|---|---|---|
| Domain for Creating a Project | hcloud ProjectMan CreateProjectDomain | Querying the Domain List of a Project | |
| Querying the Domain List of a Project | hcloud ProjectMan ListProjectDomains | Querying the Domain List of a Project | |
| Update the domain of the project. | hcloud ProjectMan UpdateProjectDomain | Update the domain of the project. | |
| Cancel the association between the domain and the project. | hcloud ProjectMan CancelProjectDomain | Cancel the association between the domain and the project. |
Item Information
User Information
What is your overall rating for this page?
Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot
