LigaAI
  1. 项目模块(project)
LigaAI
  • 登录模块(authorize)
    • 获取token
      POST
    • 获取永久token
      POST
    • 刷新token
      POST
  • 用户模块(user)
    • 获取项目的用户列表（不进行分页）
      GET
    • 获取项目的用户列表（进行分页）
      GET
    • 批量添加项目用户
      POST
    • 批量移除项目中的用户
      DELETE
  • 组织模块(org)
    • 获取组织的人员信息（分页）
      GET
    • 启用组织的某个用户
      POST
    • 禁用组织的某个用户
      POST
    • 移除组织的某个用户
      DELETE
  • 项目模块(project)
    • 项目模板列表
      GET
    • 获取项目列表
      GET
    • 获取项目概览模版
      GET
    • 新建项目
      POST
    • 更新项目
      PATCH
    • 根据项目key获取项目信息
      GET
    • 获取项目信息
      GET
    • 更改用户的角色
      POST
    • 获取角色列表
      GET
    • 获取角色列表
      POST
  • 事项模块(issue)
    • 获取issue类型列表
      GET
    • 获取issue模版
      GET
    • 获取issue的字段列表
      GET
    • 获取issue的字段详情
      GET
    • 批量新建issue
      POST
    • 新建issue
      POST
    • 批量更新issue
      PATCH
    • 更新issue
      PATCH
    • 获取issue详情V2
      GET
    • 获取issue详情
      GET
    • 根据issue编号获取详情
      GET
    • 删除issue
      DELETE
    • 批量删除issue
      DELETE
    • issue列表
      POST
    • issue列表v2
      POST
    • 获取项目下所有的筛选条件
      POST
    • 获取字段的下拉选项
      POST
    • 获取事项的关联事项列表
      GET
    • 事项添加关联
      POST
    • 事项移除关联
      POST
    • 批量新建子任务
      POST
    • 删除子任务
      DELETE
    • 更新子任务
      PATCH
    • 获取子任务列表
      POST
    • 更新子任务状态
      PATCH
    • 获取子任务可修改字段列表
      POST
    • 新建工时登记
      POST
    • 更新工时登记
      PATCH
    • 删除工时登记
      DELETE
    • 工时登记分页查询
      POST
    • 获取回收站下拉选项列表（免费版本暂不支持）
      POST
    • 回收站列表（免费版本暂不支持）
      POST
    • 恢复issue（免费版本暂不支持）
      POST
    • 为自定义字段添加选项
      POST
    • 为自定义字段移除选项
      POST
    • 已完成issue列表
      POST
  • 迭代模块(sprint)
    • 新建迭代
    • 更新迭代
    • 删除迭代
    • 获取迭代信息
    • 获取迭代列表
  • 工作流模块(workflow)
    • 查询项目工作流列表
    • 查询可流转状态列表
  • 标签模块(tag)
    • 新建标签
    • 更新标签
    • 删除标签
    • 获取标签列表
  • 史诗模块(epic)
    • 史诗过滤选项值
    • 史诗列表
    • 史诗关联事项列表
    • 获取史诗字段列表
    • 获取史诗字段详情
    • 新建史诗
    • 更新史诗
    • 删除史诗
    • 获取史诗详情
    • 史诗关联事项
  • 版本模块(version)
    • 获取版本的状态列表
    • 获取版本可供选择的人员
    • 获取所有的版本信息
    • 新建版本
    • 更新版本
    • 移除版本
    • 发布版本
    • 取消发布版本
    • 归档版本
    • 取消归档版本
    • 获取版本的详情
    • 添加事项与版本的关联
    • 解除事项与版本的关联
    • 获取版本关联issue列表
  • Webhook配置模块(webhook)
    • 获取Webhook类型列表
    • 获取Webhook事件监听列表
    • 新建Webhook
    • 删除Webhook
    • 更新Webhook配置信息
    • 获取Webhook配置信息
    • 分页查询Webhook配置信息
  • 评论模块(comment)
    • 添加评论
    • 更新评论
    • 删除评论
    • 评论列表
    • 更新表情
    • 获取表情列表
  • 文件模块(file)
    • 上传文件
    • 下载文件
    • 删除文件
    • 获取文件列表
    • 绑定文件
  • 个人消息模块(msg)
    • 获取个人消息列表
  1. 项目模块(project)

根据项目key获取项目信息

GET
https://ligai.cn/openapi/api/project/get-by-project-key
项目模块(project)

请求参数

Query 参数
projectKey
string 
项目key
必需
示例值:
1
Header 参数
Content-Type
string 
必需
示例值:
application/json
accessToken
string 
必需
示例值:
{{accessToken}}

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://ligai.cn/openapi/api/project/get-by-project-key?projectKey=1' \
--header 'accessToken: ' \
--header 'Content-Type: application/json'

返回响应

🟢200成功
*/*
OK
Body
leader
string 
项目leader
可选
description
string 
描述
可选
updateTime
string <date>
更新时间
可选
avatar
integer <int64>
图标
可选
url
string 
url
可选
leaderId
integer <int64>
可选
项目leader id
archived
integer <int32>
可选
是否归档(0:否,1:是)
projectKey
string 
项目关键字
可选
createBy
integer <int64>
创建人id
可选
createTime
string <date>
创建时间
可选
projectCategory
integer <int64>
项目分类
可选
id
integer <int64>
项目id
可选
projectName
string 
项目名称
可选
status
integer <int32>
项目状态
可选
示例
{
  "code": "0",
  "data": {
    "leader": "xxx",
    "description": "xxx",
    "updateTime": 1646301600000,
    "avatar": 1,
    "url": "xxx",
    "leaderId": 1,
    "archived": 1,
    "projectKey": "xxx",
    "createBy": 1,
    "createTime": 1646301600000,
    "projectCategory": 1,
    "id": 1,
    "projectName": "xxx",
    "status": 1
  }
}
修改于 2024-10-15 13:49:36
上一页
更新项目
下一页
获取项目信息
Built with