Skip to main content

Library

danger

ONES API 已废弃。请使用Open API。

testcase model 说明​

参数名值类型取值范围取值例子说明
uuidstringlen=8随机 8 位字符
library_uuidstring用例库 uuid
module_uuidstring用例直属的模块 uuid
pathstring模块路径(module_uuid-sub_module_uuid-testcase_uuid)
namestringlen<=1024用例名称
prioritystringtestcase 优先级
typestring用例类型
assignstringlen=8维护人
descstringlen<=65536用例描述
create_timeint64用例创建时间，微秒
numberint用例编号
conditionstring前置条件
stepsobject 数组用例操作步骤

tips:testcase 全页面可见性由 team 实体中的 testcase_visibility 控制

priority 值说明​

值说明
PRIOPThh最高
PRIOPThi高
PRIOPTno普通
PRIOPTlo低
PRIOPTll最低

casetype 说明​

值说明
functional功能测试（默认）
performance性能测试
api接口测试
install安装部署
config配置相关
safety安全相关
other其他

library model 说明​

参数名值类型取值范围取值例子说明
uuidstringlen=8随机 8 位字符
namestringlen<=32用例名称
create_timeint64用例创建时间，微秒
membersstring array编撰人员 uuids
 user_domain_typestring用户域类型
 user_domain_paramstring用户域参数
modulesobject array用例库下模块,按深度优先
create_timeint64用例创建时间，微秒

module 说明​

参数名值类型取值范围取值例子说明
uuidstringlen=8随机 8 位字符组成
parent_uuidstringlen=8随机 8 位字符组成,父模块 uuid,传""代表没有父模块
namestringlen<=32模块名称
pathstring模块路径(module_uuid-sub_module_uuid)
library_uuidstring模块所属 library
create_timeint64用例创建时间，微秒
is_defaultbooltrue 为无所属模块，false 为用户创建的模块

用例操作步骤 说明​

参数名值类型取值范围默认值取值例子说明
uuidstringlen=8用例步骤 uuid
descstring步骤描述
resultstring步骤预期结果

API 说明​

1. 添加测试用例​

URL​

https://your-host-name/project/api/project/team/:teamUUID/items/add

HTTP Method​

POST

调用权限​

manage_library_cases

传值方式​

JSON

参数列表​

参数名值类型是否可以空取值范围取值例子说明
namestring否测试用例名称
assignstring否负责人
prioritystring否优先级
typestring否类型
module_uuidstring否模块 UUID
conditionstring是前置条件
library_uuidstring否用例库 UUID
descstring是描述
stepsstep是操作步骤
related_wiki_pagearray是关联的 wiki 页面
testcase_case_stepsarray是操作步骤
item_typestring否类型
testcase_librarystring否所属用例库
testcase_modulestring否所属模块
createTimestring是创建时间

请求体参考​

{
    "item":{
        "name":"埋得很深的用例",
        "assign":"Pqmud3zh",
        "priority":"EuXiaKfb",
        "type":"DYAmwpym",
        "module_uuid":"TfbK82Pf",
        "condition":"",
        "library_uuid":"E9CnzCJb",
        "desc":"",
        "steps":[],
        "related_wiki_page":[],
        "testcase_case_steps":[],
        "item_type":"testcase_case",
        "testcase_library":"E9CnzCJb",
        "testcase_module":"TfbK82Pf",
        "createTime":1615880000
    }
}

返回值参考​

{
    "item": {
        "assign": "Pqmud3zh",
        "condition": "",
        "create_time": 1620470220,
        "desc": "",
        "item_type": "testcase_case",
        "key": "testcase_case-7fAnWt8y",
        "name": "埋得很深的用例",
        "number": 3655,
        "path": "CLiZNFWL-HzWmz2vg-RmZ6mAWU-TfbK82Pf-7fAnWt8y",
        "testcase_library": "E9CnzCJb",
        "testcase_module": "TfbK82Pf",
        "uuid": "7fAnWt8y"
    }
}

返回的 HTTP status code​

状态码说明
200操作成功
500接口错误
801参数无效

返回的 errcode 说明​

codeerrcode说明
403LimitExceeded.TestCase超过免费版 TestCase 数量限制

2. 修改测试用例​

URL​

https://your-host-name/project/api/project/team/:teamUUID/testcase/library/:libraryUUID/cases/update

HTTP Method​

POST

调用权限​

manage_library_cases

传值方式​

JSON

参数列表​

参数名值类型是否可以空取值范围取值例子说明
casesarray否参考上方 model
 uuidstring否
 module_uuidstring否
 namestring否
 prioritystring否
 typestring否
 assignstring否
 descstring是
 stepsobject array是
 conditionstring是

返回 JSON​

参数名值类型说明
casesarraylibrary 下所有 cases

返回的 HTTP status code​

状态码说明
200操作成功
500接口错误
801参数无效

3. 删除测试用例​

URL​

