搜索用例列表 - PingCodeRESTAPI

用于按条件搜索用例列表。

权限：企业令牌/用户令牌

Scopes：pcp:read:testhub:testcase

Body 参数说明：

mode (String, 必填): 搜索模式。 query 表示基于 payload.filter 的结构化条件查询。

payload (Object, 必填): 搜索参数。

payload.filter (Object, 选填): 过滤条件。过滤时使用类 MongoDB 的查询语法，可通过属性名、操作符和对应值进行过滤。引用类型（含数组引用类型）使用 {属性名}.id 作为属性名，例如 library.id 、 participants.id 。自定义属性使用 properties.{属性key} 作为属性名，例如 properties.prop_a 。文本类型（如 title 、 description 、 precondition ，以及自定义单行文本、多行文本、链接类型）的操作符： exists 、 contains 。枚举类型（如 test_type ）的操作符： exists 、 in 、 nin 。数字类型（自定义数字、进度、评分类型）的操作符： exists 、 eq 、 ne 、 gt 、 lt 、 gte 、 lte 。时间类型（如 created_at 、 updated_at ，以及自定义日期）的操作符： exists 、 gt 、 lt 、 gte 、 lte 、 between （值为 [起始时间戳, 结束时间戳] ；过滤时以「天」为单位。选项类型（自定义下拉单选、下拉多选、级联单选、级联多选）的操作符： exists 、 in 、 nin 。引用类型（如 library.id 、 state.id 、 type.id 、 maintenance.id 、 participants.id ）的操作符： exists 、 in 、 nin 。每个属性仅支持一个操作符。暂不支持使用逻辑运算符。内置属性和一些特殊属性暂不支持过滤： id 、 url 、 identifier 、 short_id 、 html_url 、 public_image_token 、 steps 、 is_archived 、 is_deleted 。

payload.keywords (String, 选填): 关键字。支持用例编号和用例标题。

payload.include_public_image_token (String, 选填): 包含获取图片资源 token 的属性。使用 , 分割，最多 32 个，支持 description 和自定义多行文本类型的属性。

payload.include_deleted (Boolean, 选填): 是否查询已删除的用例。

payload.include_archived (Boolean, 选填): 是否查询已归档的用例。

payload.page_size (Number, 选填): 每页条数，取值范围 1-100。

payload.page_index (Number, 选填): 页码，从 0 开始。

请求参数

Header 参数

Body 参数application/json

示例

{
  "mode": "query",
  "payload": {
    "filter": {
      "title": {
        "contains": "登录"
      },
      "maintenance.id": {
        "nin": [
          "315c85d24643678a9a0417f68e846aae"
        ]
      },
      "library.id": {
        "in": [
          "5eb623f6a70571487ea47000",
          "5eb623f6a70571487ea47001"
        ]
      },
      "participants.id": {
        "in": [
          "a0417f68e846aae315c85d24643678a9"
        ]
      },
      "created_at": {
        "gte": 1730000000
      }
    },
    "keywords": "CSK",
    "include_public_image_token": "description",
    "include_deleted": false,
    "include_archived": false,
    "page_size": 10,
    "page_index": 0
  }
}

请求示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200响应示例：

application/json

Bodyapplication/json

示例

