TAPD Open Platform

https://open.tapd.cn/document/api-doc/
Admin
TAPD Open Platform enables business teams to customize and develop applications through interface...
Tokens:661,940
Snippets:3,729
Trust Score:9.4
Update:1 day ago
Show doc for...
Tokens:
Raw
### curl example with Basic Auth

Source: https://open.tapd.cn/document/api-doc/API%E6%96%87%E6%A1%A3/api_reference/setting/add_version.html

Example curl command using Basic Auth to create a version. Replace 'api_user' and 'api_password' with your credentials.

```bash
curl -u 'api_user:api_password' -d 'workspace_id=64851079&name=test3&creator=tapd_api' 'https://api.tapd.cn/versions'
```

--------------------------------

### GET /workspaces/get_mini_project_list_with_permission

Source: https://open.tapd.cn/document/api-doc/API%E6%96%87%E6%A1%A3/mini_api_reference/workspace/get_mini_project_list_with_permission.html

获取用户所有参与的空间列表，包括有编辑权限的空间。

```APIDOC
## GET /workspaces/get_mini_project_list_with_permission

### Description
获取用户所有参与的空间列表，包括有编辑权限的空间。

### Method
GET

### Endpoint
https://api.tapd.cn/workspaces/get_mini_project_list_with_permission

### Authentication
支持Basic Auth和OAuth Access Token两种鉴权方式。

### Request Example
curl 使用 Basic Auth 鉴权调用示例：
```bash
curl -u "用户名:密码" "https://api.tapd.cn/workspaces/get_mini_project_list_with_permission"
```

curl 使用 OAuth Access Token 鉴权调用示例：
```bash
curl -H "Authorization: Bearer <access_token>" "https://api.tapd.cn/workspaces/get_mini_project_list_with_permission"
```

### Response
#### Success Response
返回结果包含空间列表及空间相关重要字段说明。

#### Response Example
（返回结果示例未在文档中提供）

### 空间相关重要字段说明
（字段说明未在文档中提供）
```

--------------------------------

### GET /workflows/first_step

Source: https://open.tapd.cn/document/api-doc/API%E6%96%87%E6%A1%A3/api_reference/workflow/get_workflow_first_step.html

获取工作流起始状态。一次只能获取一个项目的工作流起始状态。

```APIDOC
## [GET] /workflows/first_step

### Description
获取工作流起始状态。一次只能获取一个项目的工作流起始状态。

### Method
GET

### Endpoint
https://api.tapd.cn/workflows/first_step

### Parameters
#### Query Parameters
- **workspace_id** (integer) - Required - 项目ID
- **system** (string) - Required - 系统名。取 bug （缺陷的）或者 story（需求的）
- **workitem_type_id** (integer) - Optional - 需求类别
- **type** (string) - Optional - 节点类型。默认为 status，返回起始状态。step 返回结束节点，仅并行工作流支持

### Request Example
curl -u 'api_user:api_password' 'https://api.tapd.cn/workflows/first_step?system=story&workspace_id=10104801&workitem_type_id=1010104801000022091'

### Response
#### Success Response (200)
- **status** (integer) - 状态码，1 表示成功
- **data** (object) - 数据对象，键为状态英文名，值为状态中文名
- **info** (string) - 信息，成功时为 "success"

#### Response Example
{
    "status": 1,
    "data": {
        "planning": "规划中"
    },
    "info": "success"
}
```

--------------------------------

### GET /workflows/all_transitions

Source: https://open.tapd.cn/document/api-doc/API%E6%96%87%E6%A1%A3/api_reference/workflow/get_workflow_all_transitions.html

获取工作流流转细则。一次只能获取一个项目的工作流流转细则，支持JSON/XML格式，默认JSON。

