创建一个关联 - PingCodeRESTAPI

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

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

Body 参数application/json

principal_id

string

关联主体的id。

必需

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，target_id只能为bug类型的工作项id；执行用例关联缺陷，principal_type为test_run，target_type为work_item，target_id只能为bug类型的工作项id；测试用例关联需求，principal_type为test_case，target_type为idea；测试用例关联工作项，principal_type为test_case，target_type为work_item，target_id只能为story或bug类型的工作项id；测试用例关联页面，principal_type为test_case，target_type为page；页面关联需求，暂不开放；页面关联工单，暂不开放；页面关联工作项，暂不开放；页面关联测试用例，暂不开放；

target_type

string

关联的目标类型。

必需

target_id

string

关联的目标id。

必需

示例

{
    "principal_id": "547000eb6a70571487623fea",
    "principal_type": "test_run",
    "target_type": "work_item",
    "target_id": "5edca524cad2fa1125cb0630"
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://open.pingcode.com/v1/relations' \
--header 'Content-Type: application/json' \
--data-raw '{
    "principal_id": "547000eb6a70571487623fea",
    "principal_type": "test_run",
    "target_type": "work_item",
    "target_id": "5edca524cad2fa1125cb0630"
}'

返回响应

🟢200成功

application/json

Body

id

string

必需

url

string

必需

principal_type

string

必需

principal

object

必需

id

string

必需

url

string

必需

status

string

必需

target_type

string

必需

target

object

必需

id

string

必需

url

string

必需

identifier

string

必需

title

string

必需

type

string

必需

start_at

integer

必需

end_at

integer

必需

parent_id

string

必需

示例

{
    "id": "fa1125cb06305edca524cad2",
    "url": "https://rest_api_root/v1/relations/fa1125cb06305edca524cad2",
    "principal_type": "test_run",
    "principal": {
        "id": "547000eb6a70571487623fea",
        "url": "https://rest_api_root/v1/testhub/runs/547000eb6a70571487623fea",
        "status": "failure"
    },
    "target_type": "work_item",
    "target": {
        "id": "5edca524cad2fa1125cb0630",
        "url": "https://rest_api_root/v1/project/work_items/5edca524cad2fa1125cb0630",
        "identifier": "SCR-5",
        "title": "这是一个缺陷",
        "type": "bug",
        "start_at": 1583290309,
        "end_at": 1583290347,
        "parent_id": "5edca524cad2fa112b06105c"
    }
}