{
    "page_size": 10,
    "page_index": 0,
    "total": 1,
    "values": [
        {
            "id": "5edca524cad2fa112b06305c",
            "url": "https://{rest_api_root}/v1/testhub/cases/5edca524cad2fa112b06305c",
            "library": {
                "id": "5eb623f6a70571487ea47000",
                "url": "https://{rest_api_root}/v1/testhub/libraries/5eb623f6a70571487ea47000",
                "identifier": "CSK",
                "name": "测试库",
                "is_archived": 0,
                "is_deleted": 0
            },
            "identifier": "CSK-10",
            "title": "这是一个测试用例",
            "level": "P1",
            "short_id": "fdUw3C",
            "html_url": "https://yctech.pingcode.com/testhub/cases/fdUw3C",
            "important_level": {
                "id": "57a109b35ae8c20630fd7256",
                "url": "https://{rest_api_root}/v1/testhub/case_important_levels/57a109b35ae8c20630fd7256",
                "name": "P1"
            },
            "suite": {
                "id": "55714870a70ea4eb623f6700",
                "url": "https://{rest_api_root}/v1/testhub/libraries/5eb623f6a70571487ea47000/suites/55714870a70ea4eb623f6700",
                "name": "登录",
                "paths": "首页/账户"
            },
            "state": {
                "id": "686f62038668bbae4f4dd0c1",
                "url": "https://{rest_api_root}/v1/testhub/case_states/686f62038668bbae4f4dd0c1",
                "name": "设计",
                "type": "pending"
             },
            "type": {
                "id": "5cf189b35de9c20620ad7153",
                "url": "https://{rest_api_root}/v1/testhub/case_types/5cf189b35de9c20620ad7153",
                "name": "功能测试"
            },
            "maintenance": {
                "id": "a0417f68e846aae315c85d24643678a9",
                "url": "https://{rest_api_root}/v1/directory/users/a0417f68e846aae315c85d24643678a9",
                "name": "john",
                "display_name": "John",
                "avatar": "https://s3.amazonaws.com/bucket/b46ef40c-e22e-4ecf-a599-cace9fba839a_160x160.png"
            },
            "test_type": "automation",
            "description": "测试用例的备注",
            "precondition": "前置条件的描述信息",
            "properties": {
                "prop_a": "prop_a_value",
                "prop_b": "prop_b_value"
            },
            "estimated_workload": 8,
            "remaining_workload": 5,
            "steps": [
                {
                    "step_id": "524cad5edb06305cca2fa100",
                    "description": "UI测试",
                    "expected_value": null,
                    "is_group": true,
                    "group_id": null
                },
                {
                    "step_id": "524cad5edb06305cca2fa112",
                    "description": "在浏览器地址栏中输入https://pingcode.com",
                    "expected_value": "成功访问PingCode官网",
                    "is_group": false,
                    "group_id": "524cad5edb06305cca2fa100"
                },
                {
                    "step_id": "524cad5edb06305cca2fa113",
                    "description": "点击下一页按钮",
                    "expected_value": "成功跳转至下一页",
                    "is_group": false,
                    "group_id": "524cad5edb06305cca2fa100"
                }
            ],
            "participants": [
                {
                    "id": "a0417f68e846aae315c85d24643678a9",
                    "url": "https://{rest_api_root}/v1/participants/a0417f68e846aae315c85d24643678a9?principal_type=test_case&principal_id=5edca524cad2fa112b06305c",
                    "type": "user",
                    "user": {
                        "id": "a0417f68e846aae315c85d24643678a9",
                        "url": "https://{rest_api_root}/v1/directory/users/a0417f68e846aae315c85d24643678a9",
                        "name": "john",
                        "display_name": "John",
                        "avatar": "https://s3.amazonaws.com/bucket/b46ef40c-e22e-4ecf-a599-cace9fba839a_160x160.png"
                    }
                }
            ],
            "public_image_token": "IcF1VmJFF-UIi9lMU18m1NFFAruWXYx0ZAm90pJ2LGk",
            "created_at": 1583290300,
            "created_by": {
                "id": "a0417f68e846aae315c85d24643678a9",
                "url": "https://{rest_api_root}/v1/directory/users/a0417f68e846aae315c85d24643678a9",
                "name": "john",
                "display_name": "John",
                "avatar": "https://s3.amazonaws.com/bucket/b46ef40c-e22e-4ecf-a599-cace9fba839a_160x160.png"
            },
            "updated_at": 1583293300,
            "updated_by": {
                "id": "a0417f68e846aae315c85d24643678a9",
                "url": "https://{rest_api_root}/v1/directory/users/a0417f68e846aae315c85d24643678a9",
                "name": "john",
                "display_name": "John",
                "avatar": "https://s3.amazonaws.com/bucket/b46ef40c-e22e-4ecf-a599-cace9fba839a_160x160.png"
            },
            "is_archived": 0,
            "is_deleted": 0
        }
    ]
}