```APIDOC
## GET /workflows/all_transitions

### Description
获取工作流流转细则，包括流转步骤、附加字段和通知信息。

### Method
GET

### Endpoint
https://api.tapd.cn/workflows/all_transitions

### Parameters
#### Query Parameters
- **workspace_id** (integer) - Required - 项目ID
- **system** (string) - Required - 系统名，取 bug（缺陷的）或者 story（需求的）
- **workitem_type_id** (integer) - Optional - 需求类别

### Request Example
curl -u 'api_user:api_password' 'https://api.tapd.cn/workflows/all_transitions?system=bug&workspace_id=10104801'

### Response
#### Success Response (200)
- **status** (integer) - 状态码，1表示成功
- **data** (array) - 工作流流转列表，包含以下字段：
  - **Name** (string) - 流转名称
  - **StepPrevious** (string) - 前一步骤
  - **StepNext** (string) - 下一步骤
  - **Appendfield** (array) - 附加字段列表，包含：
    - **DBModel** (string) - 数据库模型
    - **FieldName** (string) - 字段名
    - **Notnull** (string) - 是否必填
    - **Sort** (string) - 排序
    - **DefaultValue** (array) - 默认值（可选）
  - **Inform** (array) - 通知信息列表，包含：
    - **InformType** (string) - 通知类型
    - **InformId** (string) - 通知ID

#### Response Example
{
    "status": 1,
    "data": [
        {
            "Name": "start-new",
            "StepPrevious": "start",
            "StepNext": "new",
            "Appendfield": [
                {
                    "DBModel": "Bug",
                    "FieldName": "BugStoryRelation_relative_id",
                    "Notnull": "yes",
                    "Sort": "2"
                },
                {
                    "DBModel": "Bug",
                    "FieldName": "begin",
                    "Notnull": "yes",
                    "Sort": "3"
                },
                {
                    "DBModel": "Bug",
                    "FieldName": "due",
                    "Notnull": "yes",
                    "Sort": "4"
                },
                {
                    "DBModel": "Bug",
                    "FieldName": "current_owner",
                    "Notnull": "yes",
                    "Sort": "1"
                },
                {
                    "DBModel": "Bug",
                    "FieldName": "module",
                    "Notnull": "yes",
                    "Sort": "8"
                },
                {
                    "DBModel": "Bug",
                    "FieldName": "priority",
                    "Notnull": "yes",
                    "Sort": "10"
                },
                {
                    "DBModel": "Bug",
                    "FieldName": "severity",
                    "Notnull": "yes",
                    "Sort": "11"
                },
                {
                    "DBModel": "Bug",
                    "FieldName": "version_report",
                    "Notnull": "yes",
                    "Sort": "12"
                }
            ]
        },
        {
            "Name": "new-new",
            "StepPrevious": "new",
            "StepNext": "new",
            "Inform": [
                {
                    "InformType": "RTX",
                    "InformId": "1716"
                },
                {
                    "InformType": "Email",
                    "InformId": "1717"
                }
            ],
            "Appendfield": [
                {
                    "DBModel": "Bug",
                    "FieldName": "remarks",
                    "Notnull": "yes",
                    "Sort": "1",
                    "DefaultValue": [
                        {
                            "Type": "default_value",
                            "Value": ""
                        }
                    ]
                },
                {
                    "DBModel": "Bug",
                    "FieldName": "current_owner",
                    "Notnull": "yes",
                    "Sort": "2"
                }
            ]
        }
    ]
}
```

--------------------------------

### GET /launch_accessories

Source: https://open.tapd.cn/document/api-doc/API%E6%96%87%E6%A1%A3/api_reference/release/get_launch_accessories.html

获取发布评审依据。该接口用于获取发布评审依据，支持JSON/XML格式，默认返回JSON。

```APIDOC
## [GET] /launch_accessories

### Description
获取发布评审依据。

### Method
GET

### Endpoint
https://api.tapd.cn/launch_accessories

### Parameters
#### Authentication
- **Basic Auth** - Required - 使用Basic Auth鉴权

### Request Example
```
curl -u 'user:password' 'https://api.tapd.cn/launch_accessories'
```

### Response
#### Success Response
返回发布评审依据数据。

#### Response Example
（未提供具体响应示例）

```

--------------------------------

### JSON response for get removed bugs

Source: https://open.tapd.cn/document/api-doc/API%E6%96%87%E6%A1%A3/api_reference/bug/get_removed_bugs.html

Example response showing a list of removed bugs with fields like id, title, reporter, created, operation_user, modified, removed_comment, type, and new_bug_url. The response includes status and info fields.

```json
{
    "status": 1,
    "data": [
        {
            "RemovedBug": {
                "id": "1100000755500695186",
                "title": "标题呀阿斯蒂芬你不是分别就开始放缓觉得斯芬克斯地方卡积分看到as艰苦地方阿克苏",
                "reporter": "gobichen",
                "created": "2021-04-22 21:29:41",
                "operation_user": "v_tingtdong",
                "modified": "2021-04-23 11:04:59",
                "removed_comment": "{\"action\":\"delete\"}",
                "type": "delete",
                "new_bug_url": ""
            }
        },
        {
            "RemovedBug": {
                "id": "1100000755500695184",
                "title": "标题呀",
                "reporter": "gobichen",
                "created": "2021-04-22 21:17:13",
                "operation_user": "v_tingtdong",
                "modified": "2021-04-23 10:25:05",
                "removed_comment":"{\"action\":\"merge\",\"comment\":\"\已\被\合\并\到\ Bug#500695186, \点\击<a href=\"http:\/\/tiger.oa.com\/755\/bugtrace\/bugs\/view?bug_id=1100000755500695186\">\这\里<\/a>\查\看\"}",
                "type": "merge",
                "new_bug_url": "http://tiger.oa.com/755/bugtrace/bugs/view?bug_id=1100000755500695186"
            }
        }
    ],
    "info": "success"
}
```

