获取关联列表 - PingCodeRESTAPI

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

Authorization: Bearer ********************

Query 参数

principal_type

string

可选

关联主体的类型。关联主体的类型和关联的目标类型需要搭配使用，比如：
需求关联工单，principal_type为idea，target_type为ticket；
需求关联工作项，principal_type为idea，target_type为work_item；
需求关联测试用例，principal_type为idea，target_type为test_case；
需求关联需求，principal_type为idea，target_type为idea；
需求关联页面，principal_type为idea，target_type为page；
工单关联需求，principal_type为ticket，target_type为idea；
工单关联工作项，principal_type为ticket，target_type为work_item；
工单关联工单，principal_type为ticket，target_type为ticket；
工单关联页面，principal_type为ticket，target_type为page；
工作项关联测试用例，principal_type为work_item，target_type为test_case；
工作项关联工单，principal_type为work_item，target_type为ticket；
工作项关联页面，principal_type为work_item，target_type为page；
测试计划关联缺陷，principal_type为test_plan，target_type为work_item；
执行用例关联缺陷，principal_type为test_run，target_type为work_item
测试用例关联需求，principal_type为test_case，target_type为idea；
测试用例关联工作项，principal_type为test_case，target_type为work_item
测试用例关联页面，principal_type为test_case，target_type为page；
页面关联需求，principal_type为page，target_type为idea；
页面关联工单，principal_type为page，target_type为ticket；
页面关联工作项，principal_type为page，target_type为work_item；
页面关联测试用例，principal_type为page，target_type为test_case；

示例值:

principal_id

string

关联主体的id。

可选

示例值:

target_type

string

关联的目标类型。

可选

示例值:

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Body

page_size

integer

必需

page_index

integer

必需

total

integer

必需

values

array [object {6}]

必需

string

可选

url

string

可选

principal_type

string

可选

principal

object

可选

target_type

string

可选

target

object

可选

示例

{
    "page_size": 30,
    "page_index": 0,
    "total": 1,
    "values": [
        {
            "id": "64b4d70ba368e6594360ea79",
            "url": "https://rest_api_root/v1/relations/64b4d70ba368e6594360ea79",
            "principal_type": "idea",
            "principal": {
                "id": "64b4d70ba368e6594360ea24",
                "url": "https://rest_api_root/v1/ship/ideas/64b4d70ba368e6594360ea24",
                "identifier": "SLC-1",
                "title": "示例需求"
            },
            "target_type": "ticket",
            "target": {
                "id": "63eca888a0a13a3efc8d4a43",
                "url": "https://rest_api_root/v1/ship/tickets/63eca888a0a13a3efc8d4a43",
                "identifier": "SLC-T1",
                "title": "希望新增支持第三方账号注册"
            }
        }
    ]
}