IBM Rational ClearQuest 变更管理和缺陷跟踪工具

官方网址：http://www-01.ibm.com/software/awdtools/clearquest/

可以采用REST API来对服务器的数据进行管理，如登录、查找记录、查看记录、提交记录、修改记录、运行查询、运行报告、运行图表等。

 

创建 REST URI 以查找记录

您可以创建 REST URI 以通过直接链接到记录在用户数据库中查找记录。

关于此任务

要创建 REST URI 以查找记录：

1. 在 Rational® ClearQuest® Web 工具栏上，单击新建变更请求旁边的箭头，然后选择新建 REST URI。 “新建 REST URI”模板窗口随即打开。
2. 从 REST URI 类型列表中选择查找记录。
3. 可选：要将 Rational ClearQuest Web 登录参数添加到 REST URI 中，请选中自动登录。
4. 可选：要将条幅、工作空间树和主工具栏添加到运行 REST URI 时打开的窗口中，请选中包含条幅、工作空间树和主工具栏。
5. 单击创建。 REST URI 模板将出现在 REST URI 模板字段中。
6. 将该模板复制到文本编辑器中并用相应的值替换占位符 {{recordId}}、{{loginid}} 和 {{password}}。

   可选：将资源请求的缺省格式从 HTML 更改为 XML 或 ATOM。

7. 将修改后的模板复制到 Web 应用程序或另一个 Web 浏览器窗口中。
8. 单击复位创建新的 REST URI 模板或单击关闭退出。

示例

示例

通过使用“新建 REST URI”向导可创建以下 REST URI 模板以查找记录。

http://CQWebServerHost/cqweb/restapi/YourConnection/YourUserDB/RECORD/{{recordId}}?format=HTML&loginId={{loginid}}&password={{password}}

变量和模板占位符具有以下含义：

CQWebServerHost

ClearQuest Web 服务器主机系统的 Web 地址。该值在创建 REST URI 模板时定义。

YourConnection

您的 ClearQuest 连接。该值在创建 REST URI 模板时定义。

YourUserDB

您的 ClearQuest 用户数据库。该值在创建 REST URI 模板时定义。

{{recordId}}

用要查找的记录标识替换该占位符。

format

资源请求的缺省格式是 HTML。您可以根据需要将格式更改为 XML 或 ATOM。

{{loginid}}

用登录标识替换该占位符。

{{password}}

用您的密码替换该占位符。

创建 REST URI 以查看记录

通过直接链接到记录，您可以创建 REST URI 来查看用户数据库中的记录。创建用于查看记录的 REST URI 打开记录的速度快于创建用于查找记录的 REST URI。原因在于当您创建 REST URI 模板以查看记录时，必须指定记录类型，这缩小了搜索范围。

关于此任务

要创建 REST URI 以查看记录：

1. 在 Rational® ClearQuest® Web 工具栏上，单击新建变更请求旁边的箭头，然后选择新建 REST URI。“新建 REST URI”向导将打开。
2. 从 REST URI 类型列表中选择查看记录。
3. 从记录类型列表中选择记录类型。
4. 可选：要将 Rational ClearQuest Web 登录参数添加到 REST URI 中，请选中自动登录复选框。
5. 可选：要将条幅、工作空间树和主工具栏包含到运行 REST URI 时打开的窗口中，请选中包含条幅、工作空间树和主工具栏复选框。
6. 单击创建。 REST URI 模板将出现在 REST URI 模板字段中。
7. 将该模板复制到文本编辑器中，然后用适当的值替换占位符，占位符用双大括号 {{ }} 括起。

   可选：将资源请求的缺省格式从 HTML 更改为 XML 或 ATOM。

8. 将修改后的模板复制到 Web 应用程序或另一个 Web 浏览器窗口中。
9. 单击复位创建新的 REST URI 模板或单击关闭退出。

示例

示例

用于查看记录的以下 REST URI 模板使用“新建 REST URI”向导创建。在该示例中，创建 REST URI 时选择了 ALMActivity 作为记录类型的值。

http://CQWebServerHost/cqweb/restapi/YourConnection/YourUserDB/RECORD/{{recordId}}?format=HTML&recordType=ALMActivity&loginId={{loginid}}&password={{password}}

变量和模板占位符具有以下含义：

CQWebServerHost

ClearQuest Web 服务器主机的 Web 地址。该值在创建 REST URI 模板时定义。

YourConnection

您的 ClearQuest 连接。该值在创建 REST URI 模板时定义。

YourUserDB

您的 ClearQuest 用户数据库。该值在创建 REST URI 模板时定义。

{{recordId}}

想要链接到的记录标识的占位符。

format

资源请求的缺省格式是 HTML。您可以根据需要将格式更改为 XML 或 ATOM。

{{loginid}}

用您的登录标识替换该占位符。

{{password}}

用您的密码替换该占位符。

创建 REST URI 以修改记录

通过直接链接到记录，您可以创建 REST URI 来修改用户数据库中的记录。

关于此任务

要创建 REST URI 以修改记录：

