检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
获取项目ID 调用API取项目ID 项目ID还用通过调用查询指定条件下的项目信息API获取。 获取项目ID的接口为“GET https://{Endpoint}/v3/projects/”,其中“{Endpoint}”为IAM的终端节点,可以从终端节点获取。接口的认证鉴权请参见认证鉴权。
其中,“error_code”表示错误码,“error_msg”表示错误描述信息。 错误码说明 当您调用API时,如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。 更多服务错误码请参见API错误中心。 表1 错误码 状态码 错误码 错误信息 描述 处理措施 400 PM.02150010
构造请求 本节介绍REST API请求的组成,并以调用IAM服务的获取用户Token获取请求认证接口说明如何调用API,该API获取用户的Token,Token可以用于调用其他API时鉴权。 您还可以通过这个视频教程了解如何构造请求调用API:https://bbs.huaweicloud
创建IPD系统设备类项目并新建工作项 CodeArts Req入门实践 04 API 通过需求管理开放的API和调用示例,您可以对项目、工作项、成员等进行管理。 API文档 使用前必读 API概览 如何调用API 附录 常见问题 了解更多常见问题、案例和解决方案 热门案例 Scrum项目需求管理流程介绍
就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限。 Token可通过调用获取用户Token接口获取,调用本服务API需要project级别的Token,即调用接口时,请求body中auth.scope的取值需要选择project,如下所示。
请参见状态码。 对于获取用户Token获取请求认证接口,如果调用后返回状态码为“201”,则表示请求成功。 响应消息头 对应请求消息头,响应同样也有消息头,如“Content-type”。 对于获取用户Token获取请求认证接口,返回如图1所示的消息头,其中“x-subject-
API概览 表1 API概览 类型 说明 Scrum项目的工作项 Scrum项目工作项的创建、删除、修改、查询等相关接口。 Scrum项目的迭代 Scrum项目迭代的创建、删除、修改、查询等相关接口。 用户信息 获取当前用户信息,更新用户昵称,获取当前用户角色。 项目成员 添加、查询、删除、退出项目成员等接口信息。
获取账号ID 在调用接口的时候,部分URL中需要填入账号ID,所以需要先在管理控制台上获取到账号ID。账号ID获取步骤如下: 登录管理控制台。 鼠标悬停在右上角的用户名,在下拉列表中单击“我的凭证”。 进入“我的凭证 > API凭证”页面,即可查看账号ID。 图1 获取账号ID 父主题:
请参见如何调用API。 URI GET /v4/projects/{project_id}/summary 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释:项目的32位uuid,项目唯一标识,可以通过ListProjectsV4接口查询项目列表
主动退出项目 功能介绍 项目成员主动退出项目,项目创建者不能退出 调用方法 请参见如何调用API。 URI DELETE /v4/projects/{project_id}/quit 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String devcloud项目的32位id
查询项目模板 功能介绍 查询项目模板 调用方法 请参见如何调用API。 URI GET /v4/projects/{project_id}/templates 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释:项目的32位uuid,
获取当前用户信息 调用方法 请参见如何调用API。 URI GET /v4/user 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。
ProjectsV4接口查询项目列表 约束限制:正则表达式, ^[A-Za-z0-9]{32}$ 取值范围:字符串,最小长度:32,最大长度:32 默认取值:不涉及 issue_id 是 Integer 参数解释:工作项id,可通过ListIssuesV4接口高级查询工作项 约束限制:正则表达式,[0-9]{1
作项。 API的调用方法请参见如何调用API。 约束限制 工作项存在。 涉及接口 先通过用户token查询指定项目的工作项列表,再通过项目id、工作项id查询工作项评论,步骤如下: 步骤1:查询用户的工作项列表 步骤2:查询工作项的评论 步骤1:查询用户的工作项列表 接口信息 URI:Post
删除项目迭代 功能介绍 删除项目迭代 调用方法 请参见如何调用API。 URI DELETE /v4/projects/{project_id}/iterations/{iteration_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String
身份认证与访问控制 身份认证 用户访问需求管理的方式有多种,包括需求管理用户界面、API、SDK,无论访问方式封装成何种形式,其本质都是通过需求管理提供的REST风格的API接口进行请求。 需求管理的接口需要经过认证请求后才可以访问成功。 需求管理支持两种认证方式: Token认证:
本章以test001为例,指导您通过API查询指定项目下的迭代列表。 API的调用方法请参见如何调用API。 约束限制 test001用户已经在需求管理中存在已自己创建的项目。 涉及接口 通过用户token查询当前用户指定项目下的迭代列表接口信息 URI:GET /v4/proj
删除附件 功能介绍 取消工作项与附件关联,如附件为工作项页面上传则删除附件 调用方法 请参见如何调用API。 URI DELETE /v4/projects/{project_id}/issues/{issue_id}/attachments/{attachment_id} 表1
删除项目的模块 功能介绍 删除项目的模块 调用方法 请参见如何调用API。 URI DELETE /v4/projects/{project_id}/modules/{module_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String devcloud项目的32位id
删除工作项 功能介绍 删除工作项 调用方法 请参见如何调用API。 URI DELETE /v4/projects/{project_id}/issues/{issue_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String devcloud项目的32位id