@mu-cabin/coding-cli 0.1.0

package/generated/index.json

@@ -0,0 +1 @@
+{"generatedAt":"2026-05-21T10:28:17.472Z","source":"https://assets.codehub.cn/document/openapi/442d1e7f2254a620a3d8cf87d9e360a5fe243bf2.yaml","baseUrl":"http://coding.example.com/open-api","total":429,"categories":[{"slug":"01","name":"团队相关接口","count":2},{"slug":"02","name":"组织和成员相关接口","count":16},{"slug":"03","name":"权限相关接口","count":25},{"slug":"04","name":"项目相关接口","count":27},{"slug":"05","name":"项目集相关接口","count":6},{"slug":"06","name":"Service Hook 相关接口","count":10},{"slug":"07","name":"关联资源相关接口","count":2},{"slug":"08","name":"项目协同相关接口","count":65},{"slug":"09","name":"代码托管相关接口","count":152},{"slug":"10","name":"持续集成相关接口","count":24},{"slug":"11","name":"持续部署相关接口","count":33},{"slug":"12","name":"制品仓库相关接口","count":19},{"slug":"13","name":"Wiki 相关接口","count":12},{"slug":"14","name":"文件网盘相关接口","count":3},{"slug":"15","name":"测试管理相关接口","count":29},{"slug":"16","name":"其他接口","count":1},{"slug":"17","name":"导出任务接口","count":3}],"actions":{"DescribeCodingCurrentUser":{"summary":"当前用户信息查询","category":"01-团队相关接口","description":"✨ 当前用户信息查询","params":[],"response":[{"name":"User","type":"CurrentUser","required":false,"description":"当前用户信息"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"https://coding.example.com/?Action=DescribeCodingCurrentUser\n&<公共请求参数>"},"DescribeTeam":{"summary":"团队信息查询","category":"01-团队相关接口","description":"✨ 团队信息查询","params":[],"response":[{"name":"Data","type":"TeamData","required":false,"description":"团队信息"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeTeam\n<公共请求参数>\n\n{}"},"CreateDepartment":{"summary":"部门创建","category":"02-组织和成员相关接口","description":"✨ 部门创建","params":[{"name":"Name","type":"string","required":true,"description":"部门名"},{"name":"ParentId","type":"integer (int64)","required":true,"description":"父部门ID"}],"response":[{"name":"Department","type":"DepartmentDepartmentData","required":false,"description":"所创建的部门信息"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: CreateDepartment\n<公共请求参数>\n\n{\n  \"Name\": \"ccccoding\",\n  \"ParentId\": 0\n}"},"DeleteDepartment":{"summary":"部门删除","category":"02-组织和成员相关接口","description":"✨ 部门删除","params":[{"name":"DepartmentId","type":"integer (int64)","required":true,"description":"部门ID"}],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"destructive","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DeleteDepartment\n<公共请求参数>\n\n{\n  \"DepartmentId\": 2907180\n}"},"DeleteTeamMember":{"summary":"团队成员删除","category":"02-组织和成员相关接口","description":"✨ 团队成员删除","params":[{"name":"UserId","type":"integer (uint64)","required":true,"description":"用户Id"}],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"destructive","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DeleteTeamMember\n<公共请求参数>\n\n\n{\n    \"UserId\": 1\n}"},"DescribeDepartment":{"summary":"部门详情查询","category":"02-组织和成员相关接口","description":"✨ 部门详情查询","params":[{"name":"DepartmentId","type":"integer (int64)","required":true,"description":"部门ID"},{"name":"GetTree","type":"boolean","required":false,"description":"是否获取部门树"}],"response":[{"name":"DepartmentTree","type":"DepartmentDepartmentTreeData","required":false,"description":"部门树信息"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeDepartment\n<公共请求参数>\n\n{\n  \"DepartmentId\": 2904528,\n  \"GetTree\": true\n}"},"DescribeDepartmentMembers":{"summary":"部门成员列表查询","category":"02-组织和成员相关接口","description":"✨ 获取部门成员列表（分页列表）查询选中部门下面所有的成员","params":[{"name":"DepartmentId","type":"integer (int64)","required":true,"description":"部门名"},{"name":"KeyWords","type":"string","required":false,"description":"关键词"},{"name":"PageNumber","type":"integer (int64)","required":true,"description":"页数"},{"name":"PageSize","type":"integer (int64)","required":true,"description":"每页数量"},{"name":"Pointer","type":"boolean","required":false,"description":"是否仅查询当前部门的直接成员"}],"response":[{"name":"Data","type":"DepartmentDescribeDepartmentMemberPageList","required":false,"description":"部门成员列表（分页数据）"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeDepartmentMembers\n<公共请求参数>\n\n{\n  \"DepartmentId\": 2904528,\n  \"Pointer\": false,\n  \"KeyWords\": \"hu\",\n  \"PageSize\": 5,\n  \"PageNumber\": 1\n}"},"DescribeDepartmentSyncStatus":{"summary":"查看部门同步状态","category":"02-组织和成员相关接口","description":"✨ 查看部门同步状态","params":[],"response":[{"name":"Result","type":"","required":false},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read"},"DescribeTeamAdminMembers":{"summary":"团队管理员查询","category":"02-组织和成员相关接口","description":"✨ 查询团队管理员","params":[{"name":"PageNumber","type":"integer (uint64)","required":true,"description":"第几页"},{"name":"PageSize","type":"integer (uint64)","required":true,"description":"每页条数"}],"response":[{"name":"Data","type":"TeamAdminMemberData","required":false,"description":"团队管理员列表信息"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeTeamAdminMembers\n<公共请求参数>\n\n\n{\n        \"PageNumber\": 1,\n        \"PageSize\": 10\n}"},"DescribeTeamMember":{"summary":"团队成员信息查询（通过用户 ID）","category":"02-组织和成员相关接口","description":"✨ 通过用户 ID 查询团队成员信息","params":[{"name":"UserId","type":"integer (uint64)","required":true,"description":"用户Id"},{"name":"ShowDepartment","type":"boolean (bool)","required":false,"description":"是否展示部门"}],"response":[{"name":"TeamMember","type":"ApiUserUserData","required":false,"description":"团队成员数据"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeTeamMember\n<公共请求参数>\n\n\n{\n    \"UserId\": 1\n}"},"DescribeTeamMemberByEmail":{"summary":"团队成员信息查询（通过用户 Email）","category":"02-组织和成员相关接口","description":"✨ 通过用户 Email 查询团队成员信息","params":[{"name":"Email","type":"string","required":true,"description":"用户邮箱"}],"response":[{"name":"TeamMember","type":"ApiUserUserData","required":false,"description":"团队成员数据"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeTeamMemberByEmail\n<公共请求参数>\n\n\n{\n    \"Email\": \"blockuser@gmail.com\"\n}"},"DescribeTeamMembers":{"summary":"团队成员列表查询","category":"02-组织和成员相关接口","description":"✨ 团队成员列表查询","params":[{"name":"PageNumber","type":"integer (uint64)","required":true,"description":"请求页数"},{"name":"PageSize","type":"integer (uint64)","required":true,"description":"请求条数"},{"name":"ShowDepartment","type":"boolean (bool)","required":false,"description":"是否展示部门"}],"response":[{"name":"Data","type":"TeamMemberData","required":false,"description":"团队成员分页列表信息"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeTeamMembers\n<公共请求参数>\n\n{\n\t\"PageNumber\": 1,\n\t\"PageSize\": 10\n}"},"ModifyDepartment":{"summary":"部门信息修改","category":"02-组织和成员相关接口","description":"✨ 修改部门信息(部门名，移动位置)","params":[{"name":"Id","type":"integer (int64)","required":true,"description":"部门ID"},{"name":"Name","type":"string","required":true,"description":"部门名"},{"name":"ParentId","type":"integer (int64)","required":true,"description":"父级部门ID"}],"response":[{"name":"Department","type":"DepartmentDepartmentData","required":false,"description":"修改后的部门信息"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: ModifyDepartment\n<公共请求参数>\n\n{\n  \"Name\": \"dev2\",\n  \"ParentId\": 2906842,\n  \"Id\": 2906848\n}"},"ModifyDepartmentAssignee":{"summary":"部门负责人管理","category":"02-组织和成员相关接口","description":"✨ 部门负责人管理","params":[{"name":"DepartmentId","type":"integer (int64)","required":true,"description":"部门ID"},{"name":"RefIds","type":"Array of integer","required":true,"description":"用户refIds 必填"}],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: ModifyDepartmentAssignee\n<公共请求参数>\n\n{\n  \"DepartmentId\": 2906842,\n  \"RefIds\": [8812637, 8864317]\n}"},"ModifyDepartmentMember":{"summary":"部门成员管理","category":"02-组织和成员相关接口","description":"✨ 部门成员管理","params":[{"name":"DepartmentIds","type":"Array of integer","required":true,"description":"部门ID信息"},{"name":"RefIds","type":"Array of integer","required":true,"description":"用户refIds"}],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: ModifyDepartmentMember\n<公共请求参数>\n\n{\n  \"DepartmentIds\": [2906848],\n  \"RefIds\": [8918677, 8892128]\n}"},"ModifyTeamMemberLocked":{"summary":"团队成员锁定","category":"02-组织和成员相关接口","description":"✨ 通过用户 ID 团队成员锁定","params":[{"name":"UserId","type":"integer (uint64)","required":true,"description":"用户Id"}],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: ModifyTeamMemberLocked\n<公共请求参数>\n\n\n{\n    \"UserId\": 1\n}"},"ModifyTeamMemberUnlocked":{"summary":"团队成员解锁","category":"02-组织和成员相关接口","description":"✨ 通过用户 ID 解锁团队成员","params":[{"name":"UserId","type":"integer (uint64)","required":true,"description":"用户Id"}],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: ModifyTeamMemberUnlocked\n<公共请求参数>\n\n\n{\n    \"UserId\": 1\n}"},"TriggerDepartmentSync":{"summary":"同步部门三方成员","category":"02-组织和成员相关接口","description":"✨ 同步部门三方成员(限制最多每两分钟执行一次)","params":[],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: TriggerDepartmentSync\n<公共请求参数>\n\n{             \n}"},"AttachResourceScopeToPolicy":{"summary":"权限组添加可用的资源，原有其它资源不受影响，若已存在的资源不再进行追加","category":"03-权限相关接口","description":"✨ 为指定权限组添加可用的资源，原有其它资源不受影响，若已存在的资源不再进行追加","params":[{"name":"PolicyId","type":"integer (int64)","required":true,"description":"权限组 ID"},{"name":"ResourceInfos","type":"Array of ResourceInfoOfPolicyScope","required":true,"description":"添加的资源"}],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: AttachResourceScopeToPolicy\n<公共请求参数>\n\n{\n  \"PolicyId\": 37,\n  \"ResourceInfos\": [\n      {\n          \"ResourceId\": \"1\",\n          \"ResourceType\": \"project\"\n      },\n      {\n          \"ResourceType\": \"project\",\n          \"ResourceId\": \"2\"\n      }\n  ]\n}"},"AttachToResource":{"summary":"授权追加，原有其它授权不受影响，若授权已存在不再进行追加","category":"03-权限相关接口","description":"✨ 授权追加，原有其它授权不受影响，若授权已存在不再进行追加","params":[{"name":"Grants","type":"Array of GrantInfo","required":true,"description":"授权信息"},{"name":"Resource","type":"ResourceInfo","required":true,"description":"授权的资源"}],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":["InvalidParameterValue.EmailNotFoundAccount"],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: AttachToResource\n<公共请求参数>\n\n{\n  \"Resource\": {\n    \"ResourceType\": \"project\",\n    \"ResourceId\": \"102\",\n    \"ResourceScope\": \"\",\n    \"ServiceName\": \"\",\n    \"RelativeResource\": \"\"\n  },\n  \"Grants\": [\n    {\n      \"GrantScope\": \"USER\",\n      \"GrantObjectId\": \"5\",\n      \"PolicyId\": 6,\n      \"PrincipalKey\": \"\",\n      \"PrincipalValue\": \"\"\n    }\n  ]\n}"},"CreatePolicy":{"summary":"权限组创建","category":"03-权限相关接口","description":"✨ 权限组创建","params":[{"name":"Alias","type":"string","required":true,"description":"显示名称"},{"name":"Description","type":"string","required":false,"description":"描述"},{"name":"Name","type":"string","required":true,"description":"名称"},{"name":"PolicyDocument","type":"PolicyDocument","required":true,"description":"授权语句"},{"name":"PolicyType","type":"string","required":true,"description":"权限组类型：IDENTITY | RESOURCE"},{"name":"ResourceType","type":"Array of string","required":true,"description":"适用的资源类型"}],"response":[{"name":"PolicyId","type":"integer (int64)","required":false,"description":"权限组 ID"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":["InvalidParameterValue.EmailNotFoundAccount"],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: CreatePolicy\n<公共请求参数>\n\n{\n    \"Name\": \"developer\",\n    \"Alias\": \"开发\",\n    \"Description\": \"desc\",\n    \"PolicyType\": \"IDENTITY\",\n    \"ResourceType\": [\n        \"team\"\n    ],\n    \"PolicyDocument\": {\n        \"Statement\": [\n            {\n                \"Effect\": \"ALLOW\",\n                \"Resource\": [\n                    \"*\"\n                ],\n                \"Action\": [\n                    \"ram:createPolicy\"\n                ]\n            }\n        ]\n    }\n}"},"CreateUserGroup":{"summary":"用户组创建","category":"03-权限相关接口","description":"✨ 用户组创建","params":[{"name":"Description","type":"string","required":true,"description":"用户组描述"},{"name":"Name","type":"string","required":true,"description":"用户组名称"}],"response":[{"name":"Id","type":"integer (int64)","required":false,"description":"id"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: CreateUserGroup\n<公共请求参数>\n\n\n{\n  \"Name\":\"tesssddt\",\n  \"Description\":\"ddd\"\n\n}"},"CreateUserGroupUsers":{"summary":"用户组添加用户","category":"03-权限相关接口","description":"✨ 用户组添加用户","params":[{"name":"UserGroupUserInfos","type":"Array of UserGroupUserInfos","required":true,"description":"用户用户组id列表"}],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: CreateUserGroupUsers\n<公共请求参数>\n\n\n{\n   \"UserGroupUserInfos\":[\n      {\n        \"UserId\":3,\n        \"GroupId\":6\n      },\n          {\n        \"UserId\":2,\n        \"GroupId\":7\n      }\n   ]\n}"},"DeleteAllUsersOnGroup":{"summary":"用户组清理用户","category":"03-权限相关接口","description":"✨ 用户组清理用户","params":[{"name":"GroupId","type":"integer (int64)","required":true,"description":"用户组id"}],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"destructive","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DeleteAllUsersOnGroup\n<公共请求参数>\n\n{\n   \"GroupId\":7\n}"},"DeletePoliciesById":{"summary":"权限组批量删除","category":"03-权限相关接口","description":"✨ 权限组批量删除","params":[{"name":"Id","type":"Array of integer","required":true,"description":"权限组 ID"}],"response":[{"name":"DeletedPolicyId","type":"Array of integer","required":false,"description":"成功删除的权限组 ID"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":["InvalidParameterValue.EmailNotFoundAccount"],"risk":"destructive","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DeletePoliciesById\n<公共请求参数>\n\n{\n    \"Id\": [42]\n}"},"DeleteUserGroupByIds":{"summary":"用户组删除","category":"03-权限相关接口","description":"✨ 用户组删除","params":[{"name":"GroupIds","type":"Array of integer","required":true,"description":"用户组id列表"}],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"destructive","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DeleteUserGroupByIds\n<公共请求参数>\n\n\n{\n   \"GroupIds\":[6,7]\n}"},"DeleteUserGroupUsers":{"summary":"用户组删除用户","category":"03-权限相关接口","description":"✨ 用户组删除用户","params":[{"name":"UserGroupUserInfos","type":"Array of UserGroupUserInfos","required":true,"description":"用户组用户信息"}],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"destructive","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DeleteUserGroupUsers\n<公共请求参数>\n\n{\n   \"UserGroupUserInfos\":[\n      {\n        \"UserId\":3,\n        \"GroupId\":3\n      },\n          {\n        \"UserId\":4,\n        \"GroupId\":5\n      }\n   ]\n}"},"DescribeAvailablePoliciesOnResource":{"summary":"权限组列表查询（指定资源）","category":"03-权限相关接口","description":"✨ 权限组列表查询（指定资源）","params":[{"name":"Filter","type":"DescribeAvailablePoliciesOnResourceRequestFilter","required":true,"description":"查询条件"},{"name":"PageNumber","type":"integer (uint64)","required":true,"description":"请求页数"},{"name":"PageSize","type":"integer (uint64)","required":true,"description":"请求条数"},{"name":"Resource","type":"ResourceInfoOfPolicyScope","required":true,"description":"资源信息"}],"response":[{"name":"Data","type":"DescribeAvailablePoliciesOnResponsePageData","required":false,"description":"分页列表数据"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeAvailablePoliciesOnResource\n<公共请求参数>\n\n{\n    \"PageNumber\": 1,\n    \"PageSize\": 10,\n    \"Resource\": {\n        \"ResourceType\": \"project\",\n        \"ResourceId\": \"1\"\n    },\n    \"Filter\": {\n        \"Visible\": \"true\",\n        \"PolicyAlias\": \"开发\"\n    }\n}"},"DescribeGrantObjectsOnResource":{"summary":"授权对象列表分页查询","category":"03-权限相关接口","description":"✨ 授权对象列表分页查询","params":[{"name":"PageNumber","type":"integer (uint64)","required":true,"description":"页码"},{"name":"PageSize","type":"integer (uint64)","required":true,"description":"每页条数"},{"name":"Resource","type":"ResourceInfo","required":true,"description":"资源信息"}],"response":[{"name":"Data","type":"DescribeGrantObjectsOnResourcePageData","required":false,"description":"授权资源列表分页数据"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"{\n    \"PageNumber\": 1,\n    \"PageSize\": 20,\n    \"Resource\": {\n        \"ResourceId\": \"25\",\n        \"ResourceType\": \"project\"\n    }\n}"},"DescribeGrantUsersOnResource":{"summary":"授权用户列表分页查询","category":"03-权限相关接口","description":"✨ 查询指定资源下授权的用户列表，包括容器内的用户","params":[{"name":"UserIdScope","type":"Array of integer","required":false},{"name":"PolicyIdScope","type":"Array of integer","required":false},{"name":"PageSize","type":"integer (int64)","required":true,"description":"请求条数"},{"name":"PageNumber","type":"integer (int64)","required":true,"description":"请求页数"},{"name":"Resource","type":"RamGrantResourceInfoRequest","required":true,"description":"资源信息"}],"response":[{"name":"Data","type":"DescribeGrantUsersOnResourcePageData","required":false,"description":"指定资源下授权的用户列表"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\n Host: coding.example.com\n Content-Type: application/json\n X-TC-Action: DescribeGrantUsersOnResource\n <公共请求参数>\n {\n \"PageNumber\": 1,\n \"PageSize\": 10,\n \"PolicyIdScope\": [\n 6\n ],\n \"Resource\": {\n \"ResourceId\": \"3\",\n \"ResourceType\": \"project\"\n },\n \"UserIdScope\": [\n\n ]\n }"},"DescribePoliciesOnResourceType":{"summary":"权限组列表查询（指定资源类型）","category":"03-权限相关接口","description":"✨ 权限组列表查询（指定资源类型）","params":[{"name":"Filter","type":"DescribePoliciesOnResourceTypeRequestFilter","required":true,"description":"查询条件"},{"name":"PageNumber","type":"integer (uint64)","required":true,"description":"请求页数"},{"name":"PageSize","type":"integer (uint64)","required":true,"description":"请求条数"}],"response":[{"name":"Data","type":"DescribePoliciesOnResourceTypeResponsePageData","required":false,"description":"分页列表信息"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":["InvalidParameterValue.EmailNotFoundAccount"],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribePoliciesOnResourceType\n<公共请求参数>\n\n{\n\t\"PageNumber\": 1,\n\t\"PageSize\": 10,\n\t\"Filter\": {\n      \"ResourceType\": \"team\",\n      \"Visible\": \"\",\n      \"PolicyAlias\":\"开发\"\n\t}\n}"},"DescribePolicy":{"summary":"权限组详情获取","category":"03-权限相关接口","description":"✨ 权限组详情获取","params":[{"name":"AccurateActions","type":"boolean (bool)","required":true,"description":"针对模糊配置的 action 定义，是否转换成精确的 action 定义返回"},{"name":"PolicyId","type":"integer (int64)","required":true,"description":"权限组 ID"}],"response":[{"name":"PolicyInfo","type":"PolicyDetail","required":false,"description":"权限组详情"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribePolicy\n<公共请求参数>\n\n{\n\t\"PolicyId\":43,\n\t\"AccurateActions\": true\n}"},"DescribePredicatePolicyOnResource":{"summary":"资源权限判定模式获取","category":"03-权限相关接口","description":"✨ 资源权限判定模式获取","params":[{"name":"Resource","type":"ResourceInfo","required":true,"description":"资源信息"}],"response":[{"name":"PredicatePolicyOnResourceInfo","type":"PredicatePolicy","required":false,"description":"资源权限判定策略"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribePredicatePolicyOnResource\n<公共请求参数>\n\n{\n    \"Resource\":{\n        \"ResourceId\":\"8\",\n        \"ResourceType\":\"depot\"\n    }\n}"},"DescribeResourceScopeListOnPolicy":{"summary":"权限组可用资源范围分页查询","category":"03-权限相关接口","description":"✨ 权限组可用资源范围分页查询","params":[{"name":"Filter","type":"DescribeResourceScopeListOnPolicyRequestFilter","required":false,"description":"查询条件"},{"name":"PageNumber","type":"integer (uint64)","required":true,"description":"请求页码"},{"name":"PageSize","type":"integer (uint64)","required":true,"description":"请求条数"},{"name":"PolicyId","type":"integer (int64)","required":true,"description":"权限组 ID"}],"response":[{"name":"Data","type":"DescribeResourceScopeListOnPolicyResponseData","required":false,"description":"分页列表数据"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeResourceScopeListOnPolicy\n<公共请求参数>\n\n{\n  \"PageNumber\": 1,\n  \"PageSize\": 10,\n  \"PolicyId\": 37,\n  \"Filter\": {\n    \"ResourceType\": \"project\"\n  }\n}"},"DescribeUserGroups":{"summary":"用户组列表分页查询","category":"03-权限相关接口","description":"✨ 用户组列表分页查询","params":[{"name":"Filter","type":"DescribeUserGroupsRequestFilter","required":true,"description":"查询条件"},{"name":"PageNumber","type":"integer (uint64)","required":true,"description":"请求页数"},{"name":"PageSize","type":"integer (uint64)","required":true,"description":"请求条数"}],"response":[{"name":"Data","type":"DescribeUserGroupsResponsePageData","required":false,"description":"用户组分页列表信息"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":["InvalidParameterValue.EmailNotFoundAccount"],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeUserGroups\n<公共请求参数>\n\n{\n\t\"PageNumber\": 1,\n\t\"PageSize\": 10,\n\t\"Filter\": {\n\t\"GroupName\": \"\"\n\t}\n}"},"DescribeUsersByGroupId":{"summary":"用户列表查询（根据用户组id分页查询）","category":"03-权限相关接口","description":"✨ 用户列表查询（根据用户组id分页查询）","params":[{"name":"GroupId","type":"integer (uint64)","required":true,"description":"查询条件：GroupId"},{"name":"PageNumber","type":"integer (uint64)","required":true,"description":"请求页数"},{"name":"PageSize","type":"integer (uint64)","required":true,"description":"请求条数"}],"response":[{"name":"Data","type":"DescribeUsersByGroupIdResponsePageData","required":false,"description":"用户列表分页数据"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":["InvalidParameterValue.EmailNotFoundAccount"],"risk":"read","example":"{\n    \"PageNumber\": 1,\n    \"PageSize\": 20,\n    \"GroupId\":2\n}"},"DescribeUsersOnResourceAndGrantObject":{"summary":"授权用户列表分页查询（指定资源）","category":"03-权限相关接口","description":"✨ 授权用户列表分页查询（指定资源）","params":[{"name":"Grant","type":"DescribeUsersOnResourceAndGrantObjectGrantInfo","required":true,"description":"授权对象信息"},{"name":"PageNumber","type":"integer (uint64)","required":true,"description":"请求页数"},{"name":"PageSize","type":"integer (uint64)","required":true,"description":"请求条数"},{"name":"Resource","type":"ResourceInfo","required":true,"description":"资源信息"}],"response":[{"name":"Data","type":"DescribeUsersOnResourceAndGrantObjectPageData","required":false,"description":"指定资源下的授权体用户列表"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"{\n    \"PageNumber\": 1,\n    \"PageSize\": 20,\n    \"Resource\": {\n        \"ResourceId\": \"25\",\n        \"ResourceType\": \"project\"\n    },\n    \"Grant\": {\n        \"GrantObjectId\": \"2\",\n        \"GrantScope\": \"USER_GROUP\"\n    }\n}"},"DetachFromResource":{"summary":"授权收回，只收回参数指定的授权，已有其它授权不受影响","category":"03-权限相关接口","description":"✨ 授权收回，只收回参数指定的授权，已有其它授权不受影响","params":[{"name":"Grants","type":"Array of GrantInfo","required":true,"description":"授权信息"},{"name":"Resource","type":"ResourceInfo","required":true,"description":"授权的资源"}],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DetachFromResource\n<公共请求参数>\n\n{\n  \"Resource\": {\n    \"ResourceType\": \"project\",\n    \"ResourceId\": \"102\",\n    \"ResourceScope\": \"\",\n    \"ServiceName\": \"\",\n    \"RelativeResource\": \"\"\n  },\n  \"Grants\": [\n    {\n      \"GrantScope\": \"USER\",\n      \"GrantObjectId\": \"5\",\n      \"PolicyId\": 6,\n      \"PrincipalKey\": \"\",\n      \"PrincipalValue\": \"\"\n    }\n  ]\n}"},"DetachResourceScopeOnPolicy":{"summary":"权限组可用资源删除，只删除参数指定的资源，已有的其它资源不受影响","category":"03-权限相关接口","description":"✨ 权限组可用资源删除，只删除参数指定的资源，已有的其它资源不受影响","params":[{"name":"PolicyId","type":"integer (int64)","required":true,"description":"权限组 ID"},{"name":"ResourceInfos","type":"Array of ResourceInfoOfPolicyScope","required":true,"description":"删除的资源"}],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DetachResourceScopeOnPolicy\n<公共请求参数>\n\n{\n    \"PolicyId\": 37,\n    \"ResourceInfos\": [\n        {\n            \"ResourceId\": \"1\",\n            \"ResourceType\": \"project\"\n        },\n        {\n            \"ResourceType\": \"project\",\n            \"ResourceId\": \"2\"\n        }\n    ]\n}"},"ModifyPolicy":{"summary":"权限组修改","category":"03-权限相关接口","description":"✨ 权限组修改","params":[{"name":"Alias","type":"string","required":false,"description":"显示名称"},{"name":"Description","type":"string","required":false,"description":"描述"},{"name":"Id","type":"integer (int64)","required":true,"description":"权限组 ID"},{"name":"Name","type":"string","required":false,"description":"名称"},{"name":"PolicyDocument","type":"PolicyDocument","required":true,"description":"授权语句"},{"name":"ResourceType","type":"Array of string","required":true,"description":"适用的资源类型"}],"response":[{"name":"PolicyId","type":"integer (int64)","required":false,"description":"权限组 ID"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: ModifyPolicy\n<公共请求参数>\n\n{\n    \"Id\": 42,\n    \"Name\": \"developer\",\n    \"Alias\": \"开发\",\n    \"Description\": \"desc\",\n    \"ResourceType\": [\n        \"team\"\n    ],\n    \"PolicyDocument\": {\n        \"Statement\": [\n            {\n                \"Effect\": \"ALLOW\",\n                \"Resource\": [\n                    \"*\"\n                ],\n                \"Action\": [\n                    \"ram:createPolicy\"\n                ]\n            }\n        ]\n    }\n}"},"SetGrantToResource":{"summary":"授权设置，收回授权体在资源中的所有授权，重新设置为参数指定的授权","category":"03-权限相关接口","description":"✨ 授权设置，收回授权体在资源中的所有授权，重新设置为参数指定的授权","params":[{"name":"Grants","type":"Array of GrantInfo","required":true,"description":"授权信息"},{"name":"Resource","type":"ResourceInfo","required":true,"description":"授权的资源"}],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\\nContent-Type: application/json\nX-TC-Action: SetGrantToResource\n<公共请求参数>\n{\n  \"Resource\": {\n    \"ResourceType\": \"project \",\n    \"ResourceId\": \"1\",\n    \"ResourceScope\": \"\",\n    \"ServiceName\": \"\",\n    \"RelativeResource\": \"\"\n  },\n  \"Grants\": [\n    {\n      \"GrantScope\": \"USER \",\n      \"GrantObjectId\": \"2 \",\n      \"PolicyId\": 6,\n      \"PrincipalKey\": \"\",\n      \"PrincipalValue\": \"\"\n    }\n  ]\n}"},"SetPredicatePolicyOnResource":{"summary":"资源权限判定策略设置","category":"03-权限相关接口","description":"✨ 资源权限判定策略设置","params":[{"name":"Resource","type":"ResourceInfo","required":true,"description":"资源信息"},{"name":"ResourcePredicatePolicy","type":"string","required":true,"description":"SELF_PARENT // 同时使用父级资源+当前资源\n  SELF_NONE  // 只使用当前消息\n  NONE_PARENT  // 只使用父级资源"}],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: SetPredicatePolicyOnResource\n<公共请求参数>\n\n{\n    \"Resource\":{\n        \"ResourceId\":\"12\",\n        \"ResourceType\":\"depot\"\n    },\n    \"ResourcePredicatePolicy\":\"SELF_PARENT\"\n}"},"UpdateUserGroupById":{"summary":"用户组更新","category":"03-权限相关接口","description":"✨ 用户组更新","params":[{"name":"Description","type":"string","required":true,"description":"用户组描述"},{"name":"GroupId","type":"integer (int64)","required":true,"description":"用户组ID"},{"name":"Name","type":"string","required":true,"description":"用户组名称"}],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: UpdateUserGroupById\n<公共请求参数>\n\n\n{\n  \"Name\":\"tesss3t\",\n  \"GroupId\":8,\n  \"Description\":\"ddd\"\n}"},"CreateCodingProject":{"summary":"项目创建","category":"04-项目相关接口","description":"✨ Coding项目创建","params":[{"name":"Description","type":"string","required":false,"description":"项目描述"},{"name":"DisplayName","type":"string","required":true,"description":"项目名称"},{"name":"Icon","type":"string","required":false,"description":"项目图标"},{"name":"Name","type":"string","required":true,"description":"项目标识"},{"name":"ProjectTemplate","type":"string","required":true,"description":"项目模版 CODE_HOST 代码托管项目， PROJECT_MANAGE 项目管理项目， DEV_OPS DevOps项目， DEMO_BEGIN 范例项目"},{"name":"Shared","type":"integer (uint64)","required":true,"description":"0： 不公开 1：公开源代码"}],"response":[{"name":"ProjectId","type":"integer (uint64)","required":false,"description":"项目Id"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: CreateCodingProject\n<公共请求参数>\n\n{\n    \"DisplayName\": \"coding\", \n    \"Name\": \"coding\", \n    \"ProjectTemplate\": \"DEV_OPS\", \n    \"Description\": \"coding\", \n    \"Shared\": 1, \n    \"Icon\": \"coding\"\n}"},"CreateProjectAnnouncement":{"summary":"项目公告创建","category":"04-项目相关接口","description":"✨ 项目公告创建","params":[{"name":"ProjectName","type":"string","required":true,"description":"项目名"},{"name":"Content","type":"string","required":true,"description":"公告内容"}],"response":[{"name":"ProjectAnnouncement","type":"ProjectAnnouncementProjectAnnouncement","required":false,"description":"公告信息"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: CreateProjectAnnouncement\n<公共请求参数>\n\n{\n  \"ProjectName\": \"xm\",\n  \"Content\": \"公告内容\"\n}"},"CreateProjectLabel":{"summary":"项目标签创建","category":"04-项目相关接口","description":"✨ 项目标签创建","params":[{"name":"ProjectId","type":"integer (int64)","required":true,"description":"项目ID"},{"name":"Name","type":"string","required":true,"description":"标签名"},{"name":"Color","type":"string","required":true,"description":"颜色"}],"response":[{"name":"Label","type":"ProjectLabelLabels","required":false,"description":"创建的标签"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: CreateProjectLabel\n<公共请求参数>\n\n{\n  \"ProjectId\": 1,\n  \"Name\": \"labelName2\",\n  \"Color\": \"#C6C8CC\"\n}"},"CreateProjectMemberPrincipal":{"summary":"项目成员主体新增(包含用户组、部门、成员)","category":"04-项目相关接口","description":"✨ 项目成员主体新增(包含用户组、部门、成员)","params":[{"name":"Principals","type":"Array of PrincipalAdd","required":true,"description":"成员主体信息"},{"name":"ProjectId","type":"integer (uint64)","required":true,"description":"项目Id"}],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: CreateProjectMemberPrincipal\n<公共请求参数>\n\n{\n    \"ProjectId\":15,\n    \"Principals\":[\n        {\n            \"PrincipalId\":\"4\",\n            \"PrincipalType\":\"USER\",\n            \"PolicyIds\":[5,7]\n        }\n    ]\n}"},"CreateProjectWithTemplate":{"summary":"模版项目创建","category":"04-项目相关接口","description":"✨ 模版项目创建","params":[{"name":"Description","type":"string","required":false,"description":"项目描述"},{"name":"DisplayName","type":"string","required":true,"description":"项目名称"},{"name":"Icon","type":"string","required":false,"description":"项目图标"},{"name":"Invisible","type":"boolean (bool)","required":true,"description":"隐藏项目在 CODING 入口不可见  true 不可见|false 可见"},{"name":"Label","type":"string","required":true,"description":"标签(TKE、TCB、SLS、QUICKSTART、APIGW)"},{"name":"Name","type":"string","required":true,"description":"项目标识"},{"name":"ProjectTemplate","type":"string","required":true,"description":"项目模版 CODE_HOST 代码托管项目， PROJECT_MANAGE 项目管理项目， DEV_OPS DevOps项目， DEMO_BEGIN 范例项目"},{"name":"Shared","type":"integer (uint64)","required":true,"description":"0： 不公开 1：公开源代码"}],"response":[{"name":"ProjectId","type":"integer (uint64)","required":false,"description":"项目Id"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: CreateProjectWithTemplate\n<公共请求参数>\n\n{\n    \"DisplayName\": \"coding\", \n    \"Name\": \"coding\", \n    \"ProjectTemplate\": \"DEV_OPS\", \n    \"Description\": \"coding\", \n    \"Shared\": 1, \n    \"Icon\": \"/static/project_icon/scenery-version-2-13.svg\",\n    \"Invisible\": false,\n    \"Label\": \"TKE\"\n}"},"DeleteOneProject":{"summary":"单个项目删除","category":"04-项目相关接口","description":"✨ 单个项目删除","params":[{"name":"ProjectId","type":"integer (uint64)","required":true,"description":"项目Id"}],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"destructive","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DeleteOneProject\n<公共请求参数>\n\n{\n    \"ProjectId\": 123\n}"},"DeleteProjectAnnouncement":{"summary":"项目公告删除","category":"04-项目相关接口","description":"✨ 项目公告删除","params":[{"name":"ProjectName","type":"string","required":true,"description":"项目名"},{"name":"Id","type":"Array of integer","required":true,"description":"要删除的公告ID列表"}],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"destructive","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DeleteProjectAnnouncement\n<公共请求参数>\n\n{\n  \"ProjectName\": \"xm\",\n  \"Id\": [2]\n}"},"DeleteProjectLabel":{"summary":"项目标签删除","category":"04-项目相关接口","description":"✨ 项目标签删除","params":[{"name":"ProjectId","type":"integer (int64)","required":true,"description":"项目ID"},{"name":"LabelId","type":"integer (int64)","required":true,"description":"标签Id"}],"response":[{"name":"Succeed","type":"boolean (bool)","required":false,"description":"是否操作成功"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"destructive","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DeleteProjectLabel\n<公共请求参数>\n\n{\n  \"ProjectId\": 1,\n  \"LabelId\": \"2\"\n}"},"DeleteProjectMemberPrincipal":{"summary":"项目成员主体删除(包含用户组、部门、成员)","category":"04-项目相关接口","description":"✨ 项目成员主体删除(包含用户组、部门、成员)","params":[{"name":"Principals","type":"Array of PrincipalDel","required":true,"description":"成员主体信息"},{"name":"ProjectId","type":"integer (uint64)","required":true,"description":"项目Id"}],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"destructive","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DeleteProjectMemberPrincipal\n<公共请求参数>\n\n{\n    \"ProjectId\":15,\n    \"Principals\":[\n        {\n            \"PrincipalId\":\"4\",\n            \"PrincipalType\":\"USER\"\n        }\n    ]\n}"},"DescribeAllProjectLabels":{"summary":"项目标签查询","category":"04-项目相关接口","description":"✨ 项目标签查询","params":[{"name":"ProjectId","type":"integer (int64)","required":true,"description":"项目ID"}],"response":[{"name":"Labels","type":"Array of ProjectLabelLabels","required":false,"description":"标签列表"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeAllProjectLabels\n<公共请求参数>\n\n{\n  \"ProjectId\": 1\n}"},"DescribeCodingProjects":{"summary":"项目列表查询","category":"04-项目相关接口","description":"✨ 项目列表查询","params":[{"name":"PageNumber","type":"integer (uint64)","required":true,"description":"页数"},{"name":"PageSize","type":"integer (uint64)","required":true,"description":"每页条数"},{"name":"ProjectName","type":"string","required":false,"description":"项目名称"},{"name":"QueryArchived","type":"boolean","required":false,"description":"是否查询归档项目，默认 false 不查询归档项目"}],"response":[{"name":"Data","type":"ProjectsData","required":false,"description":"项目集合"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeCodingProjects\n<公共请求参数>\n\n{\n    \"ProjectName\": \"coding\",\n    \"PageNumber\": 1,\n    \"PageSize\": 10,\n    \"QueryArchived\": true\n}"},"DescribeOneProject":{"summary":"单个项目查询","category":"04-项目相关接口","description":"✨ 单个项目查询","params":[{"name":"ProjectId","type":"integer (uint64)","required":true,"description":"项目编号"}],"response":[{"name":"Project","type":"Project","required":false,"description":"项目信息"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeOneProject\n<公共请求参数>\n\n{\n    \"ProjectId\": 2\n}"},"DescribeProjectAnnouncement":{"summary":"项目公告查询","category":"04-项目相关接口","description":"✨ 项目公告查询","params":[{"name":"ProjectName","type":"string","required":true,"description":"项目名"},{"name":"Id","type":"integer (int64)","required":true,"description":"公告ID"}],"response":[{"name":"ProjectAnnouncement","type":"ProjectAnnouncementProjectAnnouncement","required":false,"description":"公告信息"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeProjectAnnouncement\n<公共请求参数>\n\n{\n  \"ProjectName\": \"xm\",\n  \"Id\": 3\n}"},"DescribeProjectAnnouncements":{"summary":"项目公告列表查询","category":"04-项目相关接口","description":"✨ 项目公告列表查询","params":[{"name":"PageSize","type":"integer (int64)","required":true,"description":"每页数量"},{"name":"PageNumber","type":"integer (int64)","required":true,"description":"页数"},{"name":"ProjectName","type":"string","required":true,"description":"项目名"}],"response":[{"name":"TotalCount","type":"integer (int64)","required":false,"description":"公告总数"},{"name":"PageSize","type":"integer (int64)","required":false,"description":"每页数量"},{"name":"PageNumber","type":"integer (int64)","required":false,"description":"页数"},{"name":"List","type":"Array of ProjectAnnouncementProjectAnnouncement","required":false,"description":"公告列表"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeProjectAnnouncements\n<公共请求参数>\n\n{\n  \"ProjectName\": \"xm\",\n  \"PageSize\": 10,\n  \"PageNumber\": 1\n}"},"DescribeProjectByName":{"summary":"项目查询(通过项目名称)","category":"04-项目相关接口","description":"✨ 项目查询(通过项目名称)","params":[{"name":"ProjectName","type":"string","required":true,"description":"项目名称"}],"response":[{"name":"Project","type":"Project","required":false,"description":"项目信息"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeProjectByName\n<公共请求参数>\n\n{\n    \"ProjectName\": \"coding-demo\"\n}"},"DescribeProjectCredentials":{"summary":"项目凭据列表查询","category":"04-项目相关接口","description":"✨ 项目凭据列表查询","params":[{"name":"ProjectId","type":"integer (uint64)","required":true,"description":"项目 ID"}],"response":[{"name":"Data","type":"DescribeProjectCredentialsData","required":false,"description":"获取凭据列表"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeProjectCredentials\n<公共请求参数>\n\n{\n  \"ProjectId\": 12\n}"},"DescribeProjectLabels":{"summary":"项目列表查询-指定项目标签","category":"04-项目相关接口","description":"✨ 项目列表查询-指定项目标签","params":[{"name":"Label","type":"string","required":false,"description":"标签"}],"response":[{"name":"ProjectList","type":"Array of Project","required":false,"description":"项目列表信息"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeProjectLabels\n<公共请求参数>\n\n{\n  \"Label\": \"Demo\"\n}"},"DescribeProjectMemberPrincipals":{"summary":"项目成员主体查询(包含用户组、部门、成员)","category":"04-项目相关接口","description":"✨ 项目成员主体查询(包含用户组、部门、成员)","params":[{"name":"Keyword","type":"string","required":false,"description":"关键字搜索：成员名/邮箱"},{"name":"PageNumber","type":"integer (uint64)","required":true,"description":"请求页数"},{"name":"PageSize","type":"integer (uint64)","required":true,"description":"请求条数"},{"name":"PolicyId","type":"integer (int64)","required":false,"description":"权限组Id"},{"name":"ProjectId","type":"integer (uint64)","required":true,"description":"项目Id"}],"response":[{"name":"Data","type":"PrincipalData","required":false,"description":"成员主体信息"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":["InvalidParameterValue.EmailNotFoundAccount"],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeProjectMemberPrincipals\n<公共请求参数>\n\n\n{\n    \"PageNumber\": 1, \n    \"PageSize\": 1,\n    \"Keyword\": \"coding\", \n    \"ProjectId\": 1, \n    \"PolicyId\": 1\n}"},"DescribeProjectMembers":{"summary":"项目成员列表查询","category":"04-项目相关接口","description":"✨ 项目成员列表查询","params":[{"name":"PageNumber","type":"integer (uint64)","required":true,"description":"请求页数"},{"name":"PageSize","type":"integer (uint64)","required":true,"description":"请求条数"},{"name":"ProjectId","type":"integer (uint64)","required":true,"description":"项目Id"},{"name":"RoleId","type":"integer (uint64)","required":false,"description":"用户组Id"}],"response":[{"name":"Data","type":"ProjectMemberData","required":false,"description":"项目成员分页列表信息"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeProjectMembers\n<公共请求参数>\n\n{\n\t\"PageNumber\": 1,\n\t\"PageSize\": 10,\n\t\"ProjectId\":1,\n         \"RoleId\":1\n}"},"DescribeProjectRoles":{"summary":"项目用户组查询","category":"04-项目相关接口","description":"✨ 项目用户组查询","params":[{"name":"ProjectId","type":"integer (uint64)","required":true,"description":"项目Id"}],"response":[{"name":"Roles","type":"Array of Role","required":false,"description":"用户组"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeProjectRoles\n<公共请求参数>\n\n{\n         \"ProjectId\":1\n}"},"DescribeProjectsByFeature":{"summary":"项目查询（通过一级菜单名）","category":"04-项目相关接口","description":"✨ 项目查询（通过一级菜单名查询开启某个模块的项目）","params":[{"name":"MenuName","type":"string","required":true,"description":"一级菜单名称"}],"response":[{"name":"ProjectId","type":"Array of integer","required":false,"description":"项目id"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeProjectsByFeature\n<公共请求参数>\n\n{\n    \"MenuName\":\"项目协同\"\n}"},"DescribeUserProjects":{"summary":"项目列表查询（已加入的项目）","category":"04-项目相关接口","description":"✨ 项目列表查询（已加入的项目）","params":[{"name":"ProjectName","type":"string","required":false,"description":"项目名称"},{"name":"UserId","type":"integer (int64)","required":true,"description":"用户编号"}],"response":[{"name":"ProjectList","type":"Array of Project","required":false,"description":"项目列表信息"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeUserProjects\n<公共请求参数>\n\n{\n    \"UserId\": 1,\n    \"ProjectName\": \"coding\"\n}"},"ModifyProject":{"summary":"项目信息修改","category":"04-项目相关接口","description":"✨ 项目信息修改","params":[{"name":"Description","type":"string","required":false,"description":"项目描述"},{"name":"DisplayName","type":"string","required":true,"description":"项目名称"},{"name":"EndDate","type":"string","required":false,"description":"结束时间"},{"name":"Name","type":"string","required":true,"description":"项目标识"},{"name":"ProjectId","type":"integer (int64)","required":true,"description":"项目编号"},{"name":"StartDate","type":"string","required":false,"description":"开始时间"}],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: ModifyProject\n<公共请求参数>\n\n{\n    \"ProjectId\":455,\n    \"Name\":\"coding-dev\",\n    \"DisplayName\":\"coding-dev\",\n    \"Description\":\"coding\",\n    \"StartDate\":\"2021-01-30\",\n    \"EndDate\":\"2021-03-28\"\n}"},"ModifyProjectAnnouncement":{"summary":"项目公告更新","category":"04-项目相关接口","description":"✨ 项目公告更新","params":[{"name":"ProjectName","type":"string","required":true,"description":"项目名"},{"name":"Content","type":"string","required":true,"description":"公告内容"},{"name":"Id","type":"integer (int64)","required":true,"description":"公告id"}],"response":[{"name":"ProjectAnnouncement","type":"ProjectAnnouncementProjectAnnouncement","required":false,"description":"公告信息"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: ModifyProjectAnnouncement\n<公共请求参数>\n\n{\n  \"ProjectName\": \"xm\",\n  \"Content\": \"新公告内容\",\n  \"Id\": 3\n}"},"ModifyProjectArchive":{"summary":"归档项目","category":"04-项目相关接口","description":"✨ 归档项目","params":[{"name":"ProjectId","type":"integer (int64)","required":true,"description":"项目 ID"}],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: ModifyProjectArchive\n<公共请求参数>\n\n{\n    \"ProjectId\": 123\n}"},"ModifyProjectLabel":{"summary":"项目标签修改","category":"04-项目相关接口","description":"✨ 项目标签修改","params":[{"name":"ProjectId","type":"integer (int64)","required":true,"description":"项目ID"},{"name":"LabelId","type":"integer (int64)","required":true,"description":"标签Id"},{"name":"Name","type":"string","required":true,"description":"标签名"},{"name":"Color","type":"string","required":true,"description":"颜色"}],"response":[{"name":"Label","type":"ProjectLabelLabels","required":false,"description":"创建的标签"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: ModifyProjectLabel\n<公共请求参数>\n\n{\n  \"ProjectId\": 1,\n  \"Name\": \"labelName3\",\n  \"Color\": \"#C6C8CC\",\n  \"LabelId\": \"2\"\n}"},"ModifyProjectUnarchive":{"summary":"取消归档项目","category":"04-项目相关接口","description":"✨ 取消归档项目","params":[{"name":"ProjectId","type":"integer (int64)","required":true,"description":"项目 ID"}],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: ModifyProjectUnarchive\n<公共请求参数>\n\n{\n    \"ProjectId\": 123\n}"},"CreateProgram":{"summary":"项目集创建","category":"05-项目集相关接口","description":"✨ 项目集创建","params":[{"name":"Description","type":"string","required":true,"description":"描述信息"},{"name":"DisplayName","type":"string","required":true,"description":"展示名"},{"name":"EndDate","type":"string","required":true,"description":"截止时间"},{"name":"Name","type":"string","required":true,"description":"项目集名"},{"name":"StartDate","type":"string","required":true,"description":"开始时间"},{"name":"WorkflowProgramId","type":"string","required":false,"description":"已有工作流项目集 Id"}],"response":[{"name":"Data","type":"ProgramProgram","required":false,"description":"项目集信息"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: CreateProgram\n<公共请求参数>\n\n{\n\t\"Description\": \"这是描述\",\n\t\"DisplayName\": \"展示名\",\n\t\"EndDate\": \"2000-01-01\",\n\t\"Name\": \"program\",\n\t\"StartDate\": \"2000-01-01\",\n\t\"WorkflowProgramId\": \"\"\n}"},"CreateProgramMemberPolicy":{"summary":"项目集成员权限组添加","category":"05-项目集相关接口","description":"✨ 项目集成员权限组添加","params":[{"name":"Policies","type":"Array of string","required":true,"description":"权限策略，默认策略名或者策略 ID"},{"name":"PrincipalId","type":"string","required":true,"description":"身份 ID"},{"name":"PrincipalType","type":"string","required":true,"description":"身份类型"},{"name":"ProgramId","type":"integer (int64)","required":true,"description":"项目集 ID"}],"response":[{"name":"Data","type":"Array of ProgramProgramMemberPolicy","required":false},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: CreateProgramMemberPolicy\n<公共请求参数>\n\n{\n    \"ProgramId\": 5,\n    \"PrincipalType\":\"USER\",\n    \"PrincipalId\":\"4\",\n    \"Policies\":[\"ProgramAdmin\",\"ProgramMember\"]\n}"},"CreateProgramProjects":{"summary":"项目集中添加项目","category":"05-项目集相关接口","description":"✨ 项目集中添加项目","params":[{"name":"ProgramId","type":"integer (int64)","required":true,"description":"项目集 ID"},{"name":"ProjectId","type":"Array of integer","required":true,"description":"项目 ID"}],"response":[{"name":"Data","type":"Array of ProgramProgram","required":false},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: CreateProgramProjects\n<公共请求参数>\n\n{\n    \"ProgramId\": 5,\n\t\"ProjectId\":[1,2,3]\n}"},"DeleteProgramMemberPolicy":{"summary":"项目集成员权限组删除","category":"05-项目集相关接口","description":"✨ 项目集成员权限组删除","params":[{"name":"Policies","type":"Array of string","required":true,"description":"权限策略，默认策略名或者策略 ID"},{"name":"PrincipalId","type":"string","required":true,"description":"身份 ID"},{"name":"PrincipalType","type":"string","required":true,"description":"身份类型"},{"name":"ProgramId","type":"integer (int64)","required":true,"description":"项目集 ID"}],"response":[{"name":"Data","type":"Array of ProgramProgramMemberPolicy","required":false},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"destructive","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DeleteProgramMemberPolicy\n<公共请求参数>\n\n{\n    \"ProgramId\": 5,\n    \"PrincipalType\":\"USER\",\n    \"PrincipalId\":\"4\",\n    \"Policies\":[\"ProgramAdmin\"]\n}"},"DescribeProgramProjects":{"summary":"项目集下项目列表查询","category":"05-项目集相关接口","description":"✨ 项目集下项目列表查询","params":[{"name":"ProgramId","type":"integer (uint64)","required":true,"description":"项目集 ID"}],"response":[{"name":"Data","type":"Array of Program","required":false,"description":"项目集下项目列表数据"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeProgramProjects\n<公共请求参数>\n\n{\n    \"ProgramId\": 1\n}"},"DescribePrograms":{"summary":"项目集列表查询","category":"05-项目集相关接口","description":"✨ 项目集列表查询","params":[{"name":"Keyword","type":"string","required":false,"description":"关键字搜索：项目名"},{"name":"PageNumber","type":"integer (uint64)","required":true,"description":"请求页数"},{"name":"PageSize","type":"integer (uint64)","required":true,"description":"请求条数"}],"response":[{"name":"Data","type":"ProgramData","required":false,"description":"项目集数据"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":["InvalidParameterValue.EmailNotFoundAccount"],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribePrograms\n<公共请求参数>\n\n\n{\n    \"PageNumber\": 1, \n    \"PageSize\": 1,\n    \"Keyword\": \"coding\"\n}"},"CreateServiceHook":{"summary":"Service Hook 创建","category":"06-Service Hook 相关接口","description":"✨ Service Hook 创建","params":[{"name":"ActionProperty","type":"string","required":true,"description":"发送方式属性"},{"name":"Enabled","type":"boolean (bool)","required":true,"description":"事件开关"},{"name":"Event","type":"Array of string","required":true,"description":"事件名，取值范围：ITERATION_CREATED,ITERATION_DELETED,ITERATION_UPDATED,ISSUE_CREATED,ISSUE_DELETED,ISSUE_COMMENT_CREATED,ISSUE_STATUS_UPDATED,ISSUE_ASSIGNEE_CHANGED,ISSUE_ITERATION_CHANGED,ISSUE_RELATIONSHIP_CHANGED,ISSUE_UPDATED,GIT_PUSHED,GIT_MR_CREATED,GIT_MR_UPDATED,GIT_MR_MERGED,GIT_MR_CLOSED,ARTIFACTS_VERSION_CREATED,ARTIFACTS_VERSION_UPDATED,ARTIFACTS_VERSION_DOWNLOADED,ARTIFACTS_VERSION_DELETED,ARTIFACTS_VERSION_RELEASED,ARTIFACTS_VERSION_DOWNLOAD_FORBIDDEN,ARTIFACTS_VERSION_DOWNLOAD_ALLOWED,ARTIFACTS_VERSION_DOWNLOAD_BLOCKED,ARTIFACTS_REPO_CREATED,ARTIFACTS_REPO_UPDATED,ARTIFACTS_REPO_DELETED,CI_JOB_CREATED,CI_JOB_UPDATED,CI_JOB_DELETED,CI_JOB_STARTED,CI_JOB_FINISHED,FILE_CREATED,FILE_UPDATED,FILE_RENAMED,FILE_SHARE_UPDATED,FILE_MOVED,FILE_COPIED,FILE_MOVED_TO_RECYCLE_BIN,FILE_RESTORED_FROM_RECYCLE_BIN,FILE_DELETED,WIKI_CREATED,WIKI_UPDATED,WIKI_MOVED,WIKI_SHARE_UPDATED,WIKI_ACCESS_UPDATED,WIKI_COPIED,WIKI_MOVED_TO_RECYCLE_BIN,WIKI_RESTORED_FROM_RECYCLE_BIN,WIKI_DELETED,MEMBER_CREATED,MEMBER_DELETED,MEMBER_ROLE_UPDATED,TEST_PLAN_CREATED, TEST_PLAN_UPDATED, TEST_PLAN_FINISHED, TEST_TASK_ASSIGNED, TEST_REPORT_CREATED, FLEXIBLE_TESTX_REVIEW_CREATED, FLEXIBLE_TESTX_REVIEW_COMMENTED, FLEXIBLE_TESTX_REVIEW_UPDATED, FLEXIBLE_TESTX_REVIEW_COMPLETED, FLEXIBLE_TESTX_PLAN_CREATED, FLEXIBLE_TESTX_PLAN_TASK_ASSIGNED, FLEXIBLE_TESTX_PLAN_UPDATED, FLEXIBLE_TESTX_PLAN_FINISHED, FLEXIBLE_TESTX_REPORT_CREATED, CODE_DOG_CREATE_JOB, CODE_DOG_RESULT_NOTIFY, PLAN_CREATED, PLAN_DELETED, PLAN_COMMENT_CREATED, PLAN_STATUE_CHANGED, PLAN_ASSIGNEE_CHANGED, PLAN_UPDATED, RISK_CREATED, RISK_DELETED, RISK_COMMENT_CREATED, RISK_STATUS_CHANGED, RISK_ASSIGNEE_CHANGED, RISK_UPDATED"},{"name":"FilterProperty","type":"string","required":false,"description":"过滤器属性"},{"name":"Name","type":"string","required":false,"description":"备注名"},{"name":"ProjectId","type":"integer (int64)","required":true,"description":"项目编号或者研发空间编号"},{"name":"Service","type":"string","required":true,"description":"服务名，取值范围：WebHook、WeCom、DingDing、Jenkins、FeiShu。"},{"name":"ServiceAction","type":"string","required":true,"description":"发送方式，取值范围：dingding_group_chat_robot,wecom_group_chat_robot,jenkins_generic_build_job,feishu_group_chat_robot,webhook_http_post,webhook_http_get"},{"name":"TargetType","type":"string","required":false,"description":"目标数据类型：PROJECT,SPACE_NODE,PROGRAM,默认PROJECT"}],"response":[{"name":"ServiceHook","type":"ServiceHook","required":false,"description":"Service Hook 数据"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: CreateServiceHook\n<公共请求参数>\n\n{\n  \"ProjectId\": 450,\n  \"TargetType\": \"PROJECT\",\n  \"Name\": \"测试 OpenAPI 创建\",\n  \"Service\": \"WeCom\",\n  \"Event\": [\n    \"ISSUE_CREATED\"\n  ],\n  \"FilterProperty\": \"{\\\"type\\\":\\\"MISSION\\\",\\\"priority\\\":\\\"1\\\"}\",\n  \"ActionProperty\": \"{\\\"service_url\\\":\\\"https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=9f3bf247-35db-4fd1-bbca-d29e5e5efc02\\\",\\\"msg_type\\\":\\\"markdown\\\"}\",\n  \"ServiceAction\": \"wecom_group_chat_robot\",\n  \"Enabled\": true\n}"},"DeleteServiceHook":{"summary":"Service Hook 删除","category":"06-Service Hook 相关接口","description":"✨ Service Hook 删除","params":[{"name":"Id","type":"Array of string","required":true,"description":"Service Hook 编号"},{"name":"ProjectId","type":"integer (int64)","required":true,"description":"项目编号或者研发空间编号"},{"name":"TargetType","type":"string","required":false,"description":"目标数据类型：PROJECT,SPACE_NODE,PROGRAM,默认PROJECT"}],"response":[{"name":"Succeed","type":"boolean (bool)","required":false,"description":"是否操作成功"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"destructive","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DeleteServiceHook\n<公共请求参数>\n\n{\n  \"Id\":[\"aebb098f-fe9d-4712-afba-60c570aa20fa\",\"dd5a3b12-3a5b-4b57-8444-d84100ec8c4f\"],\n  \"ProjectId\": 450,\n  \"TargetType\":\"PROJECT\"\n}"},"DescribeEvents":{"summary":"Service Hook 事件列表查询","category":"06-Service Hook 相关接口","description":"✨ 查询 Service Hook 事件列表，返回事件英文标识、事件中文名、事件分组英文标识、事件分组中文名","params":[],"response":[{"name":"Event","type":"Array of ServiceHookEvent","required":false,"description":"事件列表"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeEvents\n<公共请求参数>\n\n{\n}"},"DescribeServiceHook":{"summary":"Service Hook 查询单条","category":"06-Service Hook 相关接口","description":"✨ Service Hook 查询","params":[{"name":"Id","type":"string","required":true,"description":"service-hook-id"},{"name":"ProjectId","type":"integer (int64)","required":true,"description":"项目或者研发空间id"},{"name":"TargetType","type":"string","required":false,"description":"目标数据类型：PROJECT,SPACE_NODE,PROGRAM,默认PROJECT"}],"response":[{"name":"ServiceHook","type":"ServiceHook","required":false,"description":"{}"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeServiceHook\n<公共请求参数>\n\n{\n  \"Id\":\"8b9fb687-f2db-46a4-ba2b-0afd3c652633\",\n  \"ProjectId\": 3\n\n}"},"DescribeServiceHookLogs":{"summary":"Service Hook 发送记录分页查询","category":"06-Service Hook 相关接口","description":"✨ Service Hook 发送记录分页查询","params":[{"name":"Id","type":"string","required":true,"description":"Service Hook 编号"},{"name":"PageNumber","type":"integer (int64)","required":true,"description":"分页页码"},{"name":"PageSize","type":"integer (int64)","required":true,"description":"分页大小"},{"name":"ProjectId","type":"integer (int64)","required":true,"description":"项目编号"},{"name":"TargetType","type":"string","required":false,"description":"目标数据类型：PROJECT,SPACE_NODE,PROGRAM,默认PROJECT"}],"response":[{"name":"Data","type":"ServiceHookLogPage","required":false,"description":"Service Hook 发送记录分页"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeServiceHookLogs\n<公共请求参数>\n\n{\n  \"Id\":\"922fadc5-5d5d-4301-a527-ce69d934c268\",\n  \"ProjectId\": 450,\n  \"PageNumber\" :1,\n  \"PageSize\":20,\n  \"TargetType\":\"PROJECT\"\n}"},"DescribeServiceHooks":{"summary":"Service Hook 列表分页查询","category":"06-Service Hook 相关接口","description":"✨ Service Hook 列表分页查询","params":[{"name":"CreatorBy","type":"Array of integer","required":false,"description":"创建人编号"},{"name":"Enabled","type":"string","required":false,"description":"事件开关，取值范围：true、false"},{"name":"Event","type":"Array of string","required":false,"description":"事件名，取值范围：ITERATION_CREATED,ITERATION_DELETED,ITERATION_UPDATED,ISSUE_CREATED,ISSUE_DELETED,ISSUE_COMMENT_CREATED,ISSUE_STATUS_UPDATED,ISSUE_ASSIGNEE_CHANGED,ISSUE_ITERATION_CHANGED,ISSUE_RELATIONSHIP_CHANGED,ISSUE_UPDATED,GIT_PUSHED,GIT_MR_CREATED,GIT_MR_UPDATED,GIT_MR_MERGED,GIT_MR_CLOSED,ARTIFACTS_VERSION_CREATED,ARTIFACTS_VERSION_UPDATED,ARTIFACTS_VERSION_DOWNLOADED,ARTIFACTS_VERSION_DELETED,ARTIFACTS_VERSION_RELEASED,ARTIFACTS_VERSION_DOWNLOAD_FORBIDDEN,ARTIFACTS_VERSION_DOWNLOAD_ALLOWED,ARTIFACTS_VERSION_DOWNLOAD_BLOCKED,ARTIFACTS_REPO_CREATED,ARTIFACTS_REPO_UPDATED,ARTIFACTS_REPO_DELETED,CI_JOB_CREATED,CI_JOB_UPDATED,CI_JOB_DELETED,CI_JOB_STARTED,CI_JOB_FINISHED,FILE_CREATED,FILE_UPDATED,FILE_RENAMED,FILE_SHARE_UPDATED,FILE_MOVED,FILE_COPIED,FILE_MOVED_TO_RECYCLE_BIN,FILE_RESTORED_FROM_RECYCLE_BIN,FILE_DELETED,WIKI_CREATED,WIKI_UPDATED,WIKI_MOVED,WIKI_SHARE_UPDATED,WIKI_ACCESS_UPDATED,WIKI_COPIED,WIKI_MOVED_TO_RECYCLE_BIN,WIKI_RESTORED_FROM_RECYCLE_BIN,WIKI_DELETED,MEMBER_CREATED,MEMBER_DELETED,MEMBER_ROLE_UPDATED,TEST_PLAN_CREATED, TEST_PLAN_UPDATED, TEST_PLAN_FINISHED, TEST_TASK_ASSIGNED, TEST_REPORT_CREATED, FLEXIBLE_TESTX_REVIEW_CREATED, FLEXIBLE_TESTX_REVIEW_COMMENTED, FLEXIBLE_TESTX_REVIEW_UPDATED, FLEXIBLE_TESTX_REVIEW_COMPLETED, FLEXIBLE_TESTX_PLAN_CREATED, FLEXIBLE_TESTX_PLAN_TASK_ASSIGNED, FLEXIBLE_TESTX_PLAN_UPDATED, FLEXIBLE_TESTX_PLAN_FINISHED, FLEXIBLE_TESTX_REPORT_CREATED, CODE_DOG_CREATE_JOB, CODE_DOG_RESULT_NOTIFY, PLAN_CREATED, PLAN_DELETED, PLAN_COMMENT_CREATED, PLAN_STATUE_CHANGED, PLAN_ASSIGNEE_CHANGED, PLAN_UPDATED, RISK_CREATED, RISK_DELETED, RISK_COMMENT_CREATED, RISK_STATUS_CHANGED, RISK_ASSIGNEE_CHANGED, RISK_UPDATED"},{"name":"Name","type":"string","required":false,"description":"备注名，支持模糊匹配"},{"name":"PageNumber","type":"integer (int64)","required":true,"description":"分页页码"},{"name":"PageSize","type":"integer (int64)","required":true,"description":"分页大小"},{"name":"ProjectId","type":"integer (int64)","required":true,"description":"项目编号"},{"name":"Service","type":"Array of string","required":false,"description":"服务名，取值范围：WebHook、WeCom、DingDing、Jenkins、FeiShu。"},{"name":"Status","type":"string","required":false,"description":"状态，取值范围：SUCCESS、FAILURE"},{"name":"TargetType","type":"string","required":true,"description":"目标数据类型：PROJECT,SPACE_NODE,PROGRAM,默认PROJECT"}],"response":[{"name":"Data","type":"ServiceHookPage","required":false,"description":"Service Hook 分页数据"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeServiceHooks\n<公共请求参数>\n\n{\n    \"ProjectId\":450,\n    \"Name\" :\"4\",\n    \"CreatorBy\" :[1,2],\n    \"Enabled\" :\"true\",\n    \"Event\":[\"ITERATION_CREATED\",\"MEMBER_ROLE_UPDATED\"],\n    \"Service\":[\"WeCom\",\"WebHook\"],\n    \"Status\":\"FAILURE\",\n    \"PageNumber\" :1,\n    \"PageSize\":20,\n    \"TargetType\":\"PROJECT\"\n}"},"EnabledServiceHook":{"summary":"Service Hook 事件开关","category":"06-Service Hook 相关接口","description":"✨ Service Hook 事件开关","params":[{"name":"Enabled","type":"boolean (bool)","required":true,"description":"是否开启"},{"name":"Id","type":"Array of string","required":true,"description":"Service Hook 编号"},{"name":"ProjectId","type":"integer (int64)","required":true,"description":"项目或者研发空间编号"},{"name":"TargetType","type":"string","required":true,"description":"目标数据类型：PROJECT,SPACE_NODE,PROGRAM,默认PROJECT"}],"response":[{"name":"Succeed","type":"boolean (bool)","required":false,"description":"是否操作成功"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: EnabledServiceHook\n<公共请求参数>\n\n{\n  \"Id\":[\"aebb098f-fe9d-4712-afba-60c570aa20fa\",\"dd5a3b12-3a5b-4b57-8444-d84100ec8c4f\"],\n  \"ProjectId\": 450,\n  \"TargetType\": \"PROJECT\",\n  \"Enabled\":true\n}"},"ModifyServiceHook":{"summary":"Service Hook 修改","category":"06-Service Hook 相关接口","description":"✨ Service Hook 修改","params":[{"name":"ActionProperty","type":"string","required":true,"description":"发送方式属性"},{"name":"Enabled","type":"boolean (bool)","required":true,"description":"事件开关"},{"name":"Event","type":"Array of string","required":true,"description":"事件名，取值范围：ITERATION_CREATED,ITERATION_DELETED,ITERATION_UPDATED,ISSUE_CREATED,ISSUE_DELETED,ISSUE_COMMENT_CREATED,ISSUE_STATUS_UPDATED,ISSUE_ASSIGNEE_CHANGED,ISSUE_ITERATION_CHANGED,ISSUE_RELATIONSHIP_CHANGED,ISSUE_UPDATED,GIT_PUSHED,GIT_MR_CREATED,GIT_MR_UPDATED,GIT_MR_MERGED,GIT_MR_CLOSED,ARTIFACTS_VERSION_CREATED,ARTIFACTS_VERSION_UPDATED,ARTIFACTS_VERSION_DOWNLOADED,ARTIFACTS_VERSION_DELETED,ARTIFACTS_VERSION_RELEASED,ARTIFACTS_VERSION_DOWNLOAD_FORBIDDEN,ARTIFACTS_VERSION_DOWNLOAD_ALLOWED,ARTIFACTS_VERSION_DOWNLOAD_BLOCKED,ARTIFACTS_REPO_CREATED,ARTIFACTS_REPO_UPDATED,ARTIFACTS_REPO_DELETED,CI_JOB_CREATED,CI_JOB_UPDATED,CI_JOB_DELETED,CI_JOB_STARTED,CI_JOB_FINISHED,FILE_CREATED,FILE_UPDATED,FILE_RENAMED,FILE_SHARE_UPDATED,FILE_MOVED,FILE_COPIED,FILE_MOVED_TO_RECYCLE_BIN,FILE_RESTORED_FROM_RECYCLE_BIN,FILE_DELETED,WIKI_CREATED,WIKI_UPDATED,WIKI_MOVED,WIKI_SHARE_UPDATED,WIKI_ACCESS_UPDATED,WIKI_COPIED,WIKI_MOVED_TO_RECYCLE_BIN,WIKI_RESTORED_FROM_RECYCLE_BIN,WIKI_DELETED,MEMBER_CREATED,MEMBER_DELETED,MEMBER_ROLE_UPDATED,TEST_PLAN_CREATED, TEST_PLAN_UPDATED, TEST_PLAN_FINISHED, TEST_TASK_ASSIGNED, TEST_REPORT_CREATED, FLEXIBLE_TESTX_REVIEW_CREATED, FLEXIBLE_TESTX_REVIEW_COMMENTED, FLEXIBLE_TESTX_REVIEW_UPDATED, FLEXIBLE_TESTX_REVIEW_COMPLETED, FLEXIBLE_TESTX_PLAN_CREATED, FLEXIBLE_TESTX_PLAN_TASK_ASSIGNED, FLEXIBLE_TESTX_PLAN_UPDATED, FLEXIBLE_TESTX_PLAN_FINISHED, FLEXIBLE_TESTX_REPORT_CREATED, CODE_DOG_CREATE_JOB, CODE_DOG_RESULT_NOTIFY, PLAN_CREATED, PLAN_DELETED, PLAN_COMMENT_CREATED, PLAN_STATUE_CHANGED, PLAN_ASSIGNEE_CHANGED, PLAN_UPDATED, RISK_CREATED, RISK_DELETED, RISK_COMMENT_CREATED, RISK_STATUS_CHANGED, RISK_ASSIGNEE_CHANGED, RISK_UPDATED"},{"name":"FilterProperty","type":"string","required":true,"description":"过滤器属性"},{"name":"Id","type":"string","required":true,"description":"Service Hook 编号"},{"name":"Name","type":"string","required":false,"description":"备注名"},{"name":"ProjectId","type":"integer (int64)","required":true,"description":"项目编号或者研发空间编号"},{"name":"Service","type":"string","required":true,"description":"服务名，取值范围：WebHook、WeCom、DingDing、Jenkins、FeiShu。"},{"name":"ServiceAction","type":"string","required":true,"description":"发送方式，取值范围：dingding_group_chat_robot,wecom_group_chat_robot,jenkins_generic_build_job,feishu_group_chat_robot,webhook_http_post,webhook_http_get"},{"name":"TargetType","type":"string","required":false,"description":"目标数据类型：PROJECT,SPACE_NODE,PROGRAM,默认PROJECT"}],"response":[{"name":"ServiceHook","type":"ServiceHook","required":false,"description":"Service Hook 数据"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: ModifyServiceHook\n<公共请求参数>\n\n{\n  \"Id\":\"922fadc5-5d5d-4301-a527-ce69d934c268\",\n  \"ProjectId\": 450,\n   \"TargetType\":\"SPACE\",\n  \"Name\": \"测试 OpenAPI 创建\",\n  \"Service\": \"WeCom\",\n  \"Event\": [\n    \"ISSUE_CREATED\"\n  ],\n  \"FilterProperty\": \"{\\\"type\\\":\\\"MISSION\\\",\\\"priority\\\":\\\"1\\\"}\",\n  \"ActionProperty\": \"{\\\"service_url\\\":\\\"https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=9f3bf247-35db-4fd1-bbca-d29e5e5efc02\\\",\\\"msg_type\\\":\\\"markdown\\\"}\",\n  \"ServiceAction\": \"wecom_group_chat_robot\",\n  \"Enabled\": true\n}"},"PingServiceHook":{"summary":"Service Hook 测试","category":"06-Service Hook 相关接口","description":"✨ Service Hook 测试","params":[{"name":"Id","type":"Array of string","required":true,"description":"Service Hook 编号"},{"name":"ProjectId","type":"integer (int64)","required":true,"description":"项目编号或者研发空间标号"},{"name":"TargetType","type":"string","required":false,"description":"目标数据类型：PROJECT,SPACE_NODE,PROGRAM,默认PROJECT"}],"response":[{"name":"Succeed","type":"boolean (bool)","required":false,"description":"是否操作成功"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: PingServiceHook\n<公共请求参数>\n\n{\n  \"Id\":[\"aebb098f-fe9d-4712-afba-60c570aa20fa\",\"dd5a3b12-3a5b-4b57-8444-d84100ec8c4f\"],\n  \"ProjectId\": 450,\n  \"TargetType\":\"PROJECT\"\n}"},"ResendServiceHookLog":{"summary":"Service Hook 重发","category":"06-Service Hook 相关接口","description":"✨ Service Hook 重发","params":[{"name":"ServiceHookLogId","type":"string","required":true,"description":"logId"}],"response":[{"name":"Data","type":"ServiceHookResendServiceHookResult","required":false,"description":"触发结果"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write"},"DescribeResourceReferencesCited":{"summary":"被引用资源列表查询","category":"07-关联资源相关接口","description":"✨ 被引用资源列表查询","params":[{"name":"ScopeType","type":"integer (int64)","required":true,"description":"所属主体类型： 1项目、2团队"},{"name":"ResourceCode","type":"string","required":true,"description":"资源 ID"},{"name":"ScopeId","type":"integer (int64)","required":true,"description":"所属主体 ID"}],"response":[{"name":"Resource","type":"Array of ResourceReferenceResourceInfo","required":false,"description":"资源列表"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeResourceReferencesCited\n<公共请求参数>\n\n{\n  \"ScopeType\": 1,\n  \"ScopeId\": 1,\n  \"ResourceCode\": \"1\"\n}"},"DescribeResourceReferencesCiting":{"summary":"引用资源列表查询","category":"07-关联资源相关接口","description":"✨ 引用资源列表查询","params":[{"name":"ScopeType","type":"integer (int64)","required":true,"description":"所属主体类型： 1项目、2团队"},{"name":"ResourceCode","type":"string","required":true,"description":"资源 ID"},{"name":"ScopeId","type":"integer (int64)","required":true,"description":"所属主体 ID"}],"response":[{"name":"Resource","type":"Array of ResourceReferenceResourceInfo","required":false,"description":"资源引用列表"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeResourceReferencesCiting\n<公共请求参数>\n\n{\n  \"ScopeType\": 1,\n  \"ScopeId\": 1,\n  \"ResourceCode\": \"1\"\n}"},"CreateIssue":{"summary":"事项创建","category":"08-项目协同相关接口","description":"✨ 创建事项","params":[{"name":"AssigneeId","type":"integer (int64)","required":false,"description":"处理人 Id"},{"name":"CustomFieldValues","type":"Array of IssueCustomFieldForm","required":false,"description":"自定义属性值列表"},{"name":"DefectTypeId","type":"integer (int64)","required":false,"description":"缺陷类型 Id"},{"name":"Description","type":"string","required":false,"description":"描述"},{"name":"DueDate","type":"object (date)","required":false,"description":"截止日期，格式：2021-01-01"},{"name":"EpicCode","type":"integer (int64)","required":false,"description":"史诗 Code，Type 为 EPIC 或 SUB_TASK时，不传该值"},{"name":"FileIds","type":"Array of integer","required":false,"description":"附件的文件 Id 列表"},{"name":"IssueTypeId","type":"integer (int64)","required":false,"description":"事项类型 Id"},{"name":"IterationCode","type":"integer (int64)","required":false,"description":"迭代 Code，Type 为 EPIC 或 SUB_TASK时，忽略该值"},{"name":"LabelIds","type":"Array of integer","required":false,"description":"标签 Id 列表"},{"name":"Name","type":"string","required":true,"description":"事项名称"},{"name":"ParentCode","type":"integer (int64)","required":false,"description":"父事项 Code\r\n敏捷模式：Type 为 SUB_TASK 时必须指定\r\n经典模式：Type 为 MISSION、REQUIREMENT 时可指定"},{"name":"Priority","type":"string","required":true,"description":"紧急程度\r\n\"0\" - 低\r\n\"1\" - 中\r\n\"2\" - 高\r\n\"3\" - 紧急"},{"name":"ProjectModuleId","type":"integer (int64)","required":false,"description":"项目模块 Id"},{"name":"ProjectName","type":"string","required":true,"description":"项目名称"},{"name":"ReleaseCodes","type":"Array of integer","required":false,"description":"版本code列表"},{"name":"RequirementTypeId","type":"integer (int64)","required":false,"description":"需求类型 Id"},{"name":"StartDate","type":"object (date)","required":false,"description":"开始日期，格式：2021-01-01"},{"name":"StatusId","type":"integer (int64)","required":false,"description":"事项状态 Id"},{"name":"StoryPoint","type":"string","required":false,"description":"故事点，例如：0.5、1"},{"name":"TargetSortCode","type":"integer (int64)","required":false,"description":"排序目标位置的事项 code\r\n可不填，排在底位"},{"name":"ThirdLinks","type":"Array of IssueThirdLinkForm","required":false,"description":"第三方链接列表"},{"name":"Type","type":"string","required":true,"description":"事项类型\r\nDEFECT - 缺陷\r\nREQUIREMENT - 需求\r\nMISSION - 任务\r\nEPIC - 史诗\r\nSUB_TASK - 子任务"},{"name":"WatcherIds","type":"Array of integer","required":false,"description":"关注人 Id 列表"},{"name":"WorkingHours","type":"number (float)","required":false,"description":"工时（小时数）"},{"name":"ShowImageOutUrl","type":"boolean (boolean)","required":false,"description":"是否查询描述中图片的下载地址"}],"response":[{"name":"Issue","type":"IssueDetail","required":false,"description":"事项的具体信息"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: CreateIssue\n<公共请求参数>\n\n{\n    \"ProjectName\":\"demo-project\",\n    \"Type\":\"REQUIREMENT\",\n    \"IssueTypeId\": 1,\n    \"ParentCode\": 0, \n    \"Name\":\"一个需求\",\n    \"Priority\": \"0\", \n    \"StatusId\": 1, \n    \"DueDate\": \"2021-01-01\", \n    \"StartDate\": \"2020-01-31\", \n    \"Description\": \"aa\", \n    \"EpicCode\": 0, \n    \"StoryPoint\": \"1\", \n    \"WorkingHours\": 2.0, \n    \"ProjectModuleId\": 1, \n    \"AssigneeId\": 0, \n    \"RequirementTypeId\": 0, \n    \"DefectTypeId\": 0, \n    \"WatcherIds\": [\n        1,2\n    ], \n    \"LabelIds\": [\n        1\n    ], \n    \"FileIds\": [\n        123\n    ], \n    \"TargetSortCode\": 0, \n    \"ThirdLinks\": [\n        {\n            \"ThirdType\": \"aaa\", \n            \"Link\": \"aaa\", \n            \"Title\": \"aaa\"\n        }\n    ], \n    \"CustomFieldValues\": [\n        {\n            \"Content\": \"1,2\", \n            \"Id\": 1\n        }\n    ]\n}"},"CreateIssueBlock":{"summary":"前置事项添加","category":"08-项目协同相关接口","description":"✨ 添加前置事项","params":[{"name":"BlockIssueCode","type":"integer (int64)","required":true,"description":"前置事项 Code"},{"name":"IssueCode","type":"integer (int64)","required":true,"description":"事项 Code"},{"name":"ProjectName","type":"string","required":true,"description":"项目名称"}],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: CreateIssueBlock\n<公共请求参数>\n\n{\n  \"ProjectName\":\"project-demo\",\n  \"IssueCode\":1,\n  \"BlockIssueCode\": 4\n}"},"CreateIssueComment":{"summary":"事项评论创建","category":"08-项目协同相关接口","description":"✨ 创建事项评论","params":[{"name":"Content","type":"string","required":true,"description":"评论内容"},{"name":"IssueCode","type":"integer (int64)","required":true,"description":"事项 Code"},{"name":"ParentId","type":"integer (int64)","required":true,"description":"父评论ID"},{"name":"ProjectName","type":"string","required":true,"description":"项目名称"}],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: CreateIssueComment\n<公共请求参数>\n\n{\n  \"ProjectName\":\"project-demo\",\n  \"IssueCode\":1,\n  \"Content\": \"内容\",\n  \"ParentId\": 0\n}"},"CreateIssueModule":{"summary":"事项模块创建","category":"08-项目协同相关接口","description":"✨ 创建事项模块","params":[{"name":"Name","type":"string","required":true,"description":"模块名称"},{"name":"ProjectName","type":"string","required":true,"description":"项目名称"}],"response":[{"name":"IssueModule","type":"IssueModule","required":false,"description":"模块信息"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: CreateIssueModule\n<公共请求参数>\n\n{\n    \"ProjectName\": \"collaboration\",\n    \"Name\": \"demo\"\n}"},"CreateIssueWorkHours":{"summary":"工时登记","category":"08-项目协同相关接口","description":"✨ 登记工时","params":[{"name":"IssueCode","type":"integer (int64)","required":true,"description":"事项 Code"},{"name":"ProjectName","type":"string","required":true,"description":"项目名称"},{"name":"RemainingHour","type":"number (float)","required":true,"description":"剩余工时"},{"name":"SpendHour","type":"number (float)","required":true,"description":"使用工时"},{"name":"StartAt","type":"integer (int64)","required":true,"description":"开始时间戳"},{"name":"WorkingDesc","type":"string","required":false,"description":"工作描述"}],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: CreateIssueWorkHours\n<公共请求参数>\n\n{\n  \"ProjectName\":\"project-demo\",\n  \"IssueCode\":1,\n  \"SpendHour\": 2,\n  \"RemainingHour\": 1,\n  \"StartAt\":\"1608630452740\",\n  \"WorkingDesc\": \"xxx\"\n}"},"CreateIteration":{"summary":"迭代创建","category":"08-项目协同相关接口","description":"✨ 创建迭代","params":[{"name":"Assignee","type":"integer (uint64)","required":false,"description":"处理人 ID"},{"name":"EndAt","type":"object (date)","required":false,"description":"结束时间，格式：2020-01-01"},{"name":"Goal","type":"string","required":false,"description":"目标"},{"name":"Name","type":"string","required":true,"description":"标题"},{"name":"ProjectName","type":"string","required":true,"description":"项目名称"},{"name":"StartAt","type":"object (date)","required":false,"description":"开始时间，格式：2020-01-01"}],"response":[{"name":"Iteration","type":"Iteration","required":false,"description":"迭代的具体信息"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: CreateIteration\n<公共请求参数>\n\n{\n  \"ProjectName\":\"demo-project\",\n  \"Name\":\"Title\"\n}"},"CreateRelease":{"summary":"版本创建","category":"08-项目协同相关接口","description":"✨ 创建版本","params":[{"name":"Assignee","type":"integer (int64)","required":false,"description":"版本处理人ID"},{"name":"Description","type":"string","required":false,"description":"版本描述"},{"name":"IterationCodes","type":"Array of integer","required":false,"description":"关联迭代code列表"},{"name":"LabelIds","type":"Array of integer","required":false,"description":"标签ID列表"},{"name":"Name","type":"string","required":true,"description":"版本名称"},{"name":"ProjectName","type":"string","required":true,"description":"项目名称"},{"name":"ReleaseDate","type":"string","required":false,"description":"版本发布日期"},{"name":"StartDate","type":"string","required":false,"description":"版本开始时间"}],"response":[{"name":"Release","type":"OpenApiRelease","required":false,"description":"版本信息"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: CreateRelease\n<公共请求参数>\n\n{\n  \"ProjectName\": \"agile\",\n  \"Name\": \"版本4\",\n  \"Description\": \"这是一个版本\",\n  \"Assignee\": 8647786,\n  \"StartDate\": \"2023-03-01\",\n  \"ReleaseDate\": \"2023-03-09\",\n  \"IterationCodes\": [\n    19,\n    27\n  ]\n}"},"CreateRequirementDefectRelation":{"summary":"需求关联缺陷","category":"08-项目协同相关接口","description":"✨ 需求关联缺陷","params":[{"name":"DefectCode","type":"integer (int64)","required":true,"description":"缺陷 Code"},{"name":"ProjectName","type":"string","required":true,"description":"项目名称"},{"name":"RequirementCode","type":"integer (int64)","required":true,"description":"需求 Code"}],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: CreateRequirementDefectRelation\n<公共请求参数>\n\n{\n  \"ProjectName\":\"project-demo\",\n  \"RequirementCode\":1,\n  \"DefectCode\":2\n}"},"DeleteIssue":{"summary":"事项删除","category":"08-项目协同相关接口","description":"✨ 删除事项","params":[{"name":"IssueCode","type":"integer (int64)","required":true,"description":"事项 Code"},{"name":"IssueType","type":"string","required":false,"description":"事项类型，可不填"},{"name":"ProjectName","type":"string","required":true,"description":"项目名称"}],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"destructive","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DeleteIssue\n<公共请求参数>\n\n{\n    \"ProjectName\":\"demo-project\",\n    \"IssueCode\": 1,\n    \"IssueType\": \"REQUIREMENT\"\n}"},"DeleteIssueBlock":{"summary":"前置事项删除","category":"08-项目协同相关接口","description":"✨ 删除前置事项","params":[{"name":"BlockIssueCode","type":"integer (int64)","required":true,"description":"前置事项 Code"},{"name":"IssueCode","type":"integer (int64)","required":true,"description":"事项 Code"},{"name":"ProjectName","type":"string","required":true,"description":"项目名称"}],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"destructive","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DeleteIssueBlock\n<公共请求参数>\n\n{\n  \"ProjectName\":\"project-demo\",\n  \"IssueCode\":1,\n  \"BlockIssueCode\": 4\n}"},"DeleteIssueModule":{"summary":"事项模块删除","category":"08-项目协同相关接口","description":"✨ 删除事项模块","params":[{"name":"ModuleId","type":"integer (int64)","required":true,"description":"模块ID"},{"name":"ProjectName","type":"string","required":true,"description":"项目名称"}],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"destructive","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DeleteIssueModule\n<公共请求参数>\n\n{\n    \"ProjectName\": \"collaboration\",\n    \"ModuleId\": 49368\n}"},"DeleteIssueWorkHours":{"summary":"工时日志删除","category":"08-项目协同相关接口","description":"✨ 删除工时日志","params":[{"name":"IssueCode","type":"integer (int64)","required":true,"description":"事项 Code"},{"name":"ProjectName","type":"string","required":true,"description":"项目名称"},{"name":"RollbackRemainingHours","type":"boolean (bool)","required":true,"description":"是否将该工时日志的使用工时归还到剩余工时，默认：false"},{"name":"WorkHourLogId","type":"integer (uint64)","required":true,"description":"工时日志 Id"}],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"destructive","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DeleteIssueWorkHours\n<公共请求参数>\n\n{\n  \"ProjectName\":\"project-demo\",\n  \"IssueCode\":1,\n  \"WorkHourLogId\": 2,\n  \"RollbackRemainingHours\": true\n}"},"DeleteIteration":{"summary":"迭代删除","category":"08-项目协同相关接口","description":"✨ 删除迭代","params":[{"name":"IterationCode","type":"integer (int64)","required":true,"description":"迭代编号"},{"name":"ProjectName","type":"string","required":true,"description":"项目名称"}],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"destructive","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DeleteIteration\n<公共请求参数>\n\n{\n  \"ProjectName\":\"project-demo\",\n  \"IterationCode\":1\n}"},"DeleteRelease":{"summary":"版本删除","category":"08-项目协同相关接口","description":"✨ 删除版本","params":[{"name":"ProjectName","type":"string","required":true,"description":"项目名称"},{"name":"ReleaseCode","type":"integer (int64)","required":true,"description":"版本code"}],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"destructive","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DeleteRelease\n<公共请求参数>\n\n{\n  \"ProjectName\": \"xjx-agile\",\n  \"ReleaseCode\": 17\n}"},"DeleteRequirementDefectRelation":{"summary":"需求取消关联缺陷","category":"08-项目协同相关接口","description":"✨ 需求取消关联缺陷","params":[{"name":"DefectCode","type":"integer (int64)","required":true,"description":"缺陷 Code"},{"name":"ProjectName","type":"string","required":true,"description":"项目名称"},{"name":"RequirementCode","type":"integer (int64)","required":true,"description":"需求 Code"}],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"destructive","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DeleteRequirementDefectRelation\n<公共请求参数>\n\n{\n  \"ProjectName\":\"project-demo\",\n  \"RequirementCode\":1,\n  \"DefectCode\":2\n}"},"DescribeAllProjectsIssueWorkLogList":{"summary":"工时日志列表查询","category":"08-项目协同相关接口","description":"✨ 查询全部有权限的项目工时日志列表","params":[{"name":"EndAt","type":"integer (int64)","required":false,"description":"结束时间"},{"name":"Limit","type":"integer (uint64)","required":false,"description":"每页数量，默认 20，最大1000"},{"name":"Offset","type":"integer (uint64)","required":false,"description":"偏移量，默认 0"},{"name":"ProjectName","type":"string","required":false,"description":"项目名称"},{"name":"StartAt","type":"integer (int64)","required":false,"description":"开始时间"},{"name":"UserId","type":"integer (int64)","required":false,"description":"用户 ID"}],"response":[{"name":"WorkLogs","type":"Array of IssueWorkLog","required":false,"description":"工时日志列表"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeAllProjectsIssueWorkLogList\n<公共请求参数>\n\n{\n  \"StartAt\": 1609430400000,\n  \"EndAt\": 1612108800000,\n  \"Offset\": 0,\n  \"Limit\": 20\n}"},"DescribeBlockedByIssueList":{"summary":"前置事项查询","category":"08-项目协同相关接口","description":"✨ 查询前置事项","params":[{"name":"IssueCode","type":"integer (int64)","required":true,"description":"事项 Code"},{"name":"ProjectName","type":"string","required":true,"description":"项目名称"}],"response":[{"name":"Issues","type":"Array of IssueSimpleData","required":false,"description":"前置事项列表"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeBlockedByIssueList\n<公共请求参数>\n\n{\n  \"ProjectName\":\"project-demo\",\n  \"IssueCode\":1\n}"},"DescribeBlockIssueList":{"summary":"后置事项查询","category":"08-项目协同相关接口","description":"✨ 查询后置事项","params":[{"name":"IssueCode","type":"integer (int64)","required":true,"description":"事项 Code"},{"name":"ProjectName","type":"string","required":true,"description":"项目名称"}],"response":[{"name":"Issues","type":"Array of IssueSimpleData","required":false,"description":"后置事项列表"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeBlockIssueList\n<公共请求参数>\n\n{\n  \"ProjectName\":\"project-demo\",\n  \"IssueCode\":1\n}"},"DescribeConfigTemplateList":{"summary":"配置方案获取","category":"08-项目协同相关接口","description":"✨ 获取配置方案","params":[{"name":"CooperateMode","type":"string","required":false,"description":"配置方案协作类型，包括 SCRUM 和 CLASSIC"},{"name":"Keyword","type":"string","required":false,"description":"关键字"},{"name":"PageNumber","type":"integer (int64)","required":true,"description":"页码"},{"name":"PageSize","type":"integer (int64)","required":true,"description":"分页大小"},{"name":"ProjectName","type":"string","required":true,"description":"项目名称"},{"name":"TemplateType","type":"string","required":false,"description":"配置方案类型，全局配置方案取值 GLOBAL ，项目配置方案取值 PROJECT，不填默认为 GLOBAL"}],"response":[{"name":"ConfigTemplateList","type":"Array of ConfigTemplate","required":false,"description":"配置方案列表"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeConfigTemplateList\n<公共请求参数>\n\n{\n  \"ProjectName\": \"test\",\n  \"TemplateType\": \"GLOBAL\",\n  \"PageNumber\": 1,\n  \"PageSize\": 20\n}"},"DescribeDefectTypes":{"summary":"缺陷类型列表查询","category":"08-项目协同相关接口","description":"✨ 缺陷类型列表查询","params":[{"name":"ProjectName","type":"string","required":true,"description":"项目标识"}],"response":[{"name":"DefectTypes","type":"Array of DefectType","required":false,"description":"缺陷类型列表"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeDefectTypes\n<公共请求参数>\n\n{\n    \"ProjectName\": \"project1\"\n}"},"DescribeIssue":{"summary":"事项详情查询","category":"08-项目协同相关接口","description":"✨ 查询事项详情","params":[{"name":"IssueCode","type":"integer (int64)","required":true,"description":"事项编号"},{"name":"ProjectName","type":"string","required":true,"description":"项目名称"},{"name":"ShowImageOutUrl","type":"boolean (boolean)","required":false,"description":"是否查询描述中图片的下载地址"}],"response":[{"name":"Issue","type":"IssueDetail","required":false,"description":"事项的具体信息"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeIssue\n<公共请求参数>\n\n{\n  \"ProjectName\":\"project-demo\",\n  \"IssueCode\":1\n}"},"DescribeIssueAttachmentPreSignedUrl":{"summary":"预签名信息获取","category":"08-项目协同相关接口","description":"✨ 拿到预签名，上传文件","params":[{"name":"FileName","type":"string","required":true,"description":"文件名"},{"name":"FileSize","type":"integer (int64)","required":true,"description":"文件大小"},{"name":"ProjectName","type":"string","required":true,"description":"项目名"}],"response":[{"name":"PreSign","type":"ApiIssueIssueAttachmentPreSign","required":false,"description":"预签名信息"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read"},"DescribeIssueByStatusUpdate":{"summary":"通过状态以及状态的更新时间查询事项列表","category":"08-项目协同相关接口","description":"✨ 通过状态以及状态的更新时间查询事项列表","params":[{"name":"ProjectName","type":"string","required":true,"description":"项目名称"},{"name":"ShowImageOutUrl","type":"boolean (bool)","required":false,"description":"是否展示事项描述中对外的路径"},{"name":"Status","type":"string","required":true,"description":"修改之后的状态"},{"name":"UpdatedAt","type":"string","required":true,"description":"状态更新时间"}],"response":[{"name":"OpenApiIssueDetail","type":"Array of IssueDetail","required":false,"description":"[\n            {\n                \"Epic\": {\n                    \"Code\": 0,\n                    \"Type\": \"\",\n                    \"Name\": \"\",\n                    \"IssueStatusId\": 0,\n                    \"IssueStatusName\": \"\",\n                    \"Priority\": \"\",\n                    \"Assignee\": {\n                        \"Id\": 0,\n                        \"Status\": 0,\n                        \"Avatar\": \"\",\n                        \"Name\": \"\",\n                        \"Email\": \"\",\n                        \"TeamId\": 0,\n                        \"Phone\": \"\",\n                        \"GlobalKey\": \"\",\n                        \"TeamGlobalKey\": \"\"\n                    }\n                },\n                \"ParentType\": \"WORK_ITEM\",\n                \"Code\": 2,\n                \"Type\": \"WORK_ITEM\",\n                \"Name\": \"撒旦法水电费\",\n                \"Description\": \"\",\n                \"IterationId\": 0,\n                \"IssueStatusId\": 44318126,\n                \"IssueStatusName\": \"已完成\",\n                \"IssueStatusType\": \"COMPLETED\",\n                \"Priority\": \"1\",\n                \"Assignee\": {\n                    \"Id\": 0,\n                    \"Status\": 0,\n                    \"Avatar\": \"\",\n                    \"Name\": \"\",\n                    \"Email\": \"\",\n                    \"TeamId\": 0,\n                    \"Phone\": \"\",\n                    \"GlobalKey\": \"\",\n                    \"TeamGlobalKey\": \"\"\n                },\n                \"StartDate\": 0,\n                \"DueDate\": 0,\n                \"WorkingHours\": 0.0,\n                \"Creator\": {\n                    \"Id\": 8732006,\n                    \"Status\": 1,\n                    \"Avatar\": \"https://coding-net-production-static-ci.codehub.cn/be0458f7-2a49-4d08-9d79-73f2767a1687.png?imageView2/1/w/0/h/0\",\n                    \"Name\": \"kingxinhu\",\n                    \"Email\": \"\",\n                    \"TeamId\": 0,\n                    \"Phone\": \"\",\n                    \"GlobalKey\": \"\",\n                    \"TeamGlobalKey\": \"\"\n                },\n                \"StoryPoint\": \"\",\n                \"CreatedAt\": 1697624080000,\n                \"UpdatedAt\": 1698373834000,\n                \"CompletedAt\": 1698373834000,\n                \"ProjectModule\": {\n                    \"Id\": 0,\n                    \"Name\": \"\"\n                },\n                \"Watchers\": [\n                    {\n                        \"Id\": 8732006,\n                        \"Status\": 1,\n                        \"Avatar\": \"https://coding-net-production-static-ci.codehub.cn/be0458f7-2a49-4d08-9d79-73f2767a1687.png?imageView2/1/w/0/h/0\",\n                        \"Name\": \"kingxinhu\",\n                        \"Email\": \"\",\n                        \"TeamId\": 0,\n                        \"Phone\": \"\",\n                        \"GlobalKey\": \"\",\n                        \"TeamGlobalKey\": \"\"\n                    }\n                ],\n                \"Labels\": [],\n                \"Files\": [],\n                \"RequirementType\": {\n                    \"Id\": 0,\n                    \"Name\": \"\"\n                },\n                \"DefectType\": {\n                    \"Id\": 0,\n                    \"Name\": \"\",\n                    \"IconUrl\": \"\"\n                },\n                \"CustomFields\": [],\n                \"ThirdLinks\": [],\n                \"SubTasks\": [],\n                \"Parent\": {\n                    \"Code\": 0,\n                    \"Type\": \"\",\n                    \"Name\": \"\",\n                    \"IssueStatusId\": 0,\n                    \"IssueStatusName\": \"\",\n                    \"Priority\": \"\",\n                    \"Assignee\": {\n                        \"Id\": 0,\n                        \"Status\": 0,\n                        \"Avatar\": \"\",\n                        \"Name\": \"\",\n                        \"Email\": \"\",\n                        \"TeamId\": 0,\n                        \"Phone\": \"\",\n                        \"GlobalKey\": \"\",\n                        \"TeamGlobalKey\": \"\"\n                    },\n                    \"IssueStatusType\": \"\",\n                    \"IssueTypeDetail\": {\n                        \"Id\": 0,\n                        \"Name\": \"\",\n                        \"IssueType\": \"\",\n                        \"Description\": \"\",\n                        \"IsSystem\": false\n                    }\n                },\n                \"Iteration\": {\n                    \"Code\": 0,\n                    \"Name\": \"\",\n                    \"Status\": \"\",\n                    \"Id\": 0\n                },\n                \"IssueTypeDetail\": {\n                    \"Id\": 8500461,\n                    \"Name\": \"工作项\",\n                    \"IssueType\": \"WORK_ITEM\",\n                    \"Description\": \"工作项表示在项目集中需要完成的需求或任务。\",\n                    \"IsSystem\": true\n                },\n                \"IssueTypeId\": 8500461,\n                \"Project\": {\n                    \"Id\": 11985312,\n                    \"CreatedAt\": 0,\n                    \"UpdatedAt\": 0,\n                    \"Status\": 0,\n                    \"Type\": 0,\n                    \"MaxMember\": 0,\n                    \"Name\": \"eee\",\n                    \"DisplayName\": \"eee\",\n                    \"Description\": \"\",\n                    \"Icon\": \"/static/project_icon/scenery-version-2-1.svg\",\n                    \"TeamOwnerId\": 0,\n                    \"UserOwnerId\": 0,\n                    \"StartDate\": 0,\n                    \"EndDate\": 0,\n                    \"TeamId\": 0,\n                    \"IsDemo\": false,\n                    \"Archived\": false,\n                    \"ProgramIds\": []\n                }\n            }\n        ]"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeIssueByStatusUpdate\n<公共请求参数>\n\n{\n    \"ProjectName\": \"hhhh\",\n    \"UpdatedAt\": \"2023-11-08\",\n    \"Status\" : \"开发中\"\n}"},"DescribeIssueCommentList":{"summary":"事项评论列表查询","category":"08-项目协同相关接口","description":"✨ 查询事项评论列表","params":[{"name":"IssueCode","type":"integer (int64)","required":true,"description":"事项 Code"},{"name":"ProjectName","type":"string","required":true,"description":"项目名称"},{"name":"ShowFileId","type":"boolean (boolean)","required":false,"description":"是否查询评论中图片FileId"}],"response":[{"name":"CommentList","type":"Array of IssueComment","required":false,"description":"事项评论列表"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeIssueCommentList\n<公共请求参数>\n\n{\n  \"ProjectName\":\"project-demo\",\n  \"IssueCode\":1\n}"},"DescribeIssueCustomFieldLogList":{"summary":"事项的自定义属性变更日志查询","category":"08-项目协同相关接口","description":"✨ 获取某个事项的自定义属性变更日志","params":[{"name":"FieldName","type":"string","required":true,"description":"自定义属性名称"},{"name":"IssueCode","type":"integer (int64)","required":true,"description":"事项编号"},{"name":"ProjectName","type":"string","required":true,"description":"项目名称"}],"response":[{"name":"FieldChangeLogList","type":"Array of CustomFieldChangeLog","required":false,"description":"事项的自定义属性变更日志"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeIssueCustomFieldLogList\n<公共请求参数>\n\n{\n\t\"ProjectName\": \"test-agile\",\n\t\"IssueCode\": 10,\n\t\"FieldName\": \"测试成员\"\n}"},"DescribeIssueFileUrl":{"summary":"事项附件的下载地址查询","category":"08-项目协同相关接口","description":"✨ 查询事项附件的下载地址","params":[{"name":"FileId","type":"integer (int64)","required":true,"description":"文件 ID"},{"name":"ProjectName","type":"string","required":true,"description":"项目名称"},{"name":"IssueCode","type":"integer (int32)","required":false,"description":"事项Code, 对应页面的ID字段, ProjectName + IssueCode 可以查询事项的附件和描述中图片的下载地址"},{"name":"QueryComment","type":"boolean (boolean)","required":false,"description":"是否查询事项评论中的图片路径， 可查询所有评论中的图片路径"}],"response":[{"name":"Url","type":"string","required":false,"description":"文件下载地址"},{"name":"AttachmentFileUrl","type":"Array of string","required":false,"description":"事项附件下载地址列表"},{"name":"DescriptionImageUrl","type":"Array of string","required":false,"description":"事项描述中图片下载地址列表"},{"name":"CommentImageUrl","type":"Array of string","required":false,"description":"事项评论中图片下载地址列表"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeIssueFileUrl\n<公共请求参数>\n\n{\n    \"ProjectName\":\"demo-project\",\n    \"FileId\": 7\n}"},"DescribeIssueFilterList":{"summary":"事项筛选器列表查询","category":"08-项目协同相关接口","description":"✨ 查询事项筛选器列表","params":[{"name":"IssueType","type":"string","required":true,"description":"事项类型\r\nALL - 全部事项\r\nDEFECT - 缺陷\r\nREQUIREMENT - 需求\r\nMISSION - 任务\r\nEPIC - 史诗"},{"name":"ProjectName","type":"string","required":true,"description":"项目名称"}],"response":[{"name":"Data","type":"IssueFilterListData","required":false,"description":"过滤器列表，包含系统过滤器和自定义过滤器"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeIssueFilterList\n<公共请求参数>\n\n{\n    \"ProjectName\":\"demo-project\",\n    \"IssueType\": \"REQUIREMENT\"\n}"},"DescribeIssueList":{"summary":"事项列表查询","category":"08-项目协同相关接口","description":"✨ 查询事项列表","params":[{"name":"Conditions","type":"Array of IssueCondition","required":false,"description":"筛选条件列表"},{"name":"IssueType","type":"string","required":true,"description":"事项类型\r\nALL - 全部事项\r\nDEFECT - 缺陷\r\nREQUIREMENT - 需求\r\nMISSION - 任务\r\nEPIC - 史诗"},{"name":"Limit","type":"integer (int64)","required":false,"description":"限制数目，默认 20"},{"name":"Offset","type":"integer (int64)","required":false,"description":"偏移量，默认 0"},{"name":"ProjectName","type":"string","required":true,"description":"项目名称"},{"name":"SortKey","type":"string","required":false,"description":"排序字段，默认：CODE\r\n可选值：STATUS, CREATED_AT, PRIORITY, UPDATED_AT, DUE_DATE, CODE, JOIN_ITERATION_AT, STATUS_TYPE, ASSIGNEE, PROJECT_ID, ISSUE_STATUS_ID, ISSUE_ITERATION_SORT, ISSUE_ROADMAP_SORT, PARENT_ID, COMPLETED_AT"},{"name":"SortValue","type":"string","required":false,"description":"排序方式\r\nDESC - 倒序（默认值）\r\nASC - 正序"},{"name":"ShowImageOutUrl","type":"boolean (boolean)","required":false,"description":"是否查询描述中图片的下载地址"}],"response":[{"name":"IssueList","type":"Array of IssueListData","required":false,"description":"事项列表"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeIssueList\n<公共请求参数>\n\n{\n    \"ProjectName\": \"demo-project\",\n    \"IssueType\": \"ALL\",\n    \"Offset\": 0,\n    \"Limit\": 10,\n    \"Conditions\": [],\n    \"SortKey\": \"CODE\",\n    \"SortValue\": \"DESC\"\n}"},"DescribeIssueListWithPage":{"summary":"事项查询,返回分页信息","category":"08-项目协同相关接口","description":"✨ 事项列表（新），返回分页信息","params":[{"name":"Conditions","type":"IssueCondition","required":false,"description":"筛选条件"},{"name":"ExcludeSubTask","type":"boolean (bool)","required":false,"description":"是否展示子工作项"},{"name":"IssueType","type":"string","required":true,"description":"ALL - 全部事项\nDEFECT - 缺陷\nREQUIREMENT - 需求\nMISSION - 任务\nEPIC - 史诗"},{"name":"PageNumber","type":"integer (int64)","required":true,"description":"页码"},{"name":"PageSize","type":"integer (int64)","required":true,"description":"每页展示数，默认 20 ，最大值 500"},{"name":"ProjectName","type":"string","required":true,"description":"项目名称"},{"name":"ShowSubIssues","type":"boolean (bool)","required":false,"description":"是否展示子事项"},{"name":"SortKey","type":"string","required":false,"description":"排序字段，默认：CODE 可选值：STATUS, CREATED_AT, PRIORITY, UPDATED_AT, DUE_DATE, CODE, JOIN_ITERATION_AT, STATUS_TYPE, ASSIGNEE, PROJECT_ID, ISSUE_STATUS_ID, ISSUE_ITERATION_SORT, ISSUE_ROADMAP_SORT, PARENT_ID, COMPLETED_AT"},{"name":"SortValue","type":"string","required":false,"description":"排序方式\nDESC - 倒序（默认值）\nASC - 正序"},{"name":"ShowImageOutUrl","type":"boolean (boolean)","required":false,"description":"是否查询描述中图片的下载地址"}],"response":[{"name":"Data","type":"OpenApiIssueListDataWithPage","required":false,"description":"数据"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeIssueListWithPage\n<公共请求参数>\n\n{\n  \"ProjectName\": \"abc\",\n  \"IssueType\": \"abc\",\n  \"PageNumber\": 0,\n  \"PageSize\": 0,\n  \"SortKey\": \"abc\",\n  \"SortValue\": \"abc\",\n  \"Conditions\": {\n    \"Key\": \"abc\",\n    \"Value\": \"abc\",\n    \"ConstValue\": \"abc\",\n    \"CustomFieldId\": 0,\n    \"CustomFieldName\": \"abc\"\n  },\n  \"ShowSubIssues\": true,\n  \"ExcludeSubTask\": true\n}"},"DescribeIssueLogList":{"summary":"事项活动日志查询","category":"08-项目协同相关接口","description":"✨ 获取某个事项的活动日志","params":[{"name":"ActionType","type":"string","required":true,"description":"动作类型，ADD、CHANGE_PARENT、CREATE、DELETE、REMOVE、UPDATE。要获取更新处理人的日志，用UPDATE+ASSIGNEE，要获取更新迭代的日志，用UPDATE+ITERATION，要获取创建事项的日志，用CREATE+SELF，以此类推"},{"name":"IssueCode","type":"integer (int64)","required":true,"description":"事项code"},{"name":"ProjectName","type":"string","required":true,"description":"项目名称"},{"name":"Target","type":"string","required":true,"description":"操作对象，取值如下 ASSIGNEE  处理人，ATTACHMENT 附件，CHILD_ISSUE  子事项，CUSTOM_FIELD  自定义属性，DEFECT_TYPE 缺陷类型，DESCRIPTION 描述，DUE_DATE 截止日期，EPIC_ISSUE 所属史诗，ISSUE_EPIC_CHANGED ，ISSUE_PROGRAM_RELATION，ISSUE_RELATION，ITERATION 迭代，LABEL 标签，MODULE 模块，NAME 名字，PARENT_ISSUE 父事项，PRIORITY 优先级，PROGRESS 进度，RELATE_DEFECT，RELATE_REQUIREMENT，REQUIREMENT_TYPE，RESOURCE，SELF，START_DATE，STATUS 状态，STORY_POINT 故事点，THIRD_LINK 第三方链接，WATCHER 关注人，WORKING_HOURS 工时"}],"response":[{"name":"IssueLogList","type":"Array of ApiIssueLogIssueLog","required":false},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read"},"DescribeIssueModuleList":{"summary":"事项模块列表查询","category":"08-项目协同相关接口","description":"✨ 查询事项模块列表","params":[{"name":"ProjectName","type":"string","required":true,"description":"项目名称"}],"response":[{"name":"IssueModules","type":"Array of IssueModule","required":false,"description":"模块列表"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeIssueModuleList\n<公共请求参数>\n\n{\n    \"ProjectName\": \"collaboration\"\n}"},"DescribeIssueReferenceResources":{"summary":"事项的引用资源列表查询","category":"08-项目协同相关接口","description":"✨ 查询事项的引用资源列表","params":[{"name":"IssueCode","type":"integer (int64)","required":true,"description":"查询的目标事项的code"},{"name":"ProjectId","type":"integer (int64)","required":true,"description":"查询的事项所在的项目ID"},{"name":"ProjectName","type":"string","required":true,"description":"项目名称"}],"response":[{"name":"Data","type":"Array of ResourceReference","required":false,"description":"事项引用的资源列表"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeIssueReferenceResources\n<公共请求参数>\n\n{\n    \"IssueCode\":1,\n    \"ProjectId\":1,\n    \"ProjectName\": \"test\"\n}"},"DescribeIssueRelatedRepos":{"summary":"事项关联的代码仓库信息查询","category":"08-项目协同相关接口","description":"✨ 查询事项关联的代码仓库信息","params":[{"name":"IssueCode","type":"integer (int64)","required":true,"description":"事项code"},{"name":"ProjectName","type":"string","required":true,"description":"项目名称"}],"response":[{"name":"IssueRelatedDepot","type":"Array of IssueRelatedDepot","required":false,"description":"事项关联的仓库信息"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeIssueRelatedRepos\n<公共请求参数>\n\n{\n    \"ProjectName\": \"hhhh\",\n    \"IssueCode\": 1\n}"},"DescribeIssueRelatedWorkItemList":{"summary":"事项关联的项目集中的工作项查询","category":"08-项目协同相关接口","description":"✨ 查询事项关联的项目集中的工作项","params":[{"name":"IssueCode","type":"integer (int64)","required":true,"description":"事项code"},{"name":"ProjectName","type":"string","required":true,"description":"项目名称"},{"name":"ShowImageOutUrl","type":"string","required":false,"description":"是否展示描述中图片外部可访问的地址"}],"response":[{"name":"WorkItemList","type":"Array of IssueDetail","required":false,"description":"事项关联的项目集中的工作项列表"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeIssueRelatedWorkItemList\n<公共请求参数>\n\n{\n    \"ProjectName\": \"hhhh\",\n    \"IssueCode\": 1\n}"},"DescribeIssueReleaseList":{"summary":"事项加入的版本查询","category":"08-项目协同相关接口","description":"✨ 获取某个事项加入的所有版本","params":[{"name":"IssueCode","type":"integer (int64)","required":true,"description":"事项code"},{"name":"ProjectName","type":"string","required":true,"description":"项目名称"}],"response":[{"name":"ReleaseList","type":"Array of OpenApiRelease","required":false,"description":"版本列表"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeIssueReleaseList\n<公共请求参数>\n\n{\n  \"ProjectName\": \"agile\",\n  \"IssueCode\": 100\n}"},"DescribeIssueStatusChangeLogList":{"summary":"事项的状态变更记录查询","category":"08-项目协同相关接口","description":"✨ 状态变更记录","params":[{"name":"IssueCode","type":"Array of integer","required":true,"description":"事项code列表"},{"name":"ProjectName","type":"string","required":true,"description":"项目名称"}],"response":[{"name":"Logs","type":"IssueStatusChangeLogList","required":false,"description":"状态修改日志"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeIssueStatusChangeLogList\n<公共请求参数>\n\n{\n  \"ProjectName\": \"abc\",\n  \"IssueCode\": [\n    0\n  ]\n}"},"DescribeIssueWorkLogList":{"summary":"事项的工时日志查询","category":"08-项目协同相关接口","description":"✨ 查询工时日志列表","params":[{"name":"IssueCode","type":"integer (int64)","required":true,"description":"事项 Code"},{"name":"ProjectName","type":"string","required":true,"description":"项目名称"}],"response":[{"name":"WorkLogs","type":"Array of IssueWorkLog","required":false,"description":"工时日志列表"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeIssueWorkLogList\n<公共请求参数>\n\n{\n  \"ProjectName\":\"project-demo\",\n  \"IssueCode\":1\n}"},"DescribeIteration":{"summary":"迭代详情查询","category":"08-项目协同相关接口","description":"✨ 查询迭代详情","params":[{"name":"IterationCode","type":"integer (int64)","required":true,"description":"迭代编号"},{"name":"ProjectName","type":"string","required":true,"description":"项目名称"}],"response":[{"name":"Iteration","type":"Iteration","required":false,"description":"迭代的具体信息"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeIteration\n<公共请求参数>\n\n{\n  \"ProjectName\":\"project-demo\",\n  \"IterationCode\":1\n}"},"DescribeIterationList":{"summary":"迭代列表获取","category":"08-项目协同相关接口","description":"✨ 迭代列表","params":[{"name":"Assignee","type":"Array of integer","required":false,"description":"处理人 ID 列表"},{"name":"EndDate","type":"object (date)","required":false,"description":"通过结束时间过滤，时间格式：2020-12-12"},{"name":"Keywords","type":"string","required":false,"description":"通过关键字搜索"},{"name":"Limit","type":"integer (int64)","required":false,"description":"每页数量，默认 20"},{"name":"Offset","type":"integer (int64)","required":false,"description":"偏移量，默认 0"},{"name":"ProjectName","type":"string","required":true,"description":"项目名称"},{"name":"StartDate","type":"object (date)","required":false,"description":"通过开始时间过滤，时间格式：2020-12-12"},{"name":"Status","type":"Array of string","required":false,"description":"迭代状态,  WAIT_PROCESS,PROCESSING,COMPLETED"}],"response":[{"name":"Data","type":"DescribeIterationListData","required":false,"description":"迭代列表信息"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeIterationList\n<公共请求参数>\n\n{\n  \"ProjectName\":\"demo-project\",\n  \"Status\":[\"WAIT_PROCESS\"],\n  \"Assignee\":[1]\n}"},"DescribeProjectIssueFieldList":{"summary":"具体事项类型的属性列表查询","category":"08-项目协同相关接口","description":"✨ 查询具体事项类型的属性列表","params":[{"name":"IssueType","type":"string","required":true,"description":"事项类型\r\nDEFECT - 缺陷\r\nREQUIREMENT - 需求\r\nMISSION - 任务\r\nEPIC - 史诗\r\nSUB_TASK - 子任务"},{"name":"ProjectName","type":"string","required":true,"description":"项目名称"},{"name":"IssueTypeId","type":"integer (int64)","required":false,"description":"事项类型id"}],"response":[{"name":"ProjectIssueFieldList","type":"Array of ProjectIssueField","required":false,"description":"项目的事项属性列表"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeProjectIssueFieldList\n<公共请求参数>\n\n{\n    \"ProjectName\":\"demo-project\",\n    \"IssueType\": \"REQUIREMENT\"\n}"},"DescribeProjectIssueStatusList":{"summary":"具体事项类型的状态列表查询","category":"08-项目协同相关接口","description":"✨ 查询具体事项类型的状态列表","params":[{"name":"IssueType","type":"string","required":true,"description":"事项类型\r\nDEFECT - 缺陷\r\nREQUIREMENT - 需求\r\nMISSION - 任务\r\nEPIC - 史诗\r\nSUB_TASK - 子任务"},{"name":"ProjectName","type":"string","required":true,"description":"项目名称"},{"name":"IssueTypeId","type":"integer (int64)","required":false,"description":"事项类型id"}],"response":[{"name":"ProjectIssueStatusList","type":"Array of ProjectIssueStatus","required":false,"description":"项目的事项状态列表"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeProjectIssueStatusList\n<公共请求参数>\n\n{\n    \"ProjectName\":\"demo-project\",\n    \"IssueType\": \"REQUIREMENT\"\n}"},"DescribeProjectIssueTypeList":{"summary":"项目事项类型列表查询","category":"08-项目协同相关接口","description":"✨ 查询项目事项类型列表","params":[{"name":"ProjectName","type":"string","required":true,"description":"项目名称"}],"response":[{"name":"IssueTypes","type":"Array of IssueTypeDetailWithSplit","required":false,"description":"事项类型列表"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeProjectIssueTypeList\n<公共请求参数>\n\n{\n  \"ProjectName\": \"project-demo\"\n}"},"DescribeRelatedCaseList":{"summary":"事项关联的测试用例查询","category":"08-项目协同相关接口","description":"✨ 管理测试用例","params":[{"name":"IssueCode","type":"integer (int64)","required":true,"description":"事项ID"},{"name":"ProjectName","type":"string","required":true,"description":"项目名称"}],"response":[{"name":"Cases","type":"Array of RelatedCase","required":false,"description":"事项关联的测试用例"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeRelatedCaseList\n<公共请求参数>\n\n{\n  \"ProjectName\":\"project name\",\n  \"IssueCode\": 1\n}"},"DescribeRelease":{"summary":"版本详情查询","category":"08-项目协同相关接口","description":"✨ 版本详情","params":[{"name":"ProjectName","type":"string","required":true,"description":"项目名称"},{"name":"ReleaseCode","type":"integer (int64)","required":true,"description":"版本code"}],"response":[{"name":"Release","type":"OpenApiRelease","required":false,"description":"版本信息"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeRelease\n<公共请求参数>\n\n{\n  \"ProjectName\": \"agile\",\n  \"ReleaseCode\": 42\n}"},"DescribeReleaseIssueList":{"summary":"版本发布范围查询","category":"08-项目协同相关接口","description":"✨ 版本发布范围","params":[{"name":"Assignees","type":"Array of integer","required":false,"description":"处理人ID数组"},{"name":"IssueTypeIds","type":"Array of integer","required":false,"description":"事项类型ID数组"},{"name":"IssueTypes","type":"Array of string","required":false,"description":"事项类型数组"},{"name":"Keywords","type":"string","required":false,"description":"关键字"},{"name":"Page","type":"integer (int64)","required":false,"description":"分页查询中的页数,page从1开始计数"},{"name":"PageSize","type":"integer (int64)","required":false,"description":"分页查询中每页的大小"},{"name":"ProjectName","type":"string","required":true,"description":"项目名称"},{"name":"ReleaseCode","type":"integer (int64)","required":true,"description":"页面上版本ID"},{"name":"ShowImageOutUrl","type":"boolean (bool)","required":false,"description":"是否展示描述中外部可访问的地址"},{"name":"ShowSubIssues","type":"boolean (bool)","required":false,"description":"是否显示字事项，和页面开关对应"},{"name":"SortBy","type":"string","required":false,"description":"排序，取值如\"ID:ASC\""},{"name":"StatusTypes","type":"Array of integer","required":false,"description":"事项状态类型数组"},{"name":"Watchers","type":"Array of integer","required":false,"description":"关注人ID数组"}],"response":[{"name":"Data","type":"IssueDetailListDataWithPage","required":false,"description":"版本发布范围"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeReleaseIssueList\n<公共请求参数>\n\n{\n  \"ProjectName\": \"xjx-agile-2\",\n  \"ReleaseCode\": 0,\n  \"IssueTypes\": [],\n  \"StatusTypes\": [],\n  \"IssueTypeIds\": [],\n  \"Assignees\": [],\n  \"Watchers\": [],\n  \"Keywords\": \"\",\n  \"SortBy\": \"\",\n  \"ShowSubIssues\": true,\n  \"Page\": 1,\n  \"PageSize\": 20\n}"},"DescribeReleaseList":{"summary":"版本列表查询","category":"08-项目协同相关接口","description":"✨ 查询项目内版本列表","params":[{"name":"Conditions","type":"Array of IssueCondition","required":false,"description":"筛选条件列表，每一个值都是一个筛选条件，条件取值可以参考页面上的对应的HTTP接口"},{"name":"Page","type":"integer (int64)","required":false,"description":"分页查询中的页数，page从1开始计数"},{"name":"PageSize","type":"integer (int64)","required":false,"description":"分页查询中每页的大小"},{"name":"ProjectName","type":"string","required":true,"description":"项目名称"},{"name":"SortKey","type":"string","required":false,"description":"排序KEY"},{"name":"SortValue","type":"string","required":false,"description":"排序VALUE"}],"response":[{"name":"Data","type":"OpenApiReleaseListDataWithPage","required":false,"description":"版本列表"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeReleaseList\n<公共请求参数>\n\n{\n  \"ProjectName\": \"agile\",\n  \"SortKey\": \"CODE\",\n  \"SortValue\": \"ASC\",\n  \"Page\": 1,\n  \"PageSize\": 20,\n  \"Conditions\": [\n    {\n      \"Key\": \"STATUS_TYPE\",\n      \"Value\": \n        \"TODO\"\n    \n    }\n  ]\n}"},"DescribeRequirementDefectRelation":{"summary":"需求关联缺陷列表查询","category":"08-项目协同相关接口","description":"✨ 查询需求关联缺陷列表","params":[{"name":"ProjectName","type":"string","required":true,"description":"项目名称"},{"name":"RequirementCode","type":"integer (int64)","required":true,"description":"需求 Code"}],"response":[{"name":"Issues","type":"Array of IssueSimpleData","required":false,"description":"缺陷列表"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeRequirementDefectRelation\n<公共请求参数>\n\n{\n  \"ProjectName\":\"project-demo\",\n  \"RequirementCode\":1\n}"},"DescribeSubIssueList":{"summary":"子事项列表查询","category":"08-项目协同相关接口","description":"✨ 查询子事项列表","params":[{"name":"IssueCode","type":"integer (int64)","required":true,"description":"事项 Code"},{"name":"ProjectName","type":"string","required":true,"description":"项目名称"}],"response":[{"name":"SubIssueList","type":"Array of IssueListData","required":false,"description":"子事项列表"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeSubIssueList\n<公共请求参数>\n\n{\n  \"ProjectName\":\"project-demo\",\n  \"IssueCode\":1\n}"},"DescribeTeamIssues":{"summary":"查询团队事项列表","category":"08-项目协同相关接口","description":"✨ 查询团队事项列表","params":[{"name":"Conditions","type":"Array of TeamIssueCondition","required":false,"description":"筛选条件列表"},{"name":"Sorts","type":"Array of TeamIssueSortCondition","required":false,"description":"排序条件列表"},{"name":"PageSize","type":"integer (int64)","required":false,"description":"分页大小， 最大500"},{"name":"PageNumber","type":"integer (int64)","required":false,"description":"页码, 从1开始"},{"name":"ShowSubIssues","type":"boolean (boolean)","required":false,"description":"是否展示子事项"},{"name":"ShowImageOutUrl","type":"boolean (boolean)","required":false,"description":"是否显示描述中真实的图片路径(cos/minio)"}],"response":[{"name":"Issues","type":"Array of IssueListData","required":false,"description":"事项列表"},{"name":"PageNumber","type":"integer (int64)","required":false,"description":"页码"},{"name":"PageSize","type":"integer (int64)","required":false,"description":"分页的大小"},{"name":"TotalCount","type":"integer (int64)","required":false,"description":"所有行数"},{"name":"TotalPage","type":"integer (int64)","required":false,"description":"全部页"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeTeamIssues\n<公共请求参数>\n\n{\n    \"PageNumber\": 1,\n    \"PageSize\": 10,\n    \"Conditions\": [\n      {\n        \"Key\": \"STATUS_TYPE\",\n        \"Value\": \"TODO, PROCESSING\"\n      },\n      {\n        \"Key\": \"ISSUE_TYPE_ID\",\n        \"Value\": \"5\"\n      }\n\n    ],\n    \"Sorts\": [],\n    \"ShowSubIssues\": false\n}"},"DescribeTeamIssueTypeList":{"summary":"企业事项类型列表查询","category":"08-项目协同相关接口","description":"✨ 查询企业事项类型列表","params":[],"response":[{"name":"IssueTypes","type":"Array of IssueTypeDetail","required":false,"description":"事项类型列表"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeTeamIssueTypeList\n<公共请求参数>\n\n{\n}"},"DescribeUserHandoverIssues":{"summary":"查询团队成员待交接事项列表","category":"08-项目协同相关接口","description":"✨ 查询团队成员待交接事项列表","params":[{"name":"WillDeleteUserId","type":"integer (int64)","required":true,"description":"用户ID"}],"response":[{"name":"Issues","type":"Array of IssueDetail","required":false,"description":"待交接事项"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeUserHandoverIssues\n<公共请求参数>\n\n{\n    \"WillDeleteUserId\": 7\n}"},"DescribeWorkbenchIssueList":{"summary":"用户在团队内的所有代办事项查询","category":"08-项目协同相关接口","description":"✨ 获取一个用户在团队内的所有代办事项（即前端页面上个人工作台中的事项列表）","params":[{"name":"Keyword","type":"string","required":false,"description":"关键字"},{"name":"PageNumber","type":"integer (int64)","required":false,"description":"分页查询的分页数，不填的话从第一页开始查询"},{"name":"PageSize","type":"integer (int64)","required":false,"description":"每页展示数，默认 20 ，最大值 500"},{"name":"ProjectId","type":"integer (int64)","required":false,"description":"不填或者填0则查询团队内参与的所有项目"},{"name":"Type","type":"string","required":false,"description":"事项类型，取值如REQUIREMENT、DEFECT等"},{"name":"ShowImageOutUrl","type":"boolean (boolean)","required":false,"description":"是否查询描述中图片的下载地址"}],"response":[{"name":"Data","type":"OpenApiTeamIssueData","required":false,"description":"工作台事项数据"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeWorkbenchIssueList\n<公共请求参数>\n\n{}"},"DescribeWorkItemSalvage":{"summary":"事项分解信息查询","category":"08-项目协同相关接口","description":"✨ 查询 事项分解信息","params":[{"name":"IssueCode","type":"integer (int64)","required":true,"description":"事项code"},{"name":"ProjectName","type":"string","required":true,"description":"项目名称"},{"name":"ShowImageOutUrl","type":"boolean (bool)","required":false,"description":"事项展示图片对外路径"}],"response":[{"name":"OpenApiIssueDetail","type":"Array of IssueDetail","required":false,"description":"事项关联的项目集工作项列表"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeWorkItemSalvage\n<公共请求参数>\n\n{\n    \"ProjectName\": \"hhhh\",\n    \"IssueCode\": 1\n}"},"InitProjectTemplate":{"summary":"项目配置方案初始化","category":"08-项目协同相关接口","description":"✨ 初始化项目配置方案","params":[{"name":"ProjectName","type":"string","required":true,"description":"项目名"},{"name":"Sync","type":"boolean","required":true,"description":"是否同步配置方案，取值 true 或者 false，不填默认为 false"},{"name":"TemplateId","type":"integer (int64)","required":true,"description":"模板id，为DescribeConfigTemplateList接口返回的，如果这里TemplateType选PROJECT，则TemplateId参数有效，否则无效。"},{"name":"TemplateType","type":"string","required":true,"description":"模板类型，取值包括 SCRUM，CLASSIC，PROJECT"}],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write"},"ModifyDefectRelatedRequirement":{"summary":"缺陷所属的需求修改","category":"08-项目协同相关接口","description":"✨ 修改缺陷所属的需求","params":[{"name":"DefectCode","type":"integer (int64)","required":true,"description":"缺陷 Code"},{"name":"ProjectName","type":"string","required":true,"description":"项目名称"},{"name":"RequirementCode","type":"integer (int64)","required":true,"description":"需求 Code"}],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: ModifyDefectRelatedRequirement\n<公共请求参数>\n\n{\n  \"ProjectName\":\"project-demo\",\n  \"DefectCode\":2,\n  \"RequirementCode\":3\n}"},"ModifyIssue":{"summary":"事项修改","category":"08-项目协同相关接口","description":"✨ 修改事项","params":[{"name":"AssigneeId","type":"integer (int64)","required":false,"description":"处理人 Id"},{"name":"Comment","type":"string","required":false,"description":"评论"},{"name":"CustomFieldValues","type":"Array of IssueCustomFieldForm","required":false,"description":"自定义属性值列表"},{"name":"DefectTypeId","type":"integer (int64)","required":false,"description":"缺陷类型 Id"},{"name":"DelFileIds","type":"Array of integer","required":false,"description":"删除的文件 Id 列表"},{"name":"DelLabelIds","type":"Array of integer","required":false,"description":"删除的标签 Id 列表"},{"name":"DelReleaseCodes","type":"Array of integer","required":false,"description":"需要删除的版本jcode列表"},{"name":"DelWatcherIds","type":"Array of integer","required":false,"description":"删除的事项关注人 Id 列表"},{"name":"DueDate","type":"object (date)","required":false,"description":"截止日期，格式：2021-01-01"},{"name":"FileIds","type":"Array of integer","required":false,"description":"添加的文件 Id 列表"},{"name":"IssueCode","type":"integer (int64)","required":true,"description":"事项 Code"},{"name":"IterationCode","type":"integer (int64)","required":false,"description":"迭代code"},{"name":"LabelIds","type":"Array of integer","required":false,"description":"标签 Id 列表"},{"name":"Name","type":"string","required":false,"description":"事项名称"},{"name":"ParentCode","type":"integer (int64)","required":false,"description":"父事项 Code\r\n敏捷模式：Type 为 SUB_TASK 时必须指定\r\n经典模式：Type 为 MISSION、REQUIREMENT 时可指定"},{"name":"Priority","type":"string","required":false,"description":"紧急程度\r\n\"0\" - 低\r\n\"1\" - 中\r\n\"2\" - 高\r\n\"3\" - 紧急"},{"name":"Progress","type":"number (float)","required":false,"description":"进度"},{"name":"ProjectModuleId","type":"integer (int64)","required":false,"description":"项目模块 Id"},{"name":"ProjectName","type":"string","required":true,"description":"项目名称"},{"name":"RecordHour","type":"IssueRecordHourForm","required":false,"description":"登记工时"},{"name":"ReleaseCodes","type":"Array of integer","required":false,"description":"版本code列表"},{"name":"RequirementTypeId","type":"integer (int64)","required":false,"description":"需求类型 Id"},{"name":"StartDate","type":"object (date)","required":false,"description":"开始日期，格式：2021-01-01"},{"name":"StatusId","type":"integer (int64)","required":false,"description":"事项状态 Id"},{"name":"StoryPoint","type":"string","required":false,"description":"故事点，例如：0.5、1"},{"name":"UpdateLabelIds","type":"Array of integer","required":false,"description":"标签 Id 列表"},{"name":"UpdateWatchers","type":"Array of integer","required":false,"description":"关注人 Id 列表"},{"name":"WatcherIds","type":"Array of integer","required":false,"description":"添加的事项关注人 Id 列表"},{"name":"WorkingHours","type":"number (float)","required":false,"description":"工时（小时数）"},{"name":"ShowImageOutUrl","type":"boolean (boolean)","required":false,"description":"是否查询描述中图片的下载地址"}],"response":[{"name":"Issue","type":"IssueDetail","required":false,"description":"事项的具体信息"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: ModifyIssue\n<公共请求参数>\n\n{\n\t\"ProjectName\": \"test-agile\",\n\t\"IssueCode\": 5,\n\t\"Name\": \"tset0002\"\n}"},"ModifyIssueComment":{"summary":"事项评论修改","category":"08-项目协同相关接口","description":"✨ 修改事项评论","params":[{"name":"CommentId","type":"integer (int64)","required":true,"description":"评论 ID"},{"name":"Content","type":"string","required":true,"description":"评论内容"},{"name":"IssueCode","type":"integer (int64)","required":true,"description":"事项 Code"},{"name":"ProjectName","type":"string","required":true,"description":"项目名称"}],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: ModifyIssueComment\n<公共请求参数>\n\n{\n  \"ProjectName\":\"project-demo\",\n  \"IssueCode\":1,\n  \"CommentId\": 1,\n  \"Content\": \"内容\"\n}"},"ModifyIssueDescription":{"summary":"事项描述修改","category":"08-项目协同相关接口","description":"✨ 修改事项描述","params":[{"name":"Description","type":"string","required":true,"description":"事项描述"},{"name":"IssueCode","type":"integer (int64)","required":true,"description":"事项 Code"},{"name":"ProjectName","type":"string","required":true,"description":"项目名称"}],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: ModifyIssueDescription\n<公共请求参数>\n\n{\n    \"ProjectName\": \"demo-project\",\n    \"IssueCode\": 1,\n    \"Description\": \"xxx\"\n}"},"ModifyIssueParentRequirement":{"summary":"事项父需求修改","category":"08-项目协同相关接口","description":"✨ 修改事项父需求","params":[{"name":"IssueCode","type":"integer (int64)","required":true,"description":"事项 Code"},{"name":"ParentIssueCode","type":"integer (int64)","required":true,"description":"父事项 Code"},{"name":"ProjectName","type":"string","required":true,"description":"项目名称"}],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: ModifyIssueParentRequirement\n<公共请求参数>\n\n{\n  \"ProjectName\":\"project-demo\",\n  \"IssueCode\":10,\n  \"ParentIssueCode\": 1\n}"},"ModifyIteration":{"summary":"迭代修改","category":"08-项目协同相关接口","description":"✨ 修改迭代","params":[{"name":"Assignee","type":"integer (uint64)","required":false,"description":"处理人 ID"},{"name":"EndAt","type":"object (date)","required":false,"description":"结束时间，格式：2020-01-01"},{"name":"Goal","type":"string","required":false,"description":"目标"},{"name":"IterationCode","type":"integer (int64)","required":true,"description":"迭代编号"},{"name":"Name","type":"string","required":true,"description":"标题"},{"name":"ProjectName","type":"string","required":true,"description":"项目名称"},{"name":"StartAt","type":"object (date)","required":false,"description":"开始时间，格式：2020-01-01"}],"response":[{"name":"Iteration","type":"Iteration","required":false,"description":"迭代的具体信息"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: ModifyIteration\n<公共请求参数>\n\n{\n  \"ProjectName\":\"demo-project\",\n  \"IterationCode\": 8,\n  \"Name\":\"Title\"\n}"},"ModifyIterationStatus":{"summary":"修改迭代状态","category":"08-项目协同相关接口","description":"✨ 修改迭代状态","params":[{"name":"EndAt","type":"string","required":false,"description":"结束时间，完成迭代必需，格式：2020-01-01"},{"name":"IterationCode","type":"integer (int64)","required":true,"description":"迭代编号"},{"name":"JoinIterationCode","type":"integer (int64)","required":false,"description":"移入迭代编号"},{"name":"Operator","type":"string","required":true,"description":"迭代状态操作，类型：start：开始迭代、complete：完成迭代、restart：重新打开"},{"name":"ProjectName","type":"string","required":true,"description":"项目描述"},{"name":"StartAt","type":"string","required":false,"description":"开始时间，开始迭代必需，格式：2020-01-01"}],"response":[{"name":"Iteration","type":"OpenApiIteration","required":false,"description":"迭代信息"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: ModifyIterationStatus\n<公共请求参数>\n\n{\n\t\"EndAt\": \"2023-05-08\",\n\t\"IterationCode\": 9,\n\t\"Operator\": \"start\",\n\t\"ProjectName\": \"test-agile\",\n\t\"StartAt\": \"2023-05-04\"\n}"},"ModifyRelease":{"summary":"版本修改","category":"08-项目协同相关接口","description":"✨ 修改版本","params":[{"name":"Assignee","type":"integer (int64)","required":false,"description":"修改之后的处理人ID"},{"name":"DelIterationCodes","type":"Array of integer","required":false,"description":"需要删除的版本已关联的迭代的列表"},{"name":"DelLabelIds","type":"Array of integer","required":false,"description":"需要删除的标签的ID列表"},{"name":"Description","type":"string","required":false,"description":"修改之后的版本描述"},{"name":"IterationCodes","type":"Array of integer","required":false,"description":"版本关联的迭代code列表"},{"name":"LabelIds","type":"Array of integer","required":false,"description":"需要添加的标签的ID列表"},{"name":"Name","type":"string","required":false,"description":"修改之后的版本名"},{"name":"ProjectName","type":"string","required":true,"description":"项目名称"},{"name":"ReleaseCode","type":"integer (int64)","required":true,"description":"页面上版本ID"},{"name":"ReleaseDate","type":"string","required":false,"description":"修改之后的版本发布日期"},{"name":"StartDate","type":"string","required":false,"description":"修改之后的版本开始日期"},{"name":"StatusId","type":"integer (int64)","required":false,"description":"修改之后的状态ID"}],"response":[{"name":"Release","type":"OpenApiRelease","required":false,"description":"版本信息"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: ModifyRelease\n<公共请求参数>\n\n{\n  \"ProjectName\": \"xjx-agile\",\n  \"ReleaseCode\": 8,\n  \"Name\": \"xjx\",\n  \"Description\": \"\",\n  \"Assignee\": 0,\n  \"StartDate\": \"\",\n  \"ReleaseDate\": \"\",\n  \"IterationCodes\": []\n}"},"ModifyWorkItemSplitIssues":{"summary":"项目集工作项分解&取消分解到项目中的事项","category":"08-项目协同相关接口","description":"✨ 项目集工作项分解/取消分解到项目中的事项","params":[{"name":"IssueCode","type":"string","required":true,"description":"目标项目中的事项ID"},{"name":"ProgramName","type":"string","required":true,"description":"项目集名称"},{"name":"ProjectName","type":"string","required":true,"description":"目标项目名称"},{"name":"Split","type":"string","required":true,"description":"true 表示分解， false 表示取消分解"},{"name":"WorkItemCode","type":"integer (int64)","required":true,"description":"页面上工作项ID"}],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: ModifyWorkItemSplitIssues\n<公共请求参数>\n\n{\n\t\"ProgramName\": \"program01\",\n\t\"WorkItemCode\": 1,\n\t\"ProjectName\": \"test-agile\",\n\t\"IssueCode\": \"5\",\n\t\"Split\": \"true\"\n}"},"PlanIterationIssue":{"summary":"迭代批量规划","category":"08-项目协同相关接口","description":"✨ 批量规划迭代","params":[{"name":"IssueCode","type":"Array of integer","required":true,"description":"需要规划的事项编号列表"},{"name":"IterationCode","type":"integer (int64)","required":true,"description":"迭代编号，将事项移出迭代请传 0"},{"name":"ProjectName","type":"string","required":true,"description":"项目名称"},{"name":"SingleMode","type":"boolean (bool)","required":false,"description":"单个事项移动模式，即未规划的子事项的迭代跟随传入的事项一同规划，否则仅规划传入的事项"}],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: PlanIterationIssue\n<公共请求参数>\n\n{\n  \"ProjectName\":\"demo-project\",\n  \"IterationCode\":1,\n  \"IssueCode\": [1,2],\n  \"SingleMode\": false\n}"},"UpdateIssueModule":{"summary":"事项模块更新","category":"08-项目协同相关接口","description":"✨ 更新事项模块","params":[{"name":"Name","type":"string","required":true,"description":"模块名称"},{"name":"ProjectName","type":"string","required":true,"description":"项目名称"},{"name":"ModuleId","type":"integer (int64)","required":true,"description":"模块ID"}],"response":[{"name":"IssueModule","type":"IssueModule","required":false,"description":"模块信息"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: UpdateIssueModule\n<公共请求参数>\n\n{\n    \"ProjectName\": \"collaboration\",\n    \"Name\": \"demo\"\n}"},"CreateBinaryFiles":{"summary":"Git文件-Git仓库创建二进制文件","category":"09-代码托管相关接口","description":"✨ Git仓库创建二进制文件，文件总大小不能超过10Mb","params":[{"name":"DepotId","type":"integer (int64)","required":true,"description":"仓库id"},{"name":"DepotPath","type":"string","required":false,"description":"仓库路径，DepotId与DepotPath二选一即可"},{"name":"DestRef","type":"string","required":false,"description":"目标分支名，如果想上传至源分支，值与源分支名一致"},{"name":"GitFiles","type":"Array of GitFile","required":true,"description":"文件信息，其中Path需带上文件名，例如：/data/ReadMe.md。\r\nContent为文件字节流进行Base64编码后的字符串。"},{"name":"LastCommitSha","type":"string","required":true,"description":"源分支最后一次提交sha"},{"name":"Message","type":"string","required":true,"description":"提交信息"},{"name":"SrcRef","type":"string","required":true,"description":"源分支名"}],"response":[{"name":"GitCommit","type":"GitCommit","required":false,"description":"提交信息"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: CreateBinaryFiles\n<公共请求参数>\n\n{\n\t\"DepotId\": 6,\n\t\"SrcRef\": \"master\",\n\t\"Message\": \"cwdvr\",\n\t\"LastCommitSha\": \"2244cd6c207e8deeb7b02ff4a895733529fdd374\",\n\t\"GitFiles\": [\n\t\t{\n\t\t\t\"Path\": \"README.md\",\n\t\t\t\"Content\": \"SSUyN20lMjBhJTIwYmluYXJ5JTIwZmlsZSUyMHRoYXQlMjBuZWVkcyUyMHRvJTIwYmUlMjBkZWNyeXB0ZWQu\"\n\t\t}\n\t]\n}"},"CreateBranchProtection":{"summary":"仓库设置-新增代码保护规则","category":"09-代码托管相关接口","description":"✨ 新增代码保护规则","params":[{"name":"DepotId","type":"integer (int64)","required":true,"description":"仓库id"},{"name":"DepotPath","type":"string","required":false,"description":"仓库路径"},{"name":"Rule","type":"string","required":true,"description":"保护规则"}],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: CreateBranchProtection\n<公共请求参数>\n\n{\n\t\"DepotId\": 6,\n\t\"Rule\": \"测试规则\"\n}"},"CreateBranchProtectionMember":{"summary":"仓库设置-新增保护分支规则管理员","category":"09-代码托管相关接口","description":"✨ 新增保护分支规则管理员","params":[{"name":"AllowPush","type":"boolean (bool)","required":true,"description":"是否允许直接推送"},{"name":"BranchProtectionId","type":"integer (int64)","required":true,"description":"保护分支规则id"},{"name":"DepotId","type":"integer (int64)","required":true,"description":"仓库id"},{"name":"DepotPath","type":"string","required":false,"description":"仓库路径"},{"name":"UserGlobalKey","type":"string","required":true,"description":"用户globalkey"}],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: CreateBranchProtectionMember\n<公共请求参数>\n\n{\n\t\"DepotId\": 6,\n\t\"BranchProtectionId\": 2,\n\t\"UserGlobalKey\": \"coding-coding\",\n\t\"AllowPush\": true,\n\t\"DepotPath\": \"codingcorp/zyx/repo_01\"\n}"},"CreateDepotByTemplate":{"summary":"仓库信息-根据模板创建仓库","category":"09-代码托管相关接口","description":"✨ 根据模板创建仓库","params":[{"name":"DepotName","type":"string","required":true,"description":"仓库名"},{"name":"Description","type":"string","required":false,"description":"仓库描述"},{"name":"ProjectId","type":"integer (int64)","required":true,"description":"项目Id"},{"name":"Template","type":"string","required":true,"description":"仓库模板。目前支持：Spring, Ruby on Rails，Ruby Sinatra，Node.js，Android，Python，Hexo，Jekyll。对应模板参数分别为：SPRING,ROR,SINATRA,NODEJS,ANDROID,FLASK,CLOUD_API_HEXO,CLOUD_API_JEKYLL。如果设置了自定义模版，可以传入自定义模版的仓库Id"}],"response":[{"name":"DepotInfo","type":"DepotInfo","required":false,"description":"仓库数据"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: CreateDepotByTemplate\n<公共请求参数>\n\n{\n\t\"ProjectId\": 1,\n\t\"DepotName\": \"de\",\n\t\"Template\": \"SPRING\"\n}"},"CreateDepotFilePushRule":{"summary":"仓库设置-新增git仓库文件推送规则","category":"09-代码托管相关接口","description":"✨ 新增 git 仓库文件推送规则","params":[{"name":"DepotPath","type":"string","required":true,"description":"仓库路径"},{"name":"IsDenyForAllUser","type":"boolean (bool)","required":true,"description":"拒绝所有人推送"},{"name":"Pattern","type":"string","required":true,"description":"文件路径"}],"response":[{"name":"GitFilePushRule","type":"Array of GitFilePushRule","required":false,"description":"git 仓库文件推送规则列表"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: CreateDepotFilePushRule\n<公共请求参数>\n\n{\n\t\"DepotPath\": \"codingcorp/zyx/repo_01\",\n\t\"Pattern\": \"111\",\n\t\"IsDenyForAllUser\": true\n}"},"CreateDepotFilePushRulePrivilege":{"summary":"仓库设置-新增git仓库文件推送规则特权者","category":"09-代码托管相关接口","description":"✨ 新增git仓库文件推送规则特权者","params":[{"name":"DepotPath","type":"string","required":true,"description":"仓库路径"},{"name":"FilePushRuleId","type":"integer (int64)","required":true,"description":"文件推送规则 ID"},{"name":"IsDeny","type":"boolean (bool)","required":true,"description":"拒绝推送"},{"name":"IsRole","type":"boolean (bool)","required":true,"description":"特权者是角色（IsUser和IsRole有且只能有一个为true）"},{"name":"IsUser","type":"boolean (bool)","required":true,"description":"特权者是用户（IsUser和IsRole有且只能有一个为true）"},{"name":"RoleId","type":"integer (int64)","required":false,"description":"角色 ID"},{"name":"UserGlobalKey","type":"string","required":true,"description":"用户全局 key"}],"response":[{"name":"GitFilePushRule","type":"Array of GitFilePushRule","required":false,"description":"git 仓库文件推送规则列表"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: CreateDepotFilePushRulePrivilege\n<公共请求参数>\n\n{\n    \"DepotPath\": \"codingcorp/project-d/depot-1\",\n    \"FilePushRuleId\": 5,\n    \"IsDeny\": true,\n    \"IsUser\": true,\n    \"IsRole\": false,\n    \"UserGlobalKey\": \"coding-coding\"\n}"},"CreateGitBranch":{"summary":"仓库分支-用于代码仓库新建分支","category":"09-代码托管相关接口","description":"✨ 用于代码仓库新建分支","params":[{"name":"BranchName","type":"string","required":true,"description":"分支名称"},{"name":"DepotId","type":"integer (int64)","required":true,"description":"仓库id"},{"name":"DepotPath","type":"string","required":false,"description":"仓库路径，DepotId与DepotPath二选一即可"},{"name":"Note","type":"string","required":false,"description":"分支备注"},{"name":"StartPoint","type":"string","required":true,"description":"创建来源的分支名称或者commitId"}],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: CreateGitBranch\n<公共请求参数>\n\n{\n    \"DepotId\":1,\n    \"BranchName\":\"dev\",\n    \"StartPoint\":\"master\"\n}"},"CreateGitCommit":{"summary":"Git提交-创建一次提交","category":"09-代码托管相关接口","description":"✨ 创建一次提交","params":[{"name":"CommitFiles","type":"Array of CommitFile","required":true,"description":"文件列表"},{"name":"DepotPath","type":"string","required":true,"description":"仓库路径"},{"name":"LastCommitSha","type":"string","required":true,"description":"最后次提交 Sha"},{"name":"Message","type":"string","required":true,"description":"提交文本"},{"name":"NewRef","type":"string","required":false,"description":"新分支（如果不修改分支名称，不需要传值）"},{"name":"Ref","type":"string","required":true,"description":"基于改动的分支"}],"response":[{"name":"GitCommit","type":"GitCommit","required":false,"description":"本次提交详细信息"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: CreateGitCommit\n<公共请求参数>\n\n{\n\t\"DepotPath\": \"codingcorp/zyx/depot\",\n\t\"LastCommitSha\": \"fc20bde8f77a3370f3e7e839191e48671c741023\",\n\t\"Message\": \"cwec\",\n\t\"Ref\": \"master\",\n\t\"NewRef\": \"ss\",\n\t\"CommitFiles\": [\n\t\t{\n\t\t\t\"ContentEncoding\": \"ENCODING_RAW\",\n\t\t\t\"Path\": \"README.md\",\n\t\t\t\"NewPath\": \"README1.md\",\n\t\t\t\"Content\": \" d dcdcwdcvwd\",\n\t\t\t\"WantDelete\": false,\n\t\t\t\"WantRename\": false\n\t\t}\n\t]\n}"},"CreateGitCommitComment":{"summary":"Git提交-为某次提交创建一条评论","category":"09-代码托管相关接口","description":"✨ 为某次提交创建一条评论","params":[{"name":"Content","type":"string","required":true,"description":"评论的内容"},{"name":"DepotId","type":"integer (int64)","required":true,"description":"仓库id"},{"name":"DepotPath","type":"string","required":false,"description":"仓库路径，DepotId与DepotPath二选一即可"},{"name":"Index","type":"integer (int64)","required":true,"description":"diff信息中的第几行"},{"name":"Path","type":"string","required":true,"description":"文件路径"},{"name":"Sha","type":"string","required":true,"description":"提交id"}],"response":[{"name":"Comment","type":"CommitComment","required":false,"description":"提交的评论详情"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: CreateGitCommitComment\n<公共请求参数>\n\n{\n  \"DepotId\": 2,\n  \"Sha\": \"377e07bf888cc625c678c379082c4fcbbfba0ff4\",\n  \"Path\": \"ee\",\n  \"Index\": 1,\n  \"Content\": \"Hello\"\n}"},"CreateGitCommitNote":{"summary":"Git提交-创建提交注释。注意：对于 NotesRef 参数建议默认为空，因为git会使用默认的ref ：refs/notes/commits，如果填了这个参数，会用这个参数指定的ref来保存您的git note，有可能会覆盖您原有的ref。","category":"09-代码托管相关接口","description":"✨ 创建提交注释,注意：对于 NotesRef 参数建议默认为空，因为 git 会使用默认的 ref ：refs/notes/commits，如果填了这个参数，会用这个参数指定的 ref 来保存您的 git note，有可能会覆盖您原有的 ref。","params":[{"name":"CommitMessage","type":"string","required":true,"description":"提交信息"},{"name":"CommitSha","type":"string","required":true,"description":"提交的 Sha"},{"name":"DepotId","type":"integer (int64)","required":true,"description":"仓库id"},{"name":"DepotPath","type":"string","required":false,"description":"仓库路径，DepotId与DepotPath二选一即可"},{"name":"Note","type":"string","required":true,"description":"注释的详情信息"},{"name":"NotesRef","type":"string","required":false,"description":"注释分支 ref。建议默认不填"}],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: CreateGitCommitNote\n<公共请求参数>\n\n{\n    \"DepotId\":1383,\n    \"NotesRef\":\"refs/master\",\n    \"CommitSha\":\"5178d68bd3ee2a93733354884f0888584d671d7b\",\n    \"Note\":\"coding\",\n    \"CommitMessage\":\"coding\"\n}"},"CreateGitDeployKey":{"summary":"仓库设置-新建部署公钥","category":"09-代码托管相关接口","description":"✨ 新建部署公钥","params":[{"name":"AllowWrite","type":"boolean (bool)","required":true,"description":"是否授予写入权限"},{"name":"Content","type":"string","required":true,"description":"SSH key"},{"name":"DepotId","type":"integer (int64)","required":true,"description":"仓库 Id"},{"name":"DepotPath","type":"string","required":false,"description":"仓库路径"},{"name":"ExpirationDate","type":"string","required":false,"description":"过期时间，不填则为永不过期"},{"name":"Title","type":"string","required":true,"description":"部署公钥标题"}],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: CreateGitDeployKey\n<公共请求参数>\n\n{\n\t\"DepotId\": 6,\n\t\"Title\": \"zyx部署公钥\",\n\t\"Content\": \"ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIF/5E1wTyoyXZJanekdHsYa66GRxZTH88OSC0a8XuCSf example@example.com\",\n\t\"AllowWrite\": true\n}"},"CreateGitDepot":{"summary":"仓库信息-创建代码仓库","category":"09-代码托管相关接口","description":"✨ 创建代码仓库","params":[{"name":"DepotName","type":"string","required":true,"description":"仓库名称"},{"name":"Description","type":"string","required":false,"description":"仓库的描述信息"},{"name":"ProjectId","type":"integer (int64)","required":true,"description":"项目id"},{"name":"Shared","type":"boolean (bool)","required":false,"description":"仓库是否允许公开访问"}],"response":[{"name":"DepotId","type":"integer (int64)","required":false,"description":"创建的仓库id"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: CreateGitDepot\n<公共请求参数>\n\n{\n    \"ProjectId\":1,\n    \"DepotName\":\"project-1\"\n}"},"CreateGitFiles":{"summary":"Git文件-创建仓库文件","category":"09-代码托管相关接口","description":"✨ 创建仓库文件","params":[{"name":"DepotId","type":"integer (int64)","required":true,"description":"仓库 ID"},{"name":"DepotPath","type":"string","required":false,"description":"仓库路径，DepotId与DepotPath二选一即可"},{"name":"GitFiles","type":"Array of GitFile","required":true,"description":"新增的文件"},{"name":"LastCommitSha","type":"string","required":true,"description":"最后次提交 Sha"},{"name":"Message","type":"string","required":true,"description":"提交文本"},{"name":"NewRef","type":"string","required":false,"description":"新分支"},{"name":"Ref","type":"string","required":true,"description":"基于改动的分支"}],"response":[{"name":"GitCommit","type":"GitCommit","required":false,"description":"提交信息"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: CreateGitFiles\n<公共请求参数>\n\n{\n\t\"DepotId\": 6,\n\t\"LastCommitSha\": \"9086f8341a4cb6dd47446bc8e79815ab18e9162f\",\n\t\"Message\": \"123\",\n\t\"Ref\": \"master\",\n\t\"GitFiles\": [\n\t\t{\n\t\t\t\"Path\": \"README.md\",\n\t\t\t\"Content\": \"123334\"\n\t\t}\n\t]\n}"},"CreateGitMergeReq":{"summary":"合并请求-创建git合并请求","category":"09-代码托管相关接口","description":"✨ 创建git合并请求","params":[{"name":"Content","type":"string","required":true,"description":"合并请求内容"},{"name":"DepotId","type":"integer (int64)","required":true,"description":"仓库id"},{"name":"DepotPath","type":"string","required":false,"description":"仓库路径与depotId选择其一就可以"},{"name":"DestBranch","type":"string","required":true,"description":"目标分支"},{"name":"Reviewers","type":"string","required":false,"description":"评审者"},{"name":"SrcBranch","type":"string","required":true,"description":"源分支"},{"name":"Title","type":"string","required":true,"description":"合并请求title"}],"response":[{"name":"MergeInfo","type":"MergeInfo","required":false,"description":"合并请求信息"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: CreateGitMergeReq\n<公共请求参数>\n\n{\n\t\"DepotId\": 0,\n\t\"Title\": \"xxx\",\n\t\"Content\": \"cccc\",\n\t\"SrcBranch\": \"fff\",\n\t\"DestBranch\": \"master\",\n\t\"DepotPath\": \"codingcorp/zyx/dee\"\n}"},"CreateGitMergeRequest":{"summary":"合并请求-创建Git合并请求mr","category":"09-代码托管相关接口","description":"✨ 创建 Git 合并请求mr","params":[{"name":"Content","type":"string","required":true,"description":"描述内容"},{"name":"DepotId","type":"integer (uint64)","required":true,"description":"仓库 ID"},{"name":"DepotPath","type":"string","required":false,"description":"仓库路径，与仓库ID二选一"},{"name":"DestBranch","type":"string","required":true,"description":"目标分支名"},{"name":"SrcBranch","type":"string","required":true,"description":"源分支名"},{"name":"Title","type":"string","required":true,"description":"标题"}],"response":[{"name":"Request","type":"GitMergeRequest","required":false,"description":"创建合并请求的信息"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: CreateGitMergeRequest\n<公共请求参数>\n\n{\n\t\"DepotId\": 6,\n\t\"Title\": \"mrmr\",\n\t\"Content\": \"123\",\n\t\"SrcBranch\": \"master-patch-3\",\n\t\"DestBranch\": \"master\"\n}"},"CreateGitProtectedTagRule":{"summary":"仓库设置-创建标签保护规则","category":"09-代码托管相关接口","description":"✨ 创建标签保护规则","params":[{"name":"DepotId","type":"integer (int64)","required":true,"description":"仓库 Id"},{"name":"DepotPath","type":"string","required":false,"description":"仓库路径，与仓库ID二选一"},{"name":"Rule","type":"string","required":true,"description":"保护规则"}],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: CreateGitProtectedTagRule\n<公共请求参数>\n\n{\n\t\"DepotId\": 6,\n\t\"Rule\": \"123321\"\n}"},"CreateGitProtectedTagRules":{"summary":"仓库设置-批量创建标签保护规则","category":"09-代码托管相关接口","description":"✨ 批量创建标签保护规则","params":[{"name":"DepotId","type":"integer (int64)","required":true,"description":"仓库 Id"},{"name":"DepotPath","type":"string","required":false,"description":"仓库路径"},{"name":"Rule","type":"Array of string","required":true,"description":"保护规则列表"}],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: CreateGitProtectedTagRules\n<公共请求参数>\n\n{\n\t\"DepotId\": 30,\n\t\"Rule\": [\n\t\t\"mas,m,t\"\n\t]\n}"},"CreateGitRelease":{"summary":"版本信息-新建git版本","category":"09-代码托管相关接口","description":"✨ 新建 git 版本","params":[{"name":"CommitSha","type":"string","required":true,"description":"提交 Sha 值"},{"name":"DepotId","type":"integer (int64)","required":true,"description":"仓库id"},{"name":"DepotPath","type":"string","required":false,"description":"仓库路径，与仓库ID二选一"},{"name":"Description","type":"string","required":true,"description":"版本描述信息"},{"name":"Pre","type":"boolean (bool)","required":true,"description":"是否为预发布版本"},{"name":"TagName","type":"string","required":true,"description":"创建来源的分支名称或者commitId"},{"name":"TargetCommitBranch","type":"string","required":true,"description":"目标提交 Sha 值"},{"name":"Title","type":"string","required":true,"description":"版本标题"}],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: CreateGitRelease\n<公共请求参数>\n\n{\n\t\"DepotId\": 6,\n\t\"TagName\": \"zyx\",\n\t\"CommitSha\": \"e49a3524bdb7aeba8344504330efaaaf978e143a\",\n\t\"TargetCommitBranch\": \"master\",\n\t\"Title\": \"创建git版本\",\n\t\"Description\": \"111\",\n\t\"Pre\": false\n}"},"CreateGitTag":{"summary":"标签信息-创建标签","category":"09-代码托管相关接口","description":"✨ 创建标签","params":[{"name":"DepotId","type":"integer (int64)","required":true,"description":"仓库id"},{"name":"DepotPath","type":"string","required":false,"description":"仓库路径，DepotId与DepotPath二选一即可"},{"name":"Message","type":"string","required":true,"description":"tag创建信息"},{"name":"StartPoint","type":"string","required":true,"description":"创建来源的分支或commitId"},{"name":"TagName","type":"string","required":true,"description":"tag名称"}],"response":[{"name":"GitTag","type":"GitTag","required":false,"description":"tag的详细信息"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: CreateGitTag\n<公共请求参数>\n\n{\n\t\"DepotId\": 6,\n\t\"StartPoint\": \"master\",\n\t\"TagName\": \"1900\",\n\t\"Message\": \"111\"\n}"},"CreateMemberSshKey":{"summary":"仓库设置-导入团队成员SSH公钥","category":"09-代码托管相关接口","description":"✨ 导入团队成员SSH公钥","params":[{"name":"Content","type":"string","required":true,"description":"公钥内容"},{"name":"ExpirationDate","type":"string","required":false,"description":"过期时间，不填为永不过期 9999-12-31"},{"name":"MemberUserId","type":"integer (int64)","required":true,"description":"成员 Id"},{"name":"Title","type":"string","required":true,"description":"导入的 ssh key 标识名"}],"response":[{"name":"SshKeyInfo","type":"SshKeyInfo","required":false,"description":"SSH公钥详细信息"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: CreateMemberSshKey\n<公共请求参数>\n\n{\n\t\"Title\": \"fffd\",\n\t\"Content\": \"ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIF/5E1wTyoyXZJanekdHsYa66GRxZTH88OSC0a8XuCSf example@example.com\",\n\t\"MemberUserId\": 2\n}"},"CreateMergeRequestNote":{"summary":"合并请求-创建合并请求行评论和改动文件diff行评论","category":"09-代码托管相关接口","description":"✨ 创建合并请求行评论和改动文件diff行评论","params":[{"name":"Content","type":"string","required":true,"description":"行评论内容"},{"name":"DepotPath","type":"string","required":true,"description":"仓库路径"},{"name":"Form","type":"MergeRequestDiffNoteForm","required":false,"description":"创建Diff信息行评论表单"},{"name":"MergeId","type":"integer (uint64)","required":true,"description":"合并请求的Iid"},{"name":"ParentId","type":"integer (uint64)","required":true,"description":"行评论的父亲Id"}],"response":[{"name":"Note","type":"MergeRequestNote","required":false,"description":"行评论内容"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"{\n  \"DepotPath\": \"codingcorp/test/test111\",\n  \"Form\": {\n    \"CommitSha\": \"2994baabc5dca2bd2a07b9230da99becf1734331\",\n    \"Index\": 1,\n    \"Path\": \"README.md\"\n  },\n  \"Content\": \"Hello\",\n  \"MergeId\": 14,\n  \"ParentId\": 0\n}"},"CreateMergeRequestReviewer":{"summary":"合并请求-新增合并请求评审者","category":"09-代码托管相关接口","description":"✨ 新增合并请求评审者","params":[{"name":"DepotId","type":"integer (int64)","required":true,"description":"仓库id"},{"name":"DepotPath","type":"string","required":false,"description":"仓库路径，DepotId与DepotPath二选一即可"},{"name":"MergeId","type":"integer (int64)","required":true,"description":"合并请求id"},{"name":"ReviewerGlobalKey","type":"string","required":true,"description":"评审者"}],"response":[{"name":"Reviewers","type":"Array of CodingUser","required":false,"description":"评审者信息"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: CreateMergeRequestReviewer\n<公共请求参数>\n\n{\n\t\"MergeId\": 18,\n\t\"DepotId\": 9,\n\t\"ReviewerGlobalKey\": \"coding-user\"\n}"},"CreateReadOnlyRef":{"summary":"仓库分支-创建只读分支","category":"09-代码托管相关接口","description":"✨ 创建只读分支","params":[{"name":"DepotPath","type":"string","required":true,"description":"仓库路径"},{"name":"RefName","type":"string","required":true,"description":"分支名称"}],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: CreateReadOnlyRef\n<公共请求参数>\n\n{\n     \"DepotPath\": \"abc\",\n     \"RefName\": \"abc\"\n}"},"CreateSshKey":{"summary":"仓库设置-导入用户SSH公钥","category":"09-代码托管相关接口","description":"✨ 导入用户SSH公钥","params":[{"name":"Content","type":"string","required":true,"description":"公钥内容"},{"name":"ExpirationDate","type":"string","required":false,"description":"过期时间，不填为永不过期 9999-12-31"},{"name":"Title","type":"string","required":true,"description":"导入的 ssh key 标识名"}],"response":[{"name":"SshKeyInfo","type":"SshKeyInfo","required":false,"description":"SSH公钥详细信息"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: CreateSshKey\n<公共请求参数>\n\n{\n  \"Title\": \"Hello\",\n  \"Content\": \"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAACAQDEPWDzF9gULVngb8Bv/SEGXVa6i5I1mFQK9nuUib0fbR4rFAvfBhbJtHoed4O+/KOc3Sxw/A0dQB6uZB7jfzw8RY5dtOvEkI1WlZ8/+7cC7Q14DkzElfCNodha/kP5dS23cIYZdESfuorWCRJZCq5CWoaV9io2DCdD1cvKbAr1CcdBNJ2UODvqxVllLnSw7rZW6D4hdJFjcLAP+ZaoZb1tqpkuS8I5QiF5smuMeLx8uGdM0/C9Pe0EXcsLk7N/YwqO4F6KnPj1TltLqs7O5hXN8BuMsLT90O2EHynq6Z1/ErSaCIszXQJQsYTJr5bJsaRZAkucDnldkX0YocnerNfH0PH+NwB0JT8Q/v9ao2FFDGG+u0fSYQ4fnOsANhNMnwr3hbQjg/S01DZBS6XryiL+MyDWB2vUgNxXQzCUGhwY2Vn9A8J9sfydTDDIQL/RDkDaBe7e4wIMqXvSP9UB/jXV2IZsbzq+QHcXW3SZJ8ueGcwI6krzlsXHZtw7xkUZhrlDHlP0q5nrrm7NZzkduwDFDZ8Pm4vig98+Wj/KDPKcig3b/y/q8XJKTK0D46x+85rS7Ti7157wltUuyqyTgoGnMZuGboU3zRvbbhEWF3PbDTCWbx+4E/YVubzq1MWQjmtglBsc7IHx79+5+D8MNrYb086WUUVIjHfzCoyAHcu99w== example@example.com\",\n  \"ExpirationDate\": \"2022-09-09\"\n}"},"DeleteBranchProtection":{"summary":"仓库设置-删除保护分支规则","category":"09-代码托管相关接口","description":"✨ 删除保护分支规则","params":[{"name":"BranchProtectionId","type":"integer (int64)","required":true,"description":"保护分支 Id"},{"name":"DepotId","type":"integer (int64)","required":true,"description":"仓库 Id"},{"name":"DepotPath","type":"string","required":false,"description":"仓库路径"}],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"destructive","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DeleteBranchProtection\n<公共请求参数>\n\n{\n\t\"DepotId\": 6,\n\t\"BranchProtectionId\": 3,\n\t\"DepotPath\": \"\"\n}"},"DeleteBranchProtectionMember":{"summary":"仓库设置-删除保护分支规则管理员","category":"09-代码托管相关接口","description":"✨ 新增保护分支规则管理员","params":[{"name":"BranchProtectionId","type":"integer (int64)","required":true,"description":"保护分支规则id"},{"name":"DepotId","type":"integer (int64)","required":true,"description":"仓库id"},{"name":"DepotPath","type":"string","required":false,"description":"仓库路径"},{"name":"UserGlobalKey","type":"string","required":true,"description":"用户globalkey"}],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"destructive","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DeleteBranchProtectionMember\n<公共请求参数>\n\n{\n\t\"DepotId\": 6,\n\t\"BranchProtectionId\": 2,\n\t\"UserGlobalKey\": \"coding-coding\"\n}"},"DeleteDepotFilePushRule":{"summary":"仓库设置-删除git仓库文件推送规则","category":"09-代码托管相关接口","description":"✨ 删除 git 仓库文件推送规则","params":[{"name":"DepotPath","type":"string","required":true,"description":"仓库路径"},{"name":"FilePushRuleId","type":"integer (int64)","required":true,"description":"文件推送规则 ID"}],"response":[{"name":"GitFilePushRule","type":"Array of GitFilePushRule","required":false,"description":"git 仓库文件推送规则列表"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"destructive","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DeleteDepotFilePushRule\n<公共请求参数>\n\n{\n\t\"DepotPath\": \"codingcorp/zyx/repo_01\",\n\t\"FilePushRuleId\": 1\n}"},"DeleteDepotFilePushRuleDenyPrivilege":{"summary":"仓库设置-删除git仓库特权者文件推送权限","category":"09-代码托管相关接口","description":"✨ 删除 git 仓库特权者文件推送权限","params":[{"name":"DepotPath","type":"string","required":true,"description":"仓库路径"},{"name":"FilePushRuleId","type":"integer (int64)","required":true,"description":"文件推送规则 ID"},{"name":"IsRole","type":"boolean (bool)","required":true,"description":"特权者是角色（IsUser和IsRole有且只能有一个为true）"},{"name":"IsUser","type":"boolean (bool)","required":true,"description":"特权者是用户（IsUser和IsRole有且只能有一个为true）"},{"name":"RoleId","type":"integer (int64)","required":false,"description":"角色 ID"},{"name":"UserGlobalKey","type":"string","required":true,"description":"用户全局 key"}],"response":[{"name":"GitFilePushRule","type":"Array of GitFilePushRule","required":false,"description":"git 仓库文件推送规则列表"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"destructive","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DeleteDepotFilePushRuleDenyPrivilege\n<公共请求参数>\n\n{\n\t\"DepotPath\": \"codingcorp/zyx/repo_01\",\n\t\"FilePushRuleId\": 1,\n\t\"IsUser\": true,\n\t\"IsRole\": false,\n\t\"UserGlobalKey\": \"coding-coding\"\n}"},"DeleteGitBranch":{"summary":"仓库分支-删除代码仓库分支","category":"09-代码托管相关接口","description":"✨ 删除代码仓库分支","params":[{"name":"BranchName","type":"string","required":true,"description":"分支名称"},{"name":"DepotId","type":"integer (int64)","required":true,"description":"仓库id"},{"name":"DepotPath","type":"string","required":false,"description":"仓库路径，DepotId与DepotPath二选一即可"}],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"destructive","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DeleteGitBranch\n<公共请求参数>\n\n{\n    \"DepotId\":2,\n    \"BranchName\":\"dev\"\n}"},"DeleteGitDeployKey":{"summary":"仓库设置-删除部署公钥","category":"09-代码托管相关接口","description":"✨ 删除部署公钥","params":[{"name":"DeployKeyId","type":"integer (int64)","required":true,"description":"SSH Key Id"},{"name":"DepotId","type":"integer (int64)","required":true,"description":"仓库id"},{"name":"DepotPath","type":"string","required":false,"description":"仓库路径"}],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"destructive","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DeleteGitDeployKey\n<公共请求参数>\n\n{\n\t\"DepotId\": 6,\n\t\"DeployKeyId\": 9\n}"},"DeleteGitDepot":{"summary":"仓库信息-删除git仓库","category":"09-代码托管相关接口","description":"✨ 删除git仓库","params":[{"name":"DepotId","type":"integer (int64)","required":true,"description":"仓库id"},{"name":"DepotPath","type":"string","required":false,"description":"仓库路径，与仓库ID二选一"}],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"destructive","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DeleteGitDepot\n<公共请求参数>\n\n{\n\t\"DepotId\": 7\n}"},"DeleteGitFiles":{"summary":"Git文件-删除文件并提交","category":"09-代码托管相关接口","description":"✨ 删除文件并提交","params":[{"name":"CommitMessage","type":"string","required":true,"description":"提交信息"},{"name":"DepotId","type":"integer (int64)","required":true,"description":"仓库id"},{"name":"DepotPath","type":"string","required":false,"description":"仓库路径，DepotId与DepotPath二选一即可"},{"name":"Paths","type":"Array of string","required":true,"description":"文件路径列表"},{"name":"Ref","type":"string","required":true,"description":"分支名"}],"response":[{"name":"GitCommit","type":"GitCommit","required":false,"description":"提交信息"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"destructive","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DeleteGitFiles\n<公共请求参数>\n\n{\n\t\"DepotId\": 6,\n\t\"CommitMessage\": \"11111\",\n\t\"Ref\": \"master\",\n\t\"Paths\": [\n\t\t\"README222.md\"\n\t]\n}"},"DeleteGitMergedBranches":{"summary":"仓库分支-删除已合并到默认分支的分支（此操作不会删除受保护的分支)","category":"09-代码托管相关接口","description":"✨ 删除已合并到默认分支的分支（此操作不会删除受保护的分支）","params":[{"name":"DepotId","type":"integer (int64)","required":true,"description":"仓库 ID"},{"name":"DepotPath","type":"string","required":true,"description":"仓库路径，DepotId与DepotPath二选一即可"}],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"destructive","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DeleteGitMergedBranches\n<公共请求参数>\n\n{\n  \"DepotId\": 0,\n  \"DepotPath\": \"abc\"\n}"},"DeleteGitProtectedTagRule":{"summary":"标签信息-删除标签保护规则","category":"09-代码托管相关接口","description":"✨ 删除标签保护规则","params":[{"name":"DepotId","type":"integer (int64)","required":true,"description":"仓库 Id"},{"name":"DepotPath","type":"string","required":false,"description":"仓库路径"},{"name":"Rule","type":"string","required":true,"description":"保护规则"}],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"destructive","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DeleteGitProtectedTagRule\n<公共请求参数>\n\n{\n\t\"DepotId\": 6,\n\t\"Rule\": \"m*\"\n}"},"DeleteGitRelease":{"summary":"版本信息-删除仓库版本","category":"09-代码托管相关接口","description":"✨ 删除仓库版本","params":[{"name":"DepotId","type":"integer (int64)","required":true,"description":"仓库id"},{"name":"DepotPath","type":"string","required":false,"description":"仓库路径"},{"name":"TagName","type":"string","required":true,"description":"描述"}],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"destructive","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DeleteGitRelease\n<公共请求参数>\n\n{\n\t\"DepotId\": 6,\n\t\"TagName\": \"1111\"\n}"},"DeleteGitTag":{"summary":"标签信息-代码仓库删除tag","category":"09-代码托管相关接口","description":"✨ 代码仓库删除tag","params":[{"name":"DepotId","type":"integer (int64)","required":true,"description":"仓库id"},{"name":"DepotPath","type":"string","required":false,"description":"仓库路径"},{"name":"TagName","type":"string","required":true,"description":"tag名称"}],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"destructive","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DeleteGitTag\n<公共请求参数>\n\n{\n\t\"DepotId\": 6,\n\t\"TagName\": \"123\"\n}"},"DeleteMemberSshKey":{"summary":"仓库设置-删除团队成员的SSH公钥","category":"09-代码托管相关接口","description":"✨ 删除团队成员的SSH公钥","params":[{"name":"MemberUserId","type":"integer (int64)","required":true,"description":"成员 Id"},{"name":"SshKeyId","type":"integer (uint64)","required":true,"description":"ssh id"}],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"destructive","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DeleteMemberSshKey\n<公共请求参数>\n\n{\n\t\"SshKeyId\": 8,\n\t\"MemberUserId\": 2\n}"},"DeleteMergeRequestNote":{"summary":"合并请求-删除合并请求行评论和改动文件diff行评论","category":"09-代码托管相关接口","description":"✨ 删除合并请求行评论和改动文件diff行评论","params":[{"name":"DepotPath","type":"string","required":true,"description":"仓库路径"},{"name":"LineNoteId","type":"integer (uint64)","required":true,"description":"行评论Id"},{"name":"MergeId","type":"integer (uint64)","required":true,"description":"合并请求的Iid"}],"response":[{"name":"Note","type":"MergeRequestNote","required":false,"description":"删除的行评论内容"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"destructive","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DeleteMergeRequestNote\n<公共请求参数>\n\n{\n\t\"DepotPath\": \"codingcorp/zyx/repo_01\",\n\t\"LineNoteId\": 330,\n\t\"MergeId\": 10\n}"},"DeleteMergeRequestReviewer":{"summary":"合并请求-删除mr评审者","category":"09-代码托管相关接口","description":"✨ 删除mr评审者","params":[{"name":"DepotId","type":"integer (int64)","required":true,"description":"仓库 ID"},{"name":"DepotPath","type":"string","required":false,"description":"仓库路径，与仓库ID二选一"},{"name":"MergeId","type":"integer (int64)","required":true,"description":"iid"},{"name":"ReviewerGlobalKey","type":"string","required":true,"description":"评审者的GK"}],"response":[{"name":"Reviewers","type":"Array of CodingUser","required":false,"description":"创建合并请求的信息"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"destructive","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DeleteMergeRequestReviewer\n<公共请求参数>\n\n{\n\t\"DepotId\": 9,\n\t\"MergeId\": 18,\n\t\"ReviewerGlobalKey\": \"coding-user\"\n}"},"DeleteSshKey":{"summary":"仓库设置-删除当前用户的SSH公钥","category":"09-代码托管相关接口","description":"✨ 删除当前用户的SSH公钥","params":[{"name":"SshKeyId","type":"integer (uint64)","required":true,"description":"ssh id"}],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"destructive","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DeleteSshKey\n<公共请求参数>\n\n{\n    \"SshKeyId\":2\n}"},"DeleteTeamLevelDepotSpec":{"summary":"仓库设置-删除团队级别的分支规范","category":"09-代码托管相关接口","description":"✨ 删除团队级别的分支规范","params":[{"name":"DepotSpecName","type":"string","required":true,"description":"仓库规范名字"}],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"destructive","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DeleteTeamLevelDepotSpec\n<公共请求参数>\n\n{\n\t\"DepotSpecName\": \"团队级别分支规范test\"\n}"},"DescribeAllMergeRequestNotes":{"summary":"合并请求-获取所有合并请求行评论和改动文件diff行评论","category":"09-代码托管相关接口","description":"✨ 获取所有合并请求行评论和改动文件diff行评论","params":[{"name":"CreatedAtEndDate","type":"string","required":false,"description":"创建结束时间"},{"name":"CreatedAtStartDate","type":"string","required":false,"description":"创建开始时间"},{"name":"DepotPath","type":"string","required":true,"description":"仓库路径"},{"name":"MergeIds","type":"Array of integer","required":false,"description":"合并请求的Iid列表"},{"name":"MrStatuses","type":"Array of string","required":false,"description":"合并请求的状态列表"},{"name":"PageNumber","type":"integer (uint64)","required":true,"description":"页码"},{"name":"PageSize","type":"integer (uint64)","required":true,"description":"页数量"},{"name":"ReporterIds","type":"Array of integer","required":false,"description":"合并请求的发起者列表"}],"response":[{"name":"Notes","type":"Array of MergeRequestNoteList","required":false,"description":"行评论内容"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeAllMergeRequestNotes\n<公共请求参数>\n\n{\n  \"DepotPath\": \"abc\",\n  \"MergeIds\": [\n    1\n  ],\n  \"MrStatuses\": [\n    \"abc\"\n  ],\n  \"ReporterIds\": [\n    1\n  ],\n  \"PageNumber\": 1,\n  \"PageSize\": 1,\n  \"CreatedAtStartDate\": \"abc\",\n  \"CreatedAtEndDate\": \"abc\"\n}"},"DescribeBranchProtection":{"summary":"仓库设置-查询单个保护分支规则","category":"09-代码托管相关接口","description":"✨ 查询单个保护分支规则","params":[{"name":"BranchProtectionId","type":"integer (int64)","required":true,"description":"保护分支规则id"},{"name":"DepotId","type":"integer (int64)","required":true,"description":"仓库id"},{"name":"DepotPath","type":"string","required":false,"description":"仓库路径，DepotId与DepotPath二选一即可"}],"response":[{"name":"BranchProtection","type":"BranchProtection","required":false,"description":"保护分支规则详情"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeBranchProtection\n<公共请求参数>\n\n{\n    \"BranchProtectionId\":\"7\",\n    \"DepotId\":\"8\"\n}"},"DescribeBranchProtectionMembers":{"summary":"仓库设置-查询保护分支规则下所有管理员信息","category":"09-代码托管相关接口","description":"✨ 查询保护分支规则下所有管理员信息","params":[{"name":"BranchProtectionId","type":"integer (int64)","required":true,"description":"保护分支规则id"},{"name":"DepotId","type":"integer (int64)","required":true,"description":"仓库id"},{"name":"DepotPath","type":"string","required":false,"description":"仓库路径，DepotId与DepptPath二选一即可"}],"response":[{"name":"Members","type":"Array of BranchProtectionMember","required":false,"description":"保护分支规则管理员列表"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeBranchProtectionMembers\n<公共请求参数>\n\n{\n    \"BranchProtectionId\":\"7\",\n    \"DepotId\":\"8\"\n}"},"DescribeBranchProtections":{"summary":"仓库设置-查询仓库保护分支规则集合","category":"09-代码托管相关接口","description":"✨ 查询仓库保护分支规则集合","params":[{"name":"DepotId","type":"integer (int64)","required":true,"description":"仓库id"},{"name":"DepotPath","type":"string","required":false,"description":"仓库路径，DepotId与DepotPath二选一即可"}],"response":[{"name":"BranchProtections","type":"Array of BranchProtection","required":false,"description":"保护分支规则列表"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeBranchProtections\n<公共请求参数>\n\n{\n    \"DepotId\":\"8\"\n}"},"DescribeCanMerge":{"summary":"合并请求-查看两个分支是否可以合并","category":"09-代码托管相关接口","description":"✨ 查看两个分支是否可以合并","params":[{"name":"DepotId","type":"integer (int64)","required":true,"description":"仓库id"},{"name":"Source","type":"string","required":true,"description":"源分支"},{"name":"Target","type":"string","required":true,"description":"目标分支"},{"name":"DepotPath","type":"string","required":false,"description":"仓库路径,与仓库Id二选一即可"}],"response":[{"name":"MergeStatus","type":"string","required":false,"description":"NOT_MERGEABLE(不允许合并),ALREADY_MERGED(完全一样的两个分支),MERGEABLE(可合并),FAILED(比较失败)"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeCanMerge\n<公共请求参数>\n\n{\n    \"DepotId\":37,\n    \"Source\": \"dev\",\n    \"Target\": \"master\"  \n}"},"DescribeChangeBetween2Commit":{"summary":"Git提交-查询两个提交之间的请求列表（source target顺序正常）","category":"09-代码托管相关接口","description":"✨ 查询两个提交之间的请求列表（source target顺序正常）","params":[{"name":"DepotId","type":"integer (int64)","required":true,"description":"仓库id"},{"name":"DepotPath","type":"string","required":false,"description":"仓库路径，选择其一即可"},{"name":"Source","type":"string","required":true,"description":"查询起点sha值"},{"name":"Target","type":"string","required":true,"description":"查询目标sha值"}],"response":[{"name":"Change","type":"Change","required":false,"description":"文件修改具体信息"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read"},"DescribeCodeSearch":{"summary":"仓库信息-查询代码片段详细列表","category":"09-代码托管相关接口","description":"✨ 查询代码片段详细列表","params":[{"name":"BranchName","type":"string","required":true,"description":"分支名称"},{"name":"DepotPath","type":"string","required":true,"description":"仓库路径"},{"name":"FilePath","type":"string","required":false,"description":"文件路径（如需查询某个路径下的代码片段，需要输入此参数）"},{"name":"KeyWord","type":"string","required":true,"description":"查询代码片段关键字"},{"name":"PageNumber","type":"integer (int64)","required":true,"description":"页码数量"},{"name":"PageSize","type":"integer (int64)","required":true,"description":"页码大小"}],"response":[{"name":"Data","type":"GrepLineData","required":false,"description":"仓库信息详情列表"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeCodeSearch\n<公共请求参数>\n\n{\n\t\"DepotPath\": \"codingcorp/zyx/depot\",\n\t\"BranchName\": \"master\",\n\t\"KeyWord\": \"鸡蛋饼\",\n\t\"PageNumber\": 1,\n\t\"PageSize\": 10\n}"},"DescribeCommitRefs":{"summary":"Git提交-查询commit的ref信息","category":"09-代码托管相关接口","description":"✨ 查询commit的ref信息","params":[{"name":"DepotPath","type":"string","required":true,"description":"仓库路径"},{"name":"Sha","type":"string","required":true,"description":"提交sha"},{"name":"Type","type":"string","required":true,"description":"ref类型,all 查询分支和标签，branch查询分支，tag查询标签"}],"response":[{"name":"CommitRefs","type":"Array of CommitRef","required":false,"description":"仓库信息详情列表"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeCommitRefs\n<公共请求参数>\n\n{\n    \"DepotPath\": \"codingcorp/ll/py-git2\",\n    \"Sha\": \"45aa7e42829707fcc1dd137331956403480d2b66\",\n    \"Type\": \"all\"\n}"},"DescribeCommitsBetweenCommitAndCommit":{"summary":"Git提交-查询两个请求之间的请求列表（source target顺序正常）","category":"09-代码托管相关接口","description":"✨ 查询两个请求之间的请求列表（source target顺序正常）","params":[{"name":"DepotId","type":"integer (int64)","required":true,"description":"仓库id"},{"name":"DepotPath","type":"string","required":false,"description":"仓库路径，选择其一即可"},{"name":"Source","type":"string","required":true,"description":"查询起点sha值"},{"name":"Target","type":"string","required":true,"description":"查询目标sha值"}],"response":[{"name":"DifferentOfCommitDetail","type":"DifferentOfCommitDetail","required":false,"description":"请求及文件修改列表"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeCommitsBetweenCommitAndCommit\n<公共请求参数>\n\n{\n  \"DepotId\": 1,\n  \"DepotPath\": \"vcs-test/vcs-test/zyx\",\n  \"Source\": \"sss\",\n  \"Target\": \"master\"\n}"},"DescribeDepotByNameInfo":{"summary":"仓库信息-查询项目下所有的仓库信息列表","category":"09-代码托管相关接口","description":"✨ 查询项目下所有的仓库信息列表","params":[{"name":"DepotName","type":"string","required":true,"description":"仓库名"},{"name":"ProjectName","type":"string","required":true,"description":"项目名称"},{"name":"TeamGk","type":"string","required":true,"description":"团队GK"}],"response":[{"name":"Depot","type":"DepotInfo","required":false,"description":"仓库信息详情列表"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeDepotByNameInfo\n<公共请求参数>\n\n{\n\t\"TeamGk\": \"codingcorp\",\n\t\"ProjectName\": \"zyx\",\n\t\"DepotName\": \"repo_01\"\n}"},"DescribeDepotDefaultBranch":{"summary":"仓库分支-查询仓库的默认分支","category":"09-代码托管相关接口","description":"✨ 查询仓库的默认分支","params":[{"name":"DepotPath","type":"string","required":true,"description":"仓库路径"}],"response":[{"name":"BranchName","type":"string","required":false,"description":"分支名称"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeDepotDefaultBranch\n<公共请求参数>\n\n{\n\t\"DepotPath\": \"codingcorp/zyx/repo_01\"\n}"},"DescribeDepotFilePushRules":{"summary":"仓库设置-查询git仓库文件推送规则","category":"09-代码托管相关接口","description":"✨ 查询 git 仓库文件推送规则","params":[{"name":"DepotPath","type":"string","required":true,"description":"仓库路径"}],"response":[{"name":"GitFilePushRule","type":"Array of GitFilePushRule","required":false,"description":"git 仓库文件推送规则列表"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeDepotFilePushRules\n<公共请求参数>\n\n{\n\t\"DepotPath\": \"codingcorp/zyx/repo_01\"\n}"},"DescribeDepotMergeRequests":{"summary":"合并请求-查询仓库合并请求列表","category":"09-代码托管相关接口","description":"✨ 查询仓库合并请求列表","params":[{"name":"CreatedAtEndDate","type":"string","required":false,"description":"mr创建结束时间"},{"name":"CreatedAtStartDate","type":"string","required":false,"description":"mr创建开始时间"},{"name":"CreatorEmails","type":"Array of string","required":false,"description":"合并请求创建者邮箱列表"},{"name":"CreatorGlobalKeys","type":"Array of string","required":false,"description":"合并请求创建者 Global Key 列表"},{"name":"DepotId","type":"integer (int64)","required":true,"description":"仓库 ID"},{"name":"DepotPath","type":"string","required":false,"description":"仓库路径"},{"name":"IsSortDirectionAsc","type":"boolean (bool)","required":false,"description":"是否升序"},{"name":"KeyWord","type":"string","required":false,"description":"关键词"},{"name":"Labels","type":"Array of string","required":false,"description":"关联标签"},{"name":"MergerEmails","type":"Array of string","required":false,"description":"合并请求合并者邮箱列表"},{"name":"MergerGlobalKeys","type":"Array of string","required":false,"description":"合并请求合并者 Global Key 列表"},{"name":"PageNumber","type":"integer (int64)","required":false,"description":"页数 默认为1"},{"name":"PageSize","type":"integer (int64)","required":false,"description":"每页数量 默认为10"},{"name":"ReviewerEmails","type":"Array of string","required":false,"description":"合并请求评审者邮箱列表"},{"name":"ReviewerGlobalKeys","type":"Array of string","required":false,"description":"评审者 Global Key 列表"},{"name":"Sort","type":"string","required":false,"description":"排序 created_at merged_at action_at"},{"name":"SourceBranches","type":"Array of string","required":false,"description":"源分支"},{"name":"Status","type":"string","required":false,"description":"合并请求状态 OPEN CLOSE ALL ACCEPTED"},{"name":"TargetBranches","type":"Array of string","required":false,"description":"目标分支"},{"name":"UpdatedAtEndDate","type":"string","required":false,"description":"mr更新结束时间"},{"name":"UpdatedAtStartDate","type":"string","required":false,"description":"mr更新开始时间"}],"response":[{"name":"Data","type":"DescribeMergeRequestsData","required":false,"description":"合并请求列表"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeDepotMergeRequests\n<公共请求参数>\n\n{\n\t\"DepotId\": 6\n}"},"DescribeDepotPushSetting":{"summary":"仓库设置-查询仓库推送设置","category":"09-代码托管相关接口","description":"✨ 查询仓库推送设置","params":[{"name":"DepotPath","type":"string","required":true,"description":"仓库路径"}],"response":[{"name":"Data","type":"DepotPushSetting","required":false,"description":"推送设置信息"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeDepotPushSetting\n<公共请求参数>\n\n{\n\t\"DepotPath\": \"codingcorp/zyx/repo_01\"\n}"},"DescribeDepotSpecDetail":{"summary":"仓库设置-查询仓库规范详情","category":"09-代码托管相关接口","description":"✨ 查询仓库规范详情","params":[{"name":"DepotPath","type":"string","required":false,"description":"仓库路径（和仓库规范名字二选一选填）"},{"name":"DepotSpecName","type":"string","required":false,"description":"仓库规范名字（和仓库路径二选一选填）"}],"response":[{"name":"Detail","type":"DepotSpecDetail","required":false,"description":"仓库规范详细信息"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeDepotSpecDetail\n<公共请求参数>\n\n{\n\t\"DepotPath\": \"codingcorp/zyx/repo_01\"\n}"},"DescribeDepotSpecs":{"summary":"仓库设置-查询仓库规范列表","category":"09-代码托管相关接口","description":"✨ 查询仓库规范列表","params":[],"response":[{"name":"DepotSpecs","type":"Array of DepotSpec","required":false,"description":"仓库规范列表"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeDepotSpecs\n<公共请求参数>\n\n{}"},"DescribeDifferentBetween2Commits":{"summary":"Git提交-两次提交之间的文件差异（source target顺序正常）","category":"09-代码托管相关接口","description":"✨ 两次提交之间的文件差异","params":[{"name":"DepotId","type":"integer (int64)","required":true,"description":"仓库Id"},{"name":"DepotPath","type":"string","required":false,"description":"仓库路径，与DepotID二选一即可"},{"name":"Path","type":"string","required":true,"description":"文件路径"},{"name":"Source","type":"string","required":true,"description":"源分支"},{"name":"Straight","type":"boolean","required":false,"description":"commit对比方式,是否直接对比差异"},{"name":"Target","type":"string","required":true,"description":"目标分支"}],"response":[{"name":"DiffFileInfo","type":"QcloudApiGitDepotDiffFileInfo","required":false,"description":"字段描述"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read"},"DescribeDifferentBetweenTwoCommits":{"summary":"Git提交-获取两次commit之间的文件差异详情(废弃，source target顺序不一致)","category":"09-代码托管相关接口","description":"✨ 获取两次 commit 之间的文件 差异详情","params":[{"name":"DepotId","type":"integer (int64)","required":true,"description":"仓库id"},{"name":"DepotPath","type":"string","required":false,"description":"仓库路径，DepotId与DepotPath二选一即可"},{"name":"Path","type":"string","required":true,"description":"文件位置"},{"name":"Source","type":"string","required":true,"description":"源请求 Sha 值,分支名称"},{"name":"Target","type":"string","required":true,"description":"目标请求 Sha 值,分支名称"}],"response":[{"name":"DiffFileInfo","type":"DiffFileInfo","required":false,"description":"文件差异详情"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeDifferentBetweenTwoCommits\n<公共请求参数>\n\n{\n    \"Source\":\"dev\",\n    \"DepotId\":\"8\",\n    \"Target\":\"master\",\n    \"Path\":\"demo\"\n}"},"DescribeGitBlameInfo":{"summary":"Git提交-获取指定commit下某文件指定代码行的最后一次提交","category":"09-代码托管相关接口","description":"✨ 获取指定 commit 下某文件指定代码行的最后一次提交","params":[{"name":"CommitSha","type":"string","required":true,"description":"提交sha"},{"name":"DepotPath","type":"string","required":true,"description":"仓库路径"},{"name":"FilePath","type":"string","required":true,"description":"文件路径"},{"name":"LineEnd","type":"integer (int64)","required":false,"description":"结束行"},{"name":"LineSnat","type":"integer (int64)","required":false,"description":"开始行"}],"response":[{"name":"Info","type":"Array of CommitInfo","required":false,"description":"提交信息"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeGitBlameInfo\n<公共请求参数>\n\n{\n\t\"DepotPath\": \"codingcorp/zyx/dee\",\n\t\"CommitSha\": \"eb9a136c76a803e26b56088cacd4a93675e02cd5\",\n\t\"FilePath\": \"README.md\"\n}"},"DescribeGitBlob":{"summary":"Git文件-查询GitBlob","category":"09-代码托管相关接口","description":"✨ 查询 Git Blob","params":[{"name":"BlobSha","type":"string","required":true,"description":"Blob ID"},{"name":"DepotId","type":"integer (int64)","required":true,"description":"仓库 ID"},{"name":"DepotPath","type":"string","required":false,"description":"仓库路径，DepotId与DepotPath二选一即可"}],"response":[{"name":"Data","type":"BlobDetail","required":false,"description":"blob信息"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeGitBlob\n<公共请求参数>\n\n{\n  \"DepotId\": 2,\n  \"BlobSha\": \"a7954ee405100719a59c1e03f4ac98ce92a2a257\"\n}"},"DescribeGitBlobRaw":{"summary":"Git文件-查询Git Blob raw信息","category":"09-代码托管相关接口","description":"✨ 查询 Git Blob raw 信息","params":[{"name":"BlobSha","type":"string","required":true,"description":"Blob ID"},{"name":"DepotId","type":"integer (int64)","required":true,"description":"仓库 ID"},{"name":"DepotPath","type":"string","required":false,"description":"仓库路径，与仓库ID二选一"}],"response":[{"name":"Content","type":"string","required":false,"description":"blob 文本内容"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeGitBlobRaw\n<公共请求参数>\n\n{\n\t\"DepotId\": 6,\n\t\"BlobSha\": \"16813720\"\n}"},"DescribeGitBranch":{"summary":"仓库分支-查询代码仓库单个分支","category":"09-代码托管相关接口","description":"✨ 查询代码仓库单个分支","params":[{"name":"BranchName","type":"string","required":true,"description":"分支名称"},{"name":"DepotId","type":"integer (int64)","required":true,"description":"仓库id"},{"name":"DepotPath","type":"string","required":false,"description":"仓库路径，与DepotId选其一就可以"}],"response":[{"name":"GitBranch","type":"GitBranch","required":false,"description":"分支详情"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeGitBranch\n<公共请求参数>\n\n{\n\t\"DepotId\": 6,\n\t\"BranchName\": \"master\"\n}"},"DescribeGitBranches":{"summary":"仓库分支-查询仓库下所有分支列表","category":"09-代码托管相关接口","description":"✨ 查询仓库下所有分支列表","params":[{"name":"DepotId","type":"integer (int64)","required":true,"description":"仓库id"},{"name":"DepotPath","type":"string","required":false,"description":"仓库路径，与DepotId二选一即可"},{"name":"KeyWord","type":"string","required":false,"description":"查询的关键词"},{"name":"PageNumber","type":"integer (int64)","required":false,"description":"分页页码"},{"name":"PageSize","type":"integer (int64)","required":false,"description":"分页页距,默认为10"}],"response":[{"name":"Branches","type":"Array of GitBranchInfo","required":false,"description":"分支详细信息"},{"name":"TotalCount","type":"integer (int64)","required":false,"description":"分支数量"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeGitBranches\n<公共请求参数>\n\n{\n\t\"DepotId\": 6\n}"},"DescribeGitBranchesBySha":{"summary":"仓库分支-根据sha值查询所在分支","category":"09-代码托管相关接口","description":"✨ 根据sha值查询所在分支","params":[{"name":"DepotId","type":"integer (int64)","required":true,"description":"仓库id"},{"name":"DepotPath","type":"string","required":false,"description":"仓库路径，DepotId与DepotPath二选一即可"},{"name":"Sha","type":"string","required":true,"description":"sha值"}],"response":[{"name":"Refs","type":"Array of RefInfo","required":false,"description":"ref信息列表"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeGitBranchesBySha\n<公共请求参数>\n\n{\n    \"Sha\":\"1b9172c65935fb6bc75c651582b0956129139075\",\n    \"DepotId\":\"8\"\n}"},"DescribeGitBranchList":{"summary":"仓库分支-查询仓库分支列表","category":"09-代码托管相关接口","description":"✨ 查询仓库分支列表","params":[{"name":"DepotPath","type":"string","required":true,"description":"仓库路径"},{"name":"KeyWord","type":"string","required":false,"description":"查询的关键词"},{"name":"PageNumber","type":"integer (int64)","required":true,"description":"分页页码"},{"name":"PageSize","type":"integer (int64)","required":true,"description":"分页页距,默认为10"}],"response":[{"name":"GitBranchesData","type":"GitBranchesData","required":false,"description":"分支集合"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeGitBranchList\n<公共请求参数>\n\n{\n    \"DepotPath\":\"/team-name/project-name/depot-name\",\n    \"PageNumber\":\"1\",\n    \"KeyWord\":\"\",\n    \"PageSize\":\"10\"\n}"},"DescribeGitCommitComments":{"summary":"Git提交-获取commit评论","category":"09-代码托管相关接口","description":"✨ 获取commit评论","params":[{"name":"DepotPath","type":"string","required":true,"description":"仓库路径"},{"name":"PageNumber","type":"integer (int64)","required":true,"description":"页码数量"},{"name":"PageSize","type":"integer (int64)","required":true,"description":"页码大小"},{"name":"Sha","type":"string","required":true,"description":"提交Sha"}],"response":[{"name":"GitCommitComments","type":"GitCommitComment","required":false,"description":"提交信息评论"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeGitCommitComments\n<公共请求参数>\n\n {\n     \"DepotPath\": \"codingcorp/ll/py-git2\",\n     \"Sha\": \"45aa7e42829707fcc1dd137331956403480d2b66\",\n     \"PageNumber\": 1,\n     \"PageSize\": 10\n }"},"DescribeGitCommitDiff":{"summary":"Git提交-查询某次提交的diff信息","category":"09-代码托管相关接口","description":"✨ 查询某次提交的diff信息","params":[{"name":"DepotId","type":"integer (int64)","required":true,"description":"仓库id"},{"name":"DepotPath","type":"string","required":false,"description":"仓库路径，DepotId与DepotPath二选一即可"},{"name":"Path","type":"string","required":false,"description":"查询指定文件时填写"},{"name":"Sha","type":"string","required":true,"description":"提交id"}],"response":[{"name":"Diffs","type":"Array of GitDiff","required":false,"description":"diff信息详情"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeGitCommitDiff\n<公共请求参数>\n\n{\n  \"DepotId\": 2,\n  \"Sha\": \"556b2a18ddf496e0a3fe46e57bbce337fd8b8718\",\n  \"Path\": \"pubspec.yaml\"\n}"},"DescribeGitCommitFilePathList":{"summary":"Git提交-查询仓库某次提交改动的文件路径列表","category":"09-代码托管相关接口","description":"✨ 查询仓库某次提交改动的文件路径列表","params":[{"name":"CommitSha","type":"string","required":true,"description":"提交的ID"},{"name":"DepotPath","type":"string","required":true,"description":"仓库路径，也可填写仓库ID的字符串形式"}],"response":[{"name":"FilePaths","type":"Array of GitCommitFilePath","required":false,"description":"文件路径列表"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeGitCommitFilePathList\n<公共请求参数>\n\n{\n  \"DepotPath\": \"2\",\n  \"CommitSha\": \"2b6947d800e2e493b25afc8955789421ed54678b\"\n}"},"DescribeGitCommitInfo":{"summary":"Git提交-查询单个请求详情信息","category":"09-代码托管相关接口","description":"✨ 查询单个请求详情信息","params":[{"name":"DepotId","type":"integer (int64)","required":true,"description":"仓库id"},{"name":"DepotPath","type":"string","required":false,"description":"与DepotId二选一即可"},{"name":"Sha","type":"string","required":true,"description":"请求的sha值"}],"response":[{"name":"GitCommit","type":"GitCommit","required":false,"description":"请求详情信息"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeGitCommitInfo\n<公共请求参数>\n\n{\n\t\"DepotId\": 6,\n\t\"Sha\": \"f6c97b661e77740ad7d9126ccf017498b4a5cedd\"\n}"},"DescribeGitCommitInfos":{"summary":"Git提交-查询仓库分支下提交列表","category":"09-代码托管相关接口","description":"✨ 查询仓库分支下提交列表","params":[{"name":"DepotId","type":"integer (int64)","required":true,"description":"仓库id"},{"name":"DepotPath","type":"string","required":false,"description":"仓库路径，DepotId与DepotPath二选一即可"},{"name":"EndDate","type":"string","required":false,"description":"查询截止日志"},{"name":"KeyWord","type":"string","required":false,"description":"提交信息中的关键词"},{"name":"PageNumber","type":"integer (int64)","required":false,"description":"分页页码"},{"name":"PageSize","type":"integer (int64)","required":false,"description":"分页页距"},{"name":"Path","type":"string","required":false,"description":"文件路径"},{"name":"Ref","type":"string","required":true,"description":"分支名称"},{"name":"StartDate","type":"string","required":false,"description":"查询起始日期"}],"response":[{"name":"Commits","type":"Array of GitCommit","required":false,"description":"请求集合"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeGitCommitInfos\n<公共请求参数>\n\n{\n\t\"DepotId\": 6,\n\t\"Ref\": \"master\"\n}"},"DescribeGitCommitNote":{"summary":"Git提交-获取提交注释","category":"09-代码托管相关接口","description":"✨ 获取提交注释","params":[{"name":"CommitSha","type":"string","required":true,"description":"提交的 Sha"},{"name":"DepotId","type":"integer (int64)","required":true,"description":"仓库id"},{"name":"DepotPath","type":"string","required":false,"description":"仓库路径，DepotId与DepotPath二选一即可"},{"name":"NotesRef","type":"string","required":true,"description":"注释 分支 Ref"}],"response":[{"name":"CommitNote","type":"string","required":false,"description":"提交注释"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeGitCommitNote\n<公共请求参数>\n\n{\n    \"DepotId\":\"8\",\n    \"CommitSha\":\"0fc50e19bdf3b9a559d19eef3ff65eff29e31883\",\n    \"NotesRef\":\"\"\n}"},"DescribeGitCommitsInPage":{"summary":"Git提交-查询仓库分支下提交列表","category":"09-代码托管相关接口","description":"✨ 查询仓库分支下提交列表","params":[{"name":"DepotId","type":"integer (int64)","required":true,"description":"仓库id"},{"name":"DepotPath","type":"string","required":false,"description":"仓库路径，DepotId与DepotPath二选一即可"},{"name":"EndDate","type":"string","required":false,"description":"查询截止日志"},{"name":"KeyWord","type":"Array of string","required":false,"description":"提交信息中的关键词"},{"name":"PageNumber","type":"integer (int64)","required":false,"description":"分页页码"},{"name":"PageSize","type":"integer (int64)","required":false,"description":"分页页距"},{"name":"Path","type":"string","required":false,"description":"文件路径"},{"name":"Ref","type":"string","required":true,"description":"分支名称"},{"name":"StartDate","type":"string","required":false,"description":"查询起始日期"}],"response":[{"name":"Data","type":"CommitData","required":false,"description":"请求集合"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeGitCommitsInPage\n<公共请求参数>\n\n{\n\t\"DepotId\": 0,\n\t\"Ref\": \"master\",\n\t\"DepotPath\": \"codingcorp/zyx/depot\"\n}"},"DescribeGitCommitStatus":{"summary":"Git提交-查询提交对应的流水线状态","category":"09-代码托管相关接口","description":"✨ 查询提交对应的流水线状态","params":[{"name":"CommitSha","type":"string","required":true,"description":"提交id"},{"name":"DepotId","type":"integer (int64)","required":true,"description":"仓库id"},{"name":"DepotPath","type":"string","required":false,"description":"仓库路径，DepotId与DepotPath二选一即可"}],"response":[{"name":"StatusCheckResults","type":"Array of StatusCheckResult","required":false,"description":"提交流水线状态列表"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeGitCommitStatus\n<公共请求参数>\n\n{\n  \"DepotId\": 0,\n  \"DepotPath\": \"codingcorp/project-d/depot-d\",\n  \"CommitSha\": \"da3e8c8f93516bc8e1609e5a91df98439c6c7b49\"\n}"},"DescribeGitContributors":{"summary":"仓库信息-查询git仓库的贡献者","category":"09-代码托管相关接口","description":"✨ 查询 git 仓库的贡献者","params":[{"name":"DepotId","type":"integer (int64)","required":true,"description":"仓库Id"},{"name":"DepotPath","type":"string","required":false,"description":"仓库路径，与仓库ID二选一"},{"name":"Ref","type":"string","required":true,"description":"分支或标签名，默认 HEAD"}],"response":[{"name":"Contributors","type":"Array of Contributor","required":false,"description":"贡献者列表"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeGitContributors\n<公共请求参数>\n\n{\n\t\"DepotId\": 6,\n\t\"Ref\": \"master\"\n}"},"DescribeGitDepot":{"summary":"仓库信息-根据代码仓库id获取代码仓库信息","category":"09-代码托管相关接口","description":"✨ 根据代码仓库id获取代码仓库信息","params":[{"name":"DepotId","type":"integer (int64)","required":true,"description":"仓库Id"},{"name":"DepotPath","type":"string","required":false,"description":"仓库路径，与仓库ID二选一"}],"response":[{"name":"Depot","type":"DepotInfo","required":false,"description":"根据代码仓库id获取代码仓库信息"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeGitDepot\n<公共请求参数>\n\n{\n\t\"DepotId\": 6\n}"},"DescribeGitDepotDeployKeys":{"summary":"仓库设置-查询某仓库下的部署公钥列表","category":"09-代码托管相关接口","description":"✨ 查询某仓库下的部署公钥列表","params":[{"name":"DepotId","type":"integer (int64)","required":true,"description":"仓库 Id"},{"name":"DepotPath","type":"string","required":false,"description":"仓库路径，与仓库ID二选一"}],"response":[{"name":"Keys","type":"Array of DeployKeyInfo","required":false,"description":"部署公钥列表"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeGitDepotDeployKeys\n<公共请求参数>\n\n{\n\t\"DepotId\": 6\n}"},"DescribeGitFile":{"summary":"Git文件-获取文件详情","category":"09-代码托管相关接口","description":"✨ 获取文件详情","params":[{"name":"DepotId","type":"integer (int64)","required":true,"description":"仓库Id"},{"name":"DepotPath","type":"string","required":false,"description":"仓库路径，DepotId与DepotPath二选一即可"},{"name":"Path","type":"string","required":false,"description":"文件路径"},{"name":"Ref","type":"string","required":true,"description":"分支名"}],"response":[{"name":"GitFile","type":"GitFileItem","required":false,"description":"文件详情"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeGitFile\n<公共请求参数>\n\n\n{\n    \"DepotId\":1,\n    \"Ref\":\"master\",\n    \"Path\":\"aaa\"\n}"},"DescribeGitFileContent":{"summary":"Git提交-查询某次提交某文件的内容","category":"09-代码托管相关接口","description":"✨ 查询某次提交某文件的内容","params":[{"name":"CommitSha","type":"string","required":true,"description":"commit的sha值"},{"name":"DepotId","type":"integer (int64)","required":true,"description":"仓库id"},{"name":"DepotPath","type":"string","required":false,"description":"仓库路径，DepotId与DepotPath二选一即可"},{"name":"Path","type":"string","required":true,"description":"文件路径"}],"response":[{"name":"GitFileContent","type":"GitFileContent","required":false,"description":"文件信息"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeGitFileContent\n<公共请求参数>\n\n{\n    \"Path\":\"demo\",\n    \"DepotId\":\"8\",\n    \"CommitSha\":\"1b9172c65935fb6bc75c651582b0956129139075\"\n}"},"DescribeGitFiles":{"summary":"Git文件-查询仓库目录下文件和文件夹名字","category":"09-代码托管相关接口","description":"✨ 获取分支目录结构","params":[{"name":"DepotId","type":"integer (int64)","required":true,"description":"仓库Id"},{"name":"DepotPath","type":"string","required":false,"description":"仓库路径，与仓库ID二选一"},{"name":"Path","type":"string","required":false,"description":"路径，不传即为根目录"},{"name":"Ref","type":"string","required":true,"description":"分支名"}],"response":[{"name":"Items","type":"Array of GitTreeItem","required":false,"description":"获取分支目录结构"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeGitFiles\n<公共请求参数>\n\n{\n\t\"DepotId\": 6,\n\t\"Ref\": \"master\"\n}"},"DescribeGitFileStat":{"summary":"Git文件-检查仓库文件是否存在","category":"09-代码托管相关接口","description":"✨ 检查仓库文件","params":[{"name":"DepotPath","type":"string","required":true,"description":"仓库路径，格式：<team>/<project>/<depot>"},{"name":"Path","type":"string","required":true,"description":"文件路径"},{"name":"Ref","type":"string","required":true,"description":"tag | branch | commit"}],"response":[{"name":"Payload","type":"DescribeGitFileStatPayload","required":false,"description":"文件信息"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeGitFileStat\n<公共请求参数>\n\n{\n    \"DepotPath\": \"codingcorp/k8s/etcd\",\n    \"Path\": \"foo.txt\",\n    \"Ref\": \"master\"\n}"},"DescribeGitMergeBase":{"summary":"仓库分支-查询两个分支的公共祖先","category":"09-代码托管相关接口","description":"✨ 查询两个分支的公共祖先","params":[{"name":"DepotId","type":"integer (int64)","required":true,"description":"仓库 ID"},{"name":"DepotPath","type":"string","required":false,"description":"仓库路径，DepotId与DepotPath二选一即可"},{"name":"DestRef","type":"string","required":true,"description":"分支2"},{"name":"SrcRef","type":"string","required":true,"description":"分支1"}],"response":[{"name":"Commit","type":"GitCommit","required":false,"description":"提交详情"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeGitMergeBase\n<公共请求参数>\n\n{\n  \"DepotId\": 0,\n  \"SrcRef\": \"abc\",\n  \"DestRef\": \"abc\",\n  \"DepotPath\": \"abc\"\n}"},"DescribeGitMergeRequestDiffDetail":{"summary":"合并请求-查询合并请求文件的 diff 详情","category":"09-代码托管相关接口","description":"✨ 查询合并请求文件的 diff 详情","params":[{"name":"DepotId","type":"integer (int64)","required":true,"description":"仓库id"},{"name":"DepotPath","type":"string","required":false,"description":"仓库路径，DepotId与DepotPath二选一即可"},{"name":"MergeId","type":"integer (int64)","required":true,"description":"合并请求id"},{"name":"Path","type":"string","required":true,"description":"文件路径"}],"response":[{"name":"Detail","type":"GitDiffMergeRequest","required":false,"description":"对比详细信息"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeGitMergeRequestDiffDetail\n<公共请求参数>\n\n{\n\t\"DepotId\": 9,\n\t\"MergeId\": 14,\n\t\"Path\": \"README.md\"\n}"},"DescribeGitMergeRequestDiffs":{"summary":"合并请求-查询合并请求diff信息的文件列表","category":"09-代码托管相关接口","description":"✨ 查询合并请求 diff 信息的文件列表","params":[{"name":"DepotId","type":"integer (int64)","required":true,"description":"仓库 ID"},{"name":"DepotPath","type":"string","required":false,"description":"仓库路径，DepotId与DepotPath二选一即可"},{"name":"MergeId","type":"integer (int64)","required":true,"description":"合并请求 ID"}],"response":[{"name":"Diff","type":"MergeRequestDiff","required":false,"description":"diff 信息概览"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeGitMergeRequestDiffs\n<公共请求参数>\n\n{\n  \"DepotId\": 0,\n  \"MergeId\": 0,\n  \"DepotPath\": \"abc\"\n}"},"DescribeGitMergeRequestParticipants":{"summary":"合并请求-获取合并请求的参与者","category":"09-代码托管相关接口","description":"✨ 获取合并请求的参与者","params":[{"name":"DepotId","type":"integer (int64)","required":true,"description":"仓库 Id"},{"name":"DepotPath","type":"string","required":false,"description":"仓库路径，DepotId与DepotPath二选一即可"},{"name":"MergeId","type":"integer (int64)","required":true,"description":"合并请求 IId"}],"response":[{"name":"Participants","type":"Array of DepotUser","required":false,"description":"参与者列表"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeGitMergeRequestParticipants\n<公共请求参数>\n\n{\n    \"DepotId\": 2,\n    \"MergeId\": 1\n}"},"DescribeGitMergeRequestsBySha":{"summary":"合并请求-查询含有某次提交的合并请求","category":"09-代码托管相关接口","description":"✨ 查询含有某次提交的合并请求","params":[{"name":"DepotId","type":"integer (int64)","required":true,"description":"仓库id"},{"name":"DepotPath","type":"string","required":false,"description":"与DepotId选择其一即可"},{"name":"Sha","type":"string","required":true,"description":"提交 Id"}],"response":[{"name":"Details","type":"Array of MergeRequestDetail","required":false,"description":"合并请求详情"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeGitMergeRequestsBySha\n<公共请求参数>\n\n{\n\t\"DepotId\": 12,\n\t\"Sha\": \"e33d8b03d270315479383365648f9433717cad0e\",\n\t\"DepotPath\": \"codingcorp/test/dee\"\n}"},"DescribeGitProjectDeployKeys":{"summary":"仓库设置-查询某项目下的部署公钥列表","category":"09-代码托管相关接口","description":"✨ 查询某项目下的部署公钥列表","params":[{"name":"ProjectId","type":"integer (int64)","required":true,"description":"项目 Id"}],"response":[{"name":"Keys","type":"Array of DeployKeyInfo","required":false,"description":"部署公钥列表"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeGitProjectDeployKeys\n<公共请求参数>\n\n{\n\t\"ProjectId\": 52\n}"},"DescribeGitProtectedTags":{"summary":"标签信息-查询受保护的标签列表","category":"09-代码托管相关接口","description":"✨ 查询受保护的标签列表","params":[{"name":"DepotId","type":"integer (int64)","required":true,"description":"仓库 Id"},{"name":"DepotPath","type":"string","required":false,"description":"仓库路径"}],"response":[{"name":"GitTags","type":"Array of GitTag","required":false,"description":"标签列表"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeGitProtectedTags\n<公共请求参数>\n\n{\n\t\"DepotId\": 6\n}"},"DescribeGitProtectedTagsByRule":{"summary":"标签信息-根据标签保护规则查询受保护的标签列表","category":"09-代码托管相关接口","description":"✨ 根据标签保护规则查询受保护的标签列表","params":[{"name":"DepotId","type":"integer (int64)","required":true,"description":"仓库 Id"},{"name":"DepotPath","type":"string","required":false,"description":"仓库路径"},{"name":"Rule","type":"string","required":true,"description":"保护规则"}],"response":[{"name":"GitTags","type":"Array of GitTag","required":false,"description":"标签列表"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeGitProtectedTagsByRule\n<公共请求参数>\n\n{\n\t\"DepotId\": 6,\n\t\"Rule\": \"11*\"\n}"},"DescribeGitRef":{"summary":"仓库分支-获取分支或标签信息","category":"09-代码托管相关接口","description":"✨ 获取分支或标签信息","params":[{"name":"DepotId","type":"integer (int64)","required":true,"description":"仓库Id"},{"name":"DepotPath","type":"string","required":false,"description":"仓库路径，DepotId与DepotPath二选一即可"},{"name":"Revision","type":"string","required":true,"description":"分支名"}],"response":[{"name":"GitRef","type":"GitRef","required":false,"description":"git分支"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeGitRef\n<公共请求参数>\n\n{\n    \"DepotId\":1,\n    \"Revision\":\"master\"\n}"},"DescribeGitRefsBySha":{"summary":"Git提交-查询含有某次提交的标签或分支列表","category":"09-代码托管相关接口","description":"✨ 查询含有某次提交的标签或分支列表","params":[{"name":"DepotId","type":"integer (int64)","required":true,"description":"仓库id"},{"name":"DepotPath","type":"string","required":false,"description":"仓库路径，DepotId与DepotPath二选一即可"},{"name":"Sha","type":"string","required":true,"description":"提交id"},{"name":"Type","type":"string","required":true,"description":"all：列表中既包含分支也包含标签，tag：列表中只包含标签，branch：列表中只包含分支"}],"response":[{"name":"Refs","type":"Array of GitReference","required":false,"description":"ref集合"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeGitRefsBySha\n<公共请求参数>\n\n{\n  \"DepotId\": 0,\n  \"Sha\": \"abc\",\n  \"Type\": \"abc\",\n  \"DepotPath\": \"abc\"\n}"},"DescribeGitReleaseDetail":{"summary":"版本信息-查询仓库的版本详情","category":"09-代码托管相关接口","description":"✨ 查询仓库的版本详情","params":[{"name":"DepotId","type":"integer (int64)","required":true,"description":"仓库id"},{"name":"DepotPath","type":"string","required":false,"description":"仓库路径，DepotId与DepotPath二选一即可"},{"name":"ReleaseId","type":"integer (int64)","required":true,"description":"版本序号Id"},{"name":"TagName","type":"string","required":true,"description":"标签名称"},{"name":"ShowResourceUrl","type":"boolean","required":false,"description":"是否展示资源地址"}],"response":[{"name":"Release","type":"Release","required":false,"description":"版本详情信息"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeGitReleaseDetail\n<公共请求参数>\n\n{\n\t\"DepotId\": 6,\n\t\"ReleaseId\": 8,\n\t\"TagName\": \"zyx\"\n}"},"DescribeGitReleases":{"summary":"版本信息-查询仓库的版本列表","category":"09-代码托管相关接口","description":"✨ 查询仓库的版本列表","params":[{"name":"DepotId","type":"integer (int64)","required":true,"description":"仓库id"},{"name":"DepotPath","type":"string","required":false,"description":"仓库路径，DepotId与DepotPath二选一即可"},{"name":"FromDate","type":"string","required":false,"description":"搜索条件:起始日期"},{"name":"PageNumber","type":"integer (int64)","required":false,"description":"页数"},{"name":"PageSize","type":"integer (int64)","required":false,"description":"每页条数"},{"name":"Status","type":"integer (int64)","required":false,"description":"搜索条件:版本状态(0:全部 1:已发布 2:预发布)"},{"name":"TagName","type":"string","required":false,"description":"搜索条件:标签名字"},{"name":"ToDate","type":"string","required":false,"description":"搜索条件:终止日期"},{"name":"ShowResourceUrl","type":"boolean","required":false,"description":"是否展示资源地址"}],"response":[{"name":"ReleasePageList","type":"ReleaseListPage","required":false,"description":"版本分页列表"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeGitReleases\n<公共请求参数>\n\n{\n\t\"DepotId\": 6\n}"},"DescribeGitTag":{"summary":"标签信息-查询单个tag","category":"09-代码托管相关接口","description":"✨ 查询单个tag","params":[{"name":"DepotId","type":"integer (int64)","required":true,"description":"仓库id"},{"name":"DepotPath","type":"string","required":false,"description":"仓库路径"},{"name":"TagName","type":"string","required":true,"description":"tag名称"}],"response":[{"name":"GitTag","type":"GitTag","required":false,"description":"tag信息"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeGitTag\n<公共请求参数>\n\n{\n\t\"DepotId\": 6,\n\t\"TagName\": \"zyx\"\n}"},"DescribeGitTags":{"summary":"标签信息-查询当前仓库下所有tags","category":"09-代码托管相关接口","description":"✨ 查询当前仓库下所有tags","params":[{"name":"DepotId","type":"integer (int64)","required":true,"description":"仓库id"},{"name":"DepotPath","type":"string","required":false,"description":"仓库路径"},{"name":"KeyWord","type":"string","required":false,"description":"TagName的模糊查询关键字"},{"name":"Page","type":"integer (int64)","required":false,"description":"页码"},{"name":"PageSize","type":"integer (int64)","required":false,"description":"每页数量"}],"response":[{"name":"GitTags","type":"Array of GitTag","required":false,"description":"tag列表信息"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeGitTags\n<公共请求参数>\n\n{\n\t\"DepotId\": 6\n}"},"DescribeGitTagsByBranch":{"summary":"标签信息-根据分支获取标签列表","category":"09-代码托管相关接口","description":"✨ 根据分支获取标签列表","params":[{"name":"Branch","type":"string","required":true,"description":"分支名称"},{"name":"DepotId","type":"integer (int64)","required":true,"description":"仓库id"},{"name":"DepotPath","type":"string","required":false,"description":"仓库路径"}],"response":[{"name":"Tags","type":"Array of string","required":false,"description":"tag列表"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeGitTagsByBranch\n<公共请求参数>\n\n{\n\t\"DepotId\": 6,\n\t\"Branch\": \"master\"\n}"},"DescribeGitTagsBySha":{"summary":"标签信息-查询含有某次提交的标签列表","category":"09-代码托管相关接口","description":"✨ 查询含有某次提交的标签列表","params":[{"name":"DepotId","type":"integer (int64)","required":true,"description":"仓库id"},{"name":"DepotPath","type":"string","required":false,"description":"仓库路径"},{"name":"Sha","type":"string","required":true,"description":"提交id"}],"response":[{"name":"GitTags","type":"Array of GitTag","required":false,"description":"tag集合"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeGitTagsBySha\n<公共请求参数>\n\n{\n\t\"DepotId\": 6,\n\t\"Sha\": \"e49a3524bdb7aeba8344504330efaaaf978e143a\"\n}"},"DescribeGitTree":{"summary":"仓库信息-查询git仓库的树","category":"09-代码托管相关接口","description":"✨ 查询 git 仓库的树","params":[{"name":"DepotId","type":"integer (int64)","required":true,"description":"仓库Id"},{"name":"DepotPath","type":"string","required":false,"description":"仓库路径，与仓库ID二选一"},{"name":"IsRecursive","type":"boolean (bool)","required":true,"description":"是否递归"},{"name":"Path","type":"string","required":false,"description":"文件路径"},{"name":"Ref","type":"string","required":true,"description":"分支或标签名，默认 HEAD"}],"response":[{"name":"Trees","type":"Array of GitTree","required":false,"description":"1"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeGitTree\n<公共请求参数>\n\n{\n\t\"DepotId\": 6,\n\t\"Ref\": \"master\",\n\t\"IsRecursive\": false\n}"},"DescribeMemberSshKey":{"summary":"仓库设置-获取团队成员的SSH公钥列表","category":"09-代码托管相关接口","description":"✨ 获取团队成员的 SSH 公钥列表","params":[{"name":"MemberUserId","type":"integer (int64)","required":true,"description":"成员 Id"},{"name":"SshKeyId","type":"integer (int64)","required":false,"description":"SSH 公钥 Id"}],"response":[{"name":"SshKeyInfos","type":"Array of SshKeyInfo","required":false,"description":"SSH公钥详情列表"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeMemberSshKey\n<公共请求参数>\n\n{\n    \"MemberUserId\": 2,\n    \"SshKeyId\": 2\n}"},"DescribeMergeReqCommits":{"summary":"合并请求-查询合并请求列表","category":"09-代码托管相关接口","description":"✨ 查询合并请求列表","params":[{"name":"DepotId","type":"integer (int64)","required":true,"description":"仓库id"},{"name":"DepotPath","type":"string","required":false,"description":"与仓库路径二选一即可"},{"name":"MergeId","type":"integer (int64)","required":true,"description":"合并请求id"}],"response":[{"name":"Commits","type":"Array of GitCommit","required":false,"description":"commit集合"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeMergeReqCommits\n<公共请求参数>\n\n{\n\t\"DepotId\": 6,\n\t\"MergeId\": 13\n}"},"DescribeMergeReqInfo":{"summary":"合并请求-查询合并请求详情","category":"09-代码托管相关接口","description":"✨ 查询合并请求详情","params":[{"name":"DepotId","type":"integer (int64)","required":true,"description":"仓库id"},{"name":"DepotPath","type":"string","required":false,"description":"仓库路径，与DepotId选择其一即可"},{"name":"MergeId","type":"integer (int64)","required":true,"description":"合并请求id"}],"response":[{"name":"MergeReqInfo","type":"MergeReqInfo","required":false,"description":"合并请求详情"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeMergeReqInfo\n<公共请求参数>\n\n{\n    \"DepotId\":\"2\",\n    \"MergeId\":\"8\"\n}"},"DescribeMergeRequest":{"summary":"合并请求-查询合并请求详情信息","category":"09-代码托管相关接口","description":"✨ 查询合并请求详情信息","params":[{"name":"DepotId","type":"integer (int64)","required":true,"description":"仓库id"},{"name":"DepotPath","type":"string","required":false,"description":"仓库路径，与DepotId选择其一即可"},{"name":"MergeId","type":"integer (int64)","required":true,"description":"合并请求iid"}],"response":[{"name":"MergeRequestInfo","type":"MergeRequestInfo","required":false,"description":"合并请求信息"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeMergeRequest\n<公共请求参数>\n\n{\n\t\"DepotId\": 9,\n\t\"MergeId\": 14\n}"},"DescribeMergeRequestFileDiff":{"summary":"合并请求-获取合并请求文件修改记录","category":"09-代码托管相关接口","description":"✨ 获取合并请求文件修改记录","params":[{"name":"DepotId","type":"integer (int64)","required":true,"description":"仓库id"},{"name":"DepotPath","type":"string","required":false,"description":"仓库路径，与仓库Id选其一就可以"},{"name":"MergeId","type":"integer (int64)","required":true,"description":"合并请求id"}],"response":[{"name":"MergeRequestFileDiff","type":"MergeRequestFileDiff","required":false,"description":"修改记录详情"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeMergeRequestFileDiff\n<公共请求参数>\n\n{\n\t\"DepotId\": 9,\n\t\"MergeId\": 14\n}"},"DescribeMergeRequestLog":{"summary":"合并请求-查询合并请求操作记录","category":"09-代码托管相关接口","description":"✨ 查询合并请求操作记录","params":[{"name":"DepotId","type":"integer (int64)","required":true,"description":"仓库id"},{"name":"DepotPath","type":"string","required":false,"description":"仓库路径，DepotId与DepotPath二选一即可"},{"name":"MergeId","type":"integer (int64)","required":true,"description":"合并请求id"}],"response":[{"name":"Logs","type":"Array of MergeRequestLog","required":false,"description":"操作记录列表"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeMergeRequestLog\n<公共请求参数>\n\n{\n    \"DepotId\":\"8\",\n    \"MergeId\":\"2\"\n}"},"DescribeMergeRequestReviewers":{"summary":"合并请求-获取合并请求的评审者","category":"09-代码托管相关接口","description":"✨ 获取合并请求的参与者","params":[{"name":"DepotId","type":"integer (int64)","required":true,"description":"仓库 Id"},{"name":"MergeId","type":"integer (int64)","required":true,"description":"合并请求 IId"}],"response":[{"name":"Reviewers","type":"Array of DepotUser","required":false,"description":"参与者列表"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeMergeRequestReviewers\n<公共请求参数>\n\n{\n\t\"DepotId\": 9,\n\t\"MergeId\": 15\n}"},"DescribeMyDepots":{"summary":"仓库信息-获取当前用户拥有读权限的仓库列表","category":"09-代码托管相关接口","description":"✨ 获取当前用户拥有读权限的仓库列表","params":[{"name":"PageNumber","type":"integer (int64)","required":true,"description":"页数"},{"name":"PageSize","type":"integer (int64)","required":true,"description":"页码"}],"response":[{"name":"Payload","type":"DepotData","required":false,"description":"仓库信息详情列表"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeMyDepots\n<公共请求参数>\n\n{\n  \"PageNumber\": 0,\n  \"PageSize\": 0\n}"},"DescribeNotesByCommits":{"summary":"仓库信息-获取提交的note信息","category":"09-代码托管相关接口","description":"✨ 获取提交的note信息","params":[{"name":"Commits","type":"Array of string","required":true,"description":"请求sha值列表"},{"name":"DepotId","type":"integer (int64)","required":true,"description":"仓库id"},{"name":"DepotPath","type":"string","required":false,"description":"仓库路径，DepotId与DepotPath二选一即可"},{"name":"NoteRef","type":"string","required":true,"description":"查询的ref地址"}],"response":[{"name":"Notes","type":"Array of CommitNote","required":false,"description":"commit notes 集合"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeNotesByCommits\n<公共请求参数>\n\n{\n    \"Commits\": [\n        \"57c0153c8a7b1594fba6f61ffc6ff21583d1028c\", \n        \"02cb304a01a191e6076419ca5866a0d810c8e7ef\"\n    ], \n    \"DepotId\": 2, \n    \"NoteRef\": \"demo\"\n}"},"DescribePersonalExternalDepots":{"summary":"个人外部仓库获取","category":"09-代码托管相关接口","description":"✨ 获取个人外部仓库","params":[{"name":"DepotType","type":"string","required":true,"description":"仓库类型"},{"name":"ProjectId","type":"integer (uint64)","required":true,"description":"项目 Id"}],"response":[{"name":"Data","type":"CodingCIPersonalExternalDepotData","required":false,"description":"外部仓库列表"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"https://coding.example.com/?Action=DescribePersonalExternalDepots\n&DepotType=CODING\n&ProjectId=456\n&<公共请求参数>"},"DescribeProjectDepotBranches":{"summary":"仓库分支列表获取","category":"09-代码托管相关接口","description":"✨ 获取仓库分支列表","params":[{"name":"DepotType","type":"string","required":true,"description":"仓库类型"},{"name":"Id","type":"integer (uint64)","required":true,"description":"仓库 Id"},{"name":"ProjectId","type":"integer (uint64)","required":true,"description":"项目 Id"}],"response":[{"name":"Data","type":"DepotDetailData","required":false,"description":"返回 Branch 数据结构"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"https://coding.example.com/?Action=DescribeProjectDepotBranches\n&ProjectId=1\n&DepotType=CODING\n&Id=1\n&<公共请求参数>"},"DescribeProjectDepotCommits":{"summary":"分支下的提交列表获取","category":"09-代码托管相关接口","description":"✨ 获取分支下的提交列表","params":[{"name":"Branch","type":"string","required":true,"description":"分支名称"},{"name":"DepotType","type":"string","required":true,"description":"仓库类型"},{"name":"Id","type":"integer (uint64)","required":true,"description":"仓库 Id"},{"name":"ProjectId","type":"integer (uint64)","required":true,"description":"项目 Id"}],"response":[{"name":"Data","type":"DepotDetailData","required":false,"description":"返回 Commit 数据结构"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"https://coding.example.com/?Action=DescribeProjectDepotCommits\n&ProjectId=1\n&DepotType=CODING\n&Id=1\n&Branch=master\n&<公共请求参数>"},"DescribeProjectDepotInfoList":{"summary":"仓库信息-查询项目下所有的仓库信息列表","category":"09-代码托管相关接口","description":"✨ 查询项目下所有的仓库信息列表","params":[{"name":"PageNumber","type":"string","required":false,"description":"页号"},{"name":"PageSize","type":"string","required":false,"description":"每页的个数"},{"name":"ProjectId","type":"integer (int64)","required":true,"description":"项目id"}],"response":[{"name":"DepotData","type":"DepotData","required":false,"description":"仓库信息详情列表"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeProjectDepotInfoList\n<公共请求参数>\n\n{\n\t\"ProjectId\": 1\n}"},"DescribeProjectDepots":{"summary":"项目仓库列表获取","category":"09-代码托管相关接口","description":"✨ 获取项目仓库列表","params":[{"name":"DepotType","type":"string","required":true,"description":"仓库类型"},{"name":"ProjectId","type":"integer (uint64)","required":true,"description":"项目 Id"}],"response":[{"name":"Data","type":"DescribeProjectDepotsData","required":false,"description":"获取仓库列表"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"https://coding.example.com/?Action=DescribeProjectDepots\n&ProjectId=1\n&DepotType=CODING\n&<公共请求参数>"},"DescribeProjectDepotTags":{"summary":"仓库的标签列表获取","category":"09-代码托管相关接口","description":"✨ 获取仓库的标签列表","params":[{"name":"DepotType","type":"string","required":true,"description":"仓库类型"},{"name":"Id","type":"integer (uint64)","required":true,"description":"仓库 Id"},{"name":"ProjectId","type":"integer (uint64)","required":true,"description":"项目 Id"}],"response":[{"name":"Data","type":"DepotDetailData","required":false,"description":"返回标签列表的数据结构"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"https://coding.example.com/?Action=DescribeProjectDepotTags\n&ProjectId=1\n&DepotType=CODING\n&Id=1\n&<公共请求参数>"},"DescribeProjectMergeRequests":{"summary":"合并请求-获取项目下的合并请求列表","category":"09-代码托管相关接口","description":"✨ 获取项目下的合并请求列表","params":[{"name":"CreatedAtEndDate","type":"string","required":false,"description":"mr创建结束时间"},{"name":"CreatedAtStartDate","type":"string","required":false,"description":"mr创建开始时间"},{"name":"CreatorEmail","type":"string","required":false,"description":"合并请求创建者邮箱"},{"name":"CreatorGlobalKey","type":"string","required":false,"description":"合并请求创建者全局 key"},{"name":"IsSortDirectionAsc","type":"boolean (bool)","required":false,"description":"是否正序排序 默认 false"},{"name":"KeyWord","type":"string","required":false,"description":"关键词"},{"name":"Label","type":"string","required":false,"description":"标签"},{"name":"MergerEmail","type":"string","required":false,"description":"合并请求合并者邮箱"},{"name":"MergerGlobalKey","type":"string","required":false,"description":"合并请求合并者全局 key"},{"name":"PageNumber","type":"integer (int64)","required":false,"description":"页数 默认 1"},{"name":"PageSize","type":"integer (int64)","required":false,"description":"每页条数 默认 10"},{"name":"ProjectId","type":"integer (int64)","required":true,"description":"项目 Id"},{"name":"ReviewerEmail","type":"string","required":false,"description":"合并请求评审者邮箱"},{"name":"ReviewerGlobalKey","type":"string","required":false,"description":"合并请求评审者全局 key"},{"name":"Sort","type":"string","required":false,"description":"排序 action_at：以更新时间排序  created_at：以创建时间排序"},{"name":"SourceBranch","type":"string","required":false,"description":"源分支"},{"name":"Status","type":"string","required":false,"description":"合并请求状态 open/close/all"},{"name":"TargetBranch","type":"string","required":false,"description":"欲合入分支"},{"name":"UpdatedAtEndDate","type":"string","required":false,"description":"mr更新结束时间"},{"name":"UpdatedAtStartDate","type":"string","required":false,"description":"mr更新开始时间"}],"response":[{"name":"Data","type":"DescribeMergeRequestsData","required":false,"description":"合并请求信息"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeProjectMergeRequests\n<公共请求参数>\n\n{\n\t\"ProjectId\": 52\n}"},"DescribeProtectedBranch":{"summary":"仓库设置-查询保护分支详情","category":"09-代码托管相关接口","description":"✨ 查询保护分支详情","params":[{"name":"BranchName","type":"string","required":true,"description":"分支名称"},{"name":"DepotId","type":"integer (int64)","required":true,"description":"仓库id"},{"name":"DepotPath","type":"string","required":false,"description":"仓库路径，DepotId与DepotPath二选一即可"}],"response":[{"name":"ProtectedBranch","type":"ProtectedBranch","required":false,"description":"保护分支详情"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeProtectedBranch\n<公共请求参数>\n\n{\n    \"DepotId\":\"8\",\n    \"BranchName\":\"master\"\n}"},"DescribeProtectedBranches":{"summary":"仓库设置-查询保护分支列表","category":"09-代码托管相关接口","description":"✨ 查询保护分支","params":[{"name":"DepotId","type":"integer (int64)","required":true,"description":"仓库id"},{"name":"DepotPath","type":"string","required":true,"description":"仓库路径"}],"response":[{"name":"ProtectedBranches","type":"Array of ProtectedBranch","required":false,"description":"保护分支列表"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeProtectedBranches\n<公共请求参数>\n\n{\n  \"DepotId\": 1,\n  \"DepotPath\":\"codingcorp/test/depot\"\n}"},"DescribeProtectedBranchMembers":{"summary":"仓库设置-查询保护分支成员","category":"09-代码托管相关接口","description":"✨ 查询保护分支成员","params":[{"name":"BranchName","type":"string","required":true,"description":"分支名称"},{"name":"DepotId","type":"integer (int64)","required":true,"description":"仓库id"},{"name":"DepotPath","type":"string","required":false,"description":"仓库路径，DepotId与DepotPath二选一即可"}],"response":[{"name":"Members","type":"Array of ProtectedBranchMember","required":false,"description":"保护分支成员列表"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeProtectedBranchMembers\n<公共请求参数>\n\n{\n    \"DepotId\":\"8\",\n    \"BranchName\":\"master\"\n}"},"DescribeSelfMergeRequests":{"summary":"合并请求-获取自己的合并请求列表","category":"09-代码托管相关接口","description":"✨ 获取自己的合并请求列表","params":[{"name":"CreatedAtEndDate","type":"string","required":false,"description":"mr创建结束时间"},{"name":"CreatedAtStartDate","type":"string","required":false,"description":"mr创建开始时间"},{"name":"IsSortDirectionAsc","type":"boolean (bool)","required":false,"description":"是否正序排序 默认 false"},{"name":"KeyWord","type":"string","required":false,"description":"关键词"},{"name":"Label","type":"string","required":false,"description":"标签"},{"name":"MergerEmail","type":"string","required":false,"description":"合并请求合并者邮箱"},{"name":"MergerGlobalKey","type":"string","required":false,"description":"合并请求合并者全局 key"},{"name":"PageNumber","type":"integer (int64)","required":false,"description":"页数 默认 1"},{"name":"PageSize","type":"integer (int64)","required":false,"description":"每页条数 默认 10"},{"name":"ReviewerEmail","type":"string","required":false,"description":"合并请求评审者邮箱"},{"name":"ReviewerGlobalKey","type":"string","required":false,"description":"合并请求评审者全局 key"},{"name":"Sort","type":"string","required":false,"description":"排序 action_at：以更新时间排序  created_at：以创建时间排序"},{"name":"SourceBranch","type":"string","required":false,"description":"源分支"},{"name":"Status","type":"string","required":false,"description":"合并请求状态 open/close/all"},{"name":"TargetBranch","type":"string","required":false,"description":"欲合入分支"},{"name":"UpdatedAtEndDate","type":"string","required":false,"description":"mr更新结束时间"},{"name":"UpdatedAtStartDate","type":"string","required":false,"description":"mr更新开始时间"}],"response":[{"name":"Data","type":"DescribeMergeRequestsData","required":false,"description":"合并请求信息"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeSelfMergeRequests\n<公共请求参数>\n\n{}"},"DescribeSingeMergeRequestNotes":{"summary":"合并请求-获取单个合并请求行评论和改动文件diff行评论","category":"09-代码托管相关接口","description":"✨ 获取单个合并请求行评论和改动文件diff行评论","params":[{"name":"DepotPath","type":"string","required":true,"description":"仓库路径"},{"name":"MergeId","type":"integer (uint64)","required":true,"description":"合并请求的Iid"}],"response":[{"name":"Notes","type":"Array of MergeRequestNoteList","required":false,"description":"单个合并请求行评论内容"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeSingeMergeRequestNotes\n<公共请求参数>\n\n{\n\t\"DepotPath\": \"codingcorp/zyx/depot\",\n\t\"MergeId\": 15\n}"},"DescribeSshKey":{"summary":"仓库设置-获取当前用户所有SSH公钥","category":"09-代码托管相关接口","description":"✨ 获取当前用户所有SSH公钥","params":[],"response":[{"name":"SshKeyInfos","type":"Array of SshKeyInfo","required":false,"description":"SSH公钥详情列表"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeSshKey\n<公共请求参数>\n\n{\n\n}"},"DescribeTeamDepotInfoList":{"summary":"仓库信息-获取团队下仓库列表，仅团队所有者或团队管理员可以调用。","category":"09-代码托管相关接口","description":"✨ 获取团队下仓库列表，仅团队所有者或团队管理员可以调用。","params":[{"name":"DepotName","type":"string","required":false,"description":"仓库名"},{"name":"PageNumber","type":"integer (int64)","required":true,"description":"页码"},{"name":"PageSize","type":"integer (int64)","required":true,"description":"页码大小"},{"name":"ProjectName","type":"string","required":false,"description":"项目名"}],"response":[{"name":"DepotData","type":"DepotData","required":false,"description":"仓库信息详情列表"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeTeamDepotInfoList\n<公共请求参数>\n\n{\n  \"ProjectName\": \"\",\n  \"DepotName\": \"\",\n  \"PageNumber\": 1,\n  \"PageSize\": 3000\n}"},"ModifyBranchProtection":{"summary":"仓库设置-修改保护分支规则相关信息","category":"09-代码托管相关接口","description":"✨ 修改保护分支规则相关信息","params":[{"name":"BranchProtection","type":"BranchProtection","required":true,"description":"保护分支规则"},{"name":"DepotId","type":"integer (int64)","required":true,"description":"仓库id"},{"name":"DepotPath","type":"string","required":false,"description":"仓库路径"}],"response":[{"name":"BranchProtection","type":"BranchProtection","required":false,"description":"保护分支规则信息"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: ModifyBranchProtection\n<公共请求参数>\n\n{\n\t\"DepotId\": 6,\n\t\"BranchProtection\": {\n\t\t\"BranchProtectionId\": 3,\n\t\t\"Rule\": \"master**\",\n\t\t\"DenyForcePush\": true,\n\t\t\"ForceSquash\": true,\n\t\t\"RequiredGrantCount\": 1,\n\t\t\"MatcherCount\": 2,\n\t\t\"SrcMustMergedTo\": \"master\"\n\t}\n}"},"ModifyBranchProtectionMemberPermission":{"summary":"仓库设置-更改保护分支管理员权限","category":"09-代码托管相关接口","description":"✨ 更改保护分支管理员权限","params":[{"name":"AllowPush","type":"boolean (bool)","required":true,"description":"是否直接推送"},{"name":"BranchRuleName","type":"string","required":true,"description":"分支规则名称"},{"name":"DepotPath","type":"string","required":true,"description":"仓库路径"},{"name":"UserGlobalKey","type":"string","required":true,"description":"用户GlobalKey"}],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: ModifyBranchProtectionMemberPermission\n<公共请求参数>\n\n{\n\t\"DepotPath\": \"codingcorp/zyx/repo_01\",\n\t\"AllowPush\": true,\n\t\"BranchRuleName\": \"master*\",\n\t\"UserGlobalKey\": \"coding-coding\"\n}"},"ModifyChooseDepotSpec":{"summary":"仓库设置-使用、取消使用仓库规范","category":"09-代码托管相关接口","description":"✨ 使用、取消使用仓库规范","params":[{"name":"DepotPath","type":"string","required":true,"description":"仓库路径"},{"name":"DepotSpecName","type":"string","required":true,"description":"选择的仓库规范名字（不使用仓库规范时，填空字符串）"}],"response":[{"name":"Detail","type":"DepotSpecDetail","required":false,"description":"仓库规范详细信息"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: ModifyChooseDepotSpec\n<公共请求参数>\n\n{\n\t\"DepotPath\": \"codingcorp/zyx/repo_01\",\n\t\"DepotSpecName\": \"单分支规范\"\n}"},"ModifyCloseMR":{"summary":"合并请求-关闭合并请求","category":"09-代码托管相关接口","description":"✨ 关闭合并请求","params":[{"name":"DepotId","type":"integer (int64)","required":true,"description":"仓库id"},{"name":"DepotPath","type":"string","required":false,"description":"仓库路径，DepotId与DepotPath二选一即可"},{"name":"MergeId","type":"integer (int64)","required":true,"description":"合并请求id"}],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: ModifyCloseMR\n<公共请求参数>\n\n{\n    \"DepotId\":37,\n    \"MergeId\": 5 \n}"},"ModifyDefaultBranch":{"summary":"仓库设置-修改仓库默认分支","category":"09-代码托管相关接口","description":"✨ 修改仓库默认分支","params":[{"name":"BranchName","type":"string","required":true,"description":"分支名"},{"name":"DepotId","type":"integer (int64)","required":true,"description":"仓库Id"},{"name":"DepotPath","type":"string","required":false,"description":"仓库路径"}],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: ModifyDefaultBranch\n<公共请求参数>\n\n{\n\t\"DepotId\": 6,\n\t\"BranchName\": \"master-patch-1\"\n}"},"ModifyDepotDescription":{"summary":"仓库信息-修改仓库描述","category":"09-代码托管相关接口","description":"✨ 修改仓库描述","params":[{"name":"DepotId","type":"integer (int64)","required":true,"description":"仓库 ID"},{"name":"DepotPath","type":"string","required":false,"description":"仓库路径，与仓库ID二选一"},{"name":"Description","type":"string","required":true,"description":"仓库描述信息"}],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: ModifyDepotDescription\n<公共请求参数>\n\n{\n\t\"DepotId\": 7, \n\t\"Description\": \"11111\"\n}"},"ModifyDepotFilePushRule":{"summary":"仓库设置-修改git仓库文件推送规则","category":"09-代码托管相关接口","description":"✨ 修改 git 仓库文件推送规则","params":[{"name":"DepotPath","type":"string","required":true,"description":"仓库路径"},{"name":"FilePushRuleId","type":"integer (int64)","required":true,"description":"文件推送规则 ID"},{"name":"IsDenyForAllUser","type":"boolean (bool)","required":true,"description":"拒绝所有人推送"}],"response":[{"name":"GitFilePushRule","type":"Array of GitFilePushRule","required":false,"description":"git 仓库文件推送规则列表"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: ModifyDepotFilePushRule\n<公共请求参数>\n\n{\n\t\"DepotPath\": \"codingcorp/zyx/repo_01\",\n\t\"FilePushRuleId\": 2,\n\t\"IsDenyForAllUser\": true\n}"},"ModifyDepotFilePushRuleDenyPrivilege":{"summary":"仓库设置-修改 git 仓库特权者文件推送权限","category":"09-代码托管相关接口","description":"✨ 修改 git 仓库特权者文件推送权限","params":[{"name":"DepotPath","type":"string","required":true,"description":"仓库路径"},{"name":"FilePushRuleId","type":"integer (int64)","required":true,"description":"文件推送规则 ID"},{"name":"IsDeny","type":"boolean (bool)","required":true,"description":"拒绝推送"},{"name":"IsRole","type":"boolean (bool)","required":true,"description":"特权者是角色（IsUser和IsRole有且只能有一个为true）"},{"name":"IsUser","type":"boolean (bool)","required":true,"description":"特权者是用户（IsUser和IsRole有且只能有一个为true）"},{"name":"RoleId","type":"integer (int64)","required":false,"description":"角色 ID"},{"name":"UserGlobalKey","type":"string","required":true,"description":"用户全局 key"}],"response":[{"name":"GitFilePushRule","type":"Array of GitFilePushRule","required":false,"description":"git 仓库文件推送规则列表"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: ModifyDepotFilePushRuleDenyPrivilege\n<公共请求参数>\n\n{\n\t\"DepotPath\": \"codingcorp/zyx/repo_01\",\n\t\"FilePushRuleId\": 1,\n\t\"IsDeny\": true,\n\t\"IsUser\": true,\n\t\"IsRole\": false,\n\t\"UserGlobalKey\": \"coding-coding\"\n}"},"ModifyDepotLevelDepotSpec":{"summary":"仓库设置-修改、新增仓库级别的仓库规范","category":"09-代码托管相关接口","description":"✨ 修改、新增仓库级别的仓库规范","params":[{"name":"DepotPath","type":"string","required":true,"description":"仓库路径"},{"name":"Param","type":"DepotSpecDepotLevelParam","required":true,"description":"修改、新增仓库级别的仓库规范参数"}],"response":[{"name":"Detail","type":"DepotSpecDetail","required":false,"description":"仓库规范详细信息"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: ModifyDepotLevelDepotSpec\n<公共请求参数>\n\n{\n\t\"Param\": {\n\t\t\"AllowPushWildRef\": true,\n\t\t\"DepotBranchTypeList\": [\n\t\t\t{\n\t\t\t\t\"Name\": \"test\",\n\t\t\t\t\"Rule\": \"t*\",\n\t\t\t\t\"Description\": \"111\"\n\t\t\t}\n\t\t]\n\t},\n\t\"DepotPath\": \"codingcorp/zyx/repo_01\"\n}"},"ModifyDepotName":{"summary":"仓库信息-修改仓库名称","category":"09-代码托管相关接口","description":"✨ 修改仓库名称","params":[{"name":"DepotId","type":"integer (int64)","required":true,"description":"仓库 ID"},{"name":"DepotName","type":"string","required":true,"description":"仓库名称"},{"name":"DepotPath","type":"string","required":false,"description":"仓库路径，与仓库ID二选一"}],"response":[{"name":"DepotInfo","type":"DepotInfo","required":false,"description":"仓库详细信息"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: ModifyDepotName\n<公共请求参数>\n\n{\n\t\"DepotId\": 7,\n\t\"DepotName\": \"rename\"\n}"},"ModifyDepotPushSetting":{"summary":"仓库设置-修改仓库推送设置","category":"09-代码托管相关接口","description":"✨ 修改仓库推送设置","params":[{"name":"DepotPath","type":"string","required":true,"description":"仓库路径"},{"name":"Param","type":"DepotPushSetting","required":true,"description":"推送设置参数"}],"response":[{"name":"Data","type":"DepotPushSetting","required":false,"description":"推送设置信息"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: ModifyDepotPushSetting\n<公共请求参数>\n\n{\n\t\"DepotPath\": \"codingcorp/zyx/repo_01\",\n\t\"Param\": {\n\t\t\"CheckCommitAuthor\": true,\n\t\t\"DenyForcePush\": false\n\t}\n}"},"ModifyDepotQuota":{"summary":"仓库信息-修改仓库容量","category":"09-代码托管相关接口","description":"✨ 修改仓库容量","params":[{"name":"DepotPath","type":"string","required":true,"description":"仓库路径"},{"name":"DepotQuotaSize","type":"string","required":true,"description":"仓库容量"}],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: ModifyDepotQuota\n<公共请求参数>\n\n{\n\t\"DepotPath\": \"codingcorp/zyx/repo_01\",\n\t\"DepotQuotaSize\": \"0.9\"\n}"},"ModifyDepotSettings":{"summary":"仓库设置-修改仓库设置","category":"09-代码托管相关接口","description":"✨ 修改仓库设置","params":[{"name":"DepotPath","type":"string","required":true,"description":"仓库路径，"},{"name":"DepotStatusCheckRequired","type":"boolean (bool)","required":true,"description":"是否开启状态检查"}],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: ModifyDepotSettings\n<公共请求参数>\n\n{\n  \"DepotPath\": \"codingcorp/k8s/etcd\",\n  \"DepotStatusCheckRequired\": true\n}"},"ModifyDepotSharedSetting":{"summary":"仓库设置-修改仓库是否开源设置","category":"09-代码托管相关接口","description":"✨ 修改仓库是否开源设置","params":[{"name":"DepotPath","type":"string","required":true,"description":"仓库路径"},{"name":"IsShared","type":"boolean (bool)","required":true,"description":"仓库是否开源"}],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: ModifyDepotSharedSetting\n<公共请求参数>\n\n{\n\t\"DepotPath\": \"codingcorp/zyx/repo_01\",\n\t\"IsShared\": true\n}"},"ModifyGitCherryPick":{"summary":"Git提交-将某次提交cherry-pick到指定分支","category":"09-代码托管相关接口","description":"✨ 将某次提交cherry-pick到指定分支","params":[{"name":"BranchName","type":"string","required":true,"description":"分支名称"},{"name":"DepotId","type":"integer (int64)","required":true,"description":"仓库 ID"},{"name":"DepotPath","type":"string","required":false,"description":"仓库路径，DepotId与DepotPath二选一即可"},{"name":"Sha","type":"string","required":true,"description":"提交 ID"}],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: ModifyGitCherryPick\n<公共请求参数>\n\n{\n  \"DepotId\": 0,\n  \"BranchName\": \"abc\",\n  \"Sha\": \"abc\",\n  \"DepotPath\": \"abc\"\n}"},"ModifyGitCommitRevert":{"summary":"Git提交-还原某次提交","category":"09-代码托管相关接口","description":"✨ 还原某次提交","params":[{"name":"BranchName","type":"string","required":true,"description":"分支名"},{"name":"DepotId","type":"integer (int64)","required":true,"description":"仓库 ID"},{"name":"DepotPath","type":"string","required":false,"description":"仓库路径，DepotId与DepotPath二选一即可"},{"name":"Message","type":"string","required":true,"description":"提交描述"},{"name":"Sha","type":"string","required":true,"description":"欲还原的提交 ID"}],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: ModifyGitCommitRevert\n<公共请求参数>\n\n{\n  \"DepotId\": 0,\n  \"BranchName\": \"abc\",\n  \"Sha\": \"abc\",\n  \"Message\": \"abc\",\n  \"DepotPath\": \"abc\"\n}"},"ModifyGitCommitStatus":{"summary":"Git提交-修改提交对应的流水线状态","category":"09-代码托管相关接口","description":"✨ 修改提交对应的流水线状态","params":[{"name":"CommitSha","type":"string","required":true,"description":"提交id"},{"name":"Context","type":"string","required":true,"description":"流水线文本内容"},{"name":"DepotId","type":"integer (int64)","required":false,"description":"仓库id"},{"name":"DepotPath","type":"string","required":false,"description":"仓库路径，DepotId与DepotPath二选一即可"},{"name":"Description","type":"string","required":true,"description":"流水线状态描述"},{"name":"State","type":"string","required":true,"description":"提交状态"},{"name":"TargetURL","type":"string","required":true,"description":"流水线链接地址"}],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: ModifyGitCommitStatus\n<公共请求参数>\n\n{\n\t\"DepotId\": 6,\n\t\"CommitSha\": \"fa175f83ff8fb319a66851daf954cc55b3e83fc9\",\n\t\"State\": \"COMMIT_STATE_ERROR\",\n\t\"Context\": \"示例构建计划spring-test\",\n\t\"TargetURL\": \"http://g-ywjw0565.capi-dev.devna.codingcorp.net/p/example-project/ci/job/2/build/1/pipeline\",\n\t\"Description\": \"构建进行中ya\"\n}"},"ModifyGitDepotArchive":{"summary":"仓库设置-仓库归档","category":"09-代码托管相关接口","description":"✨ 仓库归档","params":[{"name":"DepotId","type":"integer (int64)","required":true,"description":"仓库 ID"},{"name":"DepotPath","type":"string","required":false,"description":"仓库路径，与仓库ID二选一"}],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: ModifyGitDepotArchive\n<公共请求参数>\n\n{\n\t\"DepotId\": 7\n}"},"ModifyGitDepotUnarchive":{"summary":"仓库设置-仓库解除归档","category":"09-代码托管相关接口","description":"✨ 仓库解除归档","params":[{"name":"DepotId","type":"string","required":true,"description":"仓库id"},{"name":"DepotPath","type":"string","required":false,"description":"仓库路径，与仓库ID二选一"}],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: ModifyGitDepotUnarchive\n<公共请求参数>\n\n{\n\t\"DepotId\": \"11\"\n}"},"ModifyGitFiles":{"summary":"Git提交-修改仓库某文件","category":"09-代码托管相关接口","description":"✨ 修改仓库某文件","params":[{"name":"DepotId","type":"integer (int64)","required":true,"description":"仓库 ID"},{"name":"DepotPath","type":"string","required":false,"description":"仓库路径，DepotId与DepotPath二选一即可"},{"name":"GitFiles","type":"Array of GitFile","required":true,"description":"修改的文件"},{"name":"LastCommitSha","type":"string","required":true,"description":"最后次提交 Sha"},{"name":"Message","type":"string","required":true,"description":"提交文本"},{"name":"NewRef","type":"string","required":false,"description":"要提交的新分支"},{"name":"Ref","type":"string","required":true,"description":"基于改动的分支"}],"response":[{"name":"GitCommit","type":"GitCommit","required":false,"description":"本次提交详细信息"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: ModifyGitFiles\n<公共请求参数>\n\n{\n\t\"DepotId\": 6,\n\t\"LastCommitSha\": \"45abd0dfae0d3025037b5dbbebf4626508fc327d\",\n\t\"Message\": \"111\",\n\t\"Ref\": \"master\",\n\t\"GitFiles\": [\n\t\t{\n\t\t\t\"Path\": \"README.md\",\n\t\t\t\"Content\": \"wwwww\"\n\t\t}\n\t]\n}"},"ModifyGitMergeBranch":{"summary":"合并请求-将源分支的改动合并到目标分支","category":"09-代码托管相关接口","description":"✨ 将源分支的改动合并到目标分支","params":[{"name":"CommitMessage","type":"string","required":true,"description":"提交信息"},{"name":"DepotPath","type":"string","required":true,"description":"仓库路径或仓库ID"},{"name":"FromBranch","type":"string","required":true,"description":"源分支"},{"name":"ToBranch","type":"string","required":true,"description":"目标分支"}],"response":[{"name":"Data","type":"ModifyGitMergeBranchData","required":false,"description":"合并分支结果"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: ModifyGitMergeBranch\n<公共请求参数>\n\n{\n\t\"DepotPath\": \"codingcorp/zyx/repo_01\",\n\t\"FromBranch\": \"master-patch-2\",\n\t\"ToBranch\": \"master\",\n\t\"CommitMessage\": \"1111\"\n}"},"ModifyGitMergeRequest":{"summary":"合并请求-修改合并请求的标题和描述信息","category":"09-代码托管相关接口","description":"✨ 修改合并请求的标题和描述信息","params":[{"name":"Content","type":"string","required":false,"description":"待修改的合并请求描述"},{"name":"DepotId","type":"integer (int64)","required":true,"description":"仓库 ID"},{"name":"DepotPath","type":"string","required":false,"description":"仓库路径，与仓库ID二选一"},{"name":"MergeId","type":"integer (int64)","required":true,"description":"合并请求 IID"},{"name":"Title","type":"string","required":false,"description":"待修改的合并请求标题"}],"response":[{"name":"MergeRequestInfo","type":"MergeRequestInfo","required":false,"description":"合并请求Info信息"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: ModifyGitMergeRequest\n<公共请求参数>\n\n{\n\t\"DepotId\": 6,\n\t\"MergeId\": 11,\n\t\"Title\": \"123123\",\n\t\"Content\": \"123123\"\n}"},"ModifyGitMergeRequestRebase":{"summary":"合并请求-合并请求中的源分支进行rebase操作","category":"09-代码托管相关接口","description":"✨ 合并请求中的源分支进行rebase操作","params":[{"name":"DepotId","type":"integer (int64)","required":true,"description":"仓库 ID"},{"name":"DepotPat","type":"string","required":false,"description":"仓库路径，与仓库ID二选一"},{"name":"MergeId","type":"integer (int64)","required":true,"description":"合并请求 资源ID"}],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: ModifyGitMergeRequestRebase\n<公共请求参数>\n\n{\n\t\"DepotId\": 6,\n\t\"MergeId\": 12\n}"},"ModifyGitRebase":{"summary":"仓库信息-git变基操作","category":"09-代码托管相关接口","description":"✨ git变基操作","params":[{"name":"BaseBranchName","type":"string","required":true,"description":"基础分支名字"},{"name":"DepotId","type":"integer (int64)","required":true,"description":"仓库id"},{"name":"DepotPath","type":"string","required":false,"description":"仓库路径，DepotId与DepotPath二选一即可"},{"name":"SrcBranchName","type":"string","required":true,"description":"源分支名字"}],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: ModifyGitRebase\n<公共请求参数>\n\n{\n\t\"DepotId\": 6,\n\t\"BaseBranchName\": \"master-patch-4\",\n\t\"SrcBranchName\": \"master\"\n}"},"ModifyGitRelease":{"summary":"版本信息-修改仓库版本信息","category":"09-代码托管相关接口","description":"✨ 修改仓库版本信息","params":[{"name":"DepotId","type":"integer (int64)","required":true,"description":"仓库id"},{"name":"DepotPath","type":"string","required":false,"description":"仓库路径"},{"name":"Description","type":"string","required":false,"description":"描述"},{"name":"Pre","type":"boolean (bool)","required":false,"description":"是否预发布"},{"name":"ReleaseId","type":"integer (int64)","required":true,"description":"项目下仓库版本唯一标识符"},{"name":"TagName","type":"string","required":true,"description":"标签名称"},{"name":"Title","type":"string","required":false,"description":"标题"}],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: ModifyGitRelease\n<公共请求参数>\n\n{\n\t\"DepotId\": 6,\n\t\"TagName\": \"1111\",\n\t\"ReleaseId\": 1\n}"},"ModifyGitTransfer":{"summary":"仓库信息-仓库转移至同团队下的其他项目中","category":"09-代码托管相关接口","description":"✨ 仓库转移至同团队下的其他项目中","params":[{"name":"DepotId","type":"integer (int64)","required":true,"description":"仓库 ID"},{"name":"DepotPath","type":"string","required":false,"description":"仓库路径，与仓库ID二选一"},{"name":"TargetProjectId","type":"integer (int64)","required":true,"description":"目标项目 ID"}],"response":[{"name":"NewDepotPath","type":"string","required":false,"description":"转移后 web 页面的访问路径(不包含域名)"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: ModifyGitTransfer\n<公共请求参数>\n\n{\n\t\"DepotId\": 7,\n\t\"TargetProjectId\": 3\n}"},"ModifyMergeMR":{"summary":"合并信息-执行合并","category":"09-代码托管相关接口","description":"✨ 执行合并","params":[{"name":"DepotId","type":"integer (int64)","required":true,"description":"仓库id"},{"name":"DepotPath","type":"string","required":false,"description":"仓库路径，DepotId与DepotPath二选一即可"},{"name":"IsDelSourceBranch","type":"boolean (bool)","required":true,"description":"是否删除源分支"},{"name":"IsFastForward","type":"boolean (bool)","required":true,"description":"是否 Fast Forward 模式"},{"name":"MergeId","type":"integer (int64)","required":true,"description":"合并请求id"},{"name":"Message","type":"string","required":true,"description":"合并信息"},{"name":"Squash","type":"boolean (bool)","required":true,"description":"是否需要对mr进行 Squash"}],"response":[{"name":"MergeRequestInfo","type":"MergeRequestInfo","required":false,"description":"合并请求信息"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: ModifyMergeMR\n<公共请求参数>\n\n{\n\t\"DepotId\": 9,\n\t\"MergeId\": 16,\n\t\"Message\": \"合并mr\",\n\t\"IsDelSourceBranch\": false,\n\t\"IsFastForward\": false,\n\t\"Squash\": false\n}"},"ModifyMergeRequestBasicSettings":{"summary":"仓库设置-修改合并请求基础设置","category":"09-代码托管相关接口","description":"✨ 修改合并请求基础设置","params":[{"name":"CancelMrGrantAfterPushSrc","type":"boolean (bool)","required":true,"description":"合并请求源分支有新提交时是否自动取消合并授权"},{"name":"DefaultFastForwardMerge","type":"boolean (bool)","required":true,"description":"是否默认以 Fast-Forward 模式合并"},{"name":"DefaultTargetBranch","type":"string","required":false,"description":"合并请求默认分支"},{"name":"DeleteSrcBranchAfterMerged","type":"boolean (bool)","required":true,"description":"是否默认删除源分支"},{"name":"DepotPath","type":"string","required":true,"description":"仓库路径，格式：<team>/<project>/<depot>"},{"name":"DepotStatusCheckRequired","type":"boolean (bool)","required":true,"description":"是否开启状态检查"},{"name":"MrCheckAllReviewersAllow","type":"boolean (bool)","required":true,"description":"合并前是否必须获得所有评审者的允许合并"},{"name":"SquashOnMerge","type":"string","required":false,"description":"合并请求选择方式no_squash:默认直接合并default_squash:默认Squash合并 force_squash:只能Squash合并"}],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: ModifyMergeRequestBasicSettings\n<公共请求参数>\n\n{\n  \"DepotPath\": \"abc\",\n  \"DeleteSrcBranchAfterMerged\": true,\n  \"DefaultFastForwardMerge\": true,\n  \"CancelMrGrantAfterPushSrc\": true,\n  \"DepotStatusCheckRequired\": true,\n  \"MrCheckAllReviewersAllow\": true,\n  \"SquashOnMerge\": \"abc\",\n  \"DefaultTargetBranch\": \"abc\"\n}"},"ModifyMergeRequestMergeCommitMessageTemplate":{"summary":"仓库设置-修改合并请求合并提交消息模版","category":"09-代码托管相关接口","description":"✨ 修改合并请求合并提交消息模版","params":[{"name":"CommitMessageTemplate","type":"string","required":true,"description":"合并请求合并提交消息模版"},{"name":"DepotPath","type":"string","required":true,"description":"仓库路径"}],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: ModifyMergeRequestMergeCommitMessageTemplate\n<公共请求参数>\n\n{\n\t\"DepotPath\": \"codingcorp/zyx/depot\",\n\t\"CommitMessageTemplate\": \"ninininini\"\n}"},"ModifyMergeRequestSquashCommitMessageTemplate":{"summary":"仓库设置-修改合并请求合并压缩提交消息模版","category":"09-代码托管相关接口","description":"✨ 修改合并请求合并压缩提交消息模版","params":[{"name":"CommitMessageTemplate","type":"string","required":true,"description":"合并请求合并提交消息模版"},{"name":"DepotPath","type":"string","required":true,"description":"仓库路径"}],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: ModifyMergeRequestSquashCommitMessageTemplate\n<公共请求参数>\n\n{\n\t\"DepotPath\": \"codingcorp/zyx/repo_01\",\n\t\"CommitMessageTemplate\": \"1111\"\n}"},"ModifyTeamLevelDepotSpec":{"summary":"仓库设置-修改、新增团队级别的仓库规范","category":"09-代码托管相关接口","description":"✨ 修改、新增团队级别的仓库规范","params":[{"name":"Param","type":"DepotSpecTeamLevelParam","required":true,"description":"修改、新增团队级别的仓库规范参数"}],"response":[{"name":"Detail","type":"DepotSpecDetail","required":false,"description":"仓库规范详细信息"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: ModifyTeamLevelDepotSpec\n<公共请求参数>\n\n{\n\t\"Param\": {\n\t\t\"Name\": \"团队级别分支规范test\",\n\t\t\"ReName\": \"团队级别分支规范ReName\",\n\t\t\"Description\": \"111\",\n\t\t\"AllowPushWildRef\": true,\n\t\t\"DepotBranchTypeList\": [\n\t\t\t{\n\t\t\t\t\"Name\": \"123\",\n\t\t\t\t\"Rule\": \"1*\",\n\t\t\t\t\"Description\": \"1\"\n\t\t\t}\n\t\t]\n\t}\n}"},"BoundExternalDepot":{"summary":"外部仓库关联","category":"10-持续集成相关接口","description":"✨ 关联外部仓库","params":[{"name":"CredentialUUID","type":"string","required":false,"description":"当授权类型为USERNAME_PASSWORD时，填入和当前仓库用户名密码关联的凭证UUID"},{"name":"DepotId","type":"integer (int64)","required":false,"description":"如果是跨项目代码仓库，则此字段必填，为源代码仓库id"},{"name":"DepotType","type":"string","required":true,"description":"仓库类型"},{"name":"ExternalDepotAddress","type":"string","required":true,"description":"外部仓库标识"},{"name":"GrantType","type":"string","required":false,"description":"如果是跨项目代码仓库，则需要填入“CODING_PERSONAL_CREDENTIAL”，其他外部仓库填入“OAUTH”"},{"name":"ProjectId","type":"integer (uint64)","required":true,"description":"项目 Id"},{"name":"RepoUrl","type":"string","required":false,"description":"当授权类型为USERNAME_PASSWORD时，填入外部仓库http格式的仓库地址"},{"name":"WebHook","type":"boolean (bool)","required":true,"description":"是否开启 WebHook 一般都填写 true"}],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: BoundExternalDepot\n<公共请求参数>\n\n{\n    \"ProjectId\": \"450\",\n    \"ExternalDepotAddress\": \"https:\\/\\/github.com\\/cheerego\\/spring-gradle.git\",\n    \"WebHook\": \"true\",\n    \"DepotType\": \"GITHUB\"\n}"},"ClearCodingCIJobCache":{"summary":"构建计划缓存清理","category":"10-持续集成相关接口","description":"✨ 清理构建计划缓存","params":[{"name":"Id","type":"integer (int64)","required":true,"description":"构建计划ID"}],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"destructive","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: ClearCodingCIJobCache\n<公共请求参数>\n\n{\n  \"Id\": 0\n}"},"CreateCodingCIJob":{"summary":"构建计划创建","category":"10-持续集成相关接口","description":"✨ 创建构建计划","params":[{"name":"AlwaysUserIdList","type":"Array of integer","required":false,"description":"不管构建成功还是失败总是通知的用户"},{"name":"AutoCancelSameMergeRequest","type":"boolean (bool)","required":true,"description":"自动取消相同 MR"},{"name":"AutoCancelSameRevision","type":"boolean (bool)","required":true,"description":"自动取消相同版本"},{"name":"BranchRegex","type":"string","required":false,"description":"hookType 为 CUSTOME 时须指定"},{"name":"BranchSelector","type":"string","required":false,"description":"hookType 为 DEFAULT 时须指定"},{"name":"BuildFailUserIdList","type":"Array of integer","required":false,"description":"仅构建失败时要通知的用户"},{"name":"CachePathList","type":"Array of CodingCIJobCachePath","required":false,"description":"任务缓存目录配置"},{"name":"DepotId","type":"integer (uint64)","required":true,"description":"仓库 ID"},{"name":"DepotType","type":"string","required":true,"description":"仓库类型 CODING_OTHER_PROJ,CODING,TGIT,GITHUB,GITLAB,GITLAB_PRIVATE,GITEE,COMMON_GIT_REPO,NONE"},{"name":"EnvList","type":"Array of CIJobEnv","required":false,"description":"环境变量配置"},{"name":"ExecuteIn","type":"string","required":true,"description":"执行方式 CVM | STATIC | AGENT"},{"name":"ExecutedAgentPoolId","type":"integer (uint64)","required":false,"description":"自定义构建节点池 ID，ExecuteIn 为 AGENT 必填"},{"name":"HookType","type":"string","required":true,"description":"代码更新触发匹配规则 DEFAULT,TAG,BRANCH,CUSTOM"},{"name":"JenkinsFileFromType","type":"string","required":true,"description":"STATIC，SCM 从代码库读取"},{"name":"JenkinsFilePath","type":"string","required":false,"description":"JenkinsFileFromType 为 SCM 必填"},{"name":"JenkinsFileStaticContent","type":"string","required":false,"description":"JenkinsFileFromType 为 STATIC 必填"},{"name":"JobFromType","type":"string","required":true,"description":"构建计划来源 TKE TCB"},{"name":"Name","type":"string","required":true,"description":"构建计划名称"},{"name":"ProjectId","type":"integer (uint64)","required":true,"description":"项目 ID"},{"name":"ScheduleList","type":"Array of CodingCIJobSchedule","required":false,"description":"针对 CRON triggerMethod 的 schedule 规则配置, 暂只用于添加"},{"name":"TriggerMethodList","type":"Array of string","required":false,"description":"REF_CHANGE 代码更新触发\r\n    CRON = 1 定时触发\r\n    MR_CHANGE  MR变动触发"},{"name":"TriggerRemind","type":"string","required":false,"description":"构建结果通知触发者机制\r\nALWAYS -总是通知;\r\nBUILD_FAIL -仅构建失败时通知;"}],"response":[{"name":"Data","type":"CreateCodingCIJobData","required":false,"description":"创建构建计划返回结构"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: CreateCodingCIJob\n<公共请求参数>\n\n{\n    \"AutoCancelSameMergeRequest\": true,\n    \"AutoCancelSameRevision\": true,\n    \"BranchRegex\": \"\",\n    \"BranchSelector\": \"\",\n    \"DepotId\": 0,\n    \"DepotType\": \"NONE\",\n    \"ExecuteIn\": \"CVM\",\n    \"HookType\": \"DEFAULT\",\n    \"JenkinsFileFromType\": \"STATIC\",\n    \"JenkinsFilePath\": \"Jenkinsfile\",\n    \"JenkinsFileStaticContent\": \"文件内容过长请忽略\",\n    \"JobFromType\": \"CODING\",\n    \"Name\": \"hugoo201905135027hello64f84173-321b-4f36-aae7-5b87bfd9b7de\",\n    \"ProjectId\": 645819,\n    \"TriggerRemind\": \"ALWAYS\"\n}"},"CreateCodingCIJobByTeamTemplate":{"summary":"构建计划-根据团队模版创建","category":"10-持续集成相关接口","description":"✨ 根据团队模版创建构建计划","params":[{"name":"DepotId","type":"integer (int64)","required":true,"description":"描述信息"},{"name":"DepotType","type":"string","required":true,"description":"仓库类型"},{"name":"JobName","type":"string","required":true,"description":"构建计划名称"},{"name":"ProjectId","type":"integer (int64)","required":true,"description":"项目 ID"},{"name":"TemplateId","type":"integer (int64)","required":true,"description":"团队构建模版 ID"}],"response":[{"name":"Data","type":"JobCreateJobData","required":false,"description":"根据团队模板创建构建计划返回结构"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: CreateCodingCIJobByTeamTemplate\n<公共请求参数>\n\n{\n  \"DepotId\": 1,\n  \"JobName\": \"jobName1\",\n  \"TemplateId\": 1,\n  \"DepotType\": \"CODING\",\n  \"ProjectId\": 1\n}"},"DeleteCodingCIBuild":{"summary":"构建删除","category":"10-持续集成相关接口","description":"✨ 删除构建","params":[{"name":"BuildId","type":"integer (uint64)","required":true,"description":"构建 ID"}],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"destructive","example":"https://coding.example.com/?Action=DeleteCodingCIBuild\n&BuildId=55\n&<公共请求参数>"},"DeleteCodingCIJob":{"summary":"构建计划删除","category":"10-持续集成相关接口","description":"✨ 删除构建计划","params":[{"name":"JobId","type":"integer (uint64)","required":true,"description":"构建计划 ID"}],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"destructive","example":"https://coding.example.com/?Action=DeleteCodingCIJob\n&JobId=1\n&<公共请求参数>"},"DescribeCodingCIBuild":{"summary":"构建记录详情查询","category":"10-持续集成相关接口","description":"✨ 查询构建记录详情","params":[{"name":"BuildId","type":"integer (uint64)","required":true,"description":"构建 ID"}],"response":[{"name":"Build","type":"CodingCIBuild","required":false,"description":"构建详情"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"https://coding.example.com/?Action=DescribeCodingCIBuild\n&BuildId=1\n\n&<公共请求参数>"},"DescribeCodingCIBuildArtifacts":{"summary":"构建任务制品查询","category":"10-持续集成相关接口","description":"✨ 查询构建任务制品","params":[{"name":"BuildId","type":"integer (int64)","required":true,"description":"构建 ID"}],"response":[{"name":"Data","type":"BuildDescribeCodingCIBuildArtifactsData","required":false,"description":"构建任务的制品信息"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read"},"DescribeCodingCIBuildEnvs":{"summary":"构建计划环境变量获取","category":"10-持续集成相关接口","description":"✨ 获取构建计划环境变量","params":[{"name":"BuildId","type":"integer (uint64)","required":true,"description":"构建ID"},{"name":"Type","type":"string","required":true,"description":"SYSTEM（系统内置环境变量） Param（触发构建输入环境变量） Env（构建计划填写环境变量）"}],"response":[{"name":"EnvList","type":"Array of CIJobEnv","required":false,"description":"环境变量列表"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeCodingCIBuildEnvs\n<公共请求参数>\n\n{\"BuildId\":1,\"Type\":\"PARAM\"}"},"DescribeCodingCIBuildHtmlReports":{"summary":"构建任务网页报告查询","category":"10-持续集成相关接口","description":"✨ 构建任务网页报告查询","params":[{"name":"BuildId","type":"integer (int64)","required":true,"description":"构建 ID"}],"response":[{"name":"Data","type":"BuildDescribeCodingCIBuildHtmlReportsData","required":false,"description":"构建报告信息"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read"},"DescribeCodingCIBuildLog":{"summary":"构建日志获取","category":"10-持续集成相关接口","description":"✨ 构建日志获取","params":[{"name":"BuildId","type":"integer (uint64)","required":true,"description":"构建 ID"},{"name":"Start","type":"integer (uint64)","required":true,"description":"日志的开始位置"}],"response":[{"name":"Data","type":"DescribeCodingCIBuildLogData","required":false,"description":"日志信息"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"https://coding.example.com/?Action=DescribeCodingCIBuildLog\n&BuildId=1\n&Start=0\n&<公共请求参数>"},"DescribeCodingCIBuildLogRaw":{"summary":"构建完整日志查询（原始日志 Raw）","category":"10-持续集成相关接口","description":"✨ 构建完整日志查询（原始日志 Raw）","params":[{"name":"BuildId","type":"integer (uint64)","required":true,"description":"构建 ID"},{"name":"Start","type":"integer (uint64)","required":true,"description":"日志开始位置"}],"response":[{"name":"Data","type":"DescribeCodingCIBuildLogRawData","required":false,"description":"构建原始日志"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"https://coding.example.com/?Action=DescribeCodingCIBuildLogRaw\n&BuildId=56\n&Start=0\n&<公共请求参数>"},"DescribeCodingCIBuildMetrics":{"summary":"构建计划度量查询","category":"10-持续集成相关接口","description":"✨ 构建计划度量查询","params":[{"name":"EndTime","type":"string","required":true,"description":"结束时间 2020-11-20"},{"name":"ProjectId","type":"integer (uint64)","required":false,"description":"项目 ID,Type 为 PROJECT 时必填"},{"name":"StartTime","type":"string","required":true,"description":"开始时间 2020-11-10"},{"name":"Type","type":"string","required":false,"description":"查询级别 PROJECT 级别，TEAM 级别，目前只支持 PROJECT"}],"response":[{"name":"Data","type":"Array of DescribeCodingCIBuildMetrics","required":false,"description":"BuildMetrics 数组结构"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeCodingCIBuildMetrics\n<公共请求参数>\n\n{\n  \"Type\": \"PROJECT\",\n  \"ProjectId\": 451,\n  \"StartTime\": \"2020-11-10\",\n  \"EndTime\": \"2020-12-30\"\n}"},"DescribeCodingCIBuilds":{"summary":"构建计划的构建列表获取","category":"10-持续集成相关接口","description":"✨ 构建计划的构建列表获取","params":[{"name":"JobId","type":"integer (uint64)","required":true,"description":"构建计划 ID"},{"name":"PageNumber","type":"integer (uint64)","required":true,"description":"页码"},{"name":"PageSize","type":"integer (uint64)","required":true,"description":"每页条数"}],"response":[{"name":"Data","type":"DescribeCodingCIBuildsData","required":false,"description":"构建列表"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"https://coding.example.com/?Action=DescribeCodingCIBuilds\n&JobId=1\n&PageNumber=1\n&PageSize=2\n&<公共请求参数>"},"DescribeCodingCIBuildStage":{"summary":"构建任务阶段获取","category":"10-持续集成相关接口","description":"✨ 构建任务阶段获取","params":[{"name":"BuildId","type":"integer (uint64)","required":true,"description":"构建 ID"}],"response":[{"name":"Data","type":"CodingCIBuildStageData","required":false,"description":"包含步骤返回信息"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"https://coding.example.com/?Action=DescribeCodingCIBuildStage\n&BuildId=1\n&<公共请求参数>"},"DescribeCodingCIBuildStatistics":{"summary":"构建任务统计","category":"10-持续集成相关接口","description":"✨ 构建任务统计","params":[{"name":"EndTime","type":"string","required":true,"description":"结束时间"},{"name":"JobId","type":"integer (uint64)","required":false,"description":"MetricType 为 JOB 的时候使用该值，此时 ProjectId 可不传"},{"name":"MetricType","type":"string","required":true,"description":"统计维度 Project 还是 JOB 目前只有 PROJECT"},{"name":"Period","type":"integer (uint64)","required":true,"description":"统计间隔单位秒"},{"name":"ProjectId","type":"integer (uint64)","required":false,"description":"MetricType 为 PROJECT 的时候使用该值，此时 JobId 可不传"},{"name":"StartTime","type":"string","required":true,"description":"开始时间"}],"response":[{"name":"Data","type":"DescribeCodingCIBuildStatisticsResponseData","required":false,"description":"区间统计数据，单位毫秒"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeCodingCIBuildStatistics\n<公共请求参数>\n\n{\n    \"ProjectId\": 1, \n    \"Period\": 1, \n    \"MetricType\": \"xx\", \n    \"JobId\": 1, \n    \"StartTime\": \"2020-09-22 00:00:00\", \n    \"EndTime\": \"2020-09-22 00:00:00\"\n}"},"DescribeCodingCIBuildStep":{"summary":"构建任务指定阶段的步骤获取","category":"10-持续集成相关接口","description":"✨ 构建任务指定阶段的步骤获取","params":[{"name":"BuildId","type":"integer (uint64)","required":true,"description":"构建 ID"},{"name":"StageId","type":"integer (uint64)","required":true,"description":"阶段 ID"}],"response":[{"name":"Data","type":"CodingCIBuildStepData","required":false,"description":"Step 信息"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"https://coding.example.com/?Action=DescribeCodingCIBuildStep\n&BuildId=1\n&StageId=3\n&<公共请求参数>"},"DescribeCodingCIBuildStepLog":{"summary":"构建步骤日志获取","category":"10-持续集成相关接口","description":"✨ 构建步骤日志获取","params":[{"name":"BuildId","type":"integer (uint64)","required":true,"description":"构建 ID"},{"name":"StageId","type":"integer (uint64)","required":true,"description":"阶段 ID"},{"name":"Start","type":"integer (uint64)","required":true,"description":"日志开始位置"},{"name":"StepId","type":"integer (uint64)","required":true,"description":"步骤 ID"}],"response":[{"name":"Data","type":"DescribeCodingCIBuildStepLogData","required":false,"description":"日志详情"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"https://coding.example.com/?Action=DescribeCodingCIBuildStepLog\n&BuildId=56\n&StageId=24\n&StepId=25\n&Start=0\n\n\n&<公共请求参数>"},"DescribeCodingCIJob":{"summary":"构建计划详情获取","category":"10-持续集成相关接口","description":"✨ 构建计划详情获取","params":[{"name":"JobId","type":"integer (uint64)","required":true,"description":"构建计划 ID"}],"response":[{"name":"Job","type":"CodingCIJob","required":false,"description":"构建计划详情"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"https://coding.example.com/?Action=DescribeCodingCIJob\n&JobId=123\n&<公共请求参数>"},"DescribeCodingCIJobs":{"summary":"构建计划查询（通过项目ID）","category":"10-持续集成相关接口","description":"✨ 构建计划查询（通过项目ID）","params":[{"name":"Filter","type":"Array of Filter","required":false,"description":"过滤参数"},{"name":"ProjectId","type":"integer (uint64)","required":true,"description":"项目 ID"}],"response":[{"name":"JobList","type":"Array of CodingCIJob","required":false,"description":"CI 任务列表"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"https://coding.example.com/?Action=DescribeCodingCIJobs\n&ProjectId=123\n&<公共请求参数>"},"ModifyCodingCIAgentEnable":{"summary":"自定义构建节点启用、禁用","category":"10-持续集成相关接口","description":"✨ 自定义构建节点启用、禁用","params":[{"name":"PoolId","type":"integer (int64)","required":true,"description":"节点池 ID"},{"name":"Enable","type":"boolean","required":true,"description":"是否启用：启用true、禁用false"},{"name":"Id","type":"integer (int64)","required":true,"description":"节点ID"}],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: ModifyCodingCIAgentEnable\n<公共请求参数>\n\n{\n  \"PoolId\": 1445,\n  \"Id\": 7,\n  \"Enable\": true\n}"},"ModifyCodingCIJob":{"summary":"构建计划修改","category":"10-持续集成相关接口","description":"✨ 构建计划修改","params":[{"name":"AlwaysUserIdList","type":"Array of integer","required":false,"description":"不管构建成功还是失败总是通知的用户"},{"name":"AutoCancelSameMergeRequest","type":"boolean (bool)","required":true,"description":"自动取消相同 MR"},{"name":"AutoCancelSameRevision","type":"boolean (bool)","required":true,"description":"自动取消相同版本"},{"name":"BranchRegex","type":"string","required":false,"description":"hookType 为 CUSTOME 时须指定"},{"name":"BranchSelector","type":"string","required":false,"description":"hookType 为 DEFAULT 时须指定"},{"name":"BuildFailUserIdList","type":"Array of integer","required":false,"description":"仅构建失败时要通知的用户"},{"name":"CachePathList","type":"Array of CodingCIJobCachePath","required":false,"description":"任务缓存目录配置"},{"name":"DepotId","type":"integer (uint64)","required":true,"description":"仓库 ID"},{"name":"DepotType","type":"string","required":true,"description":"仓库类型 CODING,TGIT,GITHUB,GITLAB,GITLAB_PRIVATE,GITEE,NONE"},{"name":"EnvList","type":"Array of CodingCIJobEnv","required":false,"description":"环境变量配置"},{"name":"ExecuteIn","type":"string","required":true,"description":"执行方式 CVM | STATIC"},{"name":"ExecutedAgentPoolId","type":"integer (uint64)","required":false,"description":"自定义构建节点池 ID，ExecuteIn 为 AGENT 必填"},{"name":"HookType","type":"string","required":true,"description":"代码更新触发匹配规则"},{"name":"Id","type":"integer (uint64)","required":true,"description":"构建计划 ID"},{"name":"JenkinsFileFromType","type":"string","required":true,"description":"STATIC，SCM 从代码库读取"},{"name":"JenkinsFilePath","type":"string","required":false,"description":"JenkinsFileFromType 为 SCM 必填"},{"name":"JenkinsFileStaticContent","type":"string","required":false,"description":"JenkinsFileFromType 为 STATIC 必填"},{"name":"JobFromType","type":"string","required":true,"description":"构建计划来源 TKE TCB"},{"name":"Name","type":"string","required":false,"description":"构建计划名称"},{"name":"ProjectId","type":"integer (uint64)","required":true,"description":"项目 ID"},{"name":"ScheduleList","type":"Array of CodingCIJobSchedule","required":false,"description":"针对 CRON triggerMethod 的 schedule 规则配置, 暂只用于添加"},{"name":"TriggerMethodList","type":"Array of string","required":false,"description":"REF_CHANGE 代码更新触发\r\n    CRON = 1 定时触发\r\n    MR_CHANGE  MR变动触发\r\nTKE 对接他们传空数组老是有问题，遂改成非必填"},{"name":"TriggerRemind","type":"string","required":true,"description":"构建结果通知触发者机制\r\nALWAYS -总是通知;\r\nBUILD_FAIL -仅构建失败时通知;"}],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: ModifyCodingCIJob\n<公共请求参数>\n\n{\n    \"Id\":123,\n    \"AutoCancelSameMergeRequest\": true,\n    \"AutoCancelSameRevision\": true,\n    \"BranchRegex\": \"\",\n    \"BranchSelector\": \"\",\n    \"DepotId\": 0,\n    \"DepotType\": \"NONE\",\n    \"ExecuteIn\": \"CVM\",\n    \"HookType\": \"DEFAULT\",\n    \"JenkinsFileFromType\": \"STATIC\",\n    \"JenkinsFilePath\": \"Jenkinsfile\",\n    \"JenkinsFileStaticContent\": \"文件内容过长请忽略\",\n    \"JobFromType\": \"CODING\",\n    \"Name\": \"hugoo201905135027hello64f84173-321b-4f36-aae7-5b87bfd9b7de\",\n    \"ProjectId\": 645819,\n    \"TriggerRemind\": \"ALWAYS\"\n}"},"StopCodingCIBuild":{"summary":"构建停止","category":"10-持续集成相关接口","description":"✨ 构建停止","params":[{"name":"BuildId","type":"integer (uint64)","required":true,"description":"构建 ID"}],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"destructive","example":"https://coding.example.com/?Action=StopCodingCIBuild\n&BuildId=1\n&<公共请求参数>"},"TriggerCodingCIBuild":{"summary":"构建触发","category":"10-持续集成相关接口","description":"✨ 构建触发","params":[{"name":"JobId","type":"integer (uint64)","required":true,"description":"构建计划 Id"},{"name":"ParamList","type":"Array of CodingCIJobEnv","required":false,"description":"构建附加的环境变量"},{"name":"Reentrant","type":"string","required":false,"description":"可重入字符串"},{"name":"Revision","type":"string","required":false,"description":"分支名或 CommitId，当为构建计划的 DepotType 为 NONE 是可不传"}],"response":[{"name":"Data","type":"TriggerCodingCIBuildData","required":false,"description":"构建信息"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"https://coding.example.com/?Action=TriggerCodingCIBuild\n&Revision=master\n&JobId=23\n&<公共请求参数>"},"BindCdApplicationToProject":{"summary":"绑定 CD 应用到项目","category":"11-持续部署相关接口","description":"✨ 绑定 CD 应用到项目","params":[{"name":"Application","type":"string","required":true,"description":"CD 应用名"},{"name":"ProjectName","type":"string","required":true,"description":"项目名称"}],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: BindCdApplicationToProject\n<公共请求参数>\n\n{\n    \"ProjectName\": \"test\",\n    \"Application\": \"dev\"\n}"},"CancelCdPipeline":{"summary":"CD 部署流程取消执行","category":"11-持续部署相关接口","description":"✨ 取消执行中的 CD 部署流程","params":[{"name":"PipelineExecutionId","type":"string","required":true,"description":"部署流程执行记录 ID"},{"name":"Reason","type":"string","required":false,"description":"取消原因"}],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"destructive","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: CancelCdPipeline\n<公共请求参数>\n\n{\n  \t\"PipelineExecutionId\": \"01FCWNV355ECJSZYXFQE3166VT\"\n}"},"CreateCdCloudAccount":{"summary":"CD 云账号添加","category":"11-持续部署相关接口","description":"✨ CD 云账号添加","params":[{"name":"CloudProvider","type":"string","required":true,"description":"云账号类型（可选值：KUBERNETES、TENCENT）"},{"name":"Credential","type":"CloudAccountCredential","required":true,"description":"云账号凭据"},{"name":"Name","type":"string","required":true,"description":"云账号名称"}],"response":[{"name":"Data","type":"CreateCdCloudAccountResponseData","required":false,"description":"云账号数据"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"{\n  \"CloudProvider\": \"KUBERNETES\",\n  \"Name\": \"test\",\n  \"Credential\": {\n      \"KubernetesType\": \"KUBE_CONFIG\",\n      \"KubeConfig\": {\n          \"InsecureSkipTLSVerify\": false,\n          \"OnlySpinnakerManaged\": true,\n          \"ClusterContext\": \"kubernetes-admin@k8s-227\",\n          \"KubeConfig\": \"YXBpVmVyc2lvbjogdjEKa2luZDogQ29uZmln\"\n      }\n  }\n}"},"CreateCdHostServerGroup":{"summary":"CD 主机组添加","category":"11-持续部署相关接口","description":"✨ CD 主机组添加","params":[{"name":"AgentMachineId","type":"integer (int64)","required":true,"description":"堡垒机 ID"},{"name":"AuthMethod","type":"string","required":true,"description":"SSH 认证方式（可选值：PUBLIC_KEY、PASSWORD）"},{"name":"DisplayName","type":"string","required":true,"description":"主机组名称"},{"name":"Ips","type":"Array of string","required":true,"description":"实例 IP 列表"},{"name":"Labels","type":"Array of HostServerGroupLabel","required":false,"description":"主机组标签"},{"name":"Password","type":"string","required":false,"description":"SSH 密码"},{"name":"Port","type":"integer (int64)","required":true,"description":"SSH 端口"},{"name":"UserName","type":"string","required":true,"description":"SSH 用户名"}],"response":[{"name":"Data","type":"CreateCdHostServerGroupResponseData","required":false,"description":"主机组数据"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: CreateCdHostServerGroup\n<公共请求参数>\n\n{\n    \"AgentMachineId\": 10,\n    \"DisplayName\": \"test\",\n    \"AuthMethod\": \"PUBLIC_KEY\",\n    \"UserName\": \"root\",\n    \"Port\": 36000,\n    \"Labels\": [\n        {\n            \"Key\": \"testKey\",\n            \"Value\": \"testValue\"\n        }\n    ],\n    \"Ips\": [\n        \"127.0.0.1\"\n    ]\n}"},"CreateCdPipeline":{"summary":"CD 部署流程创建","category":"11-持续部署相关接口","description":"✨ CD 部署流程创建","params":[{"name":"PipelineJsonContent","type":"string","required":true,"description":"部署流程 JSON 配置（注意：stages 的 refId 和 requisiteStageRefIds 字段必传）"}],"response":[{"name":"Data","type":"CreateCdPipelineResponseData","required":false,"description":"CD 部署流程数据"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: CreateCdPipeline\n<公共请求参数>\n\n{\n    \"PipelineJsonContent\": \"{\\\"keepWaitingPipelines\\\":false,\\\"limitConcurrent\\\":true,\\\"application\\\":\\\"test\\\",\\\"codingNickname\\\":\\\"coding\\\",\\\"roles\\\":[\\\"团队管理员\\\",\\\"团队所有者\\\"],\\\"lastModifiedBy\\\":\\\"Hello\\\",\\\"name\\\":\\\"test\\\",\\\"stages\\\":[{\\\"refId\\\":\\\"1\\\",\\\"requisiteStageRefIds\\\":[],\\\"type\\\":\\\"wait\\\",\\\"name\\\":\\\"等待\\\",\\\"waitTime\\\":10}],\\\"index\\\":0,\\\"triggers\\\":[],\\\"updateTs\\\":\\\"1612317257852\\\",\\\"relationProjects\\\":[]}\"\n}"},"CreateCdTask":{"summary":"CD 任务执行","category":"11-持续部署相关接口","description":"✨ CD 任务执行","params":[{"name":"TaskJsonContent","type":"string","required":true,"description":"任务 JSON 配置"}],"response":[{"name":"Data","type":"CreateCdTaskResponseData","required":false,"description":"CD 任务执行记录数据"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: CreateCdTask\n<公共请求参数>\n\n{\n    \"TaskJsonContent\": \"{\\\"job\\\":[{\\\"type\\\":\\\"createApplication\\\",\\\"application\\\":{\\\"cloudProviders\\\":\\\"kubernetes,hostserver\\\",\\\"email\\\":\\\"example@example.com\\\",\\\"instancePort\\\":80,\\\"nickName\\\":\\\"coding\\\",\\\"name\\\":\\\"test\\\"},\\\"user\\\":\\\"coding\\\"}],\\\"application\\\":\\\"test\\\",\\\"description\\\":\\\"Create Application: test\\\"}\"\n}"},"DeleteCdCloudAccount":{"summary":"CD 云账号删除","category":"11-持续部署相关接口","description":"✨ CD 云账号删除","params":[{"name":"Id","type":"integer (int64)","required":true,"description":"云账号 ID"}],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"destructive","example":"{\n  \"Id\": 5000010\n}"},"DeleteCdHostServerGroup":{"summary":"CD 主机组删除","category":"11-持续部署相关接口","description":"✨ CD 主机组删除","params":[{"name":"Id","type":"integer (int64)","required":true,"description":"主机组 ID"}],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"destructive","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DeleteCdHostServerGroup\n<公共请求参数>\n\n{\n    \"Id\": 41\n}"},"DeleteCdPipeline":{"summary":"CD 部署流程删除","category":"11-持续部署相关接口","description":"✨ CD 部署流程删除","params":[{"name":"Application","type":"string","required":true,"description":"CD 应用名"},{"name":"PipelineName","type":"string","required":true,"description":"部署流程名称"}],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"destructive","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DeleteCdPipeline\n<公共请求参数>\n\n{\n    \"Application\": \"test\",\n    \"PipelineName\": \"test\"\n}"},"DescribeAgentSecret":{"summary":"堡垒机安装 Secret","category":"11-持续部署相关接口","description":"✨ 在堡垒机上安装 CD 客户端必要的 Secret 凭据参数","params":[],"response":[{"name":"Data","type":"AgentMachineSecret","required":false,"description":"Secret 值"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeAgentSecret\n<公共请求参数>\n\n{}"},"DescribeCdAgentMachines":{"summary":"CD 堡垒机列表获取","category":"11-持续部署相关接口","description":"✨ CD 堡垒机列表获取","params":[{"name":"Keyword","type":"string","required":false,"description":"检索关键字"},{"name":"PageNumber","type":"integer (int64)","required":false,"description":"页码（默认为 1）"},{"name":"PageSize","type":"integer (int64)","required":false,"description":"每页条数（默认为 10，最大值为 500）"}],"response":[{"name":"Data","type":"DescribeCdAgentMachinesResponseData","required":false,"description":"堡垒机列表数据"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeCdAgentMachines\n<公共请求参数>\n\n{\n    \"PageNumber\": 1,\n    \"PageSize\": 10,\n    \"Keyword\": \"\"\n}"},"DescribeCdApplication":{"summary":"CD 应用详情获取","category":"11-持续部署相关接口","description":"✨ CD 应用详情获取","params":[{"name":"Application","type":"string","required":true,"description":"应用名称"}],"response":[{"name":"Data","type":"DescribeCdApplicationResponseData","required":false,"description":"CD 应用详情数据"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeCdApplication\n<公共请求参数>\n\n{\n    \"Application\": \"test\"\n}"},"DescribeCdApplications":{"summary":"CD 应用列表获取","category":"11-持续部署相关接口","description":"✨ CD 应用列表获取","params":[],"response":[{"name":"Data","type":"DescribeCdApplicationsResponseData","required":false,"description":"CD 应用列表"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"https://coding.example.com/?Action=DescribeCdApplications\n&<公共请求参数>"},"DescribeCdApplicationsByProject":{"summary":"关联应用列表获取（指定项目名）","category":"11-持续部署相关接口","description":"✨ 根据项目名获取关联应用列表","params":[{"name":"ProjectName","type":"string","required":true,"description":"项目名称"}],"response":[{"name":"Data","type":"DescribeCdApplicationsByProjectResponseData","required":false,"description":"CD 应用列表"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeCdApplicationsByProject\n<公共请求参数>\n\n{\n    \"ProjectName\": \"test\"\n}"},"DescribeCdCloudAccounts":{"summary":"CD 云账号列表获取","category":"11-持续部署相关接口","description":"✨ CD 云账号列表获取","params":[{"name":"Keyword","type":"string","required":false,"description":"检索关键字"},{"name":"PageNumber","type":"integer (int64)","required":false,"description":"页码（默认为 1）"},{"name":"PageSize","type":"integer (int64)","required":false,"description":"每页条数（默认为 10，最大值为 500）"}],"response":[{"name":"Data","type":"DescribeCdCloudAccountsResponseData","required":false,"description":"云账号列表数据"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"{\n    \"PageNumber\": 1,\n    \"PageSize\": 10,\n    \"Keyword\": \"\"\n}"},"DescribeCdDeployCountByApplications":{"summary":"发布次数-根据应用名列表获取","category":"11-持续部署相关接口","description":"✨ 根据应用名列表获取发布次数","params":[{"name":"Application","type":"Array of string","required":true,"description":"应用名列表"},{"name":"EndAt","type":"string","required":true,"description":"结束时间（格式：yyyy-MM-dd HH:mm:ss）"},{"name":"StartAt","type":"string","required":true,"description":"开始时间（格式：yyyy-MM-dd HH:mm:ss）"}],"response":[{"name":"Data","type":"DescribeCdDeployCountByApplicationsResponseData","required":false,"description":"发布次数统计数据"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeCdDeployCountByApplications\n<公共请求参数>\n\n{\n    \"Application\": [\n        \"dev\", \"local\"\n    ],\n    \"StartAt\": \"2020-12-01 00:00:00\",\n    \"EndAt\": \"2020-12-03 23:59:59\"\n}"},"DescribeCdDeployCountByProject":{"summary":"关联应用的发布次数获取（指定项目名）","category":"11-持续部署相关接口","description":"✨ 关联应用的发布次数获取（指定项目名）","params":[{"name":"EndAt","type":"string","required":true,"description":"结束时间（格式：yyyy-MM-dd HH:mm:ss）"},{"name":"ProjectName","type":"string","required":true,"description":"项目名称"},{"name":"StartAt","type":"string","required":true,"description":"开始时间（格式：yyyy-MM-dd HH:mm:ss）"}],"response":[{"name":"Data","type":"DescribeCdDeployCountByProjectResponseData","required":false,"description":"发布次数统计数据"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeCdDeployCountByProject\n<公共请求参数>\n\n{\n    \"ProjectName\": \"test\",\n    \"StartAt\": \"2020-12-01 00:00:00\",\n    \"EndAt\": \"2020-12-03 23:59:59\"\n}"},"DescribeCdDeployTimeByApplications":{"summary":"发布时长-根据应用名列表获取","category":"11-持续部署相关接口","description":"✨ 发布时长-根据应用名列表获取","params":[{"name":"Application","type":"Array of string","required":true,"description":"应用名列表"},{"name":"EndAt","type":"string","required":true,"description":"结束时间（格式：yyyy-MM-dd HH:mm:ss）"},{"name":"StartAt","type":"string","required":true,"description":"开始时间（格式：yyyy-MM-dd HH:mm:ss）"}],"response":[{"name":"Data","type":"DescribeCdDeployTimeByApplicationsResponseData","required":false,"description":"发布时长统计数据"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeCdDeployTimeByApplications\n<公共请求参数>\n\n{\n    \"Application\": [\n        \"dev\", \"local\"\n    ],\n    \"StartAt\": \"2020-12-01 00:00:00\",\n    \"EndAt\": \"2020-12-31 23:59:59\"\n}"},"DescribeCdDeployTimeByProject":{"summary":"关联应用的发布时长-根据项目名获取","category":"11-持续部署相关接口","description":"✨ 关联应用的发布时长-根据项目名获取","params":[{"name":"EndAt","type":"string","required":true,"description":"结束时间（格式：yyyy-MM-dd HH:mm:ss）"},{"name":"ProjectName","type":"string","required":true,"description":"项目名称"},{"name":"StartAt","type":"string","required":true,"description":"开始时间（格式：yyyy-MM-dd HH:mm:ss）"}],"response":[{"name":"Data","type":"DescribeCdDeployTimeByProjectResponseData","required":false,"description":"发布时长统计数据"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeCdDeployTimeByProject\n<公共请求参数>\n\n{\n    \"ProjectName\": \"test\",\n    \"StartAt\": \"2020-12-01 00:00:00\",\n    \"EndAt\": \"2020-12-31 23:59:59\"\n}"},"DescribeCdDeployTrendByApplications":{"summary":"发布趋势-根据应用名列表获取","category":"11-持续部署相关接口","description":"✨ 发布趋势-根据应用名列表获取","params":[{"name":"Application","type":"Array of string","required":true,"description":"应用名列表"},{"name":"EndAt","type":"string","required":true,"description":"结束时间（格式：yyyy-MM-dd HH:mm:ss）"},{"name":"StartAt","type":"string","required":true,"description":"开始时间（格式：yyyy-MM-dd HH:mm:ss）"}],"response":[{"name":"Data","type":"DescribeCdDeployTrendByApplicationsResponseData","required":false,"description":"发布趋势统计数据"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeCdDeployTrendByApplications\n<公共请求参数>\n\n{\n    \"Application\": [\n        \"dev\", \"local\"\n    ],\n    \"StartAt\": \"2020-12-01 00:00:00\",\n    \"EndAt\": \"2020-12-03 23:59:59\"\n}"},"DescribeCdDeployTrendByProject":{"summary":"关联应用的发布趋势-根据项目名获取","category":"11-持续部署相关接口","description":"✨ 关联应用的发布趋势-根据项目名获取","params":[{"name":"EndAt","type":"string","required":true,"description":"结束时间（格式：yyyy-MM-dd HH:mm:ss）"},{"name":"ProjectName","type":"string","required":true,"description":"项目名称"},{"name":"StartAt","type":"string","required":true,"description":"开始时间（格式：yyyy-MM-dd HH:mm:ss）"}],"response":[{"name":"Data","type":"DescribeCdDeployTrendByProjectResponseData","required":false,"description":"发布趋势统计数据"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeCdDeployTrendByProject\n<公共请求参数>\n\n{\n    \"ProjectName\": \"test\",\n    \"StartAt\": \"2020-12-01 00:00:00\",\n    \"EndAt\": \"2020-12-03 23:59:59\"\n}"},"DescribeCdHostServerGroup":{"summary":"CD 主机组获取","category":"11-持续部署相关接口","description":"✨ CD 主机组获取","params":[{"name":"Id","type":"integer (int64)","required":true,"description":"主机组 ID"}],"response":[{"name":"Data","type":"DescribeCdHostServerGroupResponseData","required":false,"description":"主机组详情数据"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeCdHostServerGroup\n<公共请求参数>\n\n{\n    \"Id\": 41\n}"},"DescribeCdHostServerGroups":{"summary":"CD 主机组列表获取","category":"11-持续部署相关接口","description":"✨ CD 主机组列表获取","params":[{"name":"Keyword","type":"string","required":false,"description":"检索关键字"},{"name":"PageNumber","type":"integer (int64)","required":false,"description":"页码（默认为 1）"},{"name":"PageSize","type":"integer (int64)","required":false,"description":"每页条数（默认为 10，最大值为 500）"}],"response":[{"name":"Data","type":"DescribeCdHostServerGroupsResponseData","required":false,"description":"主机组列表数据"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeCdHostServerGroups\n<公共请求参数>\n\n{\n    \"PageNumber\": 1,\n    \"PageSize\": 10,\n    \"Keyword\": \"\"\n}"},"DescribeCdPipeline":{"summary":"CD 部署流程执行记录获取","category":"11-持续部署相关接口","description":"✨ CD 部署流程执行记录获取","params":[{"name":"PipelineExecutionId","type":"string","required":true,"description":"部署流程执行记录 ID"}],"response":[{"name":"Data","type":"DescribeCdPipelineResponseData","required":false,"description":"部署流程执行记录数据"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeCdPipeline\n<公共请求参数>\n\n{\n    \"PipelineExecutionId\": \"01EXNXJVMK6EVRHB49CH7FG2BH\"\n}"},"DescribeCdPipelineConfig":{"summary":"CD 部署流程配置-根据名称获取","category":"11-持续部署相关接口","description":"✨ CD 部署流程配置-根据名称获取","params":[{"name":"Application","type":"string","required":true,"description":"CD 应用名"},{"name":"PipelineName","type":"string","required":true,"description":"部署流程名称"}],"response":[{"name":"Data","type":"DescribeCdPipelineConfigResponseData","required":false,"description":"CD 部署流程配置数据"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeCdPipelineConfig\n<公共请求参数>\n\n{\n    \"Application\": \"test\",\n    \"PipelineName\": \"test\"\n}"},"DescribeCdPipelineConfigs":{"summary":"CD 应用下的所有部署流程配置获取","category":"11-持续部署相关接口","description":"✨ CD 应用下的所有部署流程配置获取","params":[{"name":"Application","type":"string","required":true,"description":"CD 应用名"}],"response":[{"name":"Data","type":"DescribeCdPipelineConfigsResponseData","required":false,"description":"CD 部署流程配置数据"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeCdPipelineConfigs\n<公共请求参数>\n\n{\n    \"Application\": \"test\"\n}"},"DescribeCdTask":{"summary":"CD 任务执行记录获取","category":"11-持续部署相关接口","description":"✨ CD 任务执行记录获取","params":[{"name":"TaskExecutionId","type":"string","required":true,"description":"任务执行记录 ID"}],"response":[{"name":"Data","type":"DescribeCdTaskResponseData","required":false,"description":"CD 任务执行记录数据"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeCdTask\n<公共请求参数>\n\n{\n    \"TaskExecutionId\": \"01EXNWQJFCBG9PE1GG1NPWPV4T\"\n}"},"DescribeHostServerInstance":{"summary":"CD 主机组部署详情获取","category":"11-持续部署相关接口","description":"✨ CD 主机组部署详情获取","params":[{"name":"Account","type":"string","required":true,"description":"部署账号 从 DescribeCdPipeline 获取"},{"name":"ServerGroupName","type":"string","required":true,"description":"主机组名称 从 DescribeCdPipeline 获取"}],"response":[{"name":"Data","type":"Array of CdDeployOpenApiHostServerInstance","required":false,"description":"主机组部署列表"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeHostServerInstance\n<公共请求参数>\n\n{\n  \"Account\": \"cred-4-5000015\",\n  \"ServerGroupName\": \"app4-service-v000\"\n}"},"ModifyCdCloudAccount":{"summary":"CD 云账号更新","category":"11-持续部署相关接口","description":"✨ CD 云账号更新","params":[{"name":"Credential","type":"CloudAccountCredential","required":true,"description":"云账号凭据"},{"name":"Id","type":"integer (int64)","required":true,"description":"云账号 ID"},{"name":"Name","type":"string","required":true,"description":"云账号名称"}],"response":[{"name":"Data","type":"ModifyCdCloudAccountResponseData","required":false,"description":"云账号数据"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"{\n  \"Id\": 5000010,\n  \"Name\": \"test\",\n  \"Credential\": {\n      \"KubernetesType\": \"SERVICE_ACCOUNT\",\n      \"ServiceAccount\": {\n          \"InsecureSkipTLSVerify\": false,\n          \"OnlySpinnakerManaged\": true,\n          \"Server\": \"https://api-server-host:6443\",\n          \"Secret\": \"YXBpVmVyc2lvbjogdjEKa2luZDogU2VjcmV0\"\n      }\n  }\n}"},"ModifyCdHostServerGroup":{"summary":"CD 主机组修改","category":"11-持续部署相关接口","description":"✨ CD 主机组修改","params":[{"name":"AgentMachineId","type":"integer (int64)","required":true,"description":"堡垒机 ID"},{"name":"AuthMethod","type":"string","required":true,"description":"SSH 认证方式（可选值：PUBLIC_KEY、PASSWORD）"},{"name":"DisplayName","type":"string","required":true,"description":"主机组名称"},{"name":"Id","type":"integer (int64)","required":true,"description":"主机组 ID"},{"name":"Ips","type":"Array of string","required":true,"description":"实例 IP 列表"},{"name":"Labels","type":"Array of HostServerGroupLabel","required":false,"description":"主机组标签"},{"name":"Password","type":"string","required":false,"description":"SSH 密码"},{"name":"Port","type":"integer (int64)","required":true,"description":"SSH 端口"},{"name":"UserName","type":"string","required":true,"description":"SSH 用户名"}],"response":[{"name":"Data","type":"ModifyCdHostServerGroupResponseData","required":false,"description":"主机组数据"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: ModifyCdHostServerGroup\n<公共请求参数>\n\n{\n    \"Id\": 41,\n    \"AgentMachineId\": 10,\n    \"DisplayName\": \"test-1\",\n    \"AuthMethod\": \"PUBLIC_KEY\",\n    \"UserName\": \"root\",\n    \"Port\": 36000,\n    \"Labels\": [\n        {\n            \"Key\": \"testKey\",\n            \"Value\": \"testValue\"\n        }\n    ],\n    \"Ips\": [\n        \"127.0.0.1\"\n    ]\n}"},"ModifyCdPipeline":{"summary":"CD 部署流程修改","category":"11-持续部署相关接口","description":"✨ CD 部署流程修改","params":[{"name":"PipelineConfigId","type":"string","required":true,"description":"部署流程 ID"},{"name":"PipelineJsonContent","type":"string","required":true,"description":"部署流程 JSON 配置"}],"response":[{"name":"Data","type":"ModifyCdPipelineResponseData","required":false,"description":"修改部署流程响应数据"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: ModifyCdPipeline\n<公共请求参数>\n\n{\n    \"PipelineConfigId\": \"c2b76217-ba5e-4032-abbe-888765b73db4\",\n    \"PipelineJsonContent\": \"{\\\"keepWaitingPipelines\\\":false,\\\"lastModifiedBy\\\":\\\"coding\\\",\\\"roles\\\":[\\\"团队管理员\\\",\\\"团队所有者\\\"],\\\"index\\\":0,\\\"triggers\\\":[],\\\"relationProjects\\\":[],\\\"limitConcurrent\\\":true,\\\"application\\\":\\\"test\\\",\\\"codingNickname\\\":\\\"coding\\\",\\\"name\\\":\\\"hello\\\",\\\"stages\\\":[{\\\"name\\\":\\\"等待\\\",\\\"refId\\\":\\\"1\\\",\\\"requisiteStageRefIds\\\":[],\\\"type\\\":\\\"wait\\\",\\\"waitTime\\\":5}],\\\"id\\\":\\\"c2b76217-ba5e-4032-abbe-888765b73db4\\\",\\\"updateTs\\\":\\\"1612421444090\\\"}\"\n}"},"ReorderCdPipelines":{"summary":"部署流程重排序","category":"11-持续部署相关接口","description":"✨ 部署流程重排序","params":[{"name":"Application","type":"string","required":true,"description":"CD 应用名"},{"name":"PipelineIdsIndices","type":"Array of PipelineIdIndex","required":true,"description":"部署流程排序列表"}],"response":[{"name":"Data","type":"ReorderCdPipelinesResponseData","required":false,"description":"CD 任务执行记录数据"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: ReorderCdPipelines\n<公共请求参数>\n\n{\n  \t\"Application\": \"test\",\n    \"PipelineIdsIndices\": [\n        {\n            \"PipelineId\": \"44653f6a-77a6-4243-88a0-81dbfb5047df\",\n            \"Index\": 0\n        },\n        {\n            \"PipelineId\": \"c30edba0-e0dc-45df-bc81-4126fbe20dc5\",\n            \"Index\": 1\n        }\n    ]\n}"},"TriggerCdPipeline":{"summary":"部署流程触发","category":"11-持续部署相关接口","description":"✨ 部署流程触发","params":[{"name":"Application","type":"string","required":true,"description":"CD 应用名"},{"name":"PipelineNameOrId","type":"string","required":true,"description":"部署流程名称或 ID"},{"name":"TriggerJsonContent","type":"string","required":true,"description":"触发参数 JSON 配置"}],"response":[{"name":"Data","type":"TriggerCdPipelineResponseData","required":false,"description":"部署流程执行记录数据"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: TriggerCdPipeline\n<公共请求参数>\n\n{\n    \"Application\": \"test\",\n    \"PipelineNameOrId\": \"test\",\n    \"TriggerJsonContent\": \"{\\\"buildNumber\\\":\\\"\\\",\\\"type\\\":\\\"manual\\\",\\\"dryRun\\\":false,\\\"user\\\":\\\"coding\\\"}\"\n}"},"CreateArtifactCredit":{"summary":"制品授信清单创建","category":"12-制品仓库相关接口","description":"✨ 制品授信清单创建","params":[{"name":"Ranges","type":"Array of ArtifactsOpenApiCreateArtifactCreditsRangeData","required":true,"description":"授信清单适用范围"},{"name":"Enabled","type":"boolean","required":true,"description":"是否启用"},{"name":"Rules","type":"Array of ArtifactsOpenApiArtifactCreditsRuleData","required":true,"description":"授信规则"},{"name":"Name","type":"string","required":true,"description":"授信清单名称"}],"response":[{"name":"ArtifactCreditId","type":"string","required":false,"description":"授信清单ID"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write"},"CreateArtifactProperties":{"summary":"制品属性新增（指定版本）","category":"12-制品仓库相关接口","description":"✨ 制品属性新增（指定版本）","params":[{"name":"Package","type":"string","required":true,"description":"包名"},{"name":"PackageVersion","type":"string","required":true,"description":"版本号"},{"name":"ProjectId","type":"integer (uint64)","required":true,"description":"项目 ID"},{"name":"PropertySet","type":"Array of ArtifactPropertyBean","required":true,"description":"属性列表"},{"name":"Repository","type":"string","required":true,"description":"仓库名"}],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: CreateArtifactProperties\n<公共请求参数>\n\n{\n    \"ProjectId\": 1, \n    \"Repository\": \"maven\", \n    \"Package\": \"com.demo:LocalTest\", \n    \"PackageVersion\": \"2.0\",\n    \"PropertySet\": [\n        {\n            \"Name\": \"demo\",\n            \"Value\": \"demo\"\n        }\n    ]\n}"},"CreateArtifactRepository":{"summary":"制品仓库创建","category":"12-制品仓库相关接口","description":"✨ 制品仓库创建","params":[{"name":"AccessLevel","type":"integer (uint64)","required":false,"description":"仓库权限范围:1-项目内;2-团队内;3-公开，默认：1-项目内"},{"name":"AllowProxy","type":"boolean (bool)","required":false,"description":"是否开启代理，仅支持当 Type 为 3-maven;4-npm; 5-PyPI;7-composer;10-cocoapods 时可为 true，默认：false"},{"name":"Description","type":"string","required":false,"description":"仓库描述信息"},{"name":"ProjectId","type":"integer (uint64)","required":true,"description":"项目 ID"},{"name":"RepositoryName","type":"string","required":true,"description":"仓库名称"},{"name":"Type","type":"integer (uint64)","required":true,"description":"仓库类型:1-generic;2-docker;3-maven;4-npm;5-pypi;6-helm;7-composer;8-nuget;9-conan;10-cocoapods;11-rpm"}],"response":[{"name":"Id","type":"integer (uint64)","required":false,"description":"创建成功的仓库 ID"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"https://coding.example.com/?Action=CreateArtifactRepository\n&ProjectId=1\n&RepositoryName=dockerhub\n&Type=2\n&Description=dockerhub\n&AccessLevel=1\n&AllowProxy=false\n&<公共请求参数>"},"DeleteArtifactProperties":{"summary":"制品属性删除","category":"12-制品仓库相关接口","description":"✨ 删除指定版本制品的指定制品属性","params":[{"name":"Package","type":"string","required":true,"description":"包名"},{"name":"PackageVersion","type":"string","required":true,"description":"版本号"},{"name":"ProjectId","type":"integer (uint64)","required":true,"description":"项目 ID"},{"name":"PropertyNameSet","type":"Array of string","required":true,"description":"属性名称列表（ 以 ‘coding.’ 作为属性名称开头的属性，将不可删除）"},{"name":"Repository","type":"string","required":true,"description":"仓库名"}],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"destructive","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DeleteArtifactProperties\n<公共请求参数>\n\n{\n    \"ProjectId\": 1, \n    \"Repository\": \"maven\", \n    \"Package\": \"com.demo:LocalTest\", \n    \"PackageVersion\": \"2.0\",\n    \"PropertyNameSet\": [\n        \"name1\", \n        \"name2\"\n    ]\n}"},"DescribeArtifactChecksums":{"summary":"制品Checksum列表查询","category":"12-制品仓库相关接口","description":"✨ 制品Checksum列表查询","params":[{"name":"Package","type":"string","required":true,"description":"包名"},{"name":"PackageVersion","type":"string","required":true,"description":"版本号"},{"name":"ProjectId","type":"integer (uint64)","required":true,"description":"项目 ID"},{"name":"Repository","type":"string","required":true,"description":"仓库名"}],"response":[{"name":"InstanceSet","type":"Array of ArtifactChecksum","required":false,"description":"制品Checksum列表"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeArtifactChecksums\n<公共请求参数>\n\n{\n    \"ProjectId\": 1, \n    \"Repository\": \"maven\", \n    \"Package\": \"com.demo:LocalTest\", \n    \"PackageVersion\": \"2.0\"\n}"},"DescribeArtifactCredit":{"summary":"查询制品授信清单详情","category":"12-制品仓库相关接口","description":"✨ 通过授信清单ID查询制品授信清单详情","params":[{"name":"ArtifactCreditId","type":"integer (int64)","required":true,"description":"授信清单ID"}],"response":[{"name":"ArtifactCredit","type":"ArtifactsOpenApiArtifactCreditsData","required":false,"description":"授信清单详情"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read"},"DescribeArtifactCreditList":{"summary":"制品授信清单列表查询","category":"12-制品仓库相关接口","description":"✨ 制品授信清单列表查询","params":[],"response":[{"name":"InstanceSet","type":"Array of ArtifactsOpenApiArtifactCreditsData","required":false,"description":"授信清单列表"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read"},"DescribeArtifactFileDownloadUrl":{"summary":"制品文件临时下载链接获取","category":"12-制品仓库相关接口","description":"✨ 制品文件临时下载链接获取","params":[{"name":"FileName","type":"string","required":true,"description":"文件名称"},{"name":"Package","type":"string","required":true,"description":"包名"},{"name":"PackageVersion","type":"string","required":true,"description":"版本号"},{"name":"ProjectId","type":"integer (uint64)","required":true,"description":"项目 ID"},{"name":"Repository","type":"string","required":true,"description":"仓库名"},{"name":"Timeout","type":"integer (uint64)","required":false,"description":"下载链接超时时间（单位：秒），默认：300"}],"response":[{"name":"Url","type":"string","required":false,"description":"临时下载链接"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeArtifactFileDownloadUrl\n<公共请求参数>\n\n{\n    \"ProjectId\": 1, \n    \"Repository\": \"maven\", \n    \"Package\": \"com.demo:LocalTest\", \n    \"PackageVersion\": \"2.0\", \n    \"FileName\": \"LocalTest-2.0-sources.jar\",\n    \"Timeout\": 600\n}"},"DescribeArtifactPackageList":{"summary":"制品包（镜像）列表查询","category":"12-制品仓库相关接口","description":"✨ 制品包（镜像）列表查询","params":[{"name":"PackagePrefix","type":"string","required":false,"description":"包名前缀"},{"name":"PageNumber","type":"integer (uint64)","required":false,"description":"页码，默认：1"},{"name":"PageSize","type":"integer (uint64)","required":false,"description":"每页展示数量，默认：10"},{"name":"ProjectId","type":"integer (uint64)","required":true,"description":"项目 ID"},{"name":"Repository","type":"string","required":true,"description":"仓库名称"}],"response":[{"name":"Data","type":"ArtifactPackagePageBean","required":false,"description":"返回数据"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeArtifactPackageList\n<公共请求参数>\n\n{\n  \"ProjectId\": 1,\n  \"PageNumber\": 1,\n  \"PageSize\": 10,\n  \"Repository\": \"docker\",\n  \"PackagePrefix\": \"folder/\"\n}"},"DescribeArtifactProperties":{"summary":"制品属性列表查询","category":"12-制品仓库相关接口","description":"✨ 指定制品版本的制品属性列表查询","params":[{"name":"Package","type":"string","required":true,"description":"包名"},{"name":"PackageVersion","type":"string","required":true,"description":"版本号"},{"name":"ProjectId","type":"integer (uint64)","required":true,"description":"项目 ID"},{"name":"Repository","type":"string","required":true,"description":"仓库名"}],"response":[{"name":"InstanceSet","type":"Array of ArtifactProperty","required":false,"description":"制品属性列表"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeArtifactProperties\n<公共请求参数>\n\n{\n    \"ProjectId\": 1, \n    \"Repository\": \"maven\", \n    \"Package\": \"com.demo:LocalTest\", \n    \"PackageVersion\": \"2.0\"\n}"},"DescribeArtifactRepositoryFileList":{"summary":"制品仓库下可下载的文件列表获取","category":"12-制品仓库相关接口","description":"✨ 制品仓库下可下载的文件列表获取","params":[{"name":"Artifacts","type":"Array of SpecifiedArtifact","required":false,"description":"指定的制品"},{"name":"ContinuationToken","type":"string","required":false,"description":"翻页符。每次 list 操作会返回 ContinuationToken，在下一次 list 传入该值，即可接续上次 list 内容进行 list，最后一页该字段为空"},{"name":"PageSize","type":"integer (uint64)","required":false,"description":"每页展示条数"},{"name":"Project","type":"string","required":true,"description":"项目名称"},{"name":"Repository","type":"string","required":true,"description":"仓库名"}],"response":[{"name":"Data","type":"ArtifactRepositoryFileListData","required":false,"description":"返回数据体"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeArtifactRepositoryFileList\n<公共请求参数>\n\n{\n    \"Project\": \"project\", \n    \"Repository\": \"maven\", \n    \"ContinuationToken\": \"5e739c1e1f8bdb20cdb0db2ab2215903\", \n    \"PageSize\": 1000,\n    \"Artifacts\": [\n        {\n             \"PackageName\": \"demo\",\n             \"VersionName\": \"latest\"\n        }\n    ]\n}"},"DescribeArtifactRepositoryList":{"summary":"制品仓库列表查询","category":"12-制品仓库相关接口","description":"✨ 查询当前团队指定项目的制品仓库列表","params":[{"name":"PageNumber","type":"integer (uint64)","required":false,"description":"页码，默认：1"},{"name":"PageSize","type":"integer (uint64)","required":false,"description":"每页展示数量，默认：10"},{"name":"ProjectId","type":"integer (uint64)","required":true,"description":"项目 ID"},{"name":"Type","type":"integer (int64)","required":false,"description":"仓库类型:1-generic;2-docker;3-maven;4-npm;5-pypi;6-helm;7-composer;8-nuget;9-conan;10-cocoapods;11-rpm"}],"response":[{"name":"Data","type":"ArtifactRepositoryPageBean","required":false,"description":"返回数据"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeArtifactRepositoryList\n<公共请求参数>\n\n{\n  \"ProjectId\": 1,\n  \"PageNumber\": 1,\n  \"PageSize\": 10,\n  \"Type\": 1\n}"},"DescribeArtifactVersionFileList":{"summary":"制品版本可下载的文件列表获取","category":"12-制品仓库相关接口","description":"✨ 制品版本可下载的文件列表获取（暂仅支持类型为: 1-Generic;3-maven;4-npm;5-pypi 制品）","params":[{"name":"Maven","type":"Maven","required":false,"description":"maven 制品类型参数"},{"name":"Package","type":"string","required":true,"description":"包名"},{"name":"PackageVersion","type":"string","required":true,"description":"版本号"},{"name":"ProjectId","type":"integer (uint64)","required":true,"description":"项目 ID"},{"name":"Repository","type":"string","required":true,"description":"仓库名"}],"response":[{"name":"InstanceSet","type":"Array of ArtifactVersionFileBean","required":false,"description":"文件列表"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeArtifactVersionFileList\n<公共请求参数>\n\n{\n    \"Maven\": {\n        \"Packaging\": \"jar\", \n        \"Classifier\": \"source\"\n    }, \n    \"ProjectId\": 1, \n    \"Repository\": \"maven\", \n    \"Package\": \"com.demo:LocalTest\", \n    \"PackageVersion\": \"2.0\"\n}"},"DescribeArtifactVersionList":{"summary":"制品版本列表查询","category":"12-制品仓库相关接口","description":"✨ 制品版本列表查询","params":[{"name":"Package","type":"string","required":true,"description":"包名称"},{"name":"PageNumber","type":"integer (uint64)","required":false,"description":"页码，默认：1"},{"name":"PageSize","type":"integer (uint64)","required":false,"description":"每页展示数量，默认：10"},{"name":"ProjectId","type":"integer (uint64)","required":true,"description":"项目 ID"},{"name":"Repository","type":"string","required":true,"description":"仓库名称"}],"response":[{"name":"Data","type":"ArtifactVersionPageBean","required":false,"description":"返回数据"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeArtifactVersionList\n<公共请求参数>\n\n{\n  \"ProjectId\": 1,\n  \"Repository\": \"docker\",\n  \"Package\": \"centos\",\n  \"PageNumber\": 1,\n  \"PageSize\": 10\n}"},"DescribeTeamArtifacts":{"summary":"制品列表查询","category":"12-制品仓库相关接口","description":"✨ 制品列表查询","params":[{"name":"PageNumber","type":"integer (int64)","required":false,"description":"页码，默认：1"},{"name":"PageSize","type":"integer (int64)","required":false,"description":"每页展示数量，默认：10"},{"name":"Rule","type":"ArtifactFilterRule","required":false,"description":"筛选规则（数组之间筛选关系为and，数组之内筛选关系为or）"}],"response":[{"name":"Data","type":"TeamArtifactPage","required":false,"description":"分页列表"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeTeamArtifacts\n<公共请求参数>\n\n{\n    \"PageNumber\":1,\n    \"PageSize\":10,\n    \"Rule\":{\n        \"ArtifactType\":[\n            1\n        ],\n        \"ProjectName\":[\n            \"test\"\n        ],\n        \"Repository\":[\n            \"g1\"\n        ],\n        \"Package\":[\n            {\n                \"Algorithm\":\"EQUAL\",\n                \"Value\":\"1\"\n            },\n            {\n                \"Algorithm\":\"REGEX\",\n                \"Value\":\"\\\\d+\"\n            }\n        ],\n        \"PackageVersion\":[\n            {\n                \"Algorithm\":\"EQUAL\",\n                \"Value\":\"latest\"\n            },\n            {\n                \"Algorithm\":\"REGEX\",\n                \"Value\":\"\\\\d+\"\n            }\n        ]\n    }\n}"},"ForbiddenArtifactVersion":{"summary":"制品版本下载 禁止、解禁","category":"12-制品仓库相关接口","description":"✨ 制品版本下载 禁止、解禁","params":[{"name":"ForbiddenAction","type":"string","required":true,"description":"FORBIDDEN 禁止下载，UNFORBIDDEN 解除禁止下载"},{"name":"ForbiddenNote","type":"string","required":false,"description":"禁止下载说明"},{"name":"Package","type":"string","required":true,"description":"包名"},{"name":"PackageVersion","type":"string","required":true,"description":"版本号"},{"name":"ProjectId","type":"integer (uint64)","required":true,"description":"项目 ID"},{"name":"Repository","type":"string","required":true,"description":"仓库名"}],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: ForbiddenArtifactVersion\n<公共请求参数>\n\n{\n    \"ProjectId\": 1, \n    \"Repository\": \"maven\", \n    \"Package\": \"com.demo:LocalTest\", \n    \"PackageVersion\": \"2.0\",\n    \"ForbiddenAction\": \"FORBIDDEN\",\n    \"ForbiddenNote\": \"未通过质量红线\"\n}"},"ModifyArtifactCredit":{"summary":"制品授信清单修改","category":"12-制品仓库相关接口","description":"✨ 制品授信清单修改","params":[{"name":"Ranges","type":"Array of ArtifactsOpenApiCreateArtifactCreditsRangeData","required":true,"description":"授信清单范围"},{"name":"Enabled","type":"boolean","required":true,"description":"是否启用"},{"name":"Id","type":"integer (int64)","required":true,"description":"授信清单ID"},{"name":"Rules","type":"Array of ArtifactsOpenApiArtifactCreditsRuleData","required":true,"description":"授信清单规则"},{"name":"Name","type":"string","required":true,"description":"授信清单名称"}],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write"},"ModifyArtifactProperties":{"summary":"制品属性修改","category":"12-制品仓库相关接口","description":"✨ 指定版本制品的制品属性修改","params":[{"name":"Package","type":"string","required":true,"description":"包名"},{"name":"PackageVersion","type":"string","required":true,"description":"版本号"},{"name":"ProjectId","type":"integer (uint64)","required":true,"description":"项目 ID"},{"name":"PropertySet","type":"Array of ArtifactPropertyBean","required":true,"description":"属性列表"},{"name":"Repository","type":"string","required":true,"description":"仓库名"}],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: ModifyArtifactProperties\n<公共请求参数>\n\n{\n    \"ProjectId\": 1, \n    \"Repository\": \"maven\", \n    \"Package\": \"com.demo:LocalTest\", \n    \"PackageVersion\": \"2.0\",\n    \"PropertySet\": [\n        {\n            \"Name\": \"demo\",\n            \"Value\": \"demo\"\n        }\n    ]\n}"},"ReleaseArtifactVersion":{"summary":"制品版本发布","category":"12-制品仓库相关接口","description":"✨ 将指定版本的制品的发布状态调整为已发布","params":[{"name":"Package","type":"string","required":true,"description":"包名"},{"name":"PackageVersion","type":"string","required":true,"description":"版本号"},{"name":"ProjectId","type":"integer (uint64)","required":true,"description":"项目 ID"},{"name":"Repository","type":"string","required":true,"description":"仓库名"}],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: ReleaseArtifactVersion\n<公共请求参数>\n\n{\n    \"ProjectId\": 1, \n    \"Repository\": \"maven\", \n    \"Package\": \"com.demo:LocalTest\", \n    \"PackageVersion\": \"2.0\"\n}"},"CreateUploadToken":{"summary":"上传文件的Token获取","category":"13-Wiki 相关接口","description":"✨ 获取上传文件的Token，成功后使用uploadLink 上传文件(ex:https://coding-net-test-self-1257242599.cos.ap-shanghai.myqcloud.com/b5d0d8e0-3aca-11eb-8673-a9b6d94ca755.png)","params":[{"name":"FileName","type":"string","required":true,"description":"文件名"},{"name":"ProjectName","type":"string","required":true,"description":"项目名称"}],"response":[{"name":"Token","type":"Token","required":false,"description":"Token信息"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: CreateUploadToken\n<公共请求参数>\n\n{\n  \"ProjectName\":\"demo-project\",\n  \"FileName\":\"filename.zip\"\n}"},"CreateWiki":{"summary":"Wiki创建","category":"13-Wiki 相关接口","description":"✨ Wiki创建","params":[{"name":"Content","type":"string","required":true,"description":"Wiki内容"},{"name":"Msg","type":"string","required":false,"description":"备注"},{"name":"ParentIid","type":"integer (int64)","required":true,"description":"父级iid"},{"name":"ProjectName","type":"string","required":true,"description":"项目名称"},{"name":"Title","type":"string","required":true,"description":"Wiki标题"}],"response":[{"name":"Data","type":"WikiData","required":false,"description":"Wiki详细数据"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: CreateWiki\n<公共请求参数>\n\n{\n  \"ProjectName\":\"demo-project\",\n  \"Title\":\"Title\",\n  \"Content\":\"内容\",\n  \"ParentIid\":0,\n  \"Msg\":\"提交说明\"\n}"},"CreateWikiByZip":{"summary":"Wiki 通过zip包上传","category":"13-Wiki 相关接口","description":"✨ 通过zip包上传wiki","params":[{"name":"AuthToken","type":"string","required":true,"description":"验证文件的token"},{"name":"FileName","type":"string","required":true,"description":"文件名"},{"name":"Key","type":"string","required":true,"description":"上传文件的uuid名称 b5d0d8e0-3aca-11eb-8673-a9b6d94ca755.png"},{"name":"ParentIid","type":"integer (int64)","required":true,"description":"父级iid"},{"name":"ProjectName","type":"string","required":true,"description":"项目名称"},{"name":"Time","type":"integer (uint64)","required":true,"description":"获取token的时间"}],"response":[{"name":"JobId","type":"string","required":false,"description":"zip上传wiki 的任务id"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: CreateWikiByZip\n<公共请求参数>\n\n{\n  \"ProjectName\":\"demo-project\",\n  \"FileName\":\"filename.zip\",\n  \"Key\":\"9fc310d0-3837-11eb-bca5-bd71c937c060.zip\",\n  \"Time\":1605247760074,\n  \"AuthToken\":\"5b3848e2dfa921e183a071df84aa513d2018031b4df6786dfa7a214a9db855b1\",\n  \"ParentIid\": 0\n}"},"DeleteWiki":{"summary":"Wiki 移至回收站","category":"13-Wiki 相关接口","description":"✨ 删除Wiki至回收站","params":[{"name":"Iid","type":"integer (int64)","required":true,"description":"wiki编号"},{"name":"ProjectName","type":"string","required":true,"description":"项目名称"}],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"destructive","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DeleteWiki\n<公共请求参数>\n\n{\n  \"ProjectName\":\"demo-project\",\n  \"Iid\":1\n}"},"DescribeImportJobStatus":{"summary":"zip包创建wiki的任务状态查询","category":"13-Wiki 相关接口","description":"✨ 通过zip包创建wiki任务状态查询","params":[{"name":"JobId","type":"string","required":true,"description":"任务Id"},{"name":"ProjectName","type":"string","required":true,"description":"项目名称"}],"response":[{"name":"Data","type":"WikiJobStatus","required":false,"description":"导入wiki状态"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeImportJobStatus\n<公共请求参数>\n\n{\n  \"ProjectName\":\"demo-project\",\n  \"JobId\":\"asdaqweqsdaddsdsadsa\"\n}"},"DescribeUpdateJobStatus":{"summary":"zip包更新wiki的任务状态查询","category":"13-Wiki 相关接口","description":"✨ 通过zip包更新wiki任务状态查询","params":[{"name":"JobId","type":"string","required":true,"description":"任务Id"},{"name":"ProjectName","type":"string","required":true,"description":"项目名称"}],"response":[{"name":"Data","type":"WikiJobStatus","required":false,"description":"导入wiki的状态"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeUpdateJobStatus\n<公共请求参数>\n\n{\n  \"ProjectName\":\"demo-project\",\n  \"JobId\":\"asdaqweqsdaddsdsadsa\"\n}"},"DescribeWiki":{"summary":"Wiki 详情获取","category":"13-Wiki 相关接口","description":"✨ 获取Wiki详情","params":[{"name":"Iid","type":"integer (int64)","required":true,"description":"wiki编号"},{"name":"ProjectName","type":"string","required":true,"description":"项目名称"},{"name":"VersionId","type":"integer (int64)","required":true,"description":"版本号"}],"response":[{"name":"Data","type":"WikiData","required":false,"description":"Wiki的具体信息"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeWiki\n<公共请求参数>\n\n{\n  \"ProjectName\":\"demo-project\",\n  \"Iid\":1,\n  \"VersionId\":1\n}"},"DescribeWikiList":{"summary":"Wiki 列表详情获取","category":"13-Wiki 相关接口","description":"✨ 获取Wiki列表详情","params":[{"name":"ProjectName","type":"string","required":true,"description":"项目名称"}],"response":[{"name":"Data","type":"Array of WikiListData","required":false,"description":"wiki列表数据"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeWikiList\n<公共请求参数>\n\n{\n  \"ProjectName\":\"demo-project\"\n}"},"ModifyWiki":{"summary":"Wiki 更新","category":"13-Wiki 相关接口","description":"✨ 更新Wiki","params":[{"name":"Content","type":"string","required":true,"description":"内容"},{"name":"Iid","type":"integer (int64)","required":true,"description":"wiki编号"},{"name":"Msg","type":"string","required":false,"description":"备注"},{"name":"ProjectName","type":"string","required":true,"description":"项目名称"},{"name":"Title","type":"string","required":true,"description":"标题"}],"response":[{"name":"Data","type":"WikiData","required":false,"description":"Wiki详情"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: ModifyWiki\n<公共请求参数>\n\n{\n  \"ProjectName\":\"demo-project\",\n  \"Title\":\"Title\",\n  \"Content\":\"内容\",\n  \"Iid\":1,\n  \"Msg\":\"提交说明\"\n}"},"ModifyWikiByZip":{"summary":"通过zip包更新wiki","category":"13-Wiki 相关接口","description":"✨ 通过zip包更新wiki","params":[{"name":"AuthToken","type":"string","required":true,"description":"验证文件的token"},{"name":"FileName","type":"string","required":true,"description":"文件名"},{"name":"Iid","type":"integer (int64)","required":true,"description":"wiki的Iid"},{"name":"Key","type":"string","required":true,"description":"上传文件的uuid名称 b5d0d8e0-3aca-11eb-8673-a9b6d94ca755.png"},{"name":"ProjectName","type":"string","required":true,"description":"项目名称"},{"name":"Time","type":"integer (uint64)","required":true,"description":"获取token的时间"}],"response":[{"name":"JobId","type":"string","required":false,"description":"zip上传wiki 的任务id"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: ModifyWikiByZip\n<公共请求参数>\n\n{\n  \"ProjectName\":\"demo-project\",\n  \"FileName\":\"filename.zip\",\n  \"Key\":\"9fc310d0-3837-11eb-bca5-bd71c937c060.zip\",\n  \"Time\":1605247760074,\n  \"AuthToken\":\"5b3848e2dfa921e183a071df84aa513d2018031b4df6786dfa7a214a9db855b1\",\n  \"Iid\": 1\n}"},"ModifyWikiOrder":{"summary":"Wiki 父级修改","category":"13-Wiki 相关接口","description":"✨ 修改wiki父级","params":[{"name":"After","type":"integer (int64)","required":false,"description":"在第几层级之后"},{"name":"Before","type":"integer (int64)","required":false,"description":"在第几层级之前"},{"name":"Forced","type":"boolean (bool)","required":false,"description":"是否检查权限,默认false"},{"name":"Iid","type":"integer (int64)","required":true,"description":"wiki Iid"},{"name":"ParentIid","type":"integer (int64)","required":true,"description":"父级 Iid"},{"name":"ProjectName","type":"string","required":true,"description":"项目名称"}],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: ModifyWikiOrder\n<公共请求参数>\n\n{\n  \"ProjectName\":\"demo-project\",\n  \"ParentIid\":0,\n  \"Iid\":1\n}"},"ModifyWikiTitle":{"summary":"Wiki 标题更新","category":"13-Wiki 相关接口","description":"✨ Wiki 标题更新","params":[{"name":"Iid","type":"integer (int64)","required":true,"description":"wiki 编号"},{"name":"ProjectName","type":"string","required":true,"description":"项目名称"},{"name":"Title","type":"string","required":true,"description":"wiki 标题"}],"response":[{"name":"Data","type":"WikiData","required":false,"description":"Wiki详情"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: ModifyWikiTitle\n<公共请求参数>\n\n{\n  \"ProjectName\":\"demo-project\",\n  \"Title\":\"Title\",\n  \"Iid\":1\n}"},"CreateFile":{"summary":"文件创建","category":"14-文件网盘相关接口","description":"✨ \"\n   文件上传\n  \n    1. 获取预签名URL\n    \n    Action： 固定为 DescribePreSignUploadUrl\n  ProjectName: 项目名称\n  ContentType: 内容类型，和web端的文件上传时content-type是一样的。可以参考web端上传文件时，Http Header: Content-Type\n  FolderType :文件夹类型，0: 常规文件夹, 1:隐藏文件夹。 如果是用于项目协同上传附件的场景，配置为1；如果是上传到文件网盘则配置为0。\n  FolderId:  若上传项目协同附件场景时，不需要配置或默认为0即可。若用于上传到文件网盘，可以设置文件夹ID, 用于文件存放位置，ID值通过  open api 【创建文件夹】获取。\n  FileName: 保存的文件名。\n    POST http://coding.example.com/open-api\n  Accept: application/json\n  Authorization: token 79dfe***\n    {\n      \"Action\":\"DescribePreSignUploadUrl\",\n      \"ProjectName\":\"zhishiguanli\",\n      \"FolderId\":0,\n      \"FolderType\":1,\n      \"FileName\": \"20220727_1.csv\",\n      \"ContentType\": \"image/jpeg\"\n    }\n  \n  响应数据:\n  UploadLink: 上传文件的URL\n  StorageKey: 上传到存储的文件路径\n  AuthToken: 用于校验身份数据的token，后续接口中使用\n  headers: 上传时需要的token信息\n    \n    ```\n    {\n      \"Response\": {\n        \"RequestId\": \"99b1fbfb-8477-44b3-b19f-35acbcdbdf77\",\n        \"Data\": {\n          \"UploadLink\": \"https://coding-net-production-file-1257242599.cos.ap-shanghai.myqcloud.com/c69883ec-4ae6-45eb-a28d-b73dcfa83d02.csv?sign=q-sign-algorithm%3Dsha1%26q-ak%3DAKID7B14xvfnJxWtNpV95c1sAqIwms4_GnHMa-eCuULWfvXWTqp0qv8czbirX1BlXEXd%26q-sign-time%3D1661352589%3B1661354389%26q-key-time%3D1661352589%3B1661354389%26q-header-list%3Dhost%26q-url-param-list%3D%26q-signature%3D337c3118dd1385d33f5ada4c0492755ac7d00419\",\n          \"StorageKey\": \"c69883ec-4ae6-45eb-a28d-b73dcfa83d02.csv\",\n          \"Headers\": \"{\\\"x-cos-security-token\\\":\\\"0ZVlbeAyb6cqcbI2HcZg75xppfMACLPac9f0c5517a5d13d9731b0adb708c2ecdhK1-UdtMEqc-XpsQW5v1bB1BGeHXMlwutOM24SaUfX6lSP531QDfVrKJzLl8-NpCgKZfUE_-_Pg29lfqSvWpbd0D-4pENoBL5IDhkXO1RmmDncvxbwm_aMGRMlPL3YwQEyjPGv8KJ36ZUDm1k5ERnKYf2_OllQtoW5lSeRRnvCQUd7cAvvzSIl6WD-VxXJ2N9jX5Z_bh6B9zFXtCWjr0is550-QaLSM32V0NP0wPV4bBy9PwNLA32gxhsf24dfUZZsBZZVF67lfFGWgcK7SuZRrE_QPiEd9L4et-4KxBj4pXsAxCTWmATrcAonNq6xJ-\\\"}\",\n          \"AuthToken\": \"819321faa15086676c9c474b8823d6ce67aa4ec907a4e8a37fa396f990bd610c\"\n        }\n      }\n    }\n    ```\n    \n    \n    \n    \n    2. 上传文件CreateFile\n    这个步骤需要客户端自己完成。\n    上传URL 可以参考 项目协同中描述内容中的上传文件的 COS URL。\n    \n    2.1 COS上传\n  参考脚本如下:\n  #!/bin/bash\n    \n    file=本地文件路径\n    storageKey=返回的StorageKey\n    url=https://域名/${storageKey}\n    \n    \n    # 腾讯云COS上传 curl, 注意Authorization值为sign参数，经过urldecode转化后的值。x-cos-security-token 使用 响应中的Headers中返回的值，\n    \n    curl -X PUT \"${url}\" \\\n    -H 'Authorization:q-sign-algorithm=sha1&q-ak=AKIDr0xilQrTFEUhvpLvJ9Ro3Ds_REhKTtYv-dXFbNBY8w1aDZR7rpUNPq6hXn_SdANN&q-sign-time=1661351394;1661353194&q-key-time=1661351394;1661353194&q-header-list=host&q-url-param-list=&q-signature=2574959eebb2ddf7dd5e6e19f30126c7a63cec58' \\\n    -H 'x-cos-security-token:0ZVlbeAyb6cqcbI2HcZg75xppfMACLPaba476ee7278aba618b8794dcf090c81fhK1-UdtMEqc-XpsQW5v1bHRl8XcitKZd-0CGmDfln5OqFJigfAursov8MRS8h_abNT0Bns7F7D5tN26wXra6oBlvhxZ4wU11Zk2peuDXq4eWSUWOCtvf-3IaxoCs2KEwMtSFcds1byn_00Zj2YxG8ajHQrVT6Gtry9PW3ULfNe-YPpWaX_XArXpoyjWuaXpBjIFvEhR5sB0gGSTtyXhf9S6wWJAisNlwvOls5xAdnNRHJWyt8Td_f-Lc6yYIXV-aD9ZoGyl5NEQcxEip7GQRtb-p8QD9MG_rfYsJiQ0blMGQQGzexo7YHRhRTws6dlXU' \\\n    -H 'user-agent:tencentcloud-cos-postman' \\\n    -H 'cosclientagent:cos_mc_v4' \\\n    -H 'cosclientip:219.136.173.47' -T \"${file}\"\n    \n    \n    \n    2.2 minio上传\n    minio 上传脚本DEMO如下：\n    bucket=file-storage\n    file='～/Downloads/测试简单格式1.md (2).zip'\n    \n    # 测试导入1.zip\n    \n    storageKey=c5318506-8807-4612-9ad8-d751c863983d.zip\n    s3_key=***\n    s3_secret=***\n    host=minio.nh51daup.dev.coding.io\n    \n    resource=\"/${bucket}/${storageKey}\"\n    \n    # content_type=\"application/octet-stream\"\n    \n    content_type=\"application/zip\"\n    date=`date -R`\n    _signature=\"PUT\\n\\n${content_type}\\n${date}\\n${resource}\"\n    signature=`echo -en ${_signature} | openssl sha1 -hmac ${s3_secret} -binary | base64`\n    \n    # minio文件上传 curl 命令\n    \n    curl -X PUT -T \"${file}\" \\\n  -H \"Host: ${host}\" \\\n  -H \"Date: ${date}\" \\\n  -H \"Content-Type: ${content_type}\" \\\n  -H \"Authorization: AWS ${s3_key}:${signature}\" \\\n    http://${host}${resource}\n    \n    3. 保存文件\n  StorageKey: 获取预签名URL接口返回的 StorageKey\n  AuthToken: 获取预签名URL接口返回的 AuthToken\n    \n    POST http://coding.example.com/open-api\n  Accept: application/json\n  Authorization: token 79dfe1d**ab\n    \n    {\n      \"Action\":\"CreateFile\",\n      \"StorageKey\": \"2bdb7eea-57b4-495d-a5d0-67446822cea5.csv\",\n      \"AuthToken\": \"76ee1e30ef6df0552f0bd939f1f0359510d60d1806028f5c64fa31c116cf3f22\"\n    }\n  \n  \n  响应数据格式:\n  Id: 保存后的文件ID。\n  Name: 保存后的文件名称\n    \n    ```\n    {\n      \"Response\": {\n        \"RequestId\": \"9958d6b7-ead6-4674-9ae8-21cd3054282b\",\n        \"Data\": {\n          \"Id\": 28909581,\n          \"Name\": \"20220727_1.csv\"\n        }\n      }\n    }\n    ```\n    \n    \n    \n    4. 创建事项DEMO\n    更详细参数说明参考open api文档\n  ProjectName: 项目名称\n    Name： 事项名称\n  FileIds: 数组类型，CreateFile 后响应的ID列表\n    \n    \n    POST http://coding.example.com/open-api\n  Accept: application/json\n  Authorization: token 79dfe1d9e53a2**e0ddc57ab\n    \n    ```\n    {\n      \"Action\":\"CreateIssue\",\n      \"ProjectName\":\"zhishiguanli\",\n      \"Type\":\"DEFECT\",\n      \"Name\":\"需求清221101\",\n      \"Priority\":\"0\",\n      \"FileIds\":[28909581]\n    }\n    ```\n    \n    \n    4.1 项目协同需求描述图片同步方案\n    \n    ## 方案一\n    \n    需求系统在通过 OpenAPI 写入 CODING 需求时，通过正则方式提取所有图片，调用 CODING OpenAPI 上传图片到文件网盘，再替换需求内图片地址。\n    方案前提：\n    需求系统展示需求数据来源客户需求系统。\n    具体步骤：\n    \n    1. 需求系统创建或更新图片时，调用 COIDNG 项目协同创建或编辑 OpenAPI\n    2. 获取需求系统需求描述\n    3. 正则提取图片地址\n    4. 调用 CODING OpenAPI 上传图片到文件网盘，获取到文件 ID\n    5. 通过文件 ID 和项目 ID 拼接成 CODING 图片相对地址，/api/project/{projectId}/files/{imageFileId}/imagePreview\n    6. 保存到 CODING 系统前，通过字符替换原图片地址为/api/project/{projectId}/files/{imageFileId}/imagePreview\n    7. 完成\n    \n    ## 方案二\n    \n    CODING 侧在项目协同 OpenAPI 创建或者编辑需求时，将外站图片地址转存（或者不过滤）。\n    \n    ## 结论\n    \n    方案一，无需依赖 CODING 更新，可直接开始。\n    方案二，需要依赖 CODING 更新，正在评估预计时间。\n    \n    5. 创建文件夹\n    该接口可用于文件网盘中创建文件夹。\n  ProjectName: 项目名称\n  FoldName: 文件夹名称\n  ParentId: 父文件夹ID,如果是根路径，传 0。\n    POST http://coding.example.com/open-api\n  Accept: application/json\n  Authorization: token 79dfe1d9**a6e0ddc57ab\n    \n    ```\n    {\n      \"Action\":\"CreateFolder\",\n      \"ProjectName\":\"zhishiguanli\",\n      \"FoldName\": \"Hello-sub-test-1\",\n      \"ParentId\": 0\n    }\n    ```\n    \n    响应：\n    \n    ```\n    {\n      \"Response\": {\n        \"RequestId\": \"e48d9d36-7473-4fac-b005-6fdc46afa69f\",\n        \"Data\": {\n          \"Id\": 28909737,\n          \"Name\": \"Hello-sub-test-1\"\n        }\n      }\n    }\n    ```\n    \n\n\"","params":[{"name":"AuthToken","type":"string","required":true,"description":"获取预签名URL接口返回的 AuthToken"},{"name":"StorageKey","type":"string","required":true,"description":"获取预签名URL接口返回的 StorageKey"}],"response":[{"name":"Data","type":"ApiFileFile","required":false,"description":"文件信息"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: CreateFile\n<公共请求参数>\n\n{\n  \"StorageKey\": \"2bdb7eea-57b4-495d-a5d0-67446822cea5.csv\",\n  \"AuthToken\": \"76ee1e30ef6df0552f0bd939f1f0359510d60d1806028f5c64fa31c116cf3f22\"\n}"},"CreateFolder":{"summary":"文件夹创建","category":"14-文件网盘相关接口","description":"✨ 文件夹创建","params":[{"name":"FoldName","type":"string","required":true,"description":"文件夹名"},{"name":"ParentId","type":"integer (int64)","required":true,"description":"父文件夹ID"},{"name":"ProjectName","type":"string","required":true,"description":"项目名"}],"response":[{"name":"Data","type":"ApiFileFolder","required":false,"description":"文件夹信息"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: CreateFolder\n<公共请求参数>\n\n{\n  \"FoldName\": \"个人资料\",\n  \"ParentId\": 0,\n  \"ProjectName\": \"coding\"\n}"},"DescribePreSignUploadUrl":{"summary":"预签名URL获取","category":"14-文件网盘相关接口","description":"✨ 预签名信息获取，上传文件","params":[{"name":"ContentType","type":"string","required":true,"description":"内容类型，和web端的文件上传时content-type是一样的"},{"name":"FileName","type":"string","required":true,"description":"文件名"},{"name":"FolderId","type":"integer (int64)","required":true,"description":"若上传项目协同附件场景时，不需要配置或默认为0即可。若用于上传到文件网盘，可以设置文件夹ID, 用于文件存放位置，ID值通过open api【创建文件夹】获取"},{"name":"FolderType","type":"integer (int64)","required":true,"description":"文件夹类型，0: 常规文件夹, 1:隐藏文件夹。 如果是用于项目协同上传附件的场景，配置为1；如果是上传到文件网盘则配置为0。"},{"name":"ProjectName","type":"string","required":true,"description":"项目名称"}],"response":[{"name":"Data","type":"ApiFilePreSignUploadUrlData","required":false,"description":"上传信息"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribePreSignUploadUrl\n<公共请求参数>\n\n{\n    \"ProjectName\":\"zhishiguanli\",\n    \"FolderId\":0,\n    \"FolderType\":1,\n    \"FileName\": \"20220727_1.csv\",\n    \"ContentType\": \"image/jpeg\"\n}"},"ArchiveTestRun":{"summary":"测试计划归档","category":"15-测试管理相关接口","description":"✨ 测试计划归档","params":[{"name":"ProjectName","type":"string","required":true,"description":"项目名称"},{"name":"RunId","type":"integer (uint64)","required":true,"description":"计划 ID"}],"response":[{"name":"Data","type":"RunData","required":false,"description":"测试计划信息"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"destructive","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: ArchiveTestRun\n<公共请求参数>\n\n{\n  \"ProjectName\":\"project name\",\n  \"RunId\":1\n}"},"CreateAttachmentPrepareSignUrl":{"summary":"附件预上传信息生成","category":"15-测试管理相关接口","description":"✨ 生成附件预上传信息","params":[{"name":"FileName","type":"string","required":true,"description":"文件名"},{"name":"ProjectName","type":"string","required":true,"description":"项目名称"}],"response":[{"name":"Data","type":"AttachmentPrepareData","required":false,"description":"附件预上传信息"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: CreateAttachmentPrepareSignUrl\n<公共请求参数>\n\n{\n  \"ProjectName\":\"project name\",\n  \"FileName\":\"xx\"\n}"},"CreateCaseResult":{"summary":"测试用例添加测试结果","category":"15-测试管理相关接口","description":"✨ 测试用例添加测试结果","params":[{"name":"CaseId","type":"integer (uint64)","required":true,"description":"测试任务 ID"},{"name":"CustomStepStatus","type":"Array of string","required":false,"description":"每一步的测试结果（步骤用例时需要本参数）"},{"name":"ProjectName","type":"string","required":true,"description":"项目名称"},{"name":"RunId","type":"integer (uint64)","required":true,"description":"测试计划 ID"},{"name":"Status","type":"string","required":true,"description":"该任务的测试结果，可选值：UNTESTED:未测试,PASSED:通过,BLOCKED:阻塞,RETEST:重测,FAILED:失败"}],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: CreateCaseResult\n<公共请求参数>\n\n{\n  \"ProjectName\":\"project-demo\",\n  \"RunId\":110,\n  \"CaseId\":110,\n  \"Status\": \"PASSED\",\n  \"CustomStepStatus\":[\n    \"PASSED\"    \n  ]\n}"},"CreateReport":{"summary":"测试报告创建","category":"15-测试管理相关接口","description":"✨ 创建测试报告","params":[{"name":"AttachmentIds","type":"Array of integer","required":false,"description":"附件 ID 数组：来自“生成附件预上传信息”接口"},{"name":"Name","type":"string","required":true,"description":"测试报告标题"},{"name":"ProjectName","type":"string","required":true,"description":"项目名称"},{"name":"RunIds","type":"Array of integer","required":true,"description":"测试计划 ID 数组"}],"response":[{"name":"Data","type":"ReportLittleData","required":false,"description":"测试报告信息"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: CreateReport\n<公共请求参数>\n\n\n{\n  \"ProjectName\":\"project name\",\n  \"Name\":\"run demo\",\n  \"RunIds\":[\n    1,2\n  ]\n}"},"CreateTestCase":{"summary":"测试用例创建","category":"15-测试管理相关接口","description":"✨ 测试用例创建","params":[{"name":"AttachmentIds","type":"Array of integer","required":false,"description":"附件 ID 数组：来自“生成附件预上传信息”接口"},{"name":"CustomSteps","type":"Array of CustomStep","required":false,"description":"自定义步骤（步骤用例必填）"},{"name":"Expected","type":"string","required":false,"description":"预期结果 （适用于文本用例）"},{"name":"Preconds","type":"string","required":false,"description":"前置步骤"},{"name":"Priority","type":"integer (uint64)","required":false,"description":"优先级，默认2（中），可选值：0（紧急）,1（高）,2（中）,3（低）"},{"name":"ProjectName","type":"string","required":true,"description":"项目名称"},{"name":"SectionId","type":"integer (uint64)","required":true,"description":"分组ID"},{"name":"Steps","type":"string","required":false,"description":"文本描述（适用于文本用例）"},{"name":"TemplateType","type":"string","required":true,"description":"用例类型，可选值：STEPS(步骤用例)，TEXT(文本用例)"},{"name":"Title","type":"string","required":true,"description":"用例标题"}],"response":[{"name":"Data","type":"CaseDataSpecial","required":false,"description":"测试用例信息"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: CreateTestCase\n<公共请求参数>\n\n{\n  \"ProjectName\":\"2\",\n  \"TemplateType\": \"STEPS\", \n  \"SectionId\": 1, \n  \"Title\":\"helel\",\n   \"Priority\": 1, \n  \"Preconds\":\"preconds\",\n  \"Steps\":\"Steps\",\n  \"Expected\":\"expected\",\n  \"CustomSteps\":[\n    {\n      \"Content\":\"expected\",\n      \"Expected\":\"steps\"\n    },\n    {\n      \"Content\":\"expected\",\n      \"Expected\":\"steps\"\n    }\n  ]\n}"},"CreateTestCaseSection":{"summary":"测试用例分组创建","category":"15-测试管理相关接口","description":"✨ 测试用例分组创建","params":[{"name":"CaseDepotId","type":"integer (uint64)","required":false,"description":"用例库ID"},{"name":"Name","type":"string","required":true,"description":"分组名称"},{"name":"ParentId","type":"integer (uint64)","required":false,"description":"父级 ID，默认 0"},{"name":"ProjectName","type":"string","required":true,"description":"项目名称"}],"response":[{"name":"Data","type":"SectionData","required":false,"description":"分组信息"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: CreateTestCaseSection\n<公共请求参数>\n\n{\n  \"ProjectName\":\"项目名称\",\n  \"Name\": \"分组名称\", \n  \"ParentId\": 1,\n  \"CaseDepotId\": 512\n}"},"CreateTestDefect":{"summary":"测试任务关联缺陷","category":"15-测试管理相关接口","description":"✨ 测试任务关联缺陷","params":[{"name":"DefectId","type":"integer (uint64)","required":true,"description":"缺陷 ID"},{"name":"ProjectName","type":"string","required":true,"description":"项目名称"},{"name":"TestId","type":"integer (uint64)","required":true,"description":"测试任务 ID"}],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: CreateTestDefect\n<公共请求参数>\n\n{\n    \"ProjectName\": \"xx\", \n    \"DefectId\": 1, \n    \"TestId\": 1\n}"},"CreateTestResult":{"summary":"测试任务添加测试结果","category":"15-测试管理相关接口","description":"✨ 测试任务添加测试结果","params":[{"name":"CustomStepStatus","type":"Array of string","required":false,"description":"每一步的测试结果（步骤用例时需要本参数）"},{"name":"ProjectName","type":"string","required":true,"description":"项目名称"},{"name":"Status","type":"string","required":true,"description":"该任务的测试结果，可选值：UNTESTED:未测试,PASSED:通过,BLOCKED:阻塞,RETEST:重测,FAILED:失败"},{"name":"TestId","type":"integer (uint64)","required":true,"description":"测试任务 ID"}],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: CreateTestResult\n<公共请求参数>\n\n{\n  \"ProjectName\":\"project-demo\",\n  \"TestId\":110,\n  \"Status\": \"PASSED\",\n  \"CustomStepStatus\":[\n    \"PASSED\"    \n  ]\n}"},"CreateTestResults":{"summary":"测试任务状态批量更新","category":"15-测试管理相关接口","description":"✨ 测试任务状态批量更新","params":[{"name":"CaseIds","type":"Array of integer","required":true,"description":"测试用例 ID 数组"},{"name":"ProjectName","type":"string","required":true,"description":"项目名称"},{"name":"RunId","type":"integer (uint64)","required":true,"description":"测试计划 ID"},{"name":"Status","type":"string","required":true,"description":"测试状态：UNTESTED:未测试,PASSED:通过,BLOCKED:阻塞,RETEST:重测,FAILED:失败"}],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: CreateTestResults\n<公共请求参数>\n\n\n{\n    \"ProjectName\": \"xx\", \n    \"RunId\":1,\n    \"CaseIds\": [\n        1\n    ],\n   \"Status\": \"xx\"\n}"},"CreateTestRun":{"summary":"测试计划创建","category":"15-测试管理相关接口","description":"✨ 测试计划创建","params":[{"name":"AssignedToId","type":"integer (uint64)","required":false,"description":"处理人 ID"},{"name":"Cases","type":"Array of integer","required":false,"description":"包含的用例 ID 列表，IncludeAll=false 必填"},{"name":"ConfigEnvironmentId","type":"integer (uint64)","required":false,"description":"环境标识"},{"name":"Description","type":"string","required":false,"description":"描述"},{"name":"ExecuteType","type":"integer (uint64)","required":false,"description":"执行类型：1-手动执行 2-自动化流水线执行"},{"name":"GitDepotId","type":"integer (uint64)","required":false,"description":"项目代码库 ID"},{"name":"GitReleaseId","type":"integer (uint64)","required":false,"description":"发布版本 ID"},{"name":"IncludeAll","type":"boolean (bool)","required":true,"description":"是否包含全部用例"},{"name":"Name","type":"string","required":true,"description":"标题"},{"name":"ProjectName","type":"string","required":true,"description":"项目名称"},{"name":"SectionId","type":"integer (int64)","required":false,"description":"分组 ID"}],"response":[{"name":"Data","type":"RunData","required":false,"description":"测试计划信息"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: CreateTestRun\n<公共请求参数>\n\n\n{\n  \"ProjectName\":\"project name\",\n  \"Name\":\"run demo\",\n  \"IncludeAll\":false,\n  \"Cases\":[\n    1,2\n  ]\n}"},"CreateTestStepResult":{"summary":"测试任务添加某步骤的测试结果","category":"15-测试管理相关接口","description":"✨ 测试任务添加某步骤的测试结果","params":[{"name":"Actual","type":"string","required":false,"description":"该步骤的实际测试结果"},{"name":"ProjectName","type":"string","required":true,"description":"项目名称"},{"name":"Status","type":"string","required":false,"description":"该任务的测试结果，可选值：UNTESTED:未测试,PASSED:通过,BLOCKED:阻塞,RETEST:重测,FAILED:失败"},{"name":"StepIndex","type":"integer (uint64)","required":true,"description":"步骤的索引顺序，起始值为 1"},{"name":"StepStatus","type":"string","required":true,"description":"该步骤的测试结果，可选值：PASSED:通过,FAILED:失败"},{"name":"TestId","type":"integer (uint64)","required":true,"description":"测试任务 ID"}],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: CreateTestStepResult\n<公共请求参数>\n\n{\n  \"ProjectName\":\"demo-project\",\n  \"TestId\":2,\n  \"StepIndex\":2,\n  \"StepStatus\":\"FAILED\",\n  \"Actual\":\"Actual\",\n  \"Status\":\"PASSED\"\n}"},"DeleteReport":{"summary":"测试报告删除","category":"15-测试管理相关接口","description":"✨ 测试报告删除","params":[{"name":"ProjectName","type":"string","required":true,"description":"项目名称"},{"name":"ReportId","type":"integer (uint64)","required":true,"description":"测试报告 ID"}],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"destructive","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DeleteReport\n<公共请求参数>\n\n\n{\n  \"ProjectName\":\"project name\",\n  \"ReportId\":1\n}"},"DeleteTestCase":{"summary":"测试用例删除","category":"15-测试管理相关接口","description":"✨ 测试用例删除","params":[{"name":"CaseId","type":"integer (uint64)","required":true,"description":"用例 ID"},{"name":"ProjectName","type":"string","required":true,"description":"项目名称"}],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"destructive","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DeleteTestCase\n<公共请求参数>\n\n{\n  \"CaseId\":1,\n  \"ProjectName\":\"2\"\n}"},"DeleteTestCaseSection":{"summary":"测试用例分组删除","category":"15-测试管理相关接口","description":"✨ 测试用例分组删除","params":[{"name":"ProjectName","type":"string","required":true,"description":"项目名称"},{"name":"SectionId","type":"integer (uint64)","required":true,"description":"分组 ID"}],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"destructive","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DeleteTestCaseSection\n<公共请求参数>\n\n{\n  \"ProjectName\":\"2\",\n  \"SectionId\":1\n}"},"DeleteTestRun":{"summary":"测试计划删除","category":"15-测试管理相关接口","description":"✨ 测试计划删除","params":[{"name":"ProjectName","type":"string","required":true,"description":"项目名称"},{"name":"RunId","type":"integer (uint64)","required":true,"description":"计划 ID"}],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"destructive","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DeleteTestRun\n<公共请求参数>\n\n{\n  \"ProjectName\":\"project name\",\n  \"RunId\":1\n}"},"DescribeReport":{"summary":"测试报告详情","category":"15-测试管理相关接口","description":"✨ 测试报告详情","params":[{"name":"ProjectName","type":"string","required":true,"description":"项目名称"},{"name":"ReportId","type":"integer (uint64)","required":true,"description":"测试报告 ID"}],"response":[{"name":"Data","type":"ReportData","required":false,"description":"测试报告信息"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeReport\n<公共请求参数>\n\n\n{\n  \"ProjectName\":\"project name\",\n  \"ReportId\": 1\n}"},"DescribeReportList":{"summary":"测试报告列表","category":"15-测试管理相关接口","description":"✨ 测试报告列表","params":[{"name":"EndAt","type":"string","required":false,"description":"创建时间"},{"name":"Keyword","type":"string","required":false,"description":"报告名称关键词"},{"name":"ProjectName","type":"string","required":true,"description":"项目名称"},{"name":"StartAt","type":"string","required":false,"description":"创建时间"},{"name":"Status","type":"string","required":false,"description":"报告状态：CREATING 创建中，AVAILABLE 可用，UNAVAILABLE 不可用"}],"response":[{"name":"Data","type":"ReportsLittleData","required":false,"description":"测试报告信息"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeReportList\n<公共请求参数>\n\n\n{\n  \"ProjectName\":\"project name\"\n}"},"DescribeRequirementTestCaseList":{"summary":"需求关联的测试用例列表","category":"15-测试管理相关接口","description":"✨ 需求关联的测试用例列表","params":[{"name":"IssueId","type":"integer (uint64)","required":true,"description":"需求 ID"},{"name":"ProjectName","type":"string","required":true,"description":"项目名称"}],"response":[{"name":"Data","type":"CasesData","required":false,"description":"测试用例列表"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeRequirementTestCaseList\n<公共请求参数>\n\n{\n    \"ProjectName\": \"xx\", \n    \"IssueId\": 1\n}"},"DescribeTest":{"summary":"测试任务详情","category":"15-测试管理相关接口","description":"✨ 测试任务详情","params":[{"name":"ProjectName","type":"string","required":true,"description":"项目名称"},{"name":"TestId","type":"integer (uint64)","required":false,"description":"测试任务 ID"}],"response":[{"name":"Data","type":"TestData","required":false,"description":"测试任务列表"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeTest\n<公共请求参数>\n\n{\n    \"ProjectName\": \"xx\", \n    \"TestId\": 1\n}"},"DescribeTestCase":{"summary":"测试用例详情","category":"15-测试管理相关接口","description":"✨ 测试用例详情","params":[{"name":"CaseId","type":"integer (uint64)","required":true,"description":"用例 ID"},{"name":"ProjectName","type":"string","required":true,"description":"项目名称"}],"response":[{"name":"Data","type":"CaseData","required":false,"description":"测试用例信息"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeTestCase\n<公共请求参数>\n\n{\n  \"CaseId\":1,\n  \"ProjectName\":\"2\"\n}"},"DescribeTestCaseList":{"summary":"测试用例列表","category":"15-测试管理相关接口","description":"✨ 测试用例分页数据","params":[{"name":"Keyword","type":"string","required":false,"description":"关键字搜索"},{"name":"Priority","type":"integer (uint64)","required":false,"description":"优先级，默认2（中），可选值：0（紧急）,1（高）,2（中）,3（低）"},{"name":"ProjectName","type":"string","required":true,"description":"项目名称"},{"name":"SectionId","type":"integer (uint64)","required":false,"description":"分组 ID"},{"name":"TemplateType","type":"string","required":false,"description":"用例类型，可选值：STEPS(步骤用例)，TEXT(文本用例)"},{"name":"Page","type":"integer (int64)","required":false,"description":"页码"},{"name":"PageSize","type":"integer (int64)","required":false,"description":"分页大小"}],"response":[{"name":"Data","type":"CasesDataSchema","required":false,"description":"测试用例分页数据"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeTestCaseList\n<公共请求参数>\n\n{\n    \"Priority\": 1, \n    \"ProjectName\": \"xx\", \n    \"TemplateType\": \"xx\", \n    \"Keyword\": \"xx\", \n    \"SectionId\": 1\n}"},"DescribeTestCaseSectionList":{"summary":"测试用例分组列表","category":"15-测试管理相关接口","description":"✨ 测试用例分组列表","params":[{"name":"ParentId","type":"integer (uint64)","required":false,"description":"父级 ID，默认 0"},{"name":"ProjectName","type":"string","required":true,"description":"项目名称"}],"response":[{"name":"Data","type":"SectionsData","required":false,"description":"分组信息"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeTestCaseSectionList\n<公共请求参数>\n\n{\n  \"ProjectName\":\"项目名称\",\n  \"ParentId\": 1\n}"},"DescribeTestDefectList":{"summary":"测试任务关联的缺陷列表","category":"15-测试管理相关接口","description":"✨ 测试任务关联的缺陷列表","params":[{"name":"ProjectName","type":"string","required":true,"description":"项目名称"},{"name":"TestId","type":"integer (uint64)","required":false,"description":"测试任务 ID"}],"response":[{"name":"Data","type":"TestDefectsData","required":false,"description":"测试任务关联的缺陷列表"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action:DescribeTestDefectList\n<公共请求参数>\n\n{\n    \"ProjectName\": \"xx\", \n    \"TestId\": 1\n}"},"DescribeTestList":{"summary":"测试任务列表","category":"15-测试管理相关接口","description":"✨ 测试任务列表","params":[{"name":"Priority","type":"integer (uint64)","required":false,"description":"优先级"},{"name":"ProjectName","type":"string","required":true,"description":"项目名称"},{"name":"RunId","type":"integer (uint64)","required":false,"description":"测试计划 ID"},{"name":"Status","type":"string","required":false,"description":"测试状态,UNTESTED:未测试,PASSED:通过,BLOCKED:阻塞,RETEST:重测,FAILED:失败"}],"response":[{"name":"Data","type":"TestsData","required":false,"description":"测试任务列表"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeTestList\n<公共请求参数>\n\n{\n    \"ProjectName\": \"xx\", \n    \"Priority\": 1, \n    \"Status\": \"xx\",\n    \"RunId\": 1\n}"},"DescribeTestRun":{"summary":"测试计划详情","category":"15-测试管理相关接口","description":"✨ 测试计划详情","params":[{"name":"ProjectName","type":"string","required":true,"description":"项目名称"},{"name":"RunId","type":"integer (uint64)","required":true,"description":"计划 ID"}],"response":[{"name":"Data","type":"RunData","required":false,"description":"测试计划信息"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeTestRun\n<公共请求参数>\n\n{\n  \"ProjectName\":\"project name\",\n  \"RunId\":1\n}"},"DescribeTestRunList":{"summary":"测试计划列表","category":"15-测试管理相关接口","description":"✨ 测试计划列表","params":[{"name":"ExecuteType","type":"integer (uint64)","required":false,"description":"执行方式: 1-手动执行 2-自动化流水线执行"},{"name":"GitReleaseState","type":"integer (uint64)","required":false,"description":"发布版本状态：0-未发布 1-已发布（与参数IterationId、IterationStatus、SectionId互斥）"},{"name":"IsCompleted","type":"boolean (bool)","required":false,"description":"是否已经归档"},{"name":"IterationId","type":"Array of integer","required":false,"description":"迭代 ID（与参数IterationStatus、GitReleaseState、SectionId互斥）"},{"name":"IterationStatus","type":"Array of string","required":false,"description":"迭代状态: WAIT_PROCESS、PROCESSING、COMPLETED（与参数IterationId、GitReleaseState、SectionId互斥）"},{"name":"Keyword","type":"string","required":false,"description":"计划名称"},{"name":"ProjectName","type":"string","required":true,"description":"项目名称"},{"name":"SectionId","type":"integer (int64)","required":false,"description":"分组 ID（与参数IterationId、IterationStatus、GitReleaseState互斥）"},{"name":"State","type":"integer (uint64)","required":false,"description":"状态: 0-未开始 1-进行中 2-已测完"}],"response":[{"name":"Data","type":"RunsData","required":false,"description":"测试计划列表"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribeTestRunList\n<公共请求参数>\n\n{\n  \"ProjectName\":\"project name\"\n}"},"ModifyTestCase":{"summary":"测试用例修改","category":"15-测试管理相关接口","description":"✨ 测试用例修改","params":[{"name":"AttachmentIds","type":"Array of integer","required":false,"description":"附件 ID 数组：来自“生成附件预上传信息”接口"},{"name":"CaseId","type":"integer (uint64)","required":true,"description":"用例 ID"},{"name":"CustomSteps","type":"Array of CustomStep","required":false,"description":"自定义步骤（步骤用例必填）"},{"name":"Expected","type":"string","required":false,"description":"预期结果（适用于文本用例）"},{"name":"Preconds","type":"string","required":false,"description":"前置步骤"},{"name":"Priority","type":"integer (uint64)","required":false,"description":"优先级，默认2（中），可选值：0（紧急）,1（高）,2（中）,3（低）"},{"name":"ProjectName","type":"string","required":true,"description":"项目名称"},{"name":"SectionId","type":"integer (uint64)","required":true,"description":"分组ID"},{"name":"Steps","type":"string","required":false,"description":"文本描述（适用于文本用例）"},{"name":"TemplateType","type":"string","required":true,"description":"用例类型，可选值：STEPS(步骤用例)，TEXT(文本用例)"},{"name":"Title","type":"string","required":true,"description":"用例标题"}],"response":[{"name":"Data","type":"CaseData","required":false,"description":"测试用例信息"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: ModifyTestCase\n<公共请求参数>\n\n{\n  \"CaseId\": 1, \n  \"ProjectName\":\"2\",\n  \"TemplateType\": \"STEPS\", \n  \"SectionId\": 1, \n  \"Title\":\"helel\",\n   \"Priority\": 1, \n  \"Preconds\":\"preconds\",\n  \"Steps\":\"Steps\",\n  \"Expected\":\"expected\",\n  \"CustomSteps\":[\n    {\n      \"Content\":\"expected\",\n      \"Expected\":\"steps\"\n    },\n    {\n      \"Content\":\"expected\",\n      \"Expected\":\"steps\"\n    }\n  ]\n}"},"ModifyTestCaseSection":{"summary":"测试用例分组修改","category":"15-测试管理相关接口","description":"✨ 测试用例分组修改","params":[{"name":"Name","type":"string","required":true,"description":"分组名称"},{"name":"ParentId","type":"integer (uint64)","required":false,"description":"父级 ID，默认 0"},{"name":"ProjectName","type":"string","required":true,"description":"项目名称"},{"name":"SectionId","type":"integer (uint64)","required":true,"description":"分组 ID"}],"response":[{"name":"Data","type":"SectionData","required":false,"description":"分组信息"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: ModifyTestCaseSection\n<公共请求参数>\n\n{\n  \"ProjectName\":\"项目名称\",\n  \"SectionId\":1,\n  \"Name\": \"分组名称\", \n  \"ParentId\": 1\n}"},"ModifyTestRun":{"summary":"测试计划修改","category":"15-测试管理相关接口","description":"✨ 测试计划修改","params":[{"name":"AssignedToId","type":"integer (uint64)","required":false,"description":"处理人 ID"},{"name":"Cases","type":"Array of integer","required":false,"description":"包含的用例 ID 列表，IncludeAll=false 必填"},{"name":"ConfigEnvironmentId","type":"integer (uint64)","required":false,"description":"环境标识"},{"name":"Description","type":"string","required":false,"description":"描述"},{"name":"ExecuteType","type":"integer (uint64)","required":false,"description":"执行类型：1-手动执行 2-自动化流水线执行"},{"name":"GitDepotId","type":"integer (uint64)","required":false,"description":"项目代码库 ID"},{"name":"GitReleaseId","type":"integer (uint64)","required":false,"description":"发布版本 ID"},{"name":"IncludeAll","type":"boolean (bool)","required":false,"description":"是否包含全部用例"},{"name":"Name","type":"string","required":false,"description":"标题"},{"name":"ProjectName","type":"string","required":true,"description":"项目名称"},{"name":"RunId","type":"integer (uint64)","required":true,"description":"计划 ID"},{"name":"SectionId","type":"integer (int64)","required":false,"description":"分组 ID"}],"response":[{"name":"Data","type":"RunData","required":false,"description":"测试计划信息"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: ModifyTestRun\n<公共请求参数>\n\n{\n  \"ProjectName\":\"project name\",\n  \"Name\":\"run demo\",\n  \"RunId\":1,\n  \"IncludeAll\":false,\n  \"Cases\":[\n    1,2\n  ]\n}"},"DescribePinyin":{"summary":"汉字转拼音","category":"16-其他接口","description":"✨ 汉字转拼音","params":[{"name":"Heteronym","type":"boolean","required":true,"description":"多音字"},{"name":"Style","type":"string","required":true,"description":"风格"},{"name":"Value","type":"string","required":true,"description":"汉字"}],"response":[{"name":"Data","type":"PinyinPinyinResult","required":false,"description":"返回结果"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"read","example":"POST / HTTP/1.1\nHost: coding.example.com\nContent-Type: application/json\nX-TC-Action: DescribePinyin\n<公共请求参数>\n\n{\n  \"Heteronym\": true,\n  \"Style\": \"NORMAL\",\n  \"Value\": \"学生\"\n}"},"DocumentJobCreate":{"summary":"导出事项任务创建","category":"17-导出任务接口","description":"✨ 导出事项任务创建(团队管理员或项目管理员可调用)","params":[{"name":"Event","type":"string","required":true,"description":"事件类型:PAGE_EXPORT_TO_ZIP_MD"},{"name":"EventBody","type":"string","required":true,"description":"JSON 字符串，包含 belongType（project|team|program）、belongId"}],"response":[{"name":"JobId","type":"string","required":false,"description":"任务id"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write"},"DocumentJobStart":{"summary":"启动导出任务","category":"17-导出任务接口","description":"✨ 启动导出任务","params":[{"name":"JobId","type":"string","required":true,"description":"JobId"}],"response":[{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write"},"DocumentJobStatus":{"summary":"导出任务状态","category":"17-导出任务接口","description":"✨ 导出任务状态","params":[{"name":"JobId","type":"string","required":true,"description":"JobId"}],"response":[{"name":"JobId","type":"string","required":false,"description":"任务ID"},{"name":"Status","type":"string","required":false,"description":"任务状态"},{"name":"ProcessRate","type":"object","required":false,"description":"处理进度"},{"name":"Result","type":"string","required":false,"description":"结果数据（COS中文件下载签名地址,地址有效期30分钟，30分钟后失效）"},{"name":"RequestId","type":"string","required":false,"description":"请求id"}],"errors":[],"risk":"write"}}}