go get github.com/teambition/openapi-sdk-golangpackage main
import (
"context"
openapiclient "github.com/teambition/openapi-sdk-golang"
"log"
)
var appId string = "YOU_APP_ID"
var appSecret string = "YOU_APP_SECRET"
var orgId string = "YOU_ORG_ID"
var basePath string = "https://open.teambition.com/api"
func main() {
cfg := openapiclient.NewConfiguration(appId, appSecret)
// 设置 api 地址,如果不填默认为 "https://open.teambition.com/api"
cfg.BasePath = basePath
client := openapiclient.NewAPIClient(cfg)
ctx, cancel := context.WithTimeout(context.Background(), time.Second*3)
res, httpRes, err := client.OrgAPI.GetOrgInfo(ctx).XTenantId(orgId).Execute()
log.Println(res, httpRes, err)
cancel()
}所有 URI 都相对于 https://open.teambition.com/api
| 类名 | 方法 | HTTP 请求 | 描述 |
|---|---|---|---|
| AppAPI | CheckUserVisibleInApp | Post /user/app/exists | 批量查询用户应用可见性 |
| AppAPI | GetAppAccessToken | Post /appToken | 获取应用授权Token |
| AutoflowAPI | TriggerCustomEvent | Post /autoflow/custom-event/trigger | 触发自动化自定义事件 |
| CodeAPI | CreatePlatform | Post /code/pipeline/platforms | 创建流水线源平台 |
| CodeAPI | GetPipeline | Get /code/pipeline/get/{platformId} | 根据code查询流水线 |
| CodeAPI | GetPipelinePlatform | Get /code/platform/get | 根据名称查询流水线源平台 |
| CodeAPI | GetPlatforms | Get /code/pipeline/platforms | 查询流水线源平台 |
| CodeAPI | SyncBuilds | Post /code/pipeline/platforms/{platformId}/pipelines/{pipelineId}/builds | 同步构建信息 |
| CodeAPI | SyncPipelines | Post /code/pipeline/platforms/{platformId}/pipelines | 同步流水线信息 |
| CodeAPI | UpdatePipelineParams | Post /code/pipeline/platforms/{platformId}/pipelines/{pipelineId}/buildParams | 同步流水线构建参数信息 |
| CodeAPI | UpdatePipelinePlatform | Post /code/platform/update/{platformId} | 更新流水线源平台 |
| ContactAPI | AddDepartmentMembers | Post /org/department/members | 添加部门成员 |
| ContactAPI | BatchGetOrgMembers | Post /org/member/batchGet | 批量获取企业成员 |
| ContactAPI | CountOrgMembers | Get /org/member/count | 获取企业成员数量 |
| ContactAPI | CreateDepartment | Post /org/department/create | 创建部门 |
| ContactAPI | CreateOrgRole | Post /org/organizations/{organizationId}/role/create | 创建企业角色 |
| ContactAPI | DeleteDepartment | Delete /org/department/delete | 删除部门 |
| ContactAPI | DeleteOrgMember | Post /org/member/delete | 删除企业成员 |
| ContactAPI | DisableOrgMember | Post /org/member/disable | 停用企业成员账号 |
| ContactAPI | EnableOrgMember | Post /org/member/enable | 启用企业成员账号 |
| ContactAPI | GetDepartment | Get /org/department/info | 获取部门详情 |
| ContactAPI | GetRoleInfo | Get /org/role/info | 获取角色详情 |
| ContactAPI | ListDepartmentMembers | Get /org/department/members | 获取部门成员列表 |
| ContactAPI | ListDepartments | Get /org/departments | 获取企业部门列表 |
| ContactAPI | ListOrgAdmins | Get /org/admins | 获取企业的管理员(含拥有者) |
| ContactAPI | ListOrgMembers | Get /org/member/list | 获取企业成员列表 |
| ContactAPI | ListOrgOwners | Get /org/owners | 获取企业拥有者 |
| ContactAPI | ListOrgRoles | Get /org/roles | 获取企业角色列表 |
| ContactAPI | ListSubDepartments | Get /org/departments/subDepts | 获取子部门列表 |
| ContactAPI | ListUserDepartments | Get /user/joinedDepartments | 获取用户加入的企业部门列表 |
| ContactAPI | RemoveDepartmentMembers | Delete /org/department/members | 删除部门成员 |
| ContactAPI | ResignOrgMember | Post /org/member/resignation | 离职企业成员账号 |
| ContactAPI | SearchOrgMembers | Get /org/member/search | 搜索企业成员 |
| ContactAPI | UpdateDepartment | Put /org/department/update | 更新部门信息 |
| ContactAPI | UpdateOrgMember | Put /org/member/update | 更新企业成员 |
| CustomfieldAPI | CountByCategoryV3 | Get /v3/customfield/count-by-category | 根据自定义字段分类统计自定义字段数 |
| CustomfieldAPI | CreateProjectCustomfieldV3 | Post /v3/customfield/create | 创建项目自定义字段(提交项目ID),创建企业自定义字段 |
| CustomfieldAPI | DeleteCustomfieldV3 | Post /v3/customfield/{customfieldId}/delete | 删除自定义字段,默认删除企业自定义字段,如果传递项目ID,则删除项目下自定义字段 |
| CustomfieldAPI | SearchFieldCategoriesV3 | Get /v3/customfield-category/search | 搜索企业自定义字段分类 |
| CustomfieldAPI | SearchFieldChoicesV3 | Get /v3/customfield/{customfieldId}/choice/search | 搜索层级字段选项 |
| CustomfieldAPI | SearchOrgCustomfiledV3 | Get /v3/customfield/search | 搜索企业自定义字段 |
| CustomfieldAPI | UpdateCustomfieldV3 | Put /v3/customfield/{customfieldId}/update | 更新自定义字段,默认更新企业自定义字段,如果传递项目ID,则更新项目下自定义字段 |
| CustomfieldAPI | UpdateFieldChoicesV3 | Post /v3/customfield/{customfieldId}/choice/update | 更新层级字段选项 |
| DingGroupAPI | BindProjectGroup | Post /group/bindProject | 项目关联绑定钉钉群聊 |
| DingGroupAPI | GetBindingCidByTaskId | Get /group/getBindingCidByTaskId | 通过taskId查询该任务关联的任务群Id |
| DingGroupAPI | GetBindingCidsByProjectId | Get /group/getBindingCidsByProjectId | 通过projectid查询关联的全员可见的群聊ids |
| DingGroupAPI | GetBindingProjectIdsByCid | Get /group/getBindingProjectIdsByCid | 根据群聊cid获取绑定的项目projectid |
| DingtalkAPI | BindProjectWorkspace | Post /workspace/bind-project | 绑定已有知识库 |
| DingtalkAPI | GetTaskIdsByApproveId | Get /approve/getTaskIdsByInstanceId | 通过钉钉审批实例ID反查对应任务IDs |
| DingtalkAPI | GetWorkspaceInfo | Get /workspace/query | 获取绑定知识库信息 |
| FavoritesAPI | GetV3FavoriteList | Get /v3/favorite/list | 获取收藏夹关联的主体ID |
| FileAPI | BatchGetFileDetails | Post /v3/file/query/by-resource-ids | 根据 resourceId 批量获取文件详情 |
| FileAPI | CreateFileV3 | Post /v3/work/create | 创建文件库文件 |
| FileAPI | CreateFolderV3 | Post /v3/collection/create | 创建文件夹 |
| FileAPI | CreateUploadTokenV3 | Post /v3/awos/upload-token | 创建文件上传凭证 |
| FileAPI | GetFileDetailV3 | Get /v3/work/query | 获取项目文件详情 |
| FileAPI | GetFileToken | Post /v3/file/file-token | 从现有文件资源创建 fileToken,可用于创建其他文件资源 |
| FileAPI | GetFolderDetailV3 | Get /v3/collection/query | 获取文件夹详情 |
| FileAPI | GetV3WorkActivityQuery | Get /v3/work/{workId}/activity/list | 获取文件动态 |
| FileAPI | GetV3WorkVersionQuery | Get /v3/work/{workId}/version/query | 获取文件所有版本 |
| FileAPI | ListFilesV3 | Get /v3/work/list | 获取文件列表 |
| FileAPI | MoveFileV3 | Post /v3/work/{workId}/parent | 项目内移动文件 |
| FileAPI | MoveFolderV3 | Post /v3/collection/{collectionId}/parent | 移动文件夹 |
| FileAPI | PostV3CollectionArchive | Post /v3/collection/{collectionId}/archive | 文件夹移入回收站 |
| FileAPI | PostV3CollectionDelete | Post /v3/collection/{collectionId}/delete | 删除文件夹 |
| FileAPI | PostV3WorkArchive | Post /v3/work/{workId}/archive | 文件移入回收站 |
| FileAPI | PostV3WorkInvolvememberUpdate | Post /v3/work/{workId}/involveMember/update | 修改文件参与者 |
| FileAPI | PostV3WorkMainSet | Post /v3/work/{workId}/main-version/update | 设置文件主版本 |
| FileAPI | PostV3WorkVisibleUpdate | Post /v3/work/{workId}/visible/update | 修改文件可见性 |
| FileAPI | SearchFilesV3 | Get /v3/work/search | 深度搜索项目内的文件和文件夹 |
| FileAPI | UpdateFileNameV3 | Post /v3/work/{workId}/name/update | 更新文件标题 |
| FileAPI | UpdateFileVersionV3 | Post /v3/work/{workId}/version | 更新文件版本 |
| FileAPI | UpdateFolderTitleV3 | Post /v3/collection/{collectionId}/title/update | 更新文件夹标题 |
| FileAPI | UpdateFolderVisibility | Post /v3/collection/visible/update | 更新文件夹可见性 |
| FormAPI | CreateFormRecordV3 | Post /v3/form/record/create | 创建表单记录 |
| FormAPI | GetFormProjectSpaceLinkV3 | Get /v3/form/project/link | 根据项目ID获取表单空间或根据表单空间ID获取项目ID |
| FormAPI | ListAllFormSpaceNodesV3 | Get /v3/form/node/list | 获取表单空间节点列表 |
| FormAPI | SearchFormRecordProcessNodesV3 | Get /v3/form/record/{recordId}/process/instance/node/search | 获取表单记录流程节点信息 |
| FormAPI | UpdateFormRecordFieldV3 | Post /v3/form/record/{recordId}/update | 更新表单字段值 |
| GanttAPI | CreateBaseline | Post /v3/gantt/baseline | 项目下创建甘特图基线 |
| GanttAPI | GetBaselineTasksV3 | Get /v3/gantt/baseline-task | 获取甘特图基线下的任务 |
| GanttAPI | GetBaselinesV3 | Get /v3/gantt/baseline | 获取项目下甘特图基线 |
| GanttAPI | UpdateBaseline | Put /v3/gantt/baseline | 更新项目下甘特图基线 |
| GroupAPI | AddGroupMember | Post /org/group/member/add | 添加群组成员 |
| GroupAPI | BatchGetGroupMembers | Post /org/group/member/batchGet | 批量获取群组成员 |
| GroupAPI | BatchGetGroups | Post /org/group/batchGet | 批量获取群组信息 |
| GroupAPI | CreateGroup | Post /org/group/create | 创建群组 |
| GroupAPI | DeleteGroup | Delete /org/group/delete | 删除群组 |
| GroupAPI | ListGroupMembers | Get /org/group/members | 获取群组成员列表 |
| GroupAPI | RemoveGroupMember | Delete /org/group/member/delete | 删除群组成员 |
| GroupAPI | SearchGroups | Get /org/group/search | 搜索群组 |
| GroupAPI | UpdateGroup | Put /org/group/update | 更新群组 |
| OauthAPI | GetOAuthUserInfo | Post /oauth/userInfo | 获取登录用户信息 |
| OauthAPI | GetSSOToken | Get /oauth/sso | 请求身份验证 |
| OauthAPI | GetUserAccessToken | Post /oauth/userAccessToken | 获取登录用户身份 |
| OrgAPI | GetAuditLogs | Get /audit-log/list | 获取企业审计日志 |
| OrgAPI | GetDingCorpId | Get /idmap/dingtalk/getCorpId | 查询企业绑定的钉钉 CorpId |
| OrgAPI | GetDingUserIdByTbUserId | Get /idmap/dingtalk/getDingUserId | Teambition userId 查询钉钉 userId |
| OrgAPI | GetOrgInfo | Get /org/info | 获取企业信息 |
| OrgAPI | GetTbUserIdByDingUserId | Get /idmap/dingtalk/getTbUserId | 钉钉 userId 查询 Teambition userId |
| OrgAPI | ListLicenseAllocations | Get /seat/member/allocated | 获取License名额分配列表 |
| ProgramAPI | AddProgramMembersV3 | Post /v3/program/{programId}/member/create | 批量添加成员到项目集 |
| ProgramAPI | AddProgramProjectsV3 | Post /v3/program/{programId}/project/create | 批量添加项目到项目集 |
| ProgramAPI | CreateProgramStatusCustomFieldV3 | Post /v3/program/{programId}/status/customfield/create | 更新项目集概览自定义字段值 |
| ProgramAPI | CreateProgramStatusV3 | Post /v3/program/{programId}/status/create | 创建项目集状态 |
| ProgramAPI | CreateProgramV3 | Post /v3/program/create | 创建项目集 |
| ProgramAPI | DeleteProgramStatusCustomFieldV3 | Post /v3/program/{programId}/status/customfield/delete | 删除项目集概览自定义字段 |
| ProgramAPI | DeleteProgramStatusV3 | Post /v3/program/{programId}/status/delete | 删除项目集状态 |
| ProgramAPI | DeleteProgramV3 | Post /v3/program/{programId}/delete | 删除项目集 |
| ProgramAPI | GetProgramsV3 | Get /v3/program/query | 查询项目集 |
| ProgramAPI | ListProgramMembersV3 | Get /v3/program/{programId}/member | 查询项目集内成员 |
| ProgramAPI | ListProgramProjectsV3 | Get /v3/program/{programId}/projects | 查询项目集内项目 |
| ProgramAPI | ListProgramStatusCustomFieldsV3 | Get /v3/program/{programId}/status/customfield/list | 查询项目集概览自定义字段列表 |
| ProgramAPI | ListProgramStatusesV3 | Get /v3/program/{programId}/status/list | 查询项目集状态和状态历史 |
| ProgramAPI | PostV3ProgramUpdate | Post /v3/program/{programId}/update | 更新项目集信息 |
| ProgramAPI | RemoveProgramMembersV3 | Post /v3/program/{programId}/member/delete | 批量删除项目集内的成员 |
| ProgramAPI | RemoveProgramProjectV3 | Post /v3/program/{programId}/project/{projectId}/delete | 删除项目集内的项目 |
| ProjectAPI | AddProjectGroupMemberV3 | Post /v3/project-tag/{projectTagId}/member/create | 创建项目分组成员 |
| ProjectAPI | AddProjectMembersV3 | Post /v3/project/{projectId}/member/create-v2 | 创建项目成员 v2 |
| ProjectAPI | ArchiveProjectV3 | Post /v3/project/{projectId}/archive | 项目放入回收站 |
| ProjectAPI | AssignMemberRoleV3 | Post /v3/project/{projectId}/member/role/assign | 修改项目成员的角色 |
| ProjectAPI | BatchGetProjectCustomFiledByInstanceIdsV3 | Get /v3/project/{projectId}/customfield/get-by-instance | 批量根据instanceId查询字段 |
| ProjectAPI | CompleteSprintV3 | Put /v3/project/{projectId}/sprint/{sprintId}/complete | 完成迭代 |
| ProjectAPI | CopyProjectAsyncV3 | Post /v3/project/{projectId}/copy-async | 异步复制项目 |
| ProjectAPI | CopyProjectV3 | Post /v3/project/{projectId}/copy | 复制项目 |
| ProjectAPI | CountProjectTasksV3 | Get /v3/project/{projectId}/task/count | 计数项目任务 |
| ProjectAPI | CreateBugGroup | Post /v3/project/{projectId}/bug/commongroup/create | 创建缺陷分类 |
| ProjectAPI | CreateOrgProjectRoleV3 | Post /v3/project-role/create | 创建企业后台项目角色 |
| ProjectAPI | CreateProjectFromTemplateV3 | Post /v3/project/create-from-template | 从模板创建项目 |
| ProjectAPI | CreateProjectGroupV3 | Post /v3/project-tag/create | 创建项目分组 |
| ProjectAPI | CreateProjectLinkV3 | Post /v3/project/{projectId}/objectlinks | 创建项目关联 |
| ProjectAPI | CreateProjectMemberV3 | Post /v3/project/{projectId}/member/create | 创建项目成员(弃用) |
| ProjectAPI | CreateProjectRoleV3 | Post /v3/project/{projectId}/role/create | 创建项目角色 |
| ProjectAPI | CreateProjectStatusV3 | Post /v3/project/{projectId}/status/create | 创建项目状态 |
| ProjectAPI | CreateProjectTagV3 | Post /v3/project/{projectId}/tag/create | 创建项目标签 |
| ProjectAPI | CreateProjectTemplateV3 | Post /v3/project-template/create | 创建项目模版 |
| ProjectAPI | CreateProjectV3 | Post /v3/project/create | 创建项目 |
| ProjectAPI | CreateRoleFromTemplateV3 | Post /v3/project/{projectId}/role/create-by-project-role | 引入企业后台项目角色到项目 |
| ProjectAPI | CreateSprintV3 | Post /v3/project/{projectId}/sprint/create | 创建迭代 |
| ProjectAPI | CreateStatusCustomFieldV3 | Post /v3/project/{projectId}/status/customfield/create | 更新项目概览自定义字段值 |
| ProjectAPI | CreateStoryGroup | Post /v3/project/{projectId}/story/commongroup/create | 创建需求分类 |
| ProjectAPI | CreateTaskGroupV3 | Post /v3/project/{projectId}/tasklist/create | 创建任务分组 |
| ProjectAPI | CreateTaskStageV3 | Post /v3/project/{projectId}/stage/create | 创建任务列表 |
| ProjectAPI | CreateTaskflowStatusV3 | Post /v3/project/{projectId}/taskflowstatus/create | 创建项目工作流状态 |
| ProjectAPI | CreateTaskflowV3 | Post /v3/project/{projectId}/taskflow/create | 创建项目工作流 |
| ProjectAPI | CreateTestPlan | Post /v3/project/{projectId}/testplan/create | 创建测试计划 |
| ProjectAPI | CreateTestPlanGroup | Post /v3/project/{projectId}/testplan/{testplanId}/commongroup/create | 创建测试计划分组 |
| ProjectAPI | DeleteOrgProjectRoleV3 | Post /v3/project-role/{roleId}/delete | 删除企业后台项目角色 |
| ProjectAPI | DeleteProjectGroupV3 | Delete /v3/project-tag/{projectTagId} | 删除项目分组 |
| ProjectAPI | DeleteProjectLinkV3 | Delete /v3/project/{projectId}/objectlinks/{objectlinkId} | 删除项目关联 |
| ProjectAPI | DeleteProjectMemberV3 | Post /v3/project/{projectId}/member/delete | 删除项目成员 |
| ProjectAPI | DeleteProjectRoleV3 | Post /v3/project/{projectId}/role/{roleId}/delete | 移除项目角色 |
| ProjectAPI | DeleteProjectTemplateV3 | Delete /v3/project-template/{templateId} | 删除项目模版 |
| ProjectAPI | DeleteProjectV3 | Post /v3/project/{projectId}/delete | 删除项目 |
| ProjectAPI | DeleteSprintV3 | Post /v3/project/{projectId}/sprint/{sprintId}/delete | 删除迭代 |
| ProjectAPI | DeleteStatusCustomFieldV3 | Post /v3/project/{projectId}/status/customfield/{customfieldId}/delete | 删除项目概览自定义字段(弃用) |
| ProjectAPI | DeleteTaskFlowStatusV3 | Post /v3/project/{projectId}/taskflowstatus/{tfsId}/delete | 删除项目工作流状态 |
| ProjectAPI | DeleteTaskflowV3 | Post /v3/project/{projectId}/taskflow/{taskflowId}/delete | 删除项目工作流 |
| ProjectAPI | GetAsyncJobResultV3 | Get /v3/async-job/list | 获取异步 job 执行结果 |
| ProjectAPI | GetMemberRolesV3 | Get /v3/project/{projectId}/member-role | 获取项目成员角色(包含权限穿透角色) |
| ProjectAPI | GetProjectLinksV3 | Get /v3/project/{projectId}/objectlinks | 获取项目关联列表 |
| ProjectAPI | GetProjectOrgChart | Get /v3/project/{projectId}/preference/project-team | 获取项目组织架构图 |
| ProjectAPI | GetProjectProgram | Get /v3/project/{projectId}/program/query | 查询项目所属项目集id |
| ProjectAPI | GetProjectTableCustomField | Get /v3/project/{projectId}/customfield/table | 获取项目的表格自定义字段 |
| ProjectAPI | GetProjectTagsV3 | Get /v3/project/{projectId}/project-tag | 查看项目的项目分组 |
| ProjectAPI | GetScenarioFieldsV3 | Get /v3/project/{projectId}/scenariofieldconfig/search | 获取项目任务类型 |
| ProjectAPI | GetTestCaseGroupMappings | Get /v3/project/{projectId}/testcase/commongroup-mapping | 批量获取测试用例与归属分组的对应关系 |
| ProjectAPI | InstallProjectAppV3 | Post /v3/project/{projectId}/application/{appId}/create | 安装项目应用 |
| ProjectAPI | ListBugGroups | Get /v3/project/{projectId}/bug/commongroup | 获取缺陷分类列表 |
| ProjectAPI | ListOrgProjectRolesV3 | Get /v3/project-role/list | 获取企业后台项目角色 |
| ProjectAPI | ListPrioritiesV3 | Get /v3/project/priority/list | 查询企业优先级 |
| ProjectAPI | ListProjectAppsV3 | Get /v3/project/{projectId}/application/list | 查询项目应用列表 |
| ProjectAPI | ListProjectGroupMembersV3 | Get /v3/project-tag/{projectTagId}/member/list | 获取项目分组成员列表 |
| ProjectAPI | ListProjectMembersV3 | Get /v3/project/{projectId}/member | 获取项目成员列表 |
| ProjectAPI | ListProjectRemindersV3 | Get /v3/project/{projectId}/reminder/list | 获取项目「默认任务提醒」列表 |
| ProjectAPI | ListProjectRolesV3 | Get /v3/project/{projectId}/role | 获取项目角色列表 |
| ProjectAPI | ListProjectStatusesV3 | Get /v3/project/{projectId}/status/list | 查询项目状态和状态历史 |
| ProjectAPI | ListStarredProjects | Get /v3/project-star/query | 查询用户星标项目 |
| ProjectAPI | ListStatusCustomFieldsV3 | Get /v3/project/{projectId}/status/customfield/list | 查询项目概览自定义字段列表 |
| ProjectAPI | ListStatusExecutorsV3 | Get /v3/project/{projectId}/taskflowstatus/{tfsId}/executor/list | 列出项目工作流状态流转执行角色列表 |
| ProjectAPI | ListStatusFieldGroupsV3 | Get /v3/project/{projectId}/status/field-group/list | 查询项目概览字段分组列表 |
| ProjectAPI | ListStatusValidatorsV3 | Get /v3/project/{projectId}/taskflowstatus/{tfsId}/validator/list | 列出项目工作流状态流转校验列表 |
| ProjectAPI | ListStoryGroupsV3 | Get /v3/project/{projectId}/story/commongroup | 获取需求分类列表 |
| ProjectAPI | ListTestPlanGroups | Get /v3/project/{projectId}/testplan/{testplanId}/commongroup | 获取测试计划分组列表 |
| ProjectAPI | ListTestPlans | Get /v3/project/{projectId}/testplan | 获取测试计划 |
| ProjectAPI | ListUserProjectsV3 | Get /v3/project/user-joined | 获取用户参与项目 |
| ProjectAPI | MoveTaskFlowStatusV3 | Put /v3/project/{projectId}/taskflowstatus/{tfsId}/move | 更新项目工作流状态位置 |
| ProjectAPI | QueryGroupProjects | Get /v3/project-tag/{projectTagId}/project/query | 根据项目分组 ID 查询项目 |
| ProjectAPI | QueryProjectGroupsV3 | Get /v3/project-tag/query | 查询项目分组 |
| ProjectAPI | QueryProjectsV3 | Get /v3/project/query | 查询项目 |
| ProjectAPI | QueryTestPlanGroups | Get /v3/project/{projectId}/commongroup/query | 查询测试计划分组 |
| ProjectAPI | QueryTestPlans | Get /v3/project/{projectId}/testplan/query | 查询测试计划 |
| ProjectAPI | RemoveProjectGroupMemberV3 | Post /v3/project-tag/{projectTagId}/member/delete | 删除项目分组成员 |
| ProjectAPI | RemoveStatusCustomFieldV3 | Post /v3/project/{projectId}/status/customfield/delete | 删除项目概览自定义字段 |
| ProjectAPI | RestartSprintV3 | Put /v3/project/{projectId}/sprint/{sprintId}/restart | 重新开始迭代 |
| ProjectAPI | RestoreProjectV3 | Post /v3/project/{projectId}/suspend-restore | 恢复归档项目 |
| ProjectAPI | SearchOrgTaskFlowStatusesV3 | Get /v3/tfs/search | 搜索企业工作流状态 |
| ProjectAPI | SearchProjectCustomFiledsV3 | Get /v3/project/{projectId}/customfield/search | 搜索项目自定义字段 |
| ProjectAPI | SearchProjectTagsV3 | Get /v3/project/{projectId}/tag/search | 搜索项目标签 |
| ProjectAPI | SearchProjectTasksV3 | Get /v3/project/{projectId}/task/query | 查询项目任务 |
| ProjectAPI | SearchProjectTemplatesV3 | Get /v3/project-template/search | 搜索企业项目模板 |
| ProjectAPI | SearchProjectsTQL | Get /project/search | 通过TQL搜索项目 |
| ProjectAPI | SearchSprintsV3 | Get /v3/project/{projectId}/sprint/search | 迭代搜索 |
| ProjectAPI | SearchStagesV3 | Get /v3/project/{projectId}/stage/search | 搜索任务列表 |
| ProjectAPI | SearchTaskGroupsV3 | Get /v3/project/{projectId}/tasklist/search | 搜索任务分组 |
| ProjectAPI | SearchTaskflowNodes | Get /v3/project/{projectId}/taskflow/node/search | 搜索项目工作流节点 |
| ProjectAPI | SearchTaskflowStatusesV3 | Get /v3/project/{projectId}/taskflowstatus/search | 搜索项目工作流状态 |
| ProjectAPI | SearchTaskflowsV3 | Get /v3/project/{projectId}/taskflow/search | 搜索项目工作流 |
| ProjectAPI | StarProject | Post /v3/project-star/create | 创建用户星标项目 |
| ProjectAPI | StartSprintV3 | Put /v3/project/{projectId}/sprint/{sprintId}/start | 开始迭代 |
| ProjectAPI | SuspendProjectV3 | Post /v3/project/{projectId}/suspend | 归档项目 |
| ProjectAPI | UninstallProjectAppV3 | Post /v3/project/{projectId}/application/{appId}/delete | 删除项目应用 |
| ProjectAPI | UpdateOrgProjectRoleV3 | Post /v3/project-role/{roleId} | 更新企业后台项目角色 |
| ProjectAPI | UpdateProjectCode | Put /v3/project/{projectId}/unique-id-prefix | 更新项目编号 |
| ProjectAPI | UpdateProjectCustomFieldPosition | Put /v3/project/{projectId}/customfieldLink/{customfieldLinkId}/pos | 更新项目概览自定义字段位置 |
| ProjectAPI | UpdateProjectGroupMemberPermissionV3 | Post /v3/project-tag/{projectTagId}/member/permissions/update | 更新项目分组成员权限 |
| ProjectAPI | UpdateProjectGroupV3 | Put /v3/project-tag/{projectTagId} | 修改项目分组 |
| ProjectAPI | UpdateProjectTableCustomField | Put /v3/project/{projectId}/customfield/table | 更新项目的表格自定义字段 |
| ProjectAPI | UpdateProjectTagsV3 | Put /v3/project/{projectId}/project-tag | 更新项目的项目分组 |
| ProjectAPI | UpdateProjectTemplateInfoV3 | Put /v3/project-template/{projectTemplateId} | 修改项目模板基本信息 |
| ProjectAPI | UpdateProjectV3 | Put /v3/project/{projectId} | 更新项目 |
| ProjectAPI | UpdateRolePermissionsV3 | Post /v3/project/{projectId}/role/{roleId}/permission/update | 修改项目角色的权限项 |
| ProjectAPI | UpdateSprintLabelV3 | Put /v3/project/{projectId}/sprint/{sprintId}/label/update | 迭代标签更新 |
| ProjectAPI | UpdateSprintLockV3 | Put /v3/project/{projectId}/sprint/{sprintId}/lock/update | 迭代锁定 |
| ProjectAPI | UpdateSprintPayloadV3 | Put /v3/project/{projectId}/sprint/{sprintId}/payload/update | 迭代操作限制更新 |
| ProjectAPI | UpdateSprintV3 | Put /v3/project/{projectId}/sprint/{sprintId}/update | 迭代更新 |
| ProjectAPI | UpdateStatusCustomFieldV3 | Post /v3/project/{projectId}/status/customfield/update | 更新项目概览自定义字段 |
| ProjectAPI | UpdateStatusExecutorsV3 | Post /v3/project/{projectId}/taskflowstatus/{tfsId}/executor/update | 更新项目工作流状态流转角色列表 |
| ProjectAPI | UpdateStatusFieldGroupsV3 | Put /v3/project/{projectId}/status/field-group | 更新项目概览字段分组列表 |
| ProjectAPI | UpdateStatusValidatorsV3 | Post /v3/project/{projectId}/taskflowstatus/{tfsId}/validator/update | 更新项目工作流状态流转校验列表 |
| ProjectAPI | UpdateTaskFlowRejectStatusV3 | Put /v3/project/{projectId}/taskflowstatus/{tfsId}/rejectstatus | 更新项目工作流状态流转列表 |
| ProjectAPI | UpdateTaskFlowStatusNameV3 | Put /v3/project/{projectId}/taskflowstatus/{tfsId}/name | 更新项目工作流状态名字 |
| ProjectAPI | UpdateTaskFlowStatusTypeV3 | Put /v3/project/{projectId}/taskflowstatus/{tfsId}/kind | 更新项目工作流状态 |
| ProjectAPI | UpdateTaskGroupTitleV3 | Put /v3/project/{projectId}/tasklist/{tasklistId}/title | 更新任务分组名称 |
| ProjectAPI | UpdateTaskStageNameV3 | Put /v3/project/{projectId}/stage/{stageId}/name | 更新任务列表名称 |
| ProjectAPI | UpdateTaskflowNameV3 | Put /v3/project/{projectId}/taskflow/{taskflowId}/name | 更新项目工作流 |
| ProjectAPI | UpdateTestCaseGroup | Post /v3/project/{projectId}/testcase/{testcaseId}/commongroup | 更新项目级测试用例分组 |
| ProjectplanAPI | CreatePlanApprovalV3 | Post /v3/projectplan/plans/{projectPlanId}/approve | 创建计划审批信息 |
| ProjectplanAPI | CreateProjectPlanStatusSettingV3 | Post /v3/projectplan/projects/{projectId}/planCustomStatusSetting | 配置项目级计划自定义状态信息 |
| ProjectplanAPI | DeleteV3ProjectplanScenariofieldDelete | Delete /v3/projectplan/{projectPlanId}/scenariofield/{scenariofieldId}/delete | 删除计划字段配置 |
| ProjectplanAPI | DeleteV3ProjectplanScenariofieldsDeletescenariofields | Delete /v3/projectplan/{projectPlanId}/scenariofields/{scenariofieldId}/deleteScenariofields | 删除计划字段配置 |
| ProjectplanAPI | ExecutePlanEventV3 | Put /v3/projectplan/plans/{projectPlanId}/execute/{event} | 更改计划状态(发布/变更/取消变更) |
| ProjectplanAPI | GetPlanStatusV3 | Get /v3/projectplan/plans/{projectPlanId}/status-info | 查询计划状态信息 |
| ProjectplanAPI | GetPlanV3 | Get /v3/projectplan/plans/{projectPlanId}/query | 查询计划 |
| ProjectplanAPI | GetProjectPlanStatusSettingV3 | Get /v3/projectplan/projects/{projectId}/planCustomStatusSetting | 获取项目级计划自定义状态配置 |
| ProjectplanAPI | GetV3ProjectplanListscenariofields | Get /v3/projectplan/{projectPlanId}/listScenariofields | 查询计划自定义字段 |
| ProjectplanAPI | GetV3ProjectplanListscenariofieldvalues | Get /v3/projectplan/{projectPlanId}/listScenariofieldValues | 获取字段值 |
| ProjectplanAPI | GetV3ProjectplanOperableAccessPolicyList | Get /v3/projectplan/{projectPlanId}/operable-access-policy/list | 获取当前计划可设置加锁/解锁的动作 |
| ProjectplanAPI | GetV3ProjectplanPlansList | Get /v3/projectplan/plans/{projectId}/list | 查询用户可见的计划列表 |
| ProjectplanAPI | GetV3ProjectplanScenariofieldList | Get /v3/projectplan/{projectPlanId}/scenariofield/list | 查询计划自定义字段 |
| ProjectplanAPI | GetV3ProjectplanScenariofieldValueList | Get /v3/projectplan/{projectPlanId}/scenariofield/value/list | 获取字段值 |
| ProjectplanAPI | GetV3ProjectplanTaskOperableAccessPolicyList | Get /v3/projectplan/{projectPlanId}/task/{taskId}/operable-access-policy/list | 获取当前计划任务可设置加锁/解锁的动作 |
| ProjectplanAPI | GetV3ProjectplanTaskPlansTasksSubtasks | Get /v3/projectplan-task/plans/{projectPlanId}/tasks/{taskId}/subtasks | 获取计划任务的子任务 |
| ProjectplanAPI | ListPlanMemberRolesV3 | Get /v3/projectplan/{projectPlanId}/members/list | 查询计划成员角色 |
| ProjectplanAPI | ListPlanVersionsV3 | Get /v3/projectplan/{projectPlanId}/version/list | 查询计划版本列表 |
| ProjectplanAPI | ListProjectPlanTasksLegacyV3 | Get /v3/projectplan-task/plans/{projectPlanId}/tasks | 获取计划任务列表 |
| ProjectplanAPI | ListVisiblePlansV3 | Get /v3/projectplan/projects/{projectId}/list | 查询用户可见的计划列表 |
| ProjectplanAPI | PostV3ProjectplanChangeRuleUpdate | Post /v3/projectplan/{projectPlanId}/change-rule/update | 更新计划发布规则 |
| ProjectplanAPI | PostV3ProjectplanCreatescenariofields | Post /v3/projectplan/{projectPlanId}/createScenariofields | 关联计划自定义字段 |
| ProjectplanAPI | PostV3ProjectplanProjectPlans | Post /v3/projectplan/project/{projectId}/plans | 创建计划 |
| ProjectplanAPI | PostV3ProjectplanScenariofieldUpdate | Post /v3/projectplan/{projectPlanId}/scenariofield/update | 关联计划自定义字段 |
| ProjectplanAPI | PostV3ProjectplanTaskAccessPolicyUpdate | Post /v3/projectplan/{projectPlanId}/task/{taskId}/access-policy/update | 更新计划任务加锁/解锁动作 |
| ProjectplanAPI | PostV3ProjectplanTaskPlansAddexisttasks | Post /v3/projectplan-task/plans/{projectPlanId}/addExistTasks | 将项目任务加入到计划 |
| ProjectplanAPI | PostV3ProjectplanTaskPlansTasks | Post /v3/projectplan-task/plans/{projectPlanId}/tasks | 创建计划任务 |
| ProjectplanAPI | PostV3ProjectplanTaskPlansTasksArchive | Post /v3/projectplan-task/plans/{projectPlanId}/tasks/{taskId}/archive | 删除计划任务 |
| ProjectplanAPI | PutV3ProjectplanScenariofieldValueUpdate | Put /v3/projectplan/{projectPlanId}/scenariofield/{scenariofieldId}/value/update | 更新字段值 |
| ProjectplanAPI | PutV3ProjectplanScenariofieldsUpdatescenariofieldvalue | Put /v3/projectplan/{projectPlanId}/scenariofields/{scenariofieldId}/updateScenariofieldValue | 更新字段值 |
| ProjectplanAPI | PutV3ProjectplanTaskPlansTasksExecutorid | Put /v3/projectplan-task/plans/{projectPlanId}/tasks/{taskId}/executorId | 更新计划任务执行者 |
| ProjectplanAPI | SearchProjectPlanTasksV3 | Get /v3/project/{projectId}/plan-task/search | 通过TQL搜索项目计划任务 |
| ProjectplanAPI | UpdatePlanApprovalV3 | Put /v3/projectplan/plans/{projectPlanId}/approve | 更新计划审批信息 |
| ProjectplanAPI | UpdatePlanCustomStatusV3 | Put /v3/projectplan/plans/{projectPlanId}/customStatus | 配置计划自定义状态 |
| ProjectplanAPI | UpdatePlanMemberRoleV3 | Post /v3/projectplan/plans/{projectPlanId}/members | 修改计划成员角色 |
| ProjectplanAPI | UpdateProjectPlanTaskV3 | Put /v3/projectplan-task/plans/{projectPlanId}/tasks/{taskId} | 更新计划任务(标题、开始时间、截止时间) |
| ReportAPI | SumProjectWorkTime | Post /report/project/{projectId}/statistics/worktime/total | 计算项目总工时 |
| ReportAPI | SumWorkTimeByUser | Post /report/project/{projectId}/statistics/worktime | 按人维度汇总工时 |
| SeatAPI | CreateQuotaRule | Post /seat/project/allocate | 创建名额分配规则 |
| SfcAPI | CreateSfcV3 | Post /v3/sfc/create | 创建项目任务类型(提交项目ID), 创建企业任务类型 |
| SfcAPI | DeleteSfcFieldV3 | Post /v3/sfc/{sfcId}/sf/delete | 删除项目/企业的任务类型的字段 |
| SfcAPI | DeleteSfcV3 | Post /v3/sfc/{sfcId}/delete | 删除项目任务类型(提交项目ID), 删除企业任务类型 |
| SfcAPI | SearchOrgSfcV3 | Get /v3/scenariofieldconfig/search | 搜索企业任务类型 |
| SfcAPI | UpdateSfcFieldV3 | Post /v3/sfc/{sfcId}/sf | 创建/修改 项目/企业的任务类型的字段 |
| SfcAPI | UpdateSfcTaskflowV3 | Put /v3/sfc/{sfcId}/taskflow | 修改项目下任务类型绑定工作流 |
| SfcAPI | UpdateSfcV3 | Put /v3/sfc/{sfcId} | 修改项目任务类型(提交项目ID), 修改企业任务类型 |
| TagAPI | CreateOrgTagV3 | Post /v3/tag/create | 创建企业标签 |
| TagAPI | SearchOrgTagsV3 | Get /v3/tag/search | 搜索企业标签 |
| TaskAPI | ArchiveTaskV3 | Put /v3/task/{taskId}/archive | 归档任务(移入回收站) |
| TaskAPI | CreateTaskCommentV3 | Post /v3/task/{taskId}/comment | 评论任务 |
| TaskAPI | CreateTaskDependencyV3 | Post /v3/task/dependency/create | 创建任务依赖 |
| TaskAPI | CreateTaskLinkV3 | Post /v3/task/{taskId}/objectlinks | 创建任务关联 |
| TaskAPI | CreateTaskTraceV3 | Post /v3/task/{taskId}/trace/create | 创建任务进展 |
| TaskAPI | CreateTaskV3 | Post /v3/task/create | 创建任务 |
| TaskAPI | DeleteTaskDependencyV3 | Post /v3/task/dependency/{dependencyId}/delete | 删除任务依赖 |
| TaskAPI | DeleteTaskLinkV3 | Delete /v3/task/{taskId}/objectlinks/{objectlinkId} | 删除任务关联 |
| TaskAPI | DeleteTaskV3 | Post /v3/task/{taskId}/delete | 删除任务 |
| TaskAPI | GetTaskDependenciesV3 | Get /v3/task/dependency | 获取任务依赖 |
| TaskAPI | GetTaskLinksV3 | Get /v3/task/{taskId}/objectlinks | 获取任务关联列表 |
| TaskAPI | GetTaskTableCustomFieldV3 | Get /v3/task/{taskId}/customfield/table | 获取任务的表格自定义字段 |
| TaskAPI | GetTaskTracesV3 | Get /v3/task/{taskId}/traces | 获取任务进展 |
| TaskAPI | GetTemplateV2 | Get /v2/template/info | 根据ID获取任务类型信息V2 |
| TaskAPI | ListTaskActivitiesV3 | Get /v3/task/{taskId}/activity/list | 列出任务动态 |
| TaskAPI | MoveOrgTaskToProject | Post /v3/organization-task/{taskId}/move | 轻任务移动到项目中 |
| TaskAPI | MoveTaskV3 | Put /v3/task/{taskId}/move | 跨项目移动任务 |
| TaskAPI | PutV3TaskNodeComplete | Put /v3/task/{taskId}/node/complete | 完成任务节点 |
| TaskAPI | PutV3TaskNodeList | Get /v3/task/{taskId}/node/list | 获取任务节点列表 |
| TaskAPI | PutV3TaskNodeRollback | Put /v3/task/{taskId}/node/rollback | 回滚任务节点 |
| TaskAPI | PutV3TaskNodeUpdate | Put /v3/task/{taskId}/node/update | 更新任务节点 |
| TaskAPI | QueryTaskV3 | Get /v3/task/query | 查询任务详情 |
| TaskAPI | RenderTaskRtfV3 | Get /v3/task/rtf/render | 任务富文本内容渲染为 html |
| TaskAPI | RestoreTaskV3 | Post /v3/task/{taskId}/restore | 恢复任务(移出回收站) |
| TaskAPI | SearchTasksByTQL | Get /all-task/search | 通过TQL搜索自由任务和项目任务ID |
| TaskAPI | SearchTasksByTQLV2 | Get /v2/all-task/search | 通过TQL搜索自由任务和项目任务ID (V2) |
| TaskAPI | SearchUserTasksV3 | Get /v3/usertasks/search | 搜索用户的任务 |
| TaskAPI | UpdateTaskContentV3 | Put /v3/task/{taskId}/content | 更新任务标题 |
| TaskAPI | UpdateTaskCusomFieldByInstanceV3 | Post /v3/task/{taskId}/customfield-instance/{instanceId}/update | 根据字段InstanceId更新任务自定义字段值(弃用) |
| TaskAPI | UpdateTaskCusomFieldV3 | Post /v3/task/{taskId}/customfield/update | 更新任务自定义字段值 |
| TaskAPI | UpdateTaskCustomField | Post /task/customfield/update | 更新任务字段信息 |
| TaskAPI | UpdateTaskCustomFieldV2 | Post /v3/task/{taskId}/customfield/{customfieldId}/update | 更新任务自定义字段值(弃用) |
| TaskAPI | UpdateTaskDueDateV3 | Put /v3/task/{taskId}/dueDate | 更新任务截止时间 |
| TaskAPI | UpdateTaskExecutorV3 | Put /v3/task/{taskId}/executor | 更新任务执行者 |
| TaskAPI | UpdateTaskLockV3 | Post /v3/task/{taskId}/access-policy/update | 更新任务加锁/解锁动作 |
| TaskAPI | UpdateTaskMembersV3 | Put /v3/task/{taskId}/involveMembers | 更新任务参与者 |
| TaskAPI | UpdateTaskNoteV3 | Put /v3/task/{taskId}/note | 更新任务备注 |
| TaskAPI | UpdateTaskParentV3 | Put /v3/task/{taskId}/parent | 改变任务的父任务 |
| TaskAPI | UpdateTaskPriorityV3 | Put /v3/task/{taskId}/priority | 更新任务优先级 |
| TaskAPI | UpdateTaskProgressV3 | Put /v3/task/{taskId}/progress | 更新任务进度 |
| TaskAPI | UpdateTaskSfcV3 | Put /v3/task/{taskId}/sfc/update | 更新任务的任务类型 |
| TaskAPI | UpdateTaskSprintV3 | Put /v3/task/{taskId}/sprint | 更新任务迭代 |
| TaskAPI | UpdateTaskStageV3 | Put /v3/task/{taskId}/stage/update | 更新任务列表 |
| TaskAPI | UpdateTaskStartDateV3 | Put /v3/task/{taskId}/startDate | 更新任务开始时间 |
| TaskAPI | UpdateTaskStatusV3 | Put /v3/task/{taskId}/taskflowstatus | 更新任务状态 |
| TaskAPI | UpdateTaskStoryPointV3 | Put /v3/task/{taskId}/storyPoint | 更新任务StoryPoint |
| TaskAPI | UpdateTaskTableCustomFieldV3 | Put /v3/task/{taskId}/customfield/table | 更新任务的表格自定义字段 |
| TaskAPI | UpdateTaskTagsV3 | Put /v3/task/{taskId}/tag | 更新任务标签 |
| TaskAPI | UpdateTaskVisibilityV3 | Post /v3/task/{taskId}/visible/update | 更新任务可见性 |
| TaskflowAPI | SearchOrgTaskFlowsV3 | Get /v3/taskflow/search | 搜索企业工作流 |
| TestcaseAPI | CreateTestCaseV3 | Post /v3/project/{projectId}/testcase/create | 创建测试用例 |
| TestcaseAPI | GetProjectTestHubV3 | Get /v3/project/{projectId}/testhub | 查询项目用例库 |
| TestcaseAPI | PlanTestCaseV3 | Post /v3/project/{projectId}/testplan/{testplanId}/planning | 规划测试用例 |
| TestcaseAPI | QueryOrgTestHubsV3 | Get /v3/testhub/query | 查询企业用例库列表 |
| TestcaseAPI | QueryOrgUserCasesV3 | Get /v3/testhub/{testhubId}/usercase/query | 查询企业用例库用例列表V2 |
| TestcaseAPI | QueryProjectTestHubCasesV3 | Get /v3/project/{projectId}/testhub/{testhubId}/usercase/query | 查询项目用例库用例列表 |
| TestcaseAPI | QueryTestCasesV3 | Get /v3/project/{projectId}/testcase/query | 查询测试用例列表 |
| TestcaseAPI | QueryTestGroupsV3 | Post /v3/group/query | 批量查询用例分组 |
| TestcaseAPI | UpdateTestCaseFlowStatusV3 | Put /v3/project/{projectId}/testplan/{testplanId}/testcase/{id}/flowStatusId | 更新测试用例状态 |
| WebhookAPI | GetEgressIps | Get /webhook/ips | 获取webhook出口IP列表 |
| WebhookAPI | RestartWebhookListen | Post /webhook/v1/apps/{appId}/listen | 消费者服务启动并开始监听上报 |
| WorktimeAPI | AggregateUserPlanTime | Post /plantime/aggregation/datesUsers | 获取一定时间内订阅的指定用户的计划工时聚合数 |
| WorktimeAPI | AggregateUserWorkTime | Post /worktime/aggregation/datesUsers | 获取一定时间内订阅的指定用户的实际工时聚合数据 |
| WorktimeAPI | CreatePlanTime | Post /plantime/create | 创建计划工时 |
| WorktimeAPI | CreateWorkTime | Post /worktime/create | 创建实际工时 |
| WorktimeAPI | CreateWorkTimeApproval | Post /worktime/approve/submit | 创建实际工时审批对象 |
| WorktimeAPI | DeletePlanTime | Delete /plantime/{plantimeId} | 删除计划工时单条记录 |
| WorktimeAPI | DeleteWorkTime | Delete /worktime/{worktimeId} | 删除实际工时单条记录 |
| WorktimeAPI | GetPlanTimeDetail | Get /plantime/{plantimeId} | 获取单个计划工时详情 |
| WorktimeAPI | GetWorkTimeDetail | Get /worktime/{worktimeId} | 获取单个实际工时详情 |
| WorktimeAPI | ListPlanTimes | Get /plantime/query | 获取用户所有计划工时详情数据 |
| WorktimeAPI | ListTaskPlanTimes | Get /plantime/list/task/{taskId} | 获取单个任务的计划工时列表 |
| WorktimeAPI | ListTaskWorkTimes | Get /worktime/list/task/{taskId} | 获取单个任务的实际工时列表 |
| WorktimeAPI | ListWorkTimes | Get /worktime/query | 获取用户所有实际工时详情数据 |
| WorktimeAPI | SumTaskPlanTime | Get /plantime/aggregation/task/{taskId} | 获取单个任务的计划工时总和 |
| WorktimeAPI | SumTaskWorkTime | Get /worktime/aggregation/task/{taskId} | 获取单个任务的实际工时总和 |
| WorktimeAPI | UpdatePlanTime | Put /plantime/{plantimeId} | 更新计划工时单条记录 |
| WorktimeAPI | UpdateWorkTime | Put /worktime/{worktimeId} | 更新实际工时单条记录 |
| WorktimeAPI | UpdateWorkTimeApproval | Put /worktime/approve/{openId} | 更新工时审批对象 |
| WorktimeAPI | UpdateWorkTimeLimit | Put /worktime/restriction | 更新工时企业人天的最大填报时间限制 |