https://your-host-name/project/api/project/team/:teamUUID/testcase/library/:libraryUUID/cases/delete

HTTP Method​

POST

调用权限​

manage_library_cases

传值方式​

JSON

参数列表​

参数名值类型是否可以空取值范围取值例子说明
case_uuidsarray否

返回 JSON​

参数名值类型说明
casesarraylibrary 下所有 cases

返回的 HTTP status code​

状态码说明
200操作成功
500接口错误
801参数无效

4. 获取某个用例库下的用例列表​

URL​

https://your-host-name/project/api/project/team/:teamUUID/testcase/library/:libraryUUID/cases

HTTP Method​

GET

调用权限​

manage_library_cases

传值方式​

无

返回 JSON​

参数名值类型说明
casesarraytestcase 列表

返回的 HTTP status code​

状态码说明
200操作成功
500接口错误
801参数无效

5. 添加用例库​

URL​

https://your-host-name/project/api/project/team/:teamUUID/testcase/libraries/add

HTTP Method​

POST

调用权限​

manage_library

传值方式​

JSON

参数列表​

参数名值类型是否可以空取值范围取值例子说明
libraryObject否
 namestring否
 membersarray否
  user_domain_typestring否用户域类型
  user_domain_paramstring否用户域参数

返回 JSON​

参数名值类型说明
libraryobjectlibrary model，见上方说明

返回的 HTTP status code​

状态码说明
200操作成功
500接口错误
801参数无效

6. 修改用例库​

URL​

https://your-host-name/project/api/project/team/:teamUUID/testcase/library/:libraryUUID/update

HTTP Method​

POST

调用权限​

manage_library

传值方式​

JSON

参数列表​

参数名值类型是否可以空取值范围取值例子说明
libraryobject否参考上方 model
 namestring否
 uuidstring否
 membersarray否
  user_domain_typestring否用户域类型
  user_domain_paramstring否用户域参数

返回 JSON​

参数名值类型说明
libraryobjectlibrary model，见上方说明

返回的 HTTP status code​

状态码说明
200操作成功
500接口错误
801参数无效

7. 删除用例库​

URL​

https://your-host-name/project/api/project/team/:teamUUID/testcase/library/:libraryUUID/delete

HTTP Method​

POST

调用权限​

manage_library 和 manage_library_cases

传值方式​

无

返回 JSON​

无

返回的 HTTP status code​

状态码说明
200操作成功
500接口错误
801参数无效

8. 获取用户有权限查看的用例库列表​

URL​

https://your-host-name/project/api/project/team/:teamUUID/testcase/libraries

HTTP Method​

GET

调用权限​

无，但返回的列表根据 manage_library_cases 权限过滤

传值方式​

无

返回 JSON​

参数名值类型说明
librariesarraylibrary model 列表

请求体参考​

curl -X GET \
  https://your-host-name/project/api/project/team/BDfDqJU7/testcase/libraries \
  -H 'Ones-Auth-Token: rZHTPygZHOIE2EACzbQVA0diQ69vMBF9lDarUXluG43vMvqye1xqGSQIdFVVSiPT' \
  -H 'Ones-User-Id: 6ZpgEzkk' \
  -H 'cache-control: no-cache'

返回值示例​

{
  "libraries": [
    {
      "uuid": "21mSiFwp",
      "name": "示例用例库",
      "create_time": 1535539299,
      "members": [
        {
          "user_domain_type": "testcase_administrators",
          "user_domain_param": ""
        },
        {
          "user_domain_type": "everyone",
          "user_domain_param": ""
        }
      ],
      "modules": [
        {
          "uuid": "PtEVHyC4",
          "parent_uuid": "",
          "library_uuid": "21mSiFwp",
          "path": "PtEVHyC4",
          "name": "主模块",
          "create_time": 1535539299,
          "is_default": false,
          "position": 0,
          "name_pinyin": ""
        },
        {
          "uuid": "3GP7YmqC",
          "parent_uuid": "PtEVHyC4",
          "library_uuid": "21mSiFwp",
          "path": "PtEVHyC4-3GP7YmqC",
          "name": "子模块1",
          "create_time": 1535539299,
          "is_default": false,
          "position": 0,
          "name_pinyin": ""
        },
        {
          "uuid": "sSQV8R5s",
          "parent_uuid": "PtEVHyC4",
          "library_uuid": "21mSiFwp",
          "path": "PtEVHyC4-sSQV8R5s",
          "name": "子模块2",
          "create_time": 1535539299,
          "is_default": false,
          "position": 0,
          "name_pinyin": ""
        },
        {
          "uuid": "8ZmFpYxB",
          "parent_uuid": "",
          "library_uuid": "21mSiFwp",
          "path": "8ZmFpYxB",
          "name": "无所属模块",
          "create_time": 1535539299,
          "is_default": true,
          "position": 0,
          "name_pinyin": ""
        }
      ],
      "is_pin": false,
      "field_config_uuid": ""
    }
  ],
  "server_update_stamp": 1548335882522139
}