--------------------------------

### GET /launch_accessories

Source: https://open.tapd.cn/document/api-doc/API%E6%96%87%E6%A1%A3/api_reference/release/get_launch_accessories.html

获取发布评审依据。通过项目ID和评审单ID查询评审依据信息，支持按评审依据ID、创建人和创建时间进行筛选。

```APIDOC
## [GET] /launch_accessories

### Description
获取发布评审依据。通过项目ID和评审单ID查询评审依据信息，支持按评审依据ID、创建人和创建时间进行筛选。

### Method
GET

### Endpoint
https://api.tapd.cn/launch_accessories

### Parameters
#### Query Parameters
- **workspace_id** (integer) - Required - 项目ID
- **form_id** (integer) - Required - 评审单ID
- **id** (integer) - Optional - 评审依据ID
- **created_by** (string) - Optional - 创建人
- **created** (datetime) - Optional - 创建时间，支持时间查询

### Request Example
curl -u 'api_user:api_password' 'https://api.tapd.cn/launch_accessories?workspace_id=10104801&form_id=1010104801000402051'

### Response
#### Success Response
返回评审依据信息列表。

#### Response Example
（未提供）
```

--------------------------------

### JSON response for get removed tasks

Source: https://open.tapd.cn/document/api-doc/API%E6%96%87%E6%A1%A3/api_reference/task/get_removed_tasks.html

Example JSON response returned by the API. It contains a status field, an info field, and a data array with RemovedTask objects. Each RemovedTask includes id, name, creator, created, operation_user, and modified fields.

```json
{
    "status": 1,
    "data": [
        {
            "RemovedTask": {
                "id": "1010104801500594529",
                "name": "sfgsdfg",
                "creator": "anyechen",
                "created": "2018-05-18 11:19:54",
                "operation_user": "anyechen",
                "modified": "2019-06-04 21:21:43"
            }
        },
        {
            "RemovedTask": {
                "id": "1010104801500595787",
                "name": "task2",
                "creator": "anyechen",
                "created": "2018-08-27 17:25:50",
                "operation_user": "anyechen",
                "modified": "2019-06-04 21:22:48"
            }
        },
        {
            "RemovedTask": {
                "id": "1010104801500605567",
                "name": "task_with_story_id",
                "creator": "anyechen",
                "created": "2020-03-17 16:14:46",
                "operation_user": "v_xuanfang",
                "modified": "2021-09-15 10:19:06"
            }
        },
        {
            "RemovedTask": {
                "id": "1010104801854779185",
                "name": "对对对",
                "creator": "v_xuanfang",
                "created": "2020-07-28 10:57:52",
                "operation_user": "v_xuanfang",
                "modified": "2021-09-15 10:19:06"
            }
        }
    ],
    "info": "success"
}
```

--------------------------------

### curl Basic Auth example for creating a launch accessory

Source: https://open.tapd.cn/document/api-doc/API%E6%96%87%E6%A1%A3/api_reference/release/add_launch_accessories.html

Use this curl command to create a launch accessory with Basic Auth. It sends a POST request with workspace_id, form_id, type, and content parameters to https://api.tapd.cn/launch_accessories.

```bash
curl -u 'api_user:api_password' -d 'workspace_id=10104801&form_id=1010104801079533889&type=launch_url&content=https://www.tapd.cn/' 'https://api.tapd.cn/launch_accessories'
```

--------------------------------

### TAPD Node.js SDK Demo - Initialize, Get Stories, and Upload Image

Source: https://open.tapd.cn/document/api-doc/SDK/node-README.html

This demo shows how to initialize the SDK with your application code and secret, then call getStories and uploadImage methods. It includes commented examples for file upload using a stream or Buffer. Note: the secret should be kept confidential.

```javascript
const SDK = require('@opentapd/tapd-node-sdk');

const api = new SDK({
    client: 'gggg123', // 你的应用CODE
    secret: '112A5B9F-D7B9-EC9C-B688-24E44F5043C4', // 密钥 注意保密
});


// api 详细文档可参考tapdAPI的文档
api.getStories({
    workspace_id: '755'
}).then(data => {
    console.log(data);
}).catch(e => console.log(e)); 

// 文件上传接口使用方式
var file = fs.createReadStream('your file path')

// 支持Buffer
// const {FILE}= require('@tencent/tapd-node-sdk');
// const { Readable } = require('stream');
// //Readable
// const file_stdout = Readable.from(bitmap);
// var file = new FILE({
//   stdout: file_stdout,
//   filename: 'test.jpg',
// });

api.uploadImage({
    workspace_id: "755", 
    image: file
}).then(data => {
    console.log(data);
}).catch(e => console.log(e));


api.uploadImage({
    workspace_id: "755", 
    image: file
}).then(data => {
    console.log(data);
}).catch(e => console.log(e));
```

