OpenPages REST API 8.3.0：如何通过name字段获取SOXIssue对象？

替代search路由的可行方案 #

1. 使用filter参数直接查询 #

多数API的列表接口支持filter参数做精准匹配，你可以在SOXIssue的列表路由（比如/soxissues）中添加以下参数尝试：

• 精准匹配请求示例：

  GET /soxissues?filter=name eq "你的SOXIssue名称"
  

  若需要模糊查询，可将运算符改为contains：

  GET /soxissues?filter=name contains "关键词"
  

2. 关联资源查询（若适用） #

如果SOXIssue和其他资源（如项目、分类）有关联，可先通过名称定位关联资源，再过滤SOXIssue：

• 第一步获取关联资源ID（以项目为例）：

  GET /projects?filter=name eq "目标项目名"
  

• 第二步用关联ID过滤SOXIssue：

  GET /soxissues?filter=project.id eq "项目ID"
  

3. 规范构造search路由请求 #

若坚持使用search路由，API 8.3.0的search接口通常遵循类似格式，可尝试构造POST请求：

• 请求URL：/search
• 请求体：

  {
    "query": {
      "type": "SOXIssue",
      "conditions": [
        {
          "field": "name",
          "operator": "eq",
          "value": "你的SOXIssue名称"
        }
      ]
    }
  }
  

  注意部分API的search接口仅支持POST方式传递查询条件。

调试建议 #

• 用API测试工具发送请求，查看响应头和错误信息，多数API会在错误响应中给出参数格式提示。
• 检查响应中的total字段确认是否匹配到数据；若返回空结果，尝试调整运算符（比如用like替代eq，不同API运算符可能有差异）。

内容的提问来源于stack exchange，提问作者Vinicius Magalhães