返回的 HTTP status code​

状态码说明
200操作成功
500接口错误
801参数无效

9. 添加用例库模块​

URL​

https://your-host-name/project/api/project/team/:teamUUID/testcase/library/:libraryUUID/modules/add

HTTP Method​

POST

调用权限​

manage_library

传值方式​

JSON

参数列表​

| 参数名 | 值类型 | 是否可以空 | 取值范围 | 取值例子 | 说明 | | ------------------ | ------ | ---------- | -------- | -------- | ----------------------- | --- | | module | Object | 否 | | | | |  library_uuid | string | 否 | | | | |  parent_uuid | string | 是 | | | 父模块 uuid，没有则传"" | |  name | string | 否 | | | | |

返回 JSON​

参数名值类型说明
moduleobjectmodule，见上方说明

返回的 HTTP status code​

状态码说明
200操作成功
500接口错误
801参数无效

10. 删除用例库模块​

URL​

https://your-host-name/project/api/project/team/:teamUUID/testcase/library/:libraryUUID/modules/delete

HTTP Method​

POST

调用权限​

manage_library

传值方式​

JSON

参数列表​

| 参数名 | 值类型 | 是否可以空 | 取值范围 | 取值例子 | 说明 | | ----------- | ------ | ---------- | -------- | -------- | ---- | --- | | module_uuid | string | 否 | | | | |

返回 JSON​

返回的 HTTP status code​

状态码说明
200操作成功
500接口错误
801参数无效

11. 修改用例库模块​

URL​

https://your-host-name/project/api/project/team/:teamUUID/testcase/library/:libraryUUID/modules/update

HTTP Method​

POST

调用权限​

manage_library

参数列表​

| 参数名 | 值类型 | 是否可以空 | 取值范围 | 取值例子 | 说明 | | ---------- | ------ | ---------- | -------- | -------- | ---- | --- | | module | Object | 否 | | | | |  uuid | string | 否 | | | | |  name | string | 否 | | | | |

返回 JSON​

参数名值类型说明
moduleobjectmodel，见上方说明

返回的 HTTP status code​

状态码说明
200操作成功
500接口错误
801参数无效

12. 绑定测试用例到任务​

绑定测试用例到任务

URL​

https://your-host-name/project/api/project/team/:teamUUID/testcase/bind_case

HTTP Method​

POST

调用权限​

同时有任务的 update_tasks 以及用例的 manage_library_cases

传值方式​

JSON

参数列表​

参数名值类型允许空值取值范围默认值取值例子说明
casesarrayF绑定的 case 数组
task_uuidstringFlen=16绑定的任务 uuid
 case_uuidsstring arrayFlen=8用例 uuids
 plan_uuidstringTlen=8传则代表绑定用例结果，不传则代表绑定用例本身

返回的 HTTP status code​

状态码说明
200成功
400请求结构错误
401登录信息错误
403无权限
500服务器错误
801参数错误

返回 JSON​

无

13. 解除测试用例和任务的绑定​

解除测试用例和任务的绑定

URL​

https://your-host-name/project/api/project/team/:teamUUID/testcase/unbind_case

HTTP Method​

POST

调用权限​

同时有任务的 update_tasks 以及用例的 manage_library_cases

传值方式​

JSON

参数列表​

参数名值类型允许空值取值范围默认值取值例子说明
case_uuidstringFlen=8用例 uuid
task_uuidstringFlen=16绑定的任务 uuid
plan_uuidstringlen=8传则代表绑定用例结果，不传则代表绑定用例本身

返回的 HTTP status code​

状态码说明
200成功
400请求结构错误
401登录信息错误
403无权限
500服务器错误
801参数错误

返回 JSON​

无

14. 按 ID 搜索测试用例​

按 ID 搜索测试用例

URL​

https://your-host-name/project/api/project/team/:teamUUID/testcase/search

HTTP Method​

GET

调用权限​

无，但返回的列表根据 manage_library_cases 权限过滤

传值方式​

JSON

参数列表​

参数名值类型允许空值取值范围默认值取值例子说明
keystringF用例 ID
plan_uuidstringF传则代表搜索 plan 下的用例

返回的 HTTP status code​

状态码说明
200成功
400请求结构错误
401登录信息错误
403无权限
500服务器错误
801参数错误

返回 JSON​

参数名值类型说明
casesarraytestcase 列表

15. 调整功能模块位置​

URL​

https://your-host-name/project/api/project/team/:teamUUID/testcase/library/:libraryUUID/modules/sort

HTTP Method​

POST

参数列表​

参数名值类型是否可以空取值范围取值例子说明
module_uuidstring否被操作的模块的 uuid
previous_uuidstring否操作后的上个模块的 uuid
previous_relationstring否brother,child两个模块间的关系

返回 JSON​

无

返回的 HTTP status code​

状态码说明
200操作成功
500接口错误
801参数无效
817不能修改
Last updated on