--------------------------------

### POST /launch_accessories

Source: https://open.tapd.cn/document/api-doc/API%E6%96%87%E6%A1%A3/api_reference/release/add_launch_accessories.html

创建发布评审依据，返回创建发布评审依据的数据。请求参数包括workspace_id、form_id、type和content。

```APIDOC
## POST /launch_accessories

### Description
创建发布评审依据，返回创建发布评审依据的数据。

### Method
POST

### Endpoint
https://api.tapd.cn/launch_accessories

### Parameters
#### Request Body
- **workspace_id** (integer) - Required - 项目ID
- **form_id** (string) - Required - 发布评审ID
- **type** (string) - Required - 类型（仅支持launch_url）
- **content** (string) - Required - url地址

### Request Example
```
curl -u 'api_user:api_password' -d 'workspace_id=10104801&form_id=1010104801079533889&type=launch_url&content=https://www.tapd.cn/' 'https://api.tapd.cn/launch_accessories'
```

### Response
#### Success Response (200)
- **status** (integer) - 状态码，1表示成功
- **data** (object) - 返回数据
  - **LaunchAccessory** (object) - 发布评审依据对象
    - **id** (string) - 依据ID
    - **form_id** (string) - 发布评审ID
    - **workspace_id** (string) - 所属项目ID
    - **type** (string) - 类型
    - **tag** (string) - 标签
    - **title** (string) - 标题
    - **content** (string) - url地址
    - **description** (string|null) - 详细描述
    - **content_type** (string) - 内容类型
    - **created_by** (string) - 创建人
    - **created** (string) - 创建时间
    - **group_id** (string|null) - 分组ID
    - **source** (string) - 来源
- **info** (string) - 信息，成功时为"success"

#### Response Example
```json
{
    "status": 1,
    "data": {
        "LaunchAccessory": {
            "id": "1010104801000254035",
            "form_id": "1010104801079533889",
            "workspace_id": "10104801",
            "type": "launch_url",
            "tag": "",
            "title": "URL",
            "content": "https://www.tapd.cn/",
            "description": null,
            "content_type": "",
            "created_by": "tapd",
            "created": "2022-09-08 16:45:30",
            "group_id": null,
            "source": ""
        }
    },
    "info": "success"
}
```

```

--------------------------------

### Install TAPD Node.js SDK with npm

Source: https://open.tapd.cn/document/api-doc/SDK/node-README.html

Install the @opentapd/tapd-node-sdk package using npm. Recommended Node.js version is 14.13.0 or higher.

```text
npm install @opentapd/tapd-node-sdk
```

--------------------------------

### POST /api/testx/case/v1/namespaces/{namespace}/repos/{repo_uid}/versions/{version_uid}/cases/batch-create

Source: https://open.tapd.cn/document/api-doc/API%E6%96%87%E6%A1%A3/api_reference/testx/case/batch_create_case.html

批量创建测试用例，返回创建的用例信息。支持JSON格式，通过POST请求调用，需要用户态授权。

```APIDOC
## POST /api/testx/case/v1/namespaces/{namespace}/repos/{repo_uid}/versions/{version_uid}/cases/batch-create

### Description
批量创建测试用例，返回创建的用例信息。

### Method
POST

### Endpoint
https://api.tapd.cn/api/testx/case/v1/namespaces/{namespace}/repos/{repo_uid}/versions/{version_uid}/cases/batch-create

### Parameters
#### Path Parameters
- **namespace** (string) - Required - 命名空间标识
- **repo_uid** (string) - Required - 仓库唯一标识
- **version_uid** (string) - Required - 版本唯一标识

### Request Example
（请求体未在文档中明确给出）

### Response
#### Success Response
（响应体未在文档中明确给出）

### Notes
- 支持批量插入
- 调用方式参考授权-用户态
```

--------------------------------

### 返回结果 (JSON response)

Source: https://open.tapd.cn/document/api-doc/API%E6%96%87%E6%A1%A3/api_reference/workspace/get_sub_workspaces.html

Example JSON response from the sub_workspaces API. Note: the 'created' field is missing a comma in the source example, which is a syntax error in the JSON.

```json
{
    "status": 1,
    "data": {
        "Workspace": {
            "id": "10104801",
            "name": "TAPD 乌云",
            "pretty_name": "tapd_security",
            "category": "product",
            "status": "normal",
            "description": "",
            "begin_date": null,
            "end_date": null,
            "external_on": "0",
            "creator": "",
            "created": "2015-03-27 16:02:02"
            "template_id": "1000000000000000020"
        }
    },
    "info": "success"
}
```

