Teambition Openapi SDK

@tng/teambition-openapi-sdk

Teambition 开放 API SDK，请求客户端使用的是 axios.

安装

npm

npm install @tng/teambition-openapi-sdk --save

yarn

yarn add @tng/teambition-openapi-sdk

如何使用

API 调用示例

import {Configuration, ApiClient}  from '@tng/teambition-openapi-sdk'

const appId = "YOU_APP_ID"
const appSecret = "YOU_APP_SECRET"
const cfg = new Configuration({appId: appId, appSecret: appSecret })

const client = new ApiClient(cfg);

const orgId = "YOU_ORG_ID"

// 查询企业信息
client.org.getOrgInfo({
    header: {
        xTenantId: orgId,
    },
}).then(({data}) => {
    console.log(data)
}).catch(error => {
    console.info(error)
})

// 查询任务
client.task.queryTaskV3({
    header: {
        xTenantId: orgId,
    },
    query: {
        taskId: "YOU_TASK_ID"
    }
}).then(({data}) => {
    console.log(data)
}).catch(error => {
    console.info(error)
})

Configuration构造参数：

| 参数 | 描述 | 类型 | 必须 | 默认 | | ---- | ---- | ---- | ---- | ---- | | appId | 应用的id | string | 是 | - | | appSecret | 应用的密码 | string | 是 | - | | basePath | 请求 API 网关地址，例如公有云为(https://open.teambition.com/api), 私有云一般为(https://PRIVATE_DOMAIN/gateway) | Domain | string | 否 | - |

API 接口文档

所有 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/list | 获取文件所有版本 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 | 更新工时企业人天的最大填报时间限制