从Rally API for Feature获取特定字段

从Rally API获取特定字段的方法

基础概念

Rally（现称为CA Agile Central）是一款敏捷项目管理工具，提供REST API供开发者集成和提取数据。从API中获取特定字段可以减少网络传输数据量，提高效率。

获取特定字段的方法

1. 使用fetch参数

Rally API允许通过fetch参数指定需要返回的字段：

// 示例：获取缺陷的特定字段
const rally = require('rally');
const queryConfig = {
  type: 'defect',
  fetch: ['FormattedID', 'Name', 'State', 'Severity', 'Priority'],
  limit: 100
};

rally.query(queryConfig, function(error, result) {
  if (error) {
    console.log('Error:', error);
  } else {
    console.log('Result:', result.Results);
  }
});

2. 使用REST API URL参数

直接通过URL请求时，可以在URL中添加fetch参数：

https://rally1.rallydev.com/slm/webservice/v2.0/defect?fetch=FormattedID,Name,State&query=(State = "Open")

3. 使用Rally Web Services API

对于更复杂的查询，可以使用WSAPI：

const rallyApi = {
  key: 'your_api_key',
  workspace: '/workspace/12345',
  project: '/project/67890'
};

fetch(`https://rally1.rallydev.com/slm/webservice/v2.0/hierarchicalrequirement?fetch=FormattedID,Name,ScheduleState&query=(Project = "${rallyApi.project}")`, {
  headers: {
    'ZSESSIONID': rallyApi.key
  }
})
.then(response => response.json())
.then(data => console.log(data));

优势

减少数据传输量：只获取必要字段，提高响应速度
降低客户端处理负担：无需处理不需要的数据
提高API调用效率：减少服务器处理时间

常见问题及解决方案

问题1：返回字段不全

原因：可能字段名拼写错误或该字段不存在于查询对象中

解决：

检查Rally对象模型文档确认字段名
使用describe端点查看对象可用字段

https://rally1.rallydev.com/slm/webservice/v2.0/type/defect/describe

问题2：无法获取嵌套对象字段

原因：Rally API默认不返回嵌套对象的完整信息

解决：使用点符号获取嵌套字段

fetch: ['FormattedID', 'Owner.Name', 'Project.Name']

问题3：字段值显示为引用而非实际值

原因：某些关联字段默认返回引用链接而非值

解决：使用fetch获取关联对象的特定字段

fetch: ['FormattedID', 'Parent.Name', 'Children[FormattedID,Name]']

应用场景

报表生成：只提取报表所需的特定字段
集成开发：与其他系统集成时仅传输必要数据
数据分析：提取分析所需的关键字段
自定义仪表板：构建轻量级自定义视图

最佳实践

始终限制返回字段：避免获取不必要的数据
分页处理大数据集：结合start和pagesize参数
缓存常用查询结果：减少API调用次数
使用项目/工作区限定范围：提高查询效率

// 综合示例：获取用户故事及其相关任务
const query = {
  type: 'hierarchicalrequirement',
  fetch: [
    'FormattedID',
    'Name',
    'ScheduleState',
    'Tasks[FormattedID,Name,State]',
    'Owner.DisplayName'
  ],
  query: '(Project.Name = "My Project")',
  order: 'Rank',
  start: 1,
  pagesize: 20
};

通过合理使用字段过滤，可以显著提高Rally API的使用效率和应用程序性能。