--------------------------------

### GET /tasks

Source: https://open.tapd.cn/document/api-doc/API%E6%96%87%E6%A1%A3/subject/custom_priority/

获取任务列表，支持通过priority_label参数按优先级标签筛选任务。新方式直接传优先级标签值，如High，替代旧的priority参数。

```APIDOC
## [GET] /tasks

### Description
获取任务列表，支持通过priority_label参数按优先级标签筛选任务。新方式直接传优先级标签值，如High，替代旧的priority参数。

### Method
GET

### Endpoint
https://api.tapd.cn/tasks

### Parameters
#### Query Parameters
- **workspace_id** (string) - Required - 工作空间ID
- **priority_label** (string) - Optional - 优先级标签，如High

### Request Example
curl -u 'client_id:client_secret' 'https://api.tapd.cn/tasks?workspace_id=10104801&priority_label=High'

### Response
#### Success Response (200)
- **data** (array) - 任务列表

#### Response Example
{
  "data": []
}
```

--------------------------------

### POST /api/testx/case/v1/namespaces/{namespace}/repos

Source: https://open.tapd.cn/document/api-doc/API%E6%96%87%E6%A1%A3/api_reference/testx/case/create_repo.html

创建用例仓库，返回用例仓库信息。请求参数包括Namespace、Name和Description，其中Namespace和Name为必填项。

```APIDOC
## POST /api/testx/case/v1/namespaces/{namespace}/repos

### Description
创建用例仓库，返回用例仓库信息。

### Method
POST

### Endpoint
https://api.tapd.cn/api/testx/case/v1/namespaces/{namespace}/repos

### Parameters
#### Path Parameters
- **namespace** (string) - Required - 项目ID

#### Request Body
- **Name** (string) - Required - 用例库名称
- **Description** (string) - Optional - 用例库描述

### Request Example
{
    "Name": "测试创建",
    "Description": "测试描述"
}

### Response
#### Success Response (200)
- **Error** (null) - 错误信息，成功时为null
- **Data** (object) - 用例仓库信息
  - **Audit** (object) - 审计信息
    - **Creator** (string) - 创建者
    - **Updater** (string) - 更新者
    - **CreatedAt** (string) - 创建时间
    - **UpdatedAt** (string) - 更新时间
    - **Tenant** (string) - 租户
  - **Namespace** (string) - 项目ID
  - **Uid** (string) - 仓库uid
  - **Name** (string) - 仓库名称
  - **Description** (string) - 仓库描述
  - **Versions** (array) - 用例库版本信息
    - **Audit** (object) - 审计信息
    - **Uid** (string) - 用例库版本uid
    - **Repo** (object) - 所属用例库
    - **Name** (string) - 用例库版本名称
    - **Description** (string) - 用例库版本描述
  - **Type** (string) - 用例库类型，取值：DEFALT（缺省）、SYSTEM（系统默认）

#### Response Example
{
    "Error": null,
    "Data": {
        "Audit": {
            "Creator": "xx",
            "Updater": "xx",
            "CreatedAt": "2025-07-08T17:24:07+08:00",
            "UpdatedAt": "2025-07-08T17:24:07+08:00",
            "Tenant": "xx"
        },
        "Namespace": "xxx",
        "Uid": "17130",
        "Name": "测试用例库",
        "Description": "测试",
        "Versions": [
            {
                "Audit": {
                    "Creator": "xx",
                    "Updater": "xx",
                    "CreatedAt": "2025-07-08T17:24:07+08:00",
                    "UpdatedAt": "2025-07-08T17:24:07+08:00",
                    "Tenant": "xx"
                },
                "Uid": "18198",
                "Repo": {
                    "Audit": null,
                    "Namespace": "",
                    "Uid": "17130",
                    "Name": "",
                    "Description": "",
                    "Versions": [],
                    "Nid": "",
                    "Type": "DEFALT"
                },
                "Name": "master",
                "Description": "稳定版本(默认)"
            }
        ],
        "Type": "DEFALT"
    }
}
```

--------------------------------

### GET /stories

Source: https://open.tapd.cn/document/api-doc/API%E6%96%87%E6%A1%A3/subject/custom_priority/

获取需求列表，支持通过priority_label参数按优先级标签筛选需求。新方式直接传优先级标签值，如High，替代旧的priority参数。

```APIDOC
## [GET] /stories

### Description
获取需求列表，支持通过priority_label参数按优先级标签筛选需求。新方式直接传优先级标签值，如High，替代旧的priority参数。

### Method
GET

### Endpoint
https://api.tapd.cn/stories

### Parameters
#### Query Parameters
- **workspace_id** (string) - Required - 工作空间ID
- **priority_label** (string) - Optional - 优先级标签，如High

### Request Example
curl -u 'client_id:client_secret' 'https://api.tapd.cn/stories?workspace_id=10104801&priority_label=High'

### Response
#### Success Response (200)
- **data** (array) - 需求列表

#### Response Example
{
  "data": []
}
```