1. 在 Rational® ClearQuest® Web 工具栏上，单击新建变更请求旁边的箭头，然后选择新建 REST URI。 “新建 REST URI”向导将打开。
2. 从 REST URI 类型列表中选择修改记录。
3. 从记录类型列表中选择记录类型。
4. 从操作类型列表中选择操作。 可用的操作类型由记录类型确定。
5. 可选：从自动填充的记录字段列表中选择要作为参数添加到 REST URI 的记录字段。
6. 可选：要保存对记录所作的所有更改，请选中自动保存更改复选框。
7. 可选：要将 Rational ClearQuest Web 登录参数添加到 REST URI 中，请选中自动登录。
8. 可选：要将条幅、工作空间树和主工具栏包含到运行 REST URI 时打开的窗口中，请选中包含条幅、工作空间树和主工具栏复选框。
9. 单击创建。 REST URI 模板将出现在 REST URI 模板字段中。
10. 将该模板复制到文本编辑器中，然后用适当的值替换占位符，占位符用双大括号 {{ }} 括起。

    可选：将资源请求的缺省格式从 HTML 更改为 XML 或 ATOM。

11. 将修改后的模板复制到 Web 应用程序或另一个 Web 浏览器窗口中。
12. 单击复位创建新的 REST URI 模板或单击关闭退出。

示例

示例

用于修改记录的以下 REST URI 模板使用“新建 REST URI”向导创建。在该示例中，从记录类型列表中选择了 ALMActivity，从操作类型列表中选择了 Activate，并且选中了自动保存更改、自动登录和包含条幅、工作空间树和主工具栏复选框来创建 REST URI。

http://CQWebServerHost/cqweb/restapi/YourConnection/YourUserDB/RECORD?format=HTML&recordType=ALMActivity&action=Activate&fieldsXml=&autoSave=true&loginId={{loginid}}&password={{password}}

变量和模板占位符具有以下含义：

CQWebServerHost

ClearQuest Web 服务器主机系统的 Web 地址。该值在创建 REST URI 模板时定义。

YourConnection

您的 ClearQuest 连接。该值在创建 REST URI 模板时定义。

YourUserDB

您的 ClearQuest 用户数据库。该值在创建 REST URI 模板时定义。

format

资源请求的缺省格式是 HTML。您可以根据需要将格式更改为 XML 或 ATOM。

{{loginid}}

登录标识占位符。

{{password}}

密码占位符。

以下示例显示如何将日期字段、引用字段、引用列表和多行字段值作为参数输入到 REST URI 中。

• 该示例显示如何在 REST URI 中将日期字段值作为参数提供来提交或修改记录：

  fieldsXML=<Field><Name>f_datetime</Name><Value><![CDATA[2008-09-08%2009%3A44%3A34]]></Value></Field>

  结果：记录字段 f_datetime 设置为 08/09/08 09:44:34。

• 下一个示例显示如何在 REST URI 中将引用字段或引用列表值作为参数提供来提交或修改记录：

  fieldsXML=<Field><Name>customer</Name><Value><!CDATA[Joe%20Lee]]></Value><Value><!CDATA[Jane%20Smith]]></Value></Field><Field><Name>Project</Name><Value><!CDATA[Classics]]></Value></Field>

  结果：在记录中的引用列表 customer 中添加了 Joe Lee 和 Jane Smith，在引用字段 Project 中添加了 Classics。

• 该示例显示如何在 REST URI 中将多行字段值作为参数提供来提交或修改记录：

  fieldsXML=<Field><Name>Description</Name><Value><![CDATA[firstline%0Asecondline]]></Value></Field>

  结果：在记录字段 Description 中，文本 firstline 和 secondline 格式化为显示在不同行中。

   

   

   

  创建 REST URI 以提交记录

  您可以创建 REST URI 以提交用户数据库中的记录。

  关于此任务

  要创建 REST URI 以提交记录：

  1. 在 Rational® ClearQuest® Web 工具栏上，单击新建变更请求旁边的箭头，然后选择新建 REST URI。 “新建 REST URI”模板窗口随即
  2. 打开。
  3. 从 REST URI 类型列表中选择提交记录。
  4. 从记录类型列表中选择记录类型。
  5. 可选：从自动填充的记录字段列表中选择要作为参数添加到 REST URI 的记录字段。
  6. 可选：要保存对记录所作的所有更改，请选中自动保存更改复选框。
  7. 可选：要将 Rational ClearQuest Web 登录参数添加到 REST URI 中，请选中自动登录复选框。
  8. 可选：要将条幅、工作空间树和主工具栏包含到运行 REST URI 时打开的窗口中，请选中包含条幅、工作空间树和主工具栏复选框。
  9. 单击创建。 REST URI 模板将出现在 REST URI 模板字段中。
  10. 将该模板复制到文本编辑器中，然后用适当的值替换占位符，占位符用双大括号 {{ }} 括起。

      可选：将资源请求的缺省格式从 HTML 更改为 XML 或 ATOM。

  11. 将修改后的模板复制到 Web 应用程序或另一个 Web 浏览器窗口中。
  12. 单击复位创建新的 REST URI 模板或单击关闭退出。

  示例

  示例

  用于提交记录的以下 REST URI 模板使用“新建 REST URI”向导创建。在该示例中，从记录类型列表中选择了 ALMActivity，并选中了自动保存更改、

  自动登录和包含条幅、工作空间树和主工具栏复选框以创建 REST URI。

  http://CQWebServerHost/cqweb/restapi/YourConnection/YourUserDB/RECORD?format=HTML&recordType=ALMActivity&fieldsXml=&autoSave=true&loginId={{loginid}}&password={{password}}

  变量和模板占位符具有以下含义：

  CQWebServerHost

  ClearQuest Web 服务器主机系统的 Web 地址。该值在创建 REST URI 模板时定义。

  YourConnection

  您的 ClearQuest 连接。该值在创建 REST URI 模板时定义。

  YourUserDB

  您的 ClearQuest 用户数据库。该值在创建 REST URI 模板时定义。

  format

  资源请求的缺省格式是 HTML。您可以根据需要将格式更改为 XML 或 ATOM。

  {{loginid}}

  用您的登录标识替换。

  {{password}}

  用您的密码替换。

  以下示例显示如何将日期字段、引用字段、引用列表和多行字段值作为参数输入到 REST URI 中。

  • 该示例显示如何在 REST URI 中将日期字段值作为参数提供来提交或修改记录：

    fieldsXML=<Field><Name>f_datetime</Name><Value><![CDATA[2008-09-08%2009%3A44%3A34]]></Value></Field>

    结果：记录字段 f_datetime 设置为 08/09/08 09:44:34。

  • 下一个示例显示如何在 REST URI 中将引用字段或引用列表值作为参数提供来提交或修改记录：

    fieldsXML=<Field><Name>customer</Name><Value><!CDATA[Joe%20Lee]]></Value><Value><!CDATA[Jane%20Smith]]>

    </Value></Field><Field><Name>Project</Name><Value><!CDATA[Classics]]></Value></Field>

    结果：在记录中的引用列表 customer 中添加了 Joe Lee 和 Jane Smith，在引用字段 Project 中添加了 Classics。

  • 该示例显示如何在 REST URI 中将多行字段值作为参数提供来提交或修改记录：

    fieldsXML=<Field><Name>Description</Name><Value><![CDATA[firstline%0Asecondline]]></Value></Field>

    结果：在记录字段 Description 中，文本 firstline 和 secondline 格式化为显示在不同行中。

     

     

     

    创建 REST URI 以运行查询

    您可以创建 REST URI 以运行查询。

    关于此任务

    要创建 REST URI 以运行查询：

    1. 在 Rational® ClearQuest® Web 工具栏上，单击新建变更请求旁边的箭头，然后选择新建 REST URI。“新建 REST URI”向导将打开。
    2. 从 REST URI 类型列表中选择运行查询。
    3. 从工作空间显示中的选择查询字段中选择查询。
    4. 可选：要将 Rational ClearQuest Web 登录参数添加到 REST URI 中，请选中自动登录复选框。
    5. 可选：要将条幅、工作空间树和主工具栏包含到运行 REST URI 时打开的窗口中，请选中包含条幅、工作空间树和主工具栏复选框。
    6. 单击创建。 REST URI 模板将出现在 REST URI 模板字段中。
    7. 将该模板复制到文本编辑器中，然后用适当的值替换占位符，占位符用双大括号 {{ }} 括起。

       可选：将资源请求的缺省格式从 HTML 更改为 XML 或 ATOM。

    8. 将修改后的模板复制到 Web 应用程序或另一个 Web 浏览器窗口中。
    9. 单击复位创建新的 REST URI 模板或单击关闭退出。

    示例

    示例

    用于运行查询的以下 REST URI 模板使用“新建 REST URI”向导创建。在该示例中，选中了自动登录来创建 REST URI。

    http://CQWebServerHost/cqweb/restapi/YourConnection/YourUserDB/QUERY/QuerySpecification?format=

    HTML&loginId={{loginid}}&password={{password}}&noframes=true

    变量和模板占位符具有以下含义：

    CQWebServerHost

    ClearQuest Web 服务器主机的 Web 地址。该值在创建 REST URI 模板时定义。

    YourConnection

    您的 ClearQuest 连接。该值在创建 REST URI 模板时定义。

    YourUserDB

    您的 ClearQuest 用户数据库。该值在创建 REST URI 模板时定义。

    QuerySpecification

    您在 选择查询字段中选择的查询规范。

    format

    资源请求的缺省格式是 HTML。您可以根据需要将格式更改为 XML 或 ATOM。

    {{loginid}}

    用您的登录标识替换该占位符。

    {{password}}

    用您的密码替换该占位符。

    noframes

    如果该值为 true，那么运行 REST URI 以查看资源时将不会显示 ClearQuest Web 条幅、

    工作空间树和主工具栏。仅当 format=HTML 时， noframes 过滤器才相关。