# 说明

关联TAPD对象(需求、任务、缺陷)和Git分支

# url

https://apiv2.tapd.tencent.com/branch_object

# 支持格式

JSON/XML(默认JSON格式)

# HTTP请求方式

POST

# 请求数限制

通过参数object_info[],支持批量创建多个业务对象关联同一个分支

# 请求参数

字段名 必选 类型及范围 说明
object_info[] string 1.业务对象json,如{"workspace_id":755,"type":"story","object_id":1000000755856172853},如果多个业务对象关联同一个分支可以传多个
2.使用json格式传递时,参数格式参考下面实例
repo_id integer 代码仓库ID
repo_name string 代码仓库名
repo_url string 代码仓库地址
branch string 分支名
operator string 操作人
create_from string 分支创建自(如master)

# 调用示例及返回结果

# 关联TAPD对象和Git分支

# json请求参数格式

{
    "workspace_id":20420838,
    "repo_name":"jeffjffang/demo",
    "repo_url":"http://git.code.oa.com/jeffjffang/demo",
    "branch":"dev",
    "operator":"jeffjffang",
    "object_info":["{\"workspace_id\":20420838,\"type\":\"story\",\"object_id\":1020420838859125327}", "{\"workspace_id\":20420838,\"type\":\"story\",\"object_id\":1020420838859125327}"]
}
1
2
3
4
5
6
7
8

# curl 使用 Basic Auth 鉴权调用示例

curl -u 'api_user:api_password' -d 'object_info[]={"workspace_id":755,"type":"story","object_id":1000000755856172853}&object_info[]={"workspace_id":755,"type":"bug","object_id":1000000755856091391}&repo_id=9894888&repo_name=jeffjffang/demo2&repo_url=https://git.test.code.oa.com/jeffjffang/demo2&branch=refs/heads/dev&operator=jeffjffang' 'https://apiv2.tapd.tencent.com/branch_object'

# curl 使用 OAuth Access Token 鉴权调用示例

curl -H 'Authorization: Bearer ACCESS_TOKEN' -d 'object_info[]={"workspace_id":755,"type":"story","object_id":1000000755856172853}&object_info[]={"workspace_id":755,"type":"bug","object_id":1000000755856091391}&repo_id=9894888&repo_name=jeffjffang/demo2&repo_url=https://git.test.code.oa.com/jeffjffang/demo2&branch=refs/heads/dev&operator=jeffjffang' 'https://apiv2.tapd.tencent.com/branch_object'

# 返回结果

{
  "status": 1,
  "data": [
    {
      "CodeBranchObjects": {
        "id": "1000000755000000697",
        "repo_id": "9894888",
        "repo_name": "jeffjffang/demo2",
        "repo_url": "https://git.test.code.oa.com/jeffjffang/demo2.git",
        "branch": "refs/heads/dev2",
        "branch_status": "0",
        "create_from": "",
        "type": "story",
        "object_id": "1000000755856172853",
        "workspace_id": "755",
        "created": "2019-10-21 18:45:16",
        "modified": "2019-10-21 18:45:16",
        "is_deleted": "0",
        "operator": "jeffjffang"
      }
    },
    {
      "CodeBranchObjects": {
        "id": "1000000755000000699",
        "repo_id": "9894888",
        "repo_name": "jeffjffang/demo2",
        "repo_url": "https://git.test.code.oa.com/jeffjffang/demo2.git",
        "branch": "refs/heads/dev2",
        "branch_status": "0",
        "create_from": "",
        "type": "bug",
        "object_id": "1000000755856091391",
        "workspace_id": "755",
        "created": "2019-10-21 18:45:16",
        "modified": "2019-10-21 18:45:16",
        "is_deleted": "0",
        "operator": "jeffjffang"
      }
    }
  ],
  "info": "success"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
上次更新: 2024-05-16 14:58:20