--------------------------------

### POST /api/testx/plan/v1/namespaces/{namespace}/folders/{folder_uid}/plans-list

Source: https://open.tapd.cn/document/api-doc/API%E6%96%87%E6%A1%A3/api_reference/testx/plan/list_plans.html

获取指定目录下的计划列表。支持多种过滤条件、分页和字段选择。

```APIDOC
## [POST] /api/testx/plan/v1/namespaces/{namespace}/folders/{folder_uid}/plans-list

### Description
获取指定目录下的计划列表。支持多种过滤条件、分页和字段选择。

### Method
POST

### Endpoint
`https://api.tapd.cn/api/testx/plan/v1/namespaces/{namespace}/folders/{folder_uid}/plans-list`

### Parameters
#### Path Parameters
- **namespace** (string) - Required - 命名空间
- **folder_uid** (uint64) - Required - 目录ID(0表示根目录)

#### Request Body
- **Namespace** (string) - Required - 命名空间
- **FolderUid** (uint64) - Required - 目录ID(0表示根目录)
- **WithDetail** (bool) - Optional - 是否包含详情
- **PageInfo** (pageinfo) - Optional - 分页信息
- **Ordering** (string) - Optional - 排序字段
- **States** (repeated State) - Optional - 状态过滤
- **Testers** (repeated string) - Optional - 测试者过滤
- **Uids** (repeated string) - Optional - 计划ID列表
- **Archive** (ArchiveMode) - Optional - 归档状态
- **Name** (string) - Optional - 名称模糊查询
- **Description** (string) - Optional - 描述模糊查询
- **Assigned** (NullBool) - Optional - 是否分配
- **IterationUids** (repeated string) - Optional - 迭代UID列表
- **IgnoreFolderUid** (bool) - Optional - 是否忽略目录ID条件
- **StoryUids** (repeated string) - Optional - 需求UID列表
- **StartAt** (string) - Optional - 开始时间
- **EndAt** (string) - Optional - 结束时间
- **TimeIntervalType** (TimeIntervalType) - Optional - 时间区间类型
- **Fields** (repeated string) - Optional - 返回字段列表

### Request Example
```json
{
  "Namespace": "string",
  "FolderUid": 0,
  "WithDetail": true,
  "PageInfo": {
    "Offset": 0,
    "Limit": 20
  },
  "Ordering": "string",
  "States": ["WAITING"],
  "Testers": ["string"],
  "Uids": ["string"],
  "Archive": "ARCHIVEMODE_NONE",
  "Name": "string",
  "Description": "string",
  "Assigned": "NULL_BOOL_NONE",
  "IterationUids": ["string"],
  "IgnoreFolderUid": false,
  "StoryUids": ["string"],
  "StartAt": "string",
  "EndAt": "string",
  "TimeIntervalType": "CREATE_TIME",
  "Fields": ["string"]
}
```

### Response
#### Success Response (200)
- **data** (array) - 计划列表
- **meta** (object) - 分页信息等元数据

#### Response Example
```json
{
  "data": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "status": "WAITING",
      "archive": false
    }
  ],
  "meta": {
    "total": 100,
    "offset": 0,
    "limit": 20
  }
}
```

### Enumerations
#### ArchiveMode
- **ARCHIVEMODE_NONE** - 获取全部
- **ARCHIVEMODE_YES** - 获取归档
- **ARCHIVEMODE_NO** - 获取非归档

#### TimeIntervalType
- **CREATE_TIME** - 创建时间
- **UPDATE_TIME** - 更新时间

#### State
- **NONE** - 无状态
- **WAITING** - 等待中
- **RUNNING** - 运行中
- **DONE** - 已完成
- **ARCHIVE** - 已归档

#### NullBool
- **NULL_BOOL_NONE** - 默认值(全部)
- **NULL_BOOL_FALSE** - 未分配
- **NULL_BOOL_TRUE** - 已分配

#### pageinfo
- **Offset** (uint32) - Required - 分页偏移位置
- **Limit** (uint32) - Required - 每页数量
```

--------------------------------

### GET /workspaces/users

Source: https://open.tapd.cn/document/api-doc/API%E6%96%87%E6%A1%A3/mini_api_reference/workspace/users.html

获取指定空间或公司的成员列表。一次返回所有符合条件的值，一次只能查一个空间。

```APIDOC
## GET /workspaces/users

### Description
获取指定空间或公司的成员列表。一次返回所有符合条件的值，一次只能查一个空间。

### Method
GET

### Endpoint
https://api.tapd.cn/workspaces/users

### Parameters
#### Query Parameters
- **workspace_id** (integer) - Required - 空间id 或者 公司id
- **fields** (string) - Optional - 需要查的字段值，可选值：user, role_id, email，以逗号分隔

### Request Example
curl -u 'api_user:api_password' 'https://api.tapd.cn/workspaces/users?workspace_id=69993260'

### Response
#### Success Response (200)
- **status** (integer) - 状态码，1表示成功
- **data** (array) - 成员列表，每个元素包含UserWorkspace对象
- **UserWorkspace.user** (string) - 用户名
- **UserWorkspace.role_id** (array) - 角色ID列表
- **info** (string) - 信息，成功时为"success"

#### Response Example
{
    "status": 1,
    "data": [
        {
            "UserWorkspace": {
                "user": "david",
                "role_id": [
                    "1000000000000000089"
                ]
            }
        },
        {
            "UserWorkspace": {
                "user": "zhijie",
                "role_id": [
                    "1000000000000000089"
                ]
            }
        },
        {
            "UserWorkspace": {
                "user": "orange",
                "role_id": [
                    "1000000000000000089"
                ]
            }
        },
        {
            "UserWorkspace": {
                "user": "ajun",
                "role_id": [
                    "1000000000000000012"
                ]
            }
        }
    ],
    "info": "success"
}
```

--------------------------------

### PUT /api/testx/case/v1/namespaces/{namespace}/repos/{repo_uid}/versions/{version_uid}/folders/{folder_uid}

Source: https://open.tapd.cn/document/api-doc/API%E6%96%87%E6%A1%A3/api_reference/testx/case/update_folder.html

更新测试用例目录信息，返回更新后的用例目录。请求体包含目录信息，一次更新一条数据。

```APIDOC
## [PUT] /api/testx/case/v1/namespaces/{namespace}/repos/{repo_uid}/versions/{version_uid}/folders/{folder_uid}

### Description
更新测试用例目录信息，返回更新后的用例目录。

### Method
PUT

### Endpoint
`https://api.tapd.cn/api/testx/case/v1/namespaces/{namespace}/repos/{repo_uid}/versions/{version_uid}/folders/{folder_uid}`

### Parameters
#### Path Parameters
- **namespace** (string) - Required - 项目命名空间
- **repo_uid** (string) - Required - 仓库唯一标识
- **version_uid** (string) - Required - 仓库版本唯一标识
- **folder_uid** (string) - Required - 目录唯一标识

#### Request Body
- **Namespace** (string) - Required - 项目命名空间
- **Folder** (Folder) - Required - 目录信息

#### Folder Object
- **Uid** (string) - Required - 唯一标识
- **RepoUid** (string) - Required - 仓库唯一标识
- **RepoVersionUid** (string) - Required - 仓库版本唯一标识
- **FolderUid** (string) - Required - 目录唯一标识
- **Name** (string) - Required - 目录名称
- **Owners** (repeated string) - Optional - 负责人列表
- **Description** (string) - Optional - 描述信息

### Request Example
{
  "Namespace": "string",
  "Folder": {
    "Uid": "string",
    "RepoUid": "string",
    "RepoVersionUid": "string",
    "FolderUid": "string",
    "Name": "string",
    "Owners": ["string"],
    "Description": "string"
  }
}

### Response
#### Success Response (200)
- **Error** (null) - 错误信息，成功时为null
- **Data** (object) - 更新后的目录信息
  - **Uid** (string) - 目录uid
  - **RepoUid** (string) - 仓库uid
  - **RepoVersionUid** (string) - 仓库版本uid
  - **FolderUid** (string) - 目录uid
  - **FullPath** (string) - 目录中文路径
  - **Name** (string) - 目录名称
  - **Owners** (array of string) - 目录负责人列表
  - **Description** (string) - 仓库描述
  - **CaseCount** (integer) - 目录用例数
  - **UUID** (string) - 目录uuid
  - **Path** (string) - 目录路径
  - **Audit** (object) - 审计信息
    - **Creator** (string) - 创建者
    - **Updater** (string) - 更新者
    - **CreatedAt** (string) - 创建时间
    - **UpdatedAt** (string) - 更新时间
    - **Tenant** (string) - 租户

#### Response Example
{
  "Error": null,
  "Data": {
    "Uid": "12572731",
    "RepoUid": "",
    "RepoVersionUid": "",
    "FolderUid": "",
    "FullPath": "",
    "Name": "test",
    "Owners": ["xxxx"],
    "Description": "test",
    "CaseCount": 0,
    "UUID": "40340dec-cea7-4fe6-9a96-ee07eaef2bde",
    "Path": ".",
    "Audit": {
      "Creator": "xx",
      "Updater": "xx",
      "CreatedAt": "2025-07-12T10:26:55+08:00",
      "UpdatedAt": "2025-07-12T10:26:55+08:00",
      "Tenant": "xx"
    }
  }
}
```

--------------------------------

### GET /workspaces/get_workspace_info

Source: https://open.tapd.cn/document/api-doc/API%E6%96%87%E6%A1%A3/mini_api_reference/workspace/get_workspace_info.html

获取当前用户参与的空间列表，无分页。支持JSON/XML格式，默认JSON。

```APIDOC
## GET /workspaces/get_workspace_info

### Description
获取当前用户参与的空间列表（无分页）。

### Method
GET

### Endpoint
https://api.tapd.cn/workspaces/get_workspace_info

### Parameters
无

### Request Example
无

### Response
#### Success Response (200)
返回当前用户参与的空间列表。

#### Response Example
无

```

--------------------------------

### POST /api/testx/case/v1/namespaces/{namespace}/repos/{repo_uid}/versions/{version_uid}/folders

Source: https://open.tapd.cn/document/api-doc/API%E6%96%87%E6%A1%A3/api_reference/testx/case/create_folder.html

创建测试用例目录，请求体包含目录信息，返回创建的目录详情。

```APIDOC
## POST /api/testx/case/v1/namespaces/{namespace}/repos/{repo_uid}/versions/{version_uid}/folders

### Description
创建测试用例目录，返回用例目录信息。

### Method
POST

### Endpoint
`https://api.tapd.cn/api/testx/case/v1/namespaces/{namespace}/repos/{repo_uid}/versions/{version_uid}/folders`

### Parameters
#### Path Parameters
- **namespace** (string) - Required - 项目命名空间
- **repo_uid** (string) - Required - 仓库唯一标识
- **version_uid** (string) - Required - 仓库版本唯一标识

#### Request Body
- **Namespace** (string) - Required - 项目命名空间
- **Folder** (Folder) - Required - 目录信息

#### Folder Object
- **Uid** (string) - Required - 唯一标识
- **RepoUid** (string) - Required - 仓库唯一标识
- **RepoVersionUid** (string) - Required - 仓库版本唯一标识
- **FolderUid** (string) - Required - 目录唯一标识
- **Name** (string) - Required - 目录名称
- **Owners** (repeated string) - Optional - 负责人列表
- **Description** (string) - Optional - 描述信息

### Request Example
```json
{
	"Name": "创建目录",
	"Owners": [],
	"CopyCaseUids": [],
	"FolderUid": "0"
}
```

### Response
#### Success Response (200)
- **Error** (null) - 错误信息，成功时为null
- **Data** (object) - 返回的目录信息
  - **Uid** (string) - 目录uid
  - **RepoUid** (string) - 仓库uid
  - **RepoVersionUid** (string) - 仓库版本uid
  - **FolderUid** (string) - 目录唯一标识
  - **FullPath** (string) - 目录中文路径
  - **Name** (string) - 目录名称
  - **Owners** (array) - 目录负责人列表
  - **Description** (string) - 描述信息
  - **CaseCount** (integer) - 目录用例数
  - **UUID** (string) - 目录uuid
  - **Path** (string) - 目录路径
  - **Audit** (object) - 审计信息
    - **Creator** (string) - 创建者
    - **Updater** (string) - 更新者
    - **CreatedAt** (string) - 创建时间
    - **UpdatedAt** (string) - 更新时间
    - **Tenant** (string) - 租户

#### Response Example
```json
{
    "Error": null,
    "Data": {
        "Uid": "12572731",
        "RepoUid": "",
        "RepoVersionUid": "",
        "FolderUid": "",
        "FullPath": "",
        "Name": "test",
        "Owners": [
            "xxxx"
        ],
        "Description": "test",
        "CaseCount": 0,
        "UUID": "40340dec-cea7-4fe6-9a96-ee07eaef2bde",
        "Path": ".",
        "Audit": {
            "Creator": "xx",
            "Updater": "xx",
            "CreatedAt": "2025-07-12T10:26:55+08:00",
            "UpdatedAt": "2025-07-12T10:26:55+08:00",
            "Tenant": "xx"
        }
    }
}
```

### Notes
- 支持格式：JSON
- 调用方式：参考授权-用户态
- 请求数限制：一次插入一条数据
```

--------------------------------

### curl Basic Auth Example for Creating a Module

Source: https://open.tapd.cn/document/api-doc/API%E6%96%87%E6%A1%A3/api_reference/setting/add_module.html

Example curl command using Basic Auth to create a module. It sends a POST request to https://api.tapd.cn/modules with workspace_id, name, and creator parameters.

```bash
curl -u 'api_user:api_password' -d 'workspace_id=10104801&name=创建模块&creator=tapd_api' 'https://api.tapd.cn/modules'
```
Tokens:
Raw