简介

脉冲云开放接口

Basic认证

在HTTP协议进行通信的过程中,HTTP协议定义了基本认证过程以允许HTTP服务器对WEB浏览器进行用户身份证的方法。 当一个客户端向脉冲云服务器进行数据请求时,如果客户端未被认证,则脉冲云服务器将通过基本认证过程对客户端的用户名及密码进行验证,以决定用户是否合法。 客户端需要将用户名及密码以BASE64加密,加密后的密文将附加于请求信息中。 如当用户名为mcc,密码为:123456时,客户端将用户名和密码用“:”合并,并将合并后的字符串用BASE64加密为密文,并于每次请求数据时,将密文附加于请求头(Request Header)中。 脉冲云服务器在每次收到请求包后,根据协议取得客户端附加的用户信息(BASE64加密的用户名和密码),解开请求包,对用户名及密码进行验证,如果用户名及密码正确,则根据客户端请求,返回客户端所需要的数据。否则,返回错误代码或重新要求客户端提供用户名及密码。

Mock服务

根据接口文档自动生成模拟数据,让前端在不依赖后端的情况下进行开发测试,从而提高团队的开发效率。

帐号相关

帐号相关

获取用户SSHKEY列表
稳定版 Since  1.0.0 已发布

获取用户sshkey列表

接口地址
GET/account/ssh-key
返回结果
200帐号下所有公钥列表
SshKey[]
id
string
title
string
user
string
用户ID
sort
number
排序
createdAt
string格式:date-time
创建时间
GET
/account/ssh-key
响应示例
200帐号下所有公钥列表
[
{
 ... } 
]
获取当前用户相关任务列表
稳定版 Since  1.0.0 已发布
接口地址
GET/account/task
返回结果
200
Task[]
id
string
看板任务ID
title
string
看板任务标题
iid
number
项目下唯一自增ID
type
string
任务类型
project
string
所属项目ID
board
string
所属看板ID
done
boolean默认值:false
是否完成
stage
string
所属泳道ID
user
所属用户基本信息
director
string
负责人ID
members
参与者列表
startAt
string格式:date-time
任务开始时间
endAt
string格式:date-time
任务结束时间
timeTotal
number
任务总工时
priority
number长度:0~2
任务级别
timeUsed
number
实际工时
desc
string
任务描述
tags
string[]
任务标签列表
properties
object
任务扩展属性
sort
number
任务排序编号
resourceVersion
number
资源版本
updatedAt
string格式:date-time
任务更新时间
redo
boolean
任务是否是重做的
createdAt
string格式:date-time
任务创建时间
GET
/account/task
响应示例
200
[
{
 ... } 
]
获取近期所有上传任务列表
稳定版 Since  1.0.0 已发布
接口地址
GET/account/upload
返回结果
200
file
GET
/account/upload
响应示例
200
{
"file"[
 ... ] 
}
创建SSHKEY
稳定版 Since  1.0.0 已发布
接口地址
POST/account/ssh-key
Body参数
pubKey
string必须
公钥
title
string必须
公钥标题,一般是从公钥中截取的邮箱地址
返回结果
200
SshKey
id
string
title
string
user
string
用户ID
sort
number
排序
createdAt
string格式:date-time
创建时间
POST
/account/ssh-key
请求示例
{
"pubKey"
"ssh-rsaAAAAB3NzaC1yc2E..." ,
"title"
"mcc@maichong.it" 
}
响应示例
200
{
"id"
"5a2e1edf15d6790d14bdf599" ,
"title"
"@)fn" ,
"user"
"59a4d7c750d1c01530157bdf" ,
"sort"
,
"createdAt"
"2017-12-11T05:59:59.914Z" 
}
删除SSHKEY
稳定版 Since  1.0.0 已发布
接口地址
DELETE/account/ssh-key/:id
路径参数
id
string必须
要删除的ID
返回结果
200
DELETE
/account/ssh-key/:id
响应示例
200
{ }
获取当前用户信息
稳定版 Since  1.0.0 已发布
接口地址
GET/account/info
返回结果
200
User
id
string必须格式:any
displayName
string必须
用户昵称
username
string必须
用户帐号
avatar
string必须
用户头像地址
email
string必须格式:email
用户邮箱地址
balance
number
用户账户余额
createdAt
string格式:date-time
用户创建时间
GET
/account/info
响应示例
200
{
"id"
"59101c5f42554b140e291991" ,
"displayName"
"脉冲云" ,
"username"
"13512341234" ,
"avatar"
"https://c.maichong.io/img/201705/591d63b30930ff00072826f9.jpg" ,
"email"
"mcc@maichong.it" ,
"balance"
-6727938174223384 ,
"createdAt"
"2017-08-29T02:56:08.066Z" 
}
获取当前用户储值卡列表
稳定版 Since  1.0.0 已发布

仅公有版才有此接口

接口地址
GET/account/deposit
返回结果
200
Deposit[]
id
string
储值卡ID
title
string
标题
user
string
所属用户ID
currency
string
货币类型
amount
number
数量
balance
number
余额
createdAt
string
创建时间
expiredAt
string
到期时间
GET
/account/deposit
响应示例
200
[
{
 ... } 
]
获取当前用户收支记录列表
稳定版 Since  1.0.0 已发布

分页效果

接口地址
GET/account/income/paginate
查询参数
target
string
收支记录类型
deposit
string
储值卡ID,当target为deposit时有效
currency
string
余额货币类型,当target为balance时有效
_page
number
要查询的页数
_limit
number
每页的记录数
返回结果
200
total
number
总记录数
page
number
当前页数
limit
number
每页记录数
totalPage
number
总页数
previous
number
上一页的页码
next
number
下一页的页码,如果没有,则为0
results
消费记录列表
GET
/account/income/paginate
响应示例
200
{
"total"
120 ,
"page"
,
"limit"
20 ,
"totalPage"
,
"previous"
,
"next"
,
"results"[
 ... ] 
}
获取当前用户事件列表
稳定版 Since  1.0.0 已发布
接口地址
GET/account/event/paginate
查询参数
_page
number
查询页数
_limit
number
每页记录数
返回结果
200
total
number
总记录数
page
number
当前页数
limit
number
每页记录数
totalPage
number
总页数
previous
number默认值:0
上页页码
next
number
下页页码,没有则为0
results
事件列表
GET
/account/event/paginate
响应示例
200
{
"total"
10113 ,
"page"
,
"limit"
10 ,
"totalPage"
1012 ,
"previous"
,
"next"
,
"results"[
 ... ] 
}
获取相关帐号列表
稳定版 Since  1.0.0 已发布

如果两个帐号同时出现在一个项目中,那么,这两个帐号就是彼此的相关帐号

接口地址
GET/account/related-member
返回结果
200
User$BaseInfo[]
id
string必须格式:any
displayName
string必须
用户昵称
avatar
string必须
用户头像地址
GET
/account/related-member
响应示例
200
[
{
 ... } 
]
接口管理

接口管理

创建接口库
稳定版 Since  1.0.0 已发布

需要项目的master权限或者接口文档的master权限

接口地址
POST/:project/api-library
路径参数
project
string必须
项目ID
Body参数
需要项目的master权限或者接口文档的master权限
project
string必须
项目id
path
string必须
唯一标识符
title
string
标题
version
string
接口库版本
返回结果
200创建成功
ApiLibrary
id
string必须
接口库Id
path
string必须
唯一标识符
project
string必须
项目Id
title
string
接口库标题
POST
/:project/api-library
请求示例
{
"project"
"mcc" ,
"path"
"demo" ,
"title"
"demo接口管理" ,
"version"
"0.0.1" 
}
响应示例
200创建成功
{
"id"
"mcc/demo" ,
"path"
"demo" ,
"project"
"mcc" ,
"title"
"mcc对外开放接口" 
}
获取接口库列表
稳定版 Since  1.0.0 已发布

获取接口库列表

接口地址
GET/:project/api-library
路径参数
project
string必须
项目ID
返回结果
200返回项目下库列表
ApiLibrary[]
id
string必须
接口库Id
path
string必须
唯一标识符
project
string必须
项目Id
title
string
接口库标题
GET
/:project/api-library
响应示例
200返回项目下库列表
[
{
 ... } 
]
修改接口库
稳定版 Since  1.0.0 已发布

修改接口库

接口地址
PATCH/:project/api-library/:library
路径参数
project
string必须
项目ID
library
string必须
接口库唯一标识符path的值
Body参数
修改接口库
title
string必须
接口库标题
返回结果
200返回结果
title
string
接口标题
PATCH
/:project/api-library/:library
请求示例
{
"title"
"接口库测试" 
}
响应示例
200返回结果
{
"title"
"修改了测试标题" 
}
删除接口库
稳定版 Since  1.0.0 已发布

删除接口库

接口地址
DELETE/:project/api-library/:library
路径参数
project
string必须
项目ID
library
string必须
接口库唯一标识符path的值
返回结果
200返回对象
DELETE
/:project/api-library/:library
响应示例
200返回对象
{ }
创建接口库版本
稳定版 Since  1.0.0 已发布

创建版本

接口地址
POST/:project/api-library/:library/version
路径参数
project
string必须
项目ID
library
string必须
接口库唯一标识符path的值
Body参数
创建版本
version
string必须
版本号
parent
string必须
父级版本号
返回结果
200返回版本信息
ApiVersion
library
string必须
所属接口文档库
version
string必须
当前版本号
parent
string
latest
boolean默认值:false
是否为最后一个版本
published
boolean
是否已发布
POST
/:project/api-library/:library/version
请求示例
{
"version"
"0.0.2" ,
"parent"
"0.0.1" 
}
响应示例
200返回版本信息
{
"library"
"mcc/demo" ,
"version"
"0.0.2" ,
"parent"
"0.0.1" ,
"latest"
false,
"published"
true
}
获取接口库版本列表
稳定版 Since  1.0.0 已发布

获取接口库版本列表

接口地址
GET/:project/api-library/:library/version
路径参数
project
string必须
项目ID
library
string必须
接口库唯一标识符path的值
返回结果
200返回接口库版本列表
ApiVersion[]
library
string必须
所属接口文档库
version
string必须
当前版本号
parent
string
latest
boolean默认值:false
是否为最后一个版本
published
boolean
是否已发布
GET
/:project/api-library/:library/version
响应示例
200返回接口库版本列表
[
{
 ... } 
]
删除接口库版本
稳定版 Since  1.0.0 已发布

删除接口库版本

接口地址
DELETE/:project/api-library/:library/version/:version
路径参数
project
string必须
项目ID
library
string必须
接口库唯一标识符path的值
version
string必须
接口库版本号
返回结果
200返回结果
DELETE
/:project/api-library/:library/version/:version
响应示例
200返回结果
{ }
发布一个版本
稳定版 Since  1.0.0 已发布

发布一个版本

接口地址
POST/:project/api-library/:library/version/:version/publish
路径参数
project
string必须
项目ID
library
string必须
接口库唯一标识符path的值
version
string必须
接口库版本号
返回结果
200返回发布成功
POST
/:project/api-library/:library/version/:version/publish
响应示例
200返回发布成功
{ }
下载一个版本
稳定版 Since  1.0.0 已发布

下载一个版本

接口地址
GET/:project/api-library/:library/version/:version/download
路径参数
project
string必须
项目ID
library
string必须
接口库唯一标识符path的值
version
string必须
接口库版本号
GET
/:project/api-library/:library/version/:version/download
创建接口库简介
稳定版 Since  1.0.0 已发布

创建接口库简介

接口地址
POST/:project/api-library/:library/version/:version/description
路径参数
project
string必须
项目ID
library
string必须
接口库唯一标识符path的值
version
string必须
接口库版本号
Body参数
ApiDescription$Base
title
string必须
简介标题
desc
string
简介描述
sort
string默认值:0
对简介进行排序
返回结果
200创建成功
ApiDescription
library
string必须
version
string必须
接口库版本
title
string必须
简介标题
desc
string
简介描述
sort
string默认值:0
对简介进行排序
POST
/:project/api-library/:library/version/:version/description
请求示例
{
"title"
"简介" ,
"desc"
"对简介进行详细的描述" ,
"sort"
"0" 
}
响应示例
200创建成功
{
"library"
"mcc/demo" ,
"version"
"0.0.1" ,
"title"
"简介" ,
"desc"
"对简介进行详细的描述" ,
"sort"
"0" 
}
获取简介列表
稳定版 Since  1.0.0 已发布

获取简介列表

接口地址
GET/:project/api-library/:library/version/:version/description
路径参数
project
string必须
项目ID
library
string必须
接口库唯一标识符path的值
version
string必须
接口库版本号
返回结果
200返回接口库简介列表
ApiDescription[]
library
string必须
version
string必须
接口库版本
title
string必须
简介标题
desc
string
简介描述
sort
string默认值:0
对简介进行排序
GET
/:project/api-library/:library/version/:version/description
响应示例
200返回接口库简介列表
[
{
 ... } 
]
更新简介信息
稳定版 Since  1.0.0 已发布

更新简介信息

接口地址
PATCH/:project/api-library/:library/version/:version/description/:description
路径参数
project
string必须
项目ID
library
string必须
接口库唯一标识符path的值
version
string必须
接口库版本号
description
string必须
简介ID
Body参数
更新简介信息
title
string必须
简介标题
desc
string
简介描述
sort
string默认值:0
对简介进行排序
返回结果
200返回简介信息
title
string必须
简介标题
desc
string
简介描述
sort
string默认值:0
对简介进行排序
PATCH
/:project/api-library/:library/version/:version/description/:description
请求示例
{
"title"
"简介" ,
"desc"
"对简介进行详细的描述" ,
"sort"
"0" 
}
响应示例
200返回简介信息
{
"title"
"简介" ,
"desc"
"对简介进行详细的描述" ,
"sort"
"0" 
}
删除简介
稳定版 Since  1.0.0 已发布

删除简介

接口地址
DELETE/:project/api-library/:library/version/:version/description/:description
路径参数
project
string必须
项目ID
library
string必须
接口库唯一标识符path的值
version
string必须
接口库版本号
description
string必须
简介ID
返回结果
200
DELETE
/:project/api-library/:library/version/:version/description/:description
响应示例
200
{ }
创建分组
稳定版 Since  1.0.0 已发布

创建分组

接口地址
POST/:project/api-library/:library/version/:version/group
路径参数
project
string必须
项目ID
library
string必须
接口库的唯一标识符path的值
version
string必须
要删除的接口库版本号
Body参数
ApiGroup$Base
title
string必须
分组的标题
desc
string
简介详细描述
sort
string默认值:0
简介排序
返回结果
200分组信息
ApiGroup
library
string必须
接口库ID
version
string必须
分组对应的版本号
title
string必须
分组的标题
desc
string
简介详细描述
sort
string默认值:0
简介排序
POST
/:project/api-library/:library/version/:version/group
请求示例
{
"title"
"登录模块" ,
"desc"
"用户登录" ,
"sort"
"0" 
}
响应示例
200分组信息
{
"library"
"mcc/demo" ,
"version"
"0.0.1" ,
"title"
"登录模块" ,
"desc"
"用户登录" ,
"sort"
"0" 
}
分组列表
稳定版 Since  1.0.0 已发布

接口库版本下分组列表

接口地址
PATCH/:project/api-library/:library/version/:version/group
路径参数
project
string必须
library
string必须
接口库唯一标识符path的值
version
string必须
版本号
返回结果
200分组信息列表
ApiGroup[]
library
string必须
接口库ID
version
string必须
分组对应的版本号
title
string必须
分组的标题
desc
string
简介详细描述
sort
string默认值:0
简介排序
PATCH
/:project/api-library/:library/version/:version/group
响应示例
200分组信息列表
[
{
 ... } 
]
更新分组信息
稳定版 Since  1.0.0 已发布

更新分组信息

接口地址
PATCH/:project/api-library/:library/version/:version/group/:group
路径参数
project
string必须
项目ID
library
string必须
接口库唯一标识符path的值
version
string必须
要删除的接口库版本号
group
string必须
分组ID
Body参数
ApiGroup$Base
title
string必须
分组的标题
desc
string
简介详细描述
sort
string默认值:0
简介排序
返回结果
200更新成功
ApiGroup
library
string必须
接口库ID
version
string必须
分组对应的版本号
title
string必须
分组的标题
desc
string
简介详细描述
sort
string默认值:0
简介排序
PATCH
/:project/api-library/:library/version/:version/group/:group
请求示例
{
"title"
"登录模块" ,
"desc"
"用户登录" ,
"sort"
"0" 
}
响应示例
200更新成功
{
"library"
"mcc/demo" ,
"version"
"0.0.1" ,
"title"
"登录模块" ,
"desc"
"用户登录" ,
"sort"
"0" 
}
删除分组
稳定版 Since  1.0.0 已发布

删除接口库版本下的分组,要求分组内不能包含其他接口定义

接口地址
DELETE/:project/api-library/:library/version/:version/group/:group
路径参数
project
string必须
项目ID
library
string必须
接口库唯一标识符path的值
version
string必须
要删除的接口库版本号
group
string必须
分组ID
返回结果
200删除成功
DELETE
/:project/api-library/:library/version/:version/group/:group
响应示例
200删除成功
{ }
创建接口
稳定版 Since  1.0.0 已发布

添加接口的信息

接口地址
POST/:project/api-library/:library/version/:version/route
路径参数
project
string必须
项目ID
library
string必须
接口库唯一标识符path的值
version
string必须
要删除的接口库版本号
Body参数
ApiRoute$Base
title
string必须
接口标题
desc
string
接口描述
stability
string必须
稳定性
state
string必须
开发状态
since
string必须
来源版本,如果为克隆的,就相当于从哪个版本克隆的
group
string必须
所属分组ID
method
string必须
请求类型
path
string
路由地址
bodyType
string
请求的body类型
bodyDesc
string
请求的body描述信息
sort
string默认值:0
排序
返回结果
200创建成功
POST
/:project/api-library/:library/version/:version/route
请求示例
{
"title"
"更新用户信息" ,
"desc"
"更新用户昵称" ,
"stability"
"beta" ,
"state"
"正在开发" ,
"since"
"0.0.1" ,
"group"
"5a2e5651be7680000585fe92" ,
"method"
"GET" ,
"path"
"/account/:username" ,
"bodyType"
"User$Base" ,
"bodyDesc"
"修改用户的昵称" ,
"sort"
"0" 
}
响应示例
200创建成功
{ }
获取接口列表
稳定版 Since  1.0.0 已发布

获取接口列表

接口地址
GET/:project/api-library/:library/version/:version/route
路径参数
project
string必须
项目ID
library
string必须
接口库唯一标识符path的值
version
string必须
要删除的接口库版本号
返回结果
200接口列表信息
ApiRoute[]
library
string必须
所属接口文档库ID
version
string必须
所属版本的版本号
title
string必须
接口标题
desc
string
接口描述
stability
string必须
稳定性
state
string必须
开发状态
since
string必须
来源版本,如果为克隆的,就相当于从哪个版本克隆的
group
string必须
所属分组ID
method
string必须
请求类型
path
string
路由地址
bodyType
string
请求的body类型
bodyDesc
string
请求的body描述信息
sort
string默认值:0
排序
GET
/:project/api-library/:library/version/:version/route
响应示例
200接口列表信息
[
{
 ... } 
]
更新接口信息
稳定版 Since  1.0.0 已发布

更新接口信息

接口地址
PATCH/:project/api-library/:library/version/:version/route/:route
路径参数
project
string必须
项目ID
library
string必须
接口库唯一标识符path的值
version
string必须
要删除的接口库版本号
route
string必须
接口ID
Body参数
ApiRoute$Base
title
string必须
接口标题
desc
string
接口描述
stability
string必须
稳定性
state
string必须
开发状态
since
string必须
来源版本,如果为克隆的,就相当于从哪个版本克隆的
group
string必须
所属分组ID
method
string必须
请求类型
path
string
路由地址
bodyType
string
请求的body类型
bodyDesc
string
请求的body描述信息
sort
string默认值:0
排序
返回结果
200更新成功
ApiRoute
library
string必须
所属接口文档库ID
version
string必须
所属版本的版本号
title
string必须
接口标题
desc
string
接口描述
stability
string必须
稳定性
state
string必须
开发状态
since
string必须
来源版本,如果为克隆的,就相当于从哪个版本克隆的
group
string必须
所属分组ID
method
string必须
请求类型
path
string
路由地址
bodyType
string
请求的body类型
bodyDesc
string
请求的body描述信息
sort
string默认值:0
排序
PATCH
/:project/api-library/:library/version/:version/route/:route
请求示例
{
"title"
"更新用户信息" ,
"desc"
"更新用户昵称" ,
"stability"
"beta" ,
"state"
"正在开发" ,
"since"
"0.0.1" ,
"group"
"5a2e5651be7680000585fe92" ,
"method"
"GET" ,
"path"
"/account/:username" ,
"bodyType"
"User$Base" ,
"bodyDesc"
"修改用户的昵称" ,
"sort"
"0" 
}
响应示例
200更新成功
{
"library"
"mcc/demo" ,
"version"
"0.0.1" ,
"title"
"更新用户信息" ,
"desc"
"更新用户昵称" ,
"stability"
"beta" ,
"state"
"正在开发" ,
"since"
"0.0.1" ,
"group"
"5a2e5651be7680000585fe92" ,
"method"
"GET" ,
"path"
"/account/:username" ,
"bodyType"
"User$Base" ,
"bodyDesc"
"修改用户的昵称" ,
"sort"
"0" 
}
删除接口
稳定版 Since  1.0.0 已发布

删除接口

接口地址
DELETE/:project/api-library/:library/version/:version/route/:route
路径参数
project
string必须
项目ID
library
string必须
接口库唯一标识符path的值
version
string必须
要删除的接口库版本号
route
string必须
接口ID
返回结果
200删除成功
DELETE
/:project/api-library/:library/version/:version/route/:route
响应示例
200删除成功
{ }
获取响应值列表
稳定版 Since  1.0.0 已发布

接口中response返回值列表

接口地址
GET/:project/api-library/:library/version/:version/response
路径参数
project
string必须
项目ID
library
string必须
接口库唯一标识符path的值
version
string必须
接口库版本号
返回结果
200列表信息
ApiResponse[]
library
string必须
所属接口文档库
version
string必须
当前版本号
route
string必须
响应值对应的接口ID
type
string必须
返回结果类型,例如 {}|[tuple]|OBJECT[]|OBJECT......
code
number必须
状态码
desc
string
响应值描述
GET
/:project/api-library/:library/version/:version/response
响应示例
200列表信息
[
{
 ... } 
]
新建响应值
稳定版 Since  1.0.0 已发布

新建响应值

接口地址
POST/:project/api-library/:library/version/:version/response
路径参数
project
string必须
项目ID
library
string必须
接口库唯一标识符path的值
version
string必须
接口库版本号
Body参数
ApiResponse$Base
route
string必须
响应值对应的接口ID
type
string必须
返回结果类型,例如 {}|[tuple]|OBJECT[]|OBJECT......
code
number必须
状态码
desc
string
响应值描述
返回结果
200创建成功
ApiResponse
library
string必须
所属接口文档库
version
string必须
当前版本号
route
string必须
响应值对应的接口ID
type
string必须
返回结果类型,例如 {}|[tuple]|OBJECT[]|OBJECT......
code
number必须
状态码
desc
string
响应值描述
POST
/:project/api-library/:library/version/:version/response
请求示例
{
"route"
"5a2e7320c50d3300082ece5d" ,
"type"
"User$base" ,
"code"
200 ,
"desc"
"响应值描述" 
}
响应示例
200创建成功
{
"library"
"demo" ,
"version"
"0.0.2" ,
"route"
"5a2e7320c50d3300082ece5d" ,
"type"
"User$base" ,
"code"
200 ,
"desc"
"响应值描述" 
}
更新响应值
稳定版 Since  1.0.0 已发布

更新response响应值

接口地址
PATCH/:project/api-library/:library/version/:version/response/:response
路径参数
project
string必须
项目ID
library
string必须
接口库唯一标识符path的值
version
string必须
接口库版本号
response
string必须
响应值ID
Body参数
ApiResponse$Base
route
string必须
响应值对应的接口ID
type
string必须
返回结果类型,例如 {}|[tuple]|OBJECT[]|OBJECT......
code
number必须
状态码
desc
string
响应值描述
返回结果
200修改成功
ApiResponse$Base
route
string必须
响应值对应的接口ID
type
string必须
返回结果类型,例如 {}|[tuple]|OBJECT[]|OBJECT......
code
number必须
状态码
desc
string
响应值描述
PATCH
/:project/api-library/:library/version/:version/response/:response
请求示例
{
"route"
"5a2e7320c50d3300082ece5d" ,
"type"
"User$base" ,
"code"
200 ,
"desc"
"响应值描述" 
}
响应示例
200修改成功
{
"route"
"5a2e7320c50d3300082ece5d" ,
"type"
"User$base" ,
"code"
200 ,
"desc"
"响应值描述" 
}
删除响应值
稳定版 Since  1.0.0 已发布

删除接口的response响应值

接口地址
DELETE/:project/api-library/:library/version/:version/response/:response
路径参数
project
string必须
项目ID
library
string必须
接口库唯一标识符path的值
version
string必须
接口库版本号
response
string必须
响应值ID
返回结果
200删除成功
DELETE
/:project/api-library/:library/version/:version/response/:response
响应示例
200删除成功
{ }
新建状态码
稳定版 Since  1.0.0 已发布

新建状态码

接口地址
POST/:project/api-library/:library/version/:version/code
路径参数
project
string必须
项目ID
library
string必须
接口库唯一标识符path的值
version
string必须
接口库版本号
Body参数
ApiCode$Base
desc
string
状态码描述
返回结果
200创建状态码成功
ApiCode
library
string必须
所属接口文档库
version
string必须
当前版本号
code
string必须
状态码
desc
string
状态码描述
POST
/:project/api-library/:library/version/:version/code
请求示例
{
"desc"
"创建项目失败" 
}
响应示例
200创建状态码成功
{
"library"
"mcc/demo" ,
"version"
"0.0.2" ,
"code"
"0100" ,
"desc"
"创建项目失败" 
}
获取状态码列表
稳定版 Since  1.0.0 已发布

获取状态码列表

接口地址
GET/:project/api-library/:library/version/:version/code
路径参数
project
string必须
项目ID
library
string必须
接口库唯一标识符path的值
version
string必须
接口库版本号
返回结果
200状态码列表
ApiCode[]
library
string必须
所属接口文档库
version
string必须
当前版本号
code
string必须
状态码
desc
string
状态码描述
GET
/:project/api-library/:library/version/:version/code
响应示例
200状态码列表
[
{
 ... } 
]
更新状态码
稳定版 Since  1.0.0 已发布

更新状态码

接口地址
PATCH/:project/api-library/:library/version/:version/code/:code
路径参数
project
string必须
项目ID
library
string必须
接口库唯一标识符path的值
version
string必须
接口库版本号
code
string必须
状态码号
Body参数
ApiCode$Base
desc
string
状态码描述
返回结果
200更新成功
ApiCode$Base
desc
string
状态码描述
PATCH
/:project/api-library/:library/version/:version/code/:code
请求示例
{
"desc"
"创建项目失败" 
}
响应示例
200更新成功
{
"desc"
"创建项目失败" 
}
删除状态码
稳定版 Since  1.0.0 已发布

删除状态码

接口地址
DELETE/:project/api-library/:library/version/:version/code/:code
路径参数
project
string必须
项目ID
library
string必须
接口库唯一标识符path的值
version
string必须
接口库版本号
code
string必须
状态码号
返回结果
200删除成功
DELETE
/:project/api-library/:library/version/:version/code/:code
响应示例
200删除成功
{ }
新建对象
稳定版 Since  1.0.0 已发布

新建对象

接口地址
POST/:project/api-library/:library/version/:version/object
路径参数
project
string必须
项目ID
library
string必须
接口库唯一标识符path的值
version
string必须
接口库版本号
Body参数
ApiObject$Base
title
string必须
对象名称
desc
string
对象描述
share
boolean
是否为公共资源
返回结果
200创建成功
ApiObject
project
string必须
所属项目ID
library
string必须
所属接口文档库
version
string必须
当前版本号
title
string必须
对象名称
desc
string
对象描述
share
boolean
是否为公共资源
POST
/:project/api-library/:library/version/:version/object
请求示例
{
"title"
"User" ,
"desc"
"用户信息" ,
"share"
true
}
响应示例
200创建成功
{
"project"
"mcc" ,
"library"
"mcc/demo" ,
"version"
"0.0.2" ,
"title"
"User" ,
"desc"
"用户信息" ,
"share"
true
}
获取对象列表
稳定版 Since  1.0.0 已发布

获取对象列表

接口地址
GET/:project/api-library/:library/version/:version/object
路径参数
project
string必须
项目ID
library
string必须
接口库唯一标识符path的值
version
string必须
接口库版本号
返回结果
200对象信息列表
ApiObject[]
project
string必须
所属项目ID
library
string必须
所属接口文档库
version
string必须
当前版本号
title
string必须
对象名称
desc
string
对象描述
share
boolean
是否为公共资源
GET
/:project/api-library/:library/version/:version/object
响应示例
200对象信息列表
[
{
 ... } 
]
更新对象
稳定版 Since  1.0.0 已发布

更新对象

接口地址
PATCH/:project/api-library/:library/version/:version/object/:object
路径参数
project
string必须
项目ID
library
string必须
接口库唯一标识符path的值
version
string必须
接口库版本号
object
string必须
对象ID
Body参数
ApiObject$Base
title
string必须
对象名称
desc
string
对象描述
share
boolean
是否为公共资源
返回结果
200更新成功
ApiObject
project
string必须
所属项目ID
library
string必须
所属接口文档库
version
string必须
当前版本号
title
string必须
对象名称
desc
string
对象描述
share
boolean
是否为公共资源
PATCH
/:project/api-library/:library/version/:version/object/:object
请求示例
{
"title"
"User" ,
"desc"
"用户信息" ,
"share"
true
}
响应示例
200更新成功
{
"project"
"mcc" ,
"library"
"mcc/demo" ,
"version"
"0.0.2" ,
"title"
"User" ,
"desc"
"用户信息" ,
"share"
true
}
删除对象
稳定版 Since  1.0.0 已发布

删除对象

接口地址
DELETE/:project/api-library/:library/version/:version/object/:object
路径参数
project
string必须
项目ID
library
string必须
接口库唯一标识符path的值
version
string必须
接口库版本号
object
string必须
对象ID
返回结果
200删除对象成功
DELETE
/:project/api-library/:library/version/:version/object/:object
响应示例
200删除对象成功
{ }
新建元组
稳定版 Since  1.0.0 已发布

新建元组

接口地址
POST/:project/api-library/:library/version/:version/tuple
路径参数
project
string必须
项目ID
library
string必须
接口库唯一标识符path的值
version
string必须
接口库版本号
Body参数
ApiTuple$Base
title
string必须
元组名称
desc
string
元组描述
返回结果
200创建成功
ApiTuple
project
string必须
所属项目ID
library
string必须
所属接口文档库
version
string必须
当前版本号
title
string必须
元组名称
desc
string
元组描述
share
boolean
是否为公共资源
POST
/:project/api-library/:library/version/:version/tuple
请求示例
{
"title"
"response" ,
"desc"
"响应值信息" 
}
响应示例
200创建成功
{
"project"
"mcc" ,
"library"
"mcc/demo" ,
"version"
"0.0.2" ,
"title"
"response" ,
"desc"
"响应值信息" ,
"share"
true
}
获取元组列表
稳定版 Since  1.0.0 已发布

获取元组列表

接口地址
GET/:project/api-library/:library/version/:version/tuple
路径参数
project
string必须
项目ID
library
string必须
接口库唯一标识符path的值
version
string必须
接口库版本号
返回结果
200元组信息列表
ApiTuple[]
project
string必须
所属项目ID
library
string必须
所属接口文档库
version
string必须
当前版本号
title
string必须
元组名称
desc
string
元组描述
share
boolean
是否为公共资源
GET
/:project/api-library/:library/version/:version/tuple
响应示例
200元组信息列表
[
{
 ... } 
]
修改元组
稳定版 Since  1.0.0 已发布

修改元组

接口地址
PATCH/:project/api-library/:library/version/:version/tuple/:tuple
路径参数
project
string必须
项目ID
library
string必须
接口库唯一标识符path的值
version
string必须
接口库版本号
tuple
string必须
元组ID
Body参数
ApiTuple$Base
title
string必须
元组名称
desc
string
元组描述
返回结果
200更新成功
ApiTuple
project
string必须
所属项目ID
library
string必须
所属接口文档库
version
string必须
当前版本号
title
string必须
元组名称
desc
string
元组描述
share
boolean
是否为公共资源
PATCH
/:project/api-library/:library/version/:version/tuple/:tuple
请求示例
{
"title"
"response" ,
"desc"
"响应值信息" 
}
响应示例
200更新成功
{
"project"
"mcc" ,
"library"
"mcc/demo" ,
"version"
"0.0.2" ,
"title"
"response" ,
"desc"
"响应值信息" ,
"share"
true
}
删除元组
稳定版 Since  1.0.0 已发布

删除元组

接口地址
DELETE/:project/api-library/:library/version/:version/tuple/:tuple
路径参数
project
string必须
项目ID
library
string必须
接口库唯一标识符path的值
version
string必须
接口库版本号
tuple
string必须
元组ID
返回结果
200删除成功
DELETE
/:project/api-library/:library/version/:version/tuple/:tuple
响应示例
200删除成功
{ }
新建字段
稳定版 Since  1.0.0 已发布

新建字段

接口地址
POST/:project/api-library/:library/version/:version/field
路径参数
project
string必须
项目ID
library
string必须
接口库唯一标识符path的值
version
string必须
接口库版本号
Body参数
ApiField$Base
type
string必须
字段类型,例如User,&User,[response],string,string[]......
title
string
字段名称
default
string
默认值
mock
string
示例值,支持mock函数
desc
string
字段描述
sort
string默认值:0
字段排序
options
object
参数,例如: {min:最小值或长度, max:最大值或长度,format:格式,regular:正则,enumValue:[可选值]' + ',unionType:[可选类型], required: false}, disabledFields: [对象属性]
返回结果
200创建成功
ApiField
project
string必须
所属项目ID
ref
string必须
引用类型,例如route:path、route:query、route:body、response、object、scope、tuple、schema
refId
string必须
引用对象ID
type
string必须
字段类型,例如User,&User,[response],string,string[]......
library
string必须
所属接口文档库
version
string必须
当前版本号
title
string
字段名称
default
string
默认值
mock
string
示例值,支持mock函数
desc
string
字段描述
sort
string默认值:0
字段排序
options
object
参数,例如: {min:最小值或长度, max:最大值或长度,format:格式,regular:正则,enumValue:[可选值]' + ',unionType:[可选类型], required: false}, disabledFields: [对象属性]
POST
/:project/api-library/:library/version/:version/field
请求示例
{
"type"
"number" ,
"title"
"title" ,
"default"
"false" ,
"mock"
"Scott Brown" ,
"desc"
"字段描述" ,
"sort"
"0" ,
"options"{ }
}
响应示例
200创建成功
{
"project"
"mcc" ,
"ref"
"scope" ,
"refId"
"5a2e75d7c50d3300082ece69" ,
"type"
"number" ,
"library"
"mcc/demo" ,
"version"
"0.0.2" ,
"title"
"title" ,
"default"
"false" ,
"mock"
"Scott Brown" ,
"desc"
"字段描述" ,
"sort"
"0" ,
"options"{ }
}
获取字段列表
稳定版 Since  1.0.0 已发布

获取字段列表

接口地址
GET/:project/api-library/:library/version/:version/field
路径参数
project
string必须
项目ID
library
string必须
接口库唯一标识符path的值
version
string必须
接口库版本号
返回结果
200字段信息列表
ApiField[]
project
string必须
所属项目ID
ref
string必须
引用类型,例如route:path、route:query、route:body、response、object、scope、tuple、schema
refId
string必须
引用对象ID
type
string必须
字段类型,例如User,&User,[response],string,string[]......
library
string必须
所属接口文档库
version
string必须
当前版本号
title
string
字段名称
default
string
默认值
mock
string
示例值,支持mock函数
desc
string
字段描述
sort
string默认值:0
字段排序
options
object
参数,例如: {min:最小值或长度, max:最大值或长度,format:格式,regular:正则,enumValue:[可选值]' + ',unionType:[可选类型], required: false}, disabledFields: [对象属性]
GET
/:project/api-library/:library/version/:version/field
响应示例
200字段信息列表
[
{
 ... } 
]
修改字段
稳定版 Since  1.0.0 已发布

修改字段

接口地址
PATCH/:project/api-library/:library/version/:version/field/:field
路径参数
project
string必须
项目ID
library
string必须
接口库唯一标识符path的值
version
string必须
接口库版本号
field
string必须
字段ID
Body参数
ApiField$Base
type
string必须
字段类型,例如User,&User,[response],string,string[]......
title
string
字段名称
default
string
默认值
mock
string
示例值,支持mock函数
desc
string
字段描述
sort
string默认值:0
字段排序
options
object
参数,例如: {min:最小值或长度, max:最大值或长度,format:格式,regular:正则,enumValue:[可选值]' + ',unionType:[可选类型], required: false}, disabledFields: [对象属性]
返回结果
200更新成功
ApiField
project
string必须
所属项目ID
ref
string必须
引用类型,例如route:path、route:query、route:body、response、object、scope、tuple、schema
refId
string必须
引用对象ID
type
string必须
字段类型,例如User,&User,[response],string,string[]......
library
string必须
所属接口文档库
version
string必须
当前版本号
title
string
字段名称
default
string
默认值
mock
string
示例值,支持mock函数
desc
string
字段描述
sort
string默认值:0
字段排序
options
object
参数,例如: {min:最小值或长度, max:最大值或长度,format:格式,regular:正则,enumValue:[可选值]' + ',unionType:[可选类型], required: false}, disabledFields: [对象属性]
PATCH
/:project/api-library/:library/version/:version/field/:field
请求示例
{
"type"
"number" ,
"title"
"title" ,
"default"
"false" ,
"mock"
"Scott Brown" ,
"desc"
"字段描述" ,
"sort"
"0" ,
"options"{ }
}
响应示例
200更新成功
{
"project"
"mcc" ,
"ref"
"scope" ,
"refId"
"5a2e75d7c50d3300082ece69" ,
"type"
"number" ,
"library"
"mcc/demo" ,
"version"
"0.0.2" ,
"title"
"title" ,
"default"
"false" ,
"mock"
"Scott Brown" ,
"desc"
"字段描述" ,
"sort"
"0" ,
"options"{ }
}
删除字段
稳定版 Since  1.0.0 已发布

删除字段

接口地址
DELETE/:project/api-library/:library/version/:version/field/:field
路径参数
project
string必须
项目ID
library
string必须
接口库唯一标识符path的值
version
string必须
接口库版本号
field
string必须
字段ID
返回结果
200删除成功
DELETE
/:project/api-library/:library/version/:version/field/:field
响应示例
200删除成功
{ }
看板管理

看板管理相关接口

获取看板模板列表
稳定版 Since  1.0.0 已发布
接口地址
GET/board-template
返回结果
200
BoardTemplate[]
id
string
ID
title
string
标题
pic
string
图片
desc
string
描述
GET
/board-template
响应示例
200
[
{
 ... } 
]
检查看板Path是否存在
稳定版 Since  1.0.0 已发布
接口地址
GET/:project/board/check/:path
路径参数
path
string必须
看板path
project
string必须
项目ID
返回结果
200
ok
boolean
是否可用
GET
/:project/board/check/:path
响应示例
200
{
"ok"
true
}
创建看板
稳定版 Since  1.0.0 已发布
接口地址
POST/:project/board
路径参数
project
string必须
项目ID
Body参数
template
string
模板ID
path
string必须
看板路径
title
string
看板标题
desc
string
描述
返回结果
200
Board
id
string
看板ID
project
string
项目ID
path
string
路径
title
string
标题
desc
string
描述
resourceVersion
number
资源版本
createdAt
string
创建时间
statistical
object
简略统计
POST
/:project/board
请求示例
{
"template"
"development" ,
"path"
"board_path" ,
"title"
"开发板" ,
"desc"
"描述" 
}
响应示例
200
{
"id"
"rEm^S" ,
"project"
"dRku6h^" ,
"path"
"Zg@x" ,
"title"
"bqyk" ,
"desc"
"2rT301" ,
"resourceVersion"
755544700328446 ,
"createdAt"
"GPce" ,
"statistical"{ }
}
获取看板列表
稳定版 Since  1.0.0 已发布
接口地址
GET/:project/board
路径参数
project
string必须
项目ID
返回结果
200
Board[]
id
string
看板ID
project
string
项目ID
path
string
路径
title
string
标题
desc
string
描述
resourceVersion
number
资源版本
createdAt
string
创建时间
statistical
object
简略统计
GET
/:project/board
响应示例
200
[
{
 ... } 
]
获取看板详情
稳定版 Since  1.0.0 已发布
接口地址
GET/:project/board/:board
路径参数
project
string必须
项目ID
board
string必须
看板path
返回结果
200
Board
id
string
看板ID
project
string
项目ID
path
string
路径
title
string
标题
desc
string
描述
resourceVersion
number
资源版本
createdAt
string
创建时间
statistical
object
简略统计
GET
/:project/board/:board
响应示例
200
{
"id"
"rEm^S" ,
"project"
"dRku6h^" ,
"path"
"Zg@x" ,
"title"
"bqyk" ,
"desc"
"2rT301" ,
"resourceVersion"
755544700328446 ,
"createdAt"
"GPce" ,
"statistical"{ }
}
更新看板
稳定版 Since  1.0.0 已发布
接口地址
PATCH/:project/board/:board
路径参数
project
string必须
项目ID
board
string必须
看板path
Body参数
title
string
看板标题
desc
string
描述
返回结果
200
Board
id
string
看板ID
project
string
项目ID
path
string
路径
title
string
标题
desc
string
描述
resourceVersion
number
资源版本
createdAt
string
创建时间
statistical
object
简略统计
PATCH
/:project/board/:board
请求示例
{
"title"
"开发板" ,
"desc"
"新描述" 
}
响应示例
200
{
"id"
"rEm^S" ,
"project"
"dRku6h^" ,
"path"
"Zg@x" ,
"title"
"bqyk" ,
"desc"
"2rT301" ,
"resourceVersion"
755544700328446 ,
"createdAt"
"GPce" ,
"statistical"{ }
}
删除看板
稳定版 Since  1.0.0 已发布
接口地址
DELETE/:project/board/:board
路径参数
project
string必须
项目ID
board
string必须
看板path
返回结果
200
DELETE
/:project/board/:board
响应示例
200
{ }
新建看板状态
稳定版 Since  1.0.0 已发布
接口地址
POST/:project/board/:board/stage
路径参数
project
string必须
项目ID
board
string必须
看板path
Body参数
title
string必须
看板状态标题
parent
string
父看板状态ID
sort
number
排序值
返回结果
200
BoardStage
id
string
看板状态Id
title
string
看板状态标题
board
string
所属看板ID
parent
string默认值:null
所属看板状态ID
sort
number
排序
resourceVersion
number
资源版本号
createdAt
string
创建时间
POST
/:project/board/:board/stage
请求示例
{
"title"
"开发中的任务" ,
"parent"
"stage_id" ,
"sort"
100000000 
}
响应示例
200
{
"id"
"59b3943d3e9564121c632e14" ,
"title"
"待审核" ,
"board"
"testPro/default1" ,
"parent"
"null" ,
"sort"
100000000 ,
"resourceVersion"
45 ,
"createdAt"
"2017-09-09T07:11:57.955Z" 
}
获取状态列表
稳定版 Since  1.0.0 已发布
接口地址
GET/:project/board/:board/stage
路径参数
project
string必须
项目ID
board
string必须
看板path
返回结果
200
BoardStage[]
id
string
看板状态Id
title
string
看板状态标题
board
string
所属看板ID
parent
string默认值:null
所属看板状态ID
sort
number
排序
resourceVersion
number
资源版本号
createdAt
string
创建时间
GET
/:project/board/:board/stage
响应示例
200
[
{
 ... } 
]
删除看板状态
稳定版 Since  1.0.0 已发布
接口地址
DELETE/:project/board/:board/stage/:stage
路径参数
project
string必须
项目ID
board
string必须
看板path
stage
string必须
看板状态ID
返回结果
200
DELETE
/:project/board/:board/stage/:stage
响应示例
200
{ }
更新看板状态
稳定版 Since  1.0.0 已发布
接口地址
PATCH/:project/board/:board/stage/:stage
路径参数
project
string必须
项目ID
board
string必须
看板path
stage
string必须
看板状态ID
Body参数
title
string
看板标题
parent
string
看板父状态ID
sort
number
排序
返回结果
200
BoardStage
id
string
看板状态Id
title
string
看板状态标题
board
string
所属看板ID
parent
string默认值:null
所属看板状态ID
sort
number
排序
resourceVersion
number
资源版本号
createdAt
string
创建时间
PATCH
/:project/board/:board/stage/:stage
请求示例
{
"title"
"test_stage" ,
"parent"
"stage_id" ,
"sort"
100000 
}
响应示例
200
{
"id"
"59b3943d3e9564121c632e14" ,
"title"
"待审核" ,
"board"
"testPro/default1" ,
"parent"
"null" ,
"sort"
100000000 ,
"resourceVersion"
45 ,
"createdAt"
"2017-09-09T07:11:57.955Z" 
}
获取mapping列表
稳定版 Since  1.0.0 已发布
接口地址
GET/:project/story-mapping
路径参数
project
string必须
项目ID
返回结果
200
Mapping[]
id
string
id
title
string
标题
project
string
所属项目ID
board
string
所属看板ID
x
string
x轴属性
y
string
y轴属性
desc
string
描述
resourceVersion
number
资源版本
createdAt
string格式:date-time
创建时间
GET
/:project/story-mapping
响应示例
200
[
{
 ... } 
]
获取mapping详情
稳定版 Since  1.0.0 已发布
接口地址
GET/:project/story-mapping/:mapping
路径参数
project
string必须
项目ID
mapping
string必须
看板mappingID
返回结果
200
Mapping
id
string
id
title
string
标题
project
string
所属项目ID
board
string
所属看板ID
x
string
x轴属性
y
string
y轴属性
desc
string
描述
resourceVersion
number
资源版本
createdAt
string格式:date-time
创建时间
GET
/:project/story-mapping/:mapping
响应示例
200
{
"id"
"59101c5f42554b140e291991" ,
"title"
"NFMM*De" ,
"project"
"testPro" ,
"board"
"testPro/demo" ,
"x"
"user" ,
"y"
"type" ,
"desc"
"描述" ,
"resourceVersion"
10 ,
"createdAt"
"2017-08-29T02:56:08.066Z" 
}
创建mapping
稳定版 Since  1.0.0 已发布
接口地址
POST/:project/story-mapping
路径参数
project
string必须
项目ID
Body参数
title
string
标题
board
string
所属看板ID
x
string
x轴属性
y
string
y轴属性
desc
string
描述
filters
object
过滤条件
返回结果
200
Mapping
id
string
id
title
string
标题
project
string
所属项目ID
board
string
所属看板ID
x
string
x轴属性
y
string
y轴属性
desc
string
描述
resourceVersion
number
资源版本
createdAt
string格式:date-time
创建时间
POST
/:project/story-mapping
请求示例
{
"title"
"NFMM*De" ,
"board"
"testPro/demo" ,
"x"
"user" ,
"y"
"type" ,
"desc"
"描述" ,
"filters"{ }
}
响应示例
200
{
"id"
"59101c5f42554b140e291991" ,
"title"
"NFMM*De" ,
"project"
"testPro" ,
"board"
"testPro/demo" ,
"x"
"user" ,
"y"
"type" ,
"desc"
"描述" ,
"resourceVersion"
10 ,
"createdAt"
"2017-08-29T02:56:08.066Z" 
}
更新mapping
稳定版 Since  1.0.0 已发布
接口地址
PATCH/:project/story-mapping/:mapping
路径参数
project
string必须
项目ID
mapping
string必须
看板mappingID
Body参数
title
string
标题
board
string
所属看板ID
x
string
x轴属性
y
string
y轴属性
desc
string
描述
filters
object
过滤条件
返回结果
200
Mapping
id
string
id
title
string
标题
project
string
所属项目ID
board
string
所属看板ID
x
string
x轴属性
y
string
y轴属性
desc
string
描述
resourceVersion
number
资源版本
createdAt
string格式:date-time
创建时间
PATCH
/:project/story-mapping/:mapping
请求示例
{
"title"
"NFMM*De" ,
"board"
"testPro/demo" ,
"x"
"user" ,
"y"
"type" ,
"desc"
"描述" ,
"filters"{ }
}
响应示例
200
{
"id"
"59101c5f42554b140e291991" ,
"title"
"NFMM*De" ,
"project"
"testPro" ,
"board"
"testPro/demo" ,
"x"
"user" ,
"y"
"type" ,
"desc"
"描述" ,
"resourceVersion"
10 ,
"createdAt"
"2017-08-29T02:56:08.066Z" 
}
删除mapping
稳定版 Since  1.0.0 已发布
接口地址
DELETE/:project/story-mapping/:mapping
路径参数
project
string必须
项目ID
mapping
string必须
看板mappingID
返回结果
200
DELETE
/:project/story-mapping/:mapping
响应示例
200
{ }
创建任务类型
稳定版 Since  1.0.0 已发布
接口地址
POST/:project/task-type
路径参数
project
string必须
项目ID
Body参数
title
string
标题
color
string
颜色
isDefault
boolean默认值:true
是否默认
sort
number
排序
返回结果
200
TaskType
id
string格式:any
id
title
string
标题
project
string
所属项目ID
color
string
颜色
isDefault
boolean默认值:true
是否默认
sort
number
排序
resourceVersion
number
资源版本
createdAt
string格式:date-time
创建时间
POST
/:project/task-type
请求示例
{
"title"
"@^kuy2" ,
"color"
"#049cdb" ,
"isDefault"
true,
"sort"
}
响应示例
200
{
"id"
"59101c5f42554b140e291991" ,
"title"
"@^kuy2" ,
"project"
"testPro" ,
"color"
"#049cdb" ,
"isDefault"
true,
"sort"
,
"resourceVersion"
10 ,
"createdAt"
"2017-08-29T02:56:08.066Z" 
}
获取任务类型列表
稳定版 Since  1.0.0 已发布
接口地址
GET/:project/task-type
路径参数
project
string必须
项目ID
返回结果
200
TaskType[]
id
string格式:any
id
title
string
标题
project
string
所属项目ID
color
string
颜色
isDefault
boolean默认值:true
是否默认
sort
number
排序
resourceVersion
number
资源版本
createdAt
string格式:date-time
创建时间
GET
/:project/task-type
响应示例
200
[
{
 ... } 
]
删除任务类型
稳定版 Since  1.0.0 已发布
接口地址
DELETE/:project/task-type/:id
路径参数
project
string必须
项目ID
id
string必须
要删除的ID
返回结果
200
DELETE
/:project/task-type/:id
响应示例
200
{ }
更新任务类型
稳定版 Since  1.0.0 已发布
接口地址
PATCH/:project/task-type/:id
路径参数
project
string必须
项目ID
id
string必须
任务类型ID
Body参数
title
string
标题
color
string
颜色
isDefault
boolean默认值:true
是否默认
sort
number
排序
返回结果
200
TaskType
id
string格式:any
id
title
string
标题
project
string
所属项目ID
color
string
颜色
isDefault
boolean默认值:true
是否默认
sort
number
排序
resourceVersion
number
资源版本
createdAt
string格式:date-time
创建时间
PATCH
/:project/task-type/:id
请求示例
{
"title"
"@^kuy2" ,
"color"
"#049cdb" ,
"isDefault"
true,
"sort"
}
响应示例
200
{
"id"
"59101c5f42554b140e291991" ,
"title"
"@^kuy2" ,
"project"
"testPro" ,
"color"
"#049cdb" ,
"isDefault"
true,
"sort"
,
"resourceVersion"
10 ,
"createdAt"
"2017-08-29T02:56:08.066Z" 
}
创建任务扩展属性
稳定版 Since  1.0.0 已发布
接口地址
POST/:project/task-property
路径参数
project
string必须
项目ID
Body参数
title
string
属性名
icon
string
图标,参照http://fontawesome.io,例:<i class="fa fa-address-book" aria-hidden="true"></i>,则该字段值为address-book
type
string
属性类型,可用值为 日期 datetime,数字 number,文本 text,分组 group,用户 user
options
object
选项,type为‘group’时可用
sort
number
排序
返回结果
200
TaskProperty
id
string
title
string
属性名
icon
string
图标,参照http://fontawesome.io,例:<i class="fa fa-address-book" aria-hidden="true"></i>,则该字段值为address-book
project
string
所属项目ID
type
string
属性类型,可用值为 日期 datetime,数字 number,文本 text,分组 group,用户 user
options
object
选项,type为‘group’时可用
sort
number
排序
resourceVersion
number
资源版本
createdAt
string格式:date-time
创建时间
POST
/:project/task-property
请求示例
{
"title"
"XAY#o" ,
"icon"
"list" ,
"type"
"group" ,
"options"{ }
"sort"
}
响应示例
200
{
"id"
"59101c5f42554b140e291991" ,
"title"
"XAY#o" ,
"icon"
"list" ,
"project"
"testPro" ,
"type"
"group" ,
"options"{ }
"sort"
,
"resourceVersion"
10 ,
"createdAt"
"2017-08-29T02:56:08.066Z" 
}
获取任务扩展属性列表
稳定版 Since  1.0.0 已发布
接口地址
GET/:project/task-property
路径参数
project
string必须
项目ID
返回结果
200
TaskProperty[]
id
string
title
string
属性名
icon
string
图标,参照http://fontawesome.io,例:<i class="fa fa-address-book" aria-hidden="true"></i>,则该字段值为address-book
project
string
所属项目ID
type
string
属性类型,可用值为 日期 datetime,数字 number,文本 text,分组 group,用户 user
options
object
选项,type为‘group’时可用
sort
number
排序
resourceVersion
number
资源版本
createdAt
string格式:date-time
创建时间
GET
/:project/task-property
响应示例
200
[
{
 ... } 
]
删除任务扩展属性
稳定版 Since  1.0.0 已发布
接口地址
DELETE/:project/task-property/:id
路径参数
project
string必须
项目ID
id
string必须
要删除的ID
返回结果
200
DELETE
/:project/task-property/:id
响应示例
200
{ }
更新任务扩展属性
稳定版 Since  1.0.0 已发布
接口地址
PATCH/:project/task-property/:id
路径参数
project
string必须
项目ID
id
string必须
ID
Body参数
title
string
属性名
icon
string
图标,参照http://fontawesome.io,例:<i class="fa fa-address-book" aria-hidden="true"></i>,则该字段值为address-book
type
string
属性类型,可用值为 日期 datetime,数字 number,文本 text,分组 group,用户 user
options
object
选项,type为‘group’时可用
sort
number
排序
返回结果
200
TaskProperty
id
string
title
string
属性名
icon
string
图标,参照http://fontawesome.io,例:<i class="fa fa-address-book" aria-hidden="true"></i>,则该字段值为address-book
project
string
所属项目ID
type
string
属性类型,可用值为 日期 datetime,数字 number,文本 text,分组 group,用户 user
options
object
选项,type为‘group’时可用
sort
number
排序
resourceVersion
number
资源版本
createdAt
string格式:date-time
创建时间
PATCH
/:project/task-property/:id
请求示例
{
"title"
"XAY#o" ,
"icon"
"list" ,
"type"
"group" ,
"options"{ }
"sort"
}
响应示例
200
{
"id"
"59101c5f42554b140e291991" ,
"title"
"XAY#o" ,
"icon"
"list" ,
"project"
"testPro" ,
"type"
"group" ,
"options"{ }
"sort"
,
"resourceVersion"
10 ,
"createdAt"
"2017-08-29T02:56:08.066Z" 
}
创建看板任务
稳定版 Since  1.0.0 已发布
接口地址
POST/:project/task
路径参数
project
string必须
项目ID
Body参数
title
string
看板任务标题
type
string
任务类型
board
string
所属看板ID
stage
string
所属泳道ID
director
string
负责人ID
members
参与者列表
startAt
string格式:date-time
任务开始时间
endAt
string格式:date-time
任务结束时间
timeTotal
number
任务总工时
priority
number长度:0~2
任务级别
timeUsed
number
实际工时
desc
string
任务描述
tags
string[]
任务标签列表
properties
object
任务扩展属性
sort
number
任务排序编号
返回结果
200
Task
id
string
看板任务ID
title
string
看板任务标题
iid
number
项目下唯一自增ID
type
string
任务类型
project
string
所属项目ID
board
string
所属看板ID
done
boolean默认值:false
是否完成
stage
string
所属泳道ID
user
所属用户基本信息
director
string
负责人ID
members
参与者列表
startAt
string格式:date-time
任务开始时间
endAt
string格式:date-time
任务结束时间
timeTotal
number
任务总工时
priority
number长度:0~2
任务级别
timeUsed
number
实际工时
desc
string
任务描述
tags
string[]
任务标签列表
properties
object
任务扩展属性
sort
number
任务排序编号
resourceVersion
number
资源版本
updatedAt
string格式:date-time
任务更新时间
redo
boolean
任务是否是重做的
createdAt
string格式:date-time
任务创建时间
POST
/:project/task
请求示例
{
"title"
"新任务" ,
"type"
"59a6549dbab76511b4b30813" ,
"board"
"testPro/lean" ,
"stage"
"59a779a4a328a8079cd97c19" ,
"director"
"59a779a4a328a8079cd97c19" ,
"members"[
 ... ] ,
] ,
"startAt"
"2017-08-29T02:56:08.066Z" ,
"endAt"
"2017-08-29T02:56:08.066Z" ,
"timeTotal"
,
"priority"
,
"timeUsed"
,
"desc"
"任务描述" ,
"tags"[
 ... ] ,
] ,
"properties"{ }
"sort"
880951500 
}
响应示例
200
{
"id"
"testPro/16" ,
"title"
"新任务" ,
"iid"
16 ,
"type"
"59a6549dbab76511b4b30813" ,
"project"
"testPro" ,
"board"
"testPro/lean" ,
"done"
false,
"stage"
"59a779a4a328a8079cd97c19" ,
"user"
{
 ... } ,
} ,
"director"
"59a779a4a328a8079cd97c19" ,
"members"[
 ... ] ,
] ,
"startAt"
"2017-08-29T02:56:08.066Z" ,
"endAt"
"2017-08-29T02:56:08.066Z" ,
"timeTotal"
,
"priority"
,
"timeUsed"
,
"desc"
"任务描述" ,
"tags"[
 ... ] ,
] ,
"properties"{ }
"sort"
880951500 ,
"resourceVersion"
10 ,
"updatedAt"
"2017-08-29T02:56:08.066Z" ,
"redo"
true,
"createdAt"
"2017-08-29T02:56:08.066Z" 
}
获取任务列表
稳定版 Since  1.0.0 已发布
接口地址
GET/:project/task
路径参数
project
string必须
项目ID
返回结果
200
Task[]
id
string
看板任务ID
title
string
看板任务标题
iid
number
项目下唯一自增ID
type
string
任务类型
project
string
所属项目ID
board
string
所属看板ID
done
boolean默认值:false
是否完成
stage
string
所属泳道ID
user
所属用户基本信息
director
string
负责人ID
members
参与者列表
startAt
string格式:date-time
任务开始时间
endAt
string格式:date-time
任务结束时间
timeTotal
number
任务总工时
priority
number长度:0~2
任务级别
timeUsed
number
实际工时
desc
string
任务描述
tags
string[]
任务标签列表
properties
object
任务扩展属性
sort
number
任务排序编号
resourceVersion
number
资源版本
updatedAt
string格式:date-time
任务更新时间
redo
boolean
任务是否是重做的
createdAt
string格式:date-time
任务创建时间
GET
/:project/task
响应示例
200
[
{
 ... } 
]
获取任务详情
稳定版 Since  1.0.0 已发布
接口地址
GET/:project/task/:task
路径参数
project
string必须
项目ID
task
string必须
任务iid
返回结果
200
Task
id
string
看板任务ID
title
string
看板任务标题
iid
number
项目下唯一自增ID
type
string
任务类型
project
string
所属项目ID
board
string
所属看板ID
done
boolean默认值:false
是否完成
stage
string
所属泳道ID
user
所属用户基本信息
director
string
负责人ID
members
参与者列表
startAt
string格式:date-time
任务开始时间
endAt
string格式:date-time
任务结束时间
timeTotal
number
任务总工时
priority
number长度:0~2
任务级别
timeUsed
number
实际工时
desc
string
任务描述
tags
string[]
任务标签列表
properties
object
任务扩展属性
sort
number
任务排序编号
resourceVersion
number
资源版本
updatedAt
string格式:date-time
任务更新时间
redo
boolean
任务是否是重做的
createdAt
string格式:date-time
任务创建时间
GET
/:project/task/:task
响应示例
200
{
"id"
"testPro/16" ,
"title"
"新任务" ,
"iid"
16 ,
"type"
"59a6549dbab76511b4b30813" ,
"project"
"testPro" ,
"board"
"testPro/lean" ,
"done"
false,
"stage"
"59a779a4a328a8079cd97c19" ,
"user"
{
 ... } ,
} ,
"director"
"59a779a4a328a8079cd97c19" ,
"members"[
 ... ] ,
] ,
"startAt"
"2017-08-29T02:56:08.066Z" ,
"endAt"
"2017-08-29T02:56:08.066Z" ,
"timeTotal"
,
"priority"
,
"timeUsed"
,
"desc"
"任务描述" ,
"tags"[
 ... ] ,
] ,
"properties"{ }
"sort"
880951500 ,
"resourceVersion"
10 ,
"updatedAt"
"2017-08-29T02:56:08.066Z" ,
"redo"
true,
"createdAt"
"2017-08-29T02:56:08.066Z" 
}
删除看板任务
稳定版 Since  1.0.0 已发布
接口地址
DELETE/:project/task/:task
路径参数
project
string必须
项目ID
task
string必须
任务iid
返回结果
200
DELETE
/:project/task/:task
响应示例
200
{ }
更新看板任务
稳定版 Since  1.0.0 已发布

只返回更新后的字段

接口地址
PATCH/:project/task/:task
路径参数
project
string必须
项目ID
task
string必须
任务iid
Body参数
只返回更新后的字段
title
string
看板任务标题
type
string
任务类型
board
string
所属看板ID
done
boolean默认值:false
是否完成
stage
string
所属泳道ID
director
string
负责人ID
members
参与者列表
startAt
string格式:date-time
任务开始时间
endAt
string格式:date-time
任务结束时间
timeTotal
number
任务总工时
priority
number长度:0~2
任务级别
timeUsed
number
实际工时
desc
string
任务描述
tags
string[]
任务标签列表
properties
object
任务扩展属性
sort
number
任务排序编号
返回结果
200
Task
id
string
看板任务ID
title
string
看板任务标题
iid
number
项目下唯一自增ID
type
string
任务类型
project
string
所属项目ID
board
string
所属看板ID
done
boolean默认值:false
是否完成
stage
string
所属泳道ID
user
所属用户基本信息
director
string
负责人ID
members
参与者列表
startAt
string格式:date-time
任务开始时间
endAt
string格式:date-time
任务结束时间
timeTotal
number
任务总工时
priority
number长度:0~2
任务级别
timeUsed
number
实际工时
desc
string
任务描述
tags
string[]
任务标签列表
properties
object
任务扩展属性
sort
number
任务排序编号
resourceVersion
number
资源版本
updatedAt
string格式:date-time
任务更新时间
redo
boolean
任务是否是重做的
createdAt
string格式:date-time
任务创建时间
PATCH
/:project/task/:task
请求示例
{
"title"
"新任务" ,
"type"
"59a6549dbab76511b4b30813" ,
"board"
"testPro/lean" ,
"done"
false,
"stage"
"59a779a4a328a8079cd97c19" ,
"director"
"59a779a4a328a8079cd97c19" ,
"members"[
 ... ] ,
] ,
"startAt"
"2017-08-29T02:56:08.066Z" ,
"endAt"
"2017-08-29T02:56:08.066Z" ,
"timeTotal"
,
"priority"
,
"timeUsed"
,
"desc"
"任务描述" ,
"tags"[
 ... ] ,
] ,
"properties"{ }
"sort"
880951500 
}
响应示例
200
{
"id"
"testPro/16" ,
"title"
"新任务" ,
"iid"
16 ,
"type"
"59a6549dbab76511b4b30813" ,
"project"
"testPro" ,
"board"
"testPro/lean" ,
"done"
false,
"stage"
"59a779a4a328a8079cd97c19" ,
"user"
{
 ... } ,
} ,
"director"
"59a779a4a328a8079cd97c19" ,
"members"[
 ... ] ,
] ,
"startAt"
"2017-08-29T02:56:08.066Z" ,
"endAt"
"2017-08-29T02:56:08.066Z" ,
"timeTotal"
,
"priority"
,
"timeUsed"
,
"desc"
"任务描述" ,
"tags"[
 ... ] ,
] ,
"properties"{ }
"sort"
880951500 ,
"resourceVersion"
10 ,
"updatedAt"
"2017-08-29T02:56:08.066Z" ,
"redo"
true,
"createdAt"
"2017-08-29T02:56:08.066Z" 
}
获取看板任务事件列表
稳定版 Since  1.0.0 已发布
接口地址
GET/:project/task/:task/event
路径参数
project
string必须
项目ID
task
string必须
任务iid
返回结果
200
TaskEvent[]
id
string格式:any
title
string
事件标题
icon
string
图标,参照http://fontawesome.io,例:<i class="fa fa-address-book" aria-hidden="true"></i>,则该字段值为address-book
task
string
任务iid
from
来源,事件触发者
type
string
任务类型
info
object
附加信息
createdAt
string格式:date-time
创建时间
GET
/:project/task/:task/event
响应示例
200
[
{
 ... } 
]
获取任务工时列表
稳定版 Since  1.0.0 已发布
接口地址
GET/:project/task/:task/time
路径参数
project
string必须
项目ID
task
string必须
任务iid
返回结果
200
TaskTime[]
id
string格式:any
task
string
任务ID
user
所属用户基本信息
value
number
工时
createdAt
string格式:date-time
创建时间
GET
/:project/task/:task/time
响应示例
200
[
{
 ... } 
]
添加看板任务工时
稳定版 Since  1.0.0 已发布
接口地址
POST/:project/task/:task/time
路径参数
project
string必须
项目ID
task
string必须
任务iid
Body参数
time
number
使用工时
返回结果
200
TaskTime
id
string格式:any
task
string
任务ID
user
所属用户基本信息
value
number
工时
createdAt
string格式:date-time
创建时间
POST
/:project/task/:task/time
请求示例
{
"time"
1433779975391036 
}
响应示例
200
{
"id"
"59101c5f42554b140e291991" ,
"task"
"Q92vB" ,
"user"
{
 ... } ,
} ,
"value"
899725855462554 ,
"createdAt"
"2017-08-29T02:56:08.066Z" 
}
删除看板任务工时
稳定版 Since  1.0.0 已发布
接口地址
GET/:project/task/:task/time/:time
路径参数
project
string必须
项目ID
task
string必须
任务iid
time
string必须
任务工时ID
返回结果
200
GET
/:project/task/:task/time/:time
响应示例
200
{ }
构建管理
创建构建工程
稳定版 Since  1.0.0 已发布
接口地址
POST/:project/builder
路径参数
project
string必须
项目ID
Body参数
path
string必须
构建工程路径
title
string
工程标题
pic
string
图片地址
desc
string
描述
archiveFile
string
归档文件名
image
string必须
镜像地址
env
object
services
object[]
挂载服务列表
sources
object[]必须
代码仓库列表
before
object[]
构建前步骤
steps
object[]必须
构建步骤
after
object[]
构建后步骤
triggerToken
string
构建令牌
gitCommitTrigger
boolean
提交代码是否触发构建
gitMergeTrigger
boolean
合并代码是否触发构建
dayTime
number
每天构建时间 (小时)
weekTime
number
每周构建时间 (小时)
weekDay
number[]
每周构建时间(星期X)
useCache
boolean
是否使用缓存
activated
boolean
是否激活
timeLimit
number
超时时间
返回结果
200
Builder
id
string
构建工程ID
path
string
构建工程路径
title
string
构建工程标题
pic
string
构建工程图片
lastSuccess
number
最后一次成功的任务编号
lastAt
string
最后一次构建时间
lastFailed
number
最后一次失败的任务编号
lastState
number
最后一次任务状态
lastSuccessSpend
number
最后一次成功构建时长
lastFailedSpend
number
最后一次失败构建时长
lastTriggered
number
最后触发的任务编号
image
string
镜像地址
lastSpend
number
最后一次构建时长
lastTriggeredUser
最后一次构建人
resourceVersion
number
资源版本
hasCache
boolean
是否有缓存
running
boolean
是否正在构建
POST
/:project/builder
请求示例
{
"path"
"builder_path" ,
"title"
"UsChrM6" ,
"pic"
"1*UZTbn" ,
"desc"
"GR4P" ,
"archiveFile"
"index.js" ,
"image"
"Xc9E" ,
"env"{ }
"services"[
 ... ] ,
] ,
"sources"[
 ... ] ,
] ,
"before"[
 ... ] ,
] ,
"steps"[
 ... ] ,
] ,
"after"[
 ... ] ,
] ,
"triggerToken"
"ZLDkH8[" ,
"gitCommitTrigger"
true,
"gitMergeTrigger"
true,
"dayTime"
6798183141825954 ,
"weekTime"
808986295347130 ,
"weekDay"[
 ... ] ,
] ,
"useCache"
true,
"activated"
true,
"timeLimit"
4218275075991030 
}
响应示例
200
{
"id"
"mcc/builder_path" ,
"path"
"builder_path" ,
"title"
"后台构建" ,
"pic"
"https://maichong.io/pic/builder.png" ,
"lastSuccess"
13 ,
"lastAt"
"2017-12-13T08:19:42.312Z" ,
"lastFailed"
12 ,
"lastState"
500 ,
"lastSuccessSpend"
62 ,
"lastFailedSpend"
,
"lastTriggered"
15 ,
"image"
"https://maichong.io/image/core:latest" ,
"lastSpend"
45 ,
"lastTriggeredUser"
{
 ... } ,
} ,
"resourceVersion"
8486470608708120 ,
"hasCache"
true,
"running"
true
}
获取构建工程列表
稳定版 Since  1.0.0 已发布
接口地址
GET/:project/builder
路径参数
project
string必须
项目ID
返回结果
200
Builder$List[]
id
string
构建工程ID
path
string
构建工程路径
title
string
构建工程标题
pic
string
构建工程图片
lastSuccess
number
最后一次成功的任务编号
lastAt
string
最后一次构建时间
lastFailed
number
最后一次失败的任务编号
lastState
number
最后一次任务状态
lastSuccessSpend
number
最后一次成功构建时长
lastFailedSpend
number
最后一次失败构建时长
lastTriggered
number
最后触发的任务编号
image
string
镜像地址
lastSpend
number
最后一次构建时长
lastTriggeredUser
最后一次构建人
resourceVersion
number
资源版本
GET
/:project/builder
响应示例
200
[
{
 ... } 
]
获取构建工程详情
稳定版 Since  1.0.0 已发布
接口地址
GET/:project/builder/:builder
路径参数
project
string必须
项目ID
builder
string必须
构建工程path
返回结果
200
Builder
id
string
构建工程ID
path
string
构建工程路径
title
string
构建工程标题
pic
string
构建工程图片
lastSuccess
number
最后一次成功的任务编号
lastAt
string
最后一次构建时间
lastFailed
number
最后一次失败的任务编号
lastState
number
最后一次任务状态
lastSuccessSpend
number
最后一次成功构建时长
lastFailedSpend
number
最后一次失败构建时长
lastTriggered
number
最后触发的任务编号
image
string
镜像地址
lastSpend
number
最后一次构建时长
lastTriggeredUser
最后一次构建人
resourceVersion
number
资源版本
hasCache
boolean
是否有缓存
running
boolean
是否正在构建
GET
/:project/builder/:builder
响应示例
200
{
"id"
"mcc/builder_path" ,
"path"
"builder_path" ,
"title"
"后台构建" ,
"pic"
"https://maichong.io/pic/builder.png" ,
"lastSuccess"
13 ,
"lastAt"
"2017-12-13T08:19:42.312Z" ,
"lastFailed"
12 ,
"lastState"
500 ,
"lastSuccessSpend"
62 ,
"lastFailedSpend"
,
"lastTriggered"
15 ,
"image"
"https://maichong.io/image/core:latest" ,
"lastSpend"
45 ,
"lastTriggeredUser"
{
 ... } ,
} ,
"resourceVersion"
8486470608708120 ,
"hasCache"
true,
"running"
true
}
更新构建工程
稳定版 Since  1.0.0 已发布
接口地址
PATCH/:project/builder/:builder
路径参数
project
string必须
项目ID
builder
string必须
构建工程path
Body参数
title
string必须
构建工程标题
pic
string
图片地址
desc
string
描述
archiveFile
string
归档文件
image
string必须
镜像地址
env
object
环境变量
services
object[]
挂载服务列表
sources
object[]必须
代码仓库列表
before
object[]
构建前步骤列表
steps
object[]必须
构建步骤列表
after
object[]
构建后步骤列表
triggerToken
string
构建令牌
gitCommitTrigger
boolean
代码提交是否触发
gitMergeTrigger
boolean
代码合并是否触发
dayTime
number
每天触发构建时间(小时)
weekTime
number
每周触发构建时间(小时)
weekDay
number[]
每周触发构建时间(星期X)
useCache
boolean
是否使用缓存
activated
boolean
是否激活
timeLimit
number
超时时间
返回结果
200
Builder
id
string
构建工程ID
path
string
构建工程路径
title
string
构建工程标题
pic
string
构建工程图片
lastSuccess
number
最后一次成功的任务编号
lastAt
string
最后一次构建时间
lastFailed
number
最后一次失败的任务编号
lastState
number
最后一次任务状态
lastSuccessSpend
number
最后一次成功构建时长
lastFailedSpend
number
最后一次失败构建时长
lastTriggered
number
最后触发的任务编号
image
string
镜像地址
lastSpend
number
最后一次构建时长
lastTriggeredUser
最后一次构建人
resourceVersion
number
资源版本
hasCache
boolean
是否有缓存
running
boolean
是否正在构建
PATCH
/:project/builder/:builder
请求示例
{
"title"
"GT01mt" ,
"pic"
"&iZob2" ,
"desc"
"a*1Qm" ,
"archiveFile"
"qSNJKcs" ,
"image"
"4&@j1" ,
"env"{ }
"services"[
 ... ] ,
] ,
"sources"[
 ... ] ,
] ,
"before"[
 ... ] ,
] ,
"steps"[
 ... ] ,
] ,
"after"[
 ... ] ,
] ,
"triggerToken"
"rNg6MH" ,
"gitCommitTrigger"
true,
"gitMergeTrigger"
true,
"dayTime"
5706893187473376 ,
"weekTime"
8047528318838058 ,
"weekDay"[
 ... ] ,
] ,
"useCache"
true,
"activated"
true,
"timeLimit"
5602528571272142 
}
响应示例
200
{
"id"
"mcc/builder_path" ,
"path"
"builder_path" ,
"title"
"后台构建" ,
"pic"
"https://maichong.io/pic/builder.png" ,
"lastSuccess"
13 ,
"lastAt"
"2017-12-13T08:19:42.312Z" ,
"lastFailed"
12 ,
"lastState"
500 ,
"lastSuccessSpend"
62 ,
"lastFailedSpend"
,
"lastTriggered"
15 ,
"image"
"https://maichong.io/image/core:latest" ,
"lastSpend"
45 ,
"lastTriggeredUser"
{
 ... } ,
} ,
"resourceVersion"
8486470608708120 ,
"hasCache"
true,
"running"
true
}
删除构建工程
稳定版 Since  1.0.0 已发布
接口地址
DELETE/:project/builder/:builder
路径参数
project
string必须
项目ID
builder
string必须
构建工程path
返回结果
200
DELETE
/:project/builder/:builder
响应示例
200
{ }
删除构建缓存
稳定版 Since  1.0.0 已发布
接口地址
DELETE/:project/builder/:builder/cache
路径参数
project
string必须
项目ID
builder
string必须
构建工程path
返回结果
200
Builder
id
string
构建工程ID
path
string
构建工程路径
title
string
构建工程标题
pic
string
构建工程图片
lastSuccess
number
最后一次成功的任务编号
lastAt
string
最后一次构建时间
lastFailed
number
最后一次失败的任务编号
lastState
number
最后一次任务状态
lastSuccessSpend
number
最后一次成功构建时长
lastFailedSpend
number
最后一次失败构建时长
lastTriggered
number
最后触发的任务编号
image
string
镜像地址
lastSpend
number
最后一次构建时长
lastTriggeredUser
最后一次构建人
resourceVersion
number
资源版本
hasCache
boolean
是否有缓存
running
boolean
是否正在构建
DELETE
/:project/builder/:builder/cache
响应示例
200
{
"id"
"mcc/builder_path" ,
"path"
"builder_path" ,
"title"
"后台构建" ,
"pic"
"https://maichong.io/pic/builder.png" ,
"lastSuccess"
13 ,
"lastAt"
"2017-12-13T08:19:42.312Z" ,
"lastFailed"
12 ,
"lastState"
500 ,
"lastSuccessSpend"
62 ,
"lastFailedSpend"
,
"lastTriggered"
15 ,
"image"
"https://maichong.io/image/core:latest" ,
"lastSpend"
45 ,
"lastTriggeredUser"
{
 ... } ,
} ,
"resourceVersion"
8486470608708120 ,
"hasCache"
true,
"running"
true
}
获取所有构建基础环境列表
稳定版 Since  1.0.0 已发布
接口地址
GET/builder-environment
返回结果
200
BuilderEnvironment[]
id
string
环境ID
title
string
环境标题
pic
string
环境图片
image
string
镜像地址
desc
string
描述
versions
mix
版本列表
GET
/builder-environment
响应示例
200
[
{
 ... } 
]
获取所有构建基础服务列表
稳定版 Since  1.0.0 已发布
接口地址
GET/builder-service
返回结果
200
BuilderService[]
id
string
环境ID
title
string
环境标题
pic
string
环境图片
image
string
镜像地址
desc
string
描述
versions
mix
版本列表
GET
/builder-service
响应示例
200
[
{
 ... } 
]
获取构建任务列表
稳定版 Since  1.0.0 已发布
接口地址
GET/:project/builder/:builder/task/paginate
路径参数
project
string必须
项目ID
builder
string必须
构建工程path
查询参数
_page
string
查询页数
_limit
string
每页记录数
返回结果
200
BuilderTask$List[]
id
string
构建任务ID
iid
number
项目下唯一自增编号
state
number
任务状态
createdAt
string
创建时间
spend
number
构建时长
archiveFile
string
归档文件
archiveSize
number
归档文件大小MiB
GET
/:project/builder/:builder/task/paginate
响应示例
200
[
{
 ... } 
]
触发一次构建
稳定版 Since  1.0.0 已发布
接口地址
POST/:project/builder/:builder/task
路径参数
project
string必须
项目ID
builder
string必须
构建工程path
返回结果
200
iid
number
构建任务iid
POST
/:project/builder/:builder/task
响应示例
200
{
"iid"
22 
}
获取一次构建详情
稳定版 Since  1.0.0 已发布
接口地址
GET/:project/builder/:builder/task/:iid
路径参数
project
string必须
项目ID
builder
string必须
构建工程path
iid
string
任务编号
返回结果
200
BuilderTask
id
string
构建任务ID
iid
number
项目下唯一自增编号
state
number
任务状态
createdAt
string
创建时间
spend
number
构建时长
archiveFile
string
归档文件
archiveSize
number
归档文件大小MiB
builder
string
构建工程id
logs
string
构建日志
user
构建者
startedAt
string格式:date-time
开始构建时间
endAt
string格式:date-time
结束构建时间
trigger
string
触发方式
archivePath
string
归档文件地址
fullLogs
boolean
是否显示所有日志
skipLogs
number
跳过日志行数
GET
/:project/builder/:builder/task/:iid
响应示例
200
{
"id"
"mcc/builder_path/14" ,
"iid"
14 ,
"state"
500 ,
"createdAt"
"2017-12-13T08:19:42.312Z" ,
"spend"
45 ,
"archiveFile"
"index.js" ,
"archiveSize"
102400 ,
"builder"
"mcc/builder_path" ,
"logs"
"+20130101 日志开始 +20130101 日志内容 +20130101 日志内容 +20130101 日志结束 +SUCCESS" ,
"user"
{
 ... } ,
} ,
"startedAt"
"2017-12-13T08:19:42.312Z" ,
"endAt"
"2017-12-13T08:19:42.312Z" ,
"trigger"
"builder" ,
"archivePath"
"https://oss.maichong.io/builder/file/builder_path" ,
"fullLogs"
true,
"skipLogs"
200 
}
删除一次构建详情
稳定版 Since  1.0.0 已发布
接口地址
DELETE/:project/builder/:builder/task/:iid
路径参数
project
string必须
项目ID
builder
string必须
构建工程path
iid
string必须
任务编号
返回结果
200
DELETE
/:project/builder/:builder/task/:iid
响应示例
200
{ }
终止一次构建
稳定版 Since  1.0.0 已发布
接口地址
POST/:project/builder/:builder/task/:iid/abort
路径参数
project
string必须
项目ID
builder
string必须
构建工程path
iid
string必须
构建任务编号
返回结果
200
POST
/:project/builder/:builder/task/:iid/abort
响应示例
200
{ }
文档管理
创建文档库
稳定版 Since  1.0.0 已发布
接口地址
POST/:project/document-library
路径参数
project
string必须
项目ID
Body参数
title
string
标题
path
string
路径
pic
string
图片地址
desc
string
描述
返回结果
200
DocumentLibrary
id
string
文档库ID
project
string
项目ID
title
string
文档库标题
path
string
文档库路径
pic
string
文档库图片
desc
string
描述
sort
number默认值:100
排序
createdAt
string
创建日期
POST
/:project/document-library
请求示例
{
"title"
"企业版" ,
"path"
"test" ,
"pic"
"https://c.maichong.io/img/201708/599be3135810d3000907433e.png" ,
"desc"
"@#XxuY" 
}
响应示例
200
{
"id"
"mcc/doc_path" ,
"project"
"mcc" ,
"title"
"脉冲云文档定义" ,
"path"
"doc_path" ,
"pic"
"https://maichong.io/pic/doc.png" ,
"desc"
"api文档列表" ,
"sort"
100 ,
"createdAt"
"2017-12-13T08:19:42.312Z" 
}
获取文档库列表
稳定版 Since  1.0.0 已发布
接口地址
GET/:project/document-library
路径参数
project
string必须
项目ID
返回结果
200
DocumentLibrary[]
id
string
文档库ID
project
string
项目ID
title
string
文档库标题
path
string
文档库路径
pic
string
文档库图片
desc
string
描述
sort
number默认值:100
排序
createdAt
string
创建日期
GET
/:project/document-library
响应示例
200
[
{
 ... } 
]
获取文档库详情
稳定版 Since  1.0.0 已发布
接口地址
GET/:project/document-library/:documentLibrary
路径参数
project
string必须
项目ID
documentLibrary
string必须
文档库path
返回结果
200
DocumentLibrary
id
string
文档库ID
project
string
项目ID
title
string
文档库标题
path
string
文档库路径
pic
string
文档库图片
desc
string
描述
sort
number默认值:100
排序
createdAt
string
创建日期
GET
/:project/document-library/:documentLibrary
响应示例
200
{
"id"
"mcc/doc_path" ,
"project"
"mcc" ,
"title"
"脉冲云文档定义" ,
"path"
"doc_path" ,
"pic"
"https://maichong.io/pic/doc.png" ,
"desc"
"api文档列表" ,
"sort"
100 ,
"createdAt"
"2017-12-13T08:19:42.312Z" 
}
删除文档库
稳定版 Since  1.0.0 已发布
接口地址
DELETE/:project/document-library/:documentLibrary
路径参数
project
string必须
项目ID
documentLibrary
string必须
文档库path
返回结果
200
DELETE
/:project/document-library/:documentLibrary
响应示例
200
{ }
编辑文档库
稳定版 Since  1.0.0 已发布
接口地址
PATCH/:project/document-library/:documentLibrary
路径参数
project
string必须
项目ID
documentLibrary
string必须
文档库path
Body参数
title
string
文档库标题
pic
string
文档库图片
desc
string
描述
返回结果
200
DocumentLibrary
id
string
文档库ID
project
string
项目ID
title
string
文档库标题
path
string
文档库路径
pic
string
文档库图片
desc
string
描述
sort
number默认值:100
排序
createdAt
string
创建日期
PATCH
/:project/document-library/:documentLibrary
请求示例
{
"title"
"脉冲云文档定义" ,
"pic"
"https://maichong.io/pic/doc.png" ,
"desc"
"api文档列表" 
}
响应示例
200
{
"id"
"mcc/doc_path" ,
"project"
"mcc" ,
"title"
"脉冲云文档定义" ,
"path"
"doc_path" ,
"pic"
"https://maichong.io/pic/doc.png" ,
"desc"
"api文档列表" ,
"sort"
100 ,
"createdAt"
"2017-12-13T08:19:42.312Z" 
}
创建文档
稳定版 Since  1.0.0 已发布
接口地址
POST/:project/document
路径参数
project
string必须
项目ID
Body参数
library
string必须
文档库ID
title
string必须
标题
content
string必须
内容
tags
string[]
标签
返回结果
200
Document
id
string
文档ID
project
string
所属项目ID
library
string
所属文档库ID
iid
number
项目下唯一编号
title
string
标题
tags
string[]
标签列表
content
string
内容
revision
number
当前版本
updatedBy
string
最后更新者ID
updatedAt
string
最后更新时间
createdBy
string
创建者
createdAt
string
创建时间
POST
/:project/document
请求示例
{
"library"
"kU)!" ,
"title"
"p9r" ,
"content"
"HQN" ,
"tags"[
 ... ] 
}
响应示例
200
{
"id"
"mcc/14" ,
"project"
"mcc" ,
"library"
"mcc/doc_path" ,
"iid"
14 ,
"title"
"开发文档" ,
"tags"[ ]
"content"
"开发文档内容..." ,
"revision"
,
"updatedBy"
"5a2e63eebe7680000585ff14" ,
"updatedAt"
"2017-12-13T08:19:42.312Z" ,
"createdBy"
"5a2e63eebe7680000585ff14" ,
"createdAt"
"2017-12-13T08:19:42.312Z" 
}
更新文档
稳定版 Since  1.0.0 已发布
接口地址
PATCH/:project/document/:document
路径参数
project
string必须
项目ID
document
string必须
文档编号
Body参数
library
string
title
string
标题
content
string
内容
tags
string[]
标签
返回结果
200
Document
id
string
文档ID
project
string
所属项目ID
library
string
所属文档库ID
iid
number
项目下唯一编号
title
string
标题
tags
string[]
标签列表
content
string
内容
revision
number
当前版本
updatedBy
string
最后更新者ID
updatedAt
string
最后更新时间
createdBy
string
创建者
createdAt
string
创建时间
PATCH
/:project/document/:document
请求示例
{
"library"
"jLzV" ,
"title"
"cdZ" ,
"content"
"o]s7" ,
"tags"[
 ... ] 
}
响应示例
200
{
"id"
"mcc/14" ,
"project"
"mcc" ,
"library"
"mcc/doc_path" ,
"iid"
14 ,
"title"
"开发文档" ,
"tags"[ ]
"content"
"开发文档内容..." ,
"revision"
,
"updatedBy"
"5a2e63eebe7680000585ff14" ,
"updatedAt"
"2017-12-13T08:19:42.312Z" ,
"createdBy"
"5a2e63eebe7680000585ff14" ,
"createdAt"
"2017-12-13T08:19:42.312Z" 
}
获取文档列表
稳定版 Since  1.0.0 已发布
接口地址
GET/:project/document
路径参数
project
string必须
项目ID
查询参数
library
string必须
文档库path
返回结果
200
Document[]
id
string
文档ID
project
string
所属项目ID
library
string
所属文档库ID
iid
number
项目下唯一编号
title
string
标题
tags
string[]
标签列表
content
string
内容
revision
number
当前版本
updatedBy
string
最后更新者ID
updatedAt
string
最后更新时间
createdBy
string
创建者
createdAt
string
创建时间
GET
/:project/document
响应示例
200
[
{
 ... } 
]
获取文档详情
稳定版 Since  1.0.0 已发布
接口地址
GET/:project/document/:document
路径参数
project
string必须
document
string必须
文档编号
返回结果
200
Document
id
string
文档ID
project
string
所属项目ID
library
string
所属文档库ID
iid
number
项目下唯一编号
title
string
标题
tags
string[]
标签列表
content
string
内容
revision
number
当前版本
updatedBy
string
最后更新者ID
updatedAt
string
最后更新时间
createdBy
string
创建者
createdAt
string
创建时间
403错误信息
GET
/:project/document/:document
响应示例
200
403错误信息
{
"id"
"mcc/14" ,
"project"
"mcc" ,
"library"
"mcc/doc_path" ,
"iid"
14 ,
"title"
"开发文档" ,
"tags"[ ]
"content"
"开发文档内容..." ,
"revision"
,
"updatedBy"
"5a2e63eebe7680000585ff14" ,
"updatedAt"
"2017-12-13T08:19:42.312Z" ,
"createdBy"
"5a2e63eebe7680000585ff14" ,
"createdAt"
"2017-12-13T08:19:42.312Z" 
}
删除文档
稳定版 Since  1.0.0 已发布
接口地址
DELETE/:project/document/:document
路径参数
project
string必须
document
string必须
文档编号
返回结果
200
DELETE
/:project/document/:document
响应示例
200
{ }
获取历史版本列表
稳定版 Since  1.0.0 已发布
接口地址
GET/:project/document/:document/revision
路径参数
project
string必须
项目ID
document
string必须
文档编号
返回结果
200
DocumentRevision[]
id
string格式:any
版本ID
project
string
所属项目ID
document
string
所属文档ID
title
string
标题
content
string
内容
revision
number
当前版本
createdBy
string
创建者
createdAt
string格式:date-time
用户创建时间
GET
/:project/document/:document/revision
响应示例
200
[
{
 ... } 
]
获取历史版本详情
稳定版 Since  1.0.0 已发布
接口地址
GET/:project/document/:document/revision/:revision
路径参数
project
string必须
项目ID
document
string必须
文档编号
revision
string必须
历史版本号
返回结果
200
DocumentRevision
id
string格式:any
版本ID
project
string
所属项目ID
document
string
所属文档ID
title
string
标题
content
string
内容
revision
number
当前版本
createdBy
string
创建者
createdAt
string格式:date-time
用户创建时间
GET
/:project/document/:document/revision/:revision
响应示例
200
{
"id"
"59101c5f42554b140e291991" ,
"project"
"testPro" ,
"document"
"mcc/14" ,
"title"
"开发文档" ,
"content"
"2号更新内容" ,
"revision"
,
"createdBy"
"5a2e63eebe7680000585ff14" ,
"createdAt"
"2017-08-29T02:56:08.066Z" 
}
文件管理
文件库列表接口
稳定版 Since  1.0.0 已发布
接口地址
GET/:project/file-library
路径参数
project
string必须
项目ID
返回结果
200
FileLibrary[]
id
string必须
文件id
path
string必须
唯一标识符
pic
string
图片
title
string
标题
project
string必须
所属项目ID
isSystem
boolean
是否系统文件库
permission
string
权限
size
number
文件大小
sort
string
排序
createdAt
string格式:date-time
创建时间
GET
/:project/file-library
响应示例
200
[
{
 ... } 
]
创建文件库
稳定版 Since  1.0.0 已发布
接口地址
POST/:project/file-library
路径参数
project
string必须
项目ID
Body参数
path
string必须
唯一标识符
title
string
文件库标题
pic
string必须
图片地址
返回结果
200
FileLibrary
id
string必须
文件id
path
string必须
唯一标识符
pic
string
图片
title
string
标题
project
string必须
所属项目ID
isSystem
boolean
是否系统文件库
permission
string
权限
size
number
文件大小
sort
string
排序
createdAt
string格式:date-time
创建时间
POST
/:project/file-library
请求示例
{
"path"
"demo" ,
"title"
"测试" ,
"pic"
"sTcRcd" 
}
响应示例
200
{
"id"
"59101c5f42554b140e291991" ,
"path"
"demo" ,
"pic"
"https://maichong.io/avatar/avatar.jpg" ,
"title"
"1.jpg" ,
"project"
"testPro" ,
"isSystem"
true,
"permission"
"eT[5n4" ,
"size"
2014000 ,
"sort"
"100" ,
"createdAt"
"2017-08-29T02:56:08.066Z" 
}
获取文件库详情
稳定版 Since  1.0.0 已发布
接口地址
GET/:project/file-library/:library
路径参数
project
string必须
项目ID
library
string必须
文件库唯一标识符path的值
返回结果
200
FileLibrary
id
string必须
文件id
path
string必须
唯一标识符
pic
string
图片
title
string
标题
project
string必须
所属项目ID
isSystem
boolean
是否系统文件库
permission
string
权限
size
number
文件大小
sort
string
排序
createdAt
string格式:date-time
创建时间
GET
/:project/file-library/:library
响应示例
200
{
"id"
"59101c5f42554b140e291991" ,
"path"
"demo" ,
"pic"
"https://maichong.io/avatar/avatar.jpg" ,
"title"
"1.jpg" ,
"project"
"testPro" ,
"isSystem"
true,
"permission"
"eT[5n4" ,
"size"
2014000 ,
"sort"
"100" ,
"createdAt"
"2017-08-29T02:56:08.066Z" 
}
更新文件库
稳定版 Since  1.0.0 已发布
接口地址
PATCH/:project/file-library/:library
路径参数
project
string必须
项目ID
library
string必须
文件库唯一标识符path的值
Body参数
title
string
文件库标题
library
string必须
文件库path
返回结果
200
FileLibrary
id
string必须
文件id
path
string必须
唯一标识符
pic
string
图片
title
string
标题
project
string必须
所属项目ID
isSystem
boolean
是否系统文件库
permission
string
权限
size
number
文件大小
sort
string
排序
createdAt
string格式:date-time
创建时间
PATCH
/:project/file-library/:library
请求示例
{
"title"
"测试文件库" ,
"library"
"loK0" 
}
响应示例
200
{
"id"
"59101c5f42554b140e291991" ,
"path"
"demo" ,
"pic"
"https://maichong.io/avatar/avatar.jpg" ,
"title"
"1.jpg" ,
"project"
"testPro" ,
"isSystem"
true,
"permission"
"eT[5n4" ,
"size"
2014000 ,
"sort"
"100" ,
"createdAt"
"2017-08-29T02:56:08.066Z" 
}
删除文件库
稳定版 Since  1.0.0 已发布
接口地址
DELETE/:project/file-library/:library
路径参数
project
string必须
项目ID
library
string必须
文件库唯一标识符path的值
返回结果
200
DELETE
/:project/file-library/:library
响应示例
200
{ }
文件列表或详情读取
稳定版 Since  1.0.0 已发布
接口地址
GET/:project/file-library/:library/file/*
路径参数
project
string必须
项目ID
library
string必须
文件库唯一标识符path的值
star
string
URL中的*,代表文件路径,
返回结果
200获取文件列表
title
string
当前目录标题
dir
string
当前目录
isDir
boolean
是否目录
files
文件列表
200获取文件详情
File
library
string必须
所属文件库ID
dir
string
目录
title
string
文件名
type
string
文件类型
id
string
ext
string
文件格式
revision
number
当前版本
isDir
boolean
是否文件夹
size
string
文件大小MiB
createdAt
string格式:date-time
创建时间
createdBy
string
创建者ID
updatedAt
string格式:date-time
更新时间,
updatedBy
string
最后更新者ID,类似ctime,更新内容、标题、路径、Tag等
modifiedAt
string格式:date-time
更新时间,类似mtime,只有更新内容才会变化
modifiedBy
string
最后更新者ID,类似mtime,只有更新内容才会变化
deletedAt
string格式:date-time
删除时间
deletedBy
string
删除者ID
GET
/:project/file-library/:library/file/*
响应示例
200获取文件列表
200获取文件详情
{
"title"
"4OOMvdP" ,
"dir"
"j2^fx1m" ,
"isDir"
true,
"files"[
 ... ] 
}
按文件类型检索文件
稳定版 Since  1.0.0 已发布
接口地址
GET/:project/file-library/:library/bytype
路径参数
project
string必须
项目ID
library
string必须
文件库唯一标识符path的值
查询参数
type
string必须默认值:project | cluster
文件类型
before
string
返回结果
200
next
string格式:date-time
是否有下一页,没有则为0
results
文件列表
GET
/:project/file-library/:library/bytype
响应示例
200
{
"next"
"3" ,
"results"[
 ... ] 
}
创建文件夹
稳定版 Since  1.0.0 已发布
接口地址
POST/:project/file-library/:library/mkdir/*
路径参数
project
string必须
项目ID
library
string必须
文件库唯一标识符path的值
star
string必须
URL中的*,代表文件夹名字,
返回结果
200
File
library
string必须
所属文件库ID
dir
string
目录
title
string
文件名
type
string
文件类型
id
string
ext
string
文件格式
revision
number
当前版本
isDir
boolean
是否文件夹
size
string
文件大小MiB
createdAt
string格式:date-time
创建时间
createdBy
string
创建者ID
updatedAt
string格式:date-time
更新时间,
updatedBy
string
最后更新者ID,类似ctime,更新内容、标题、路径、Tag等
modifiedAt
string格式:date-time
更新时间,类似mtime,只有更新内容才会变化
modifiedBy
string
最后更新者ID,类似mtime,只有更新内容才会变化
deletedAt
string格式:date-time
删除时间
deletedBy
string
删除者ID
POST
/:project/file-library/:library/mkdir/*
响应示例
200
{
"library"
"mcc/demo" ,
"dir"
"/" ,
"title"
"0d9hdD" ,
"type"
"c53P" ,
"id"
"59101c5f42554b140e291991" ,
"ext"
"png" ,
"revision"
,
"isDir"
true,
"size"
"1024000" ,
"createdAt"
"2017-08-29T02:56:08.066Z" ,
"createdBy"
"59101c5f42554b140e291991" ,
"updatedAt"
"2017-08-29T02:56:08.066Z" ,
"updatedBy"
"sDPH" ,
"modifiedAt"
"2017-08-29T02:56:08.066Z" ,
"modifiedBy"
"Uu%NRl" ,
"deletedAt"
"2017-08-29T02:56:08.066Z" ,
"deletedBy"
"59101c5f42554b140e291991" 
}
复制文件或文件夹
稳定版 Since  1.0.0 已发布
接口地址
POST/:project/file-library/:library/copy/*
路径参数
project
string必须
项目ID
library
string必须
目标文件库
star
string
URL中的*,代表文件路径和文件名,是最终被复制到的目录和文件名
Body参数
library
string
源文件库ID, 默认同文件库内拷贝,可以省略library参数
path
string必须
源文件路径和文件名
返回结果
200
File
library
string必须
所属文件库ID
dir
string
目录
title
string
文件名
type
string
文件类型
id
string
ext
string
文件格式
revision
number
当前版本
isDir
boolean
是否文件夹
size
string
文件大小MiB
createdAt
string格式:date-time
创建时间
createdBy
string
创建者ID
updatedAt
string格式:date-time
更新时间,
updatedBy
string
最后更新者ID,类似ctime,更新内容、标题、路径、Tag等
modifiedAt
string格式:date-time
更新时间,类似mtime,只有更新内容才会变化
modifiedBy
string
最后更新者ID,类似mtime,只有更新内容才会变化
deletedAt
string格式:date-time
删除时间
deletedBy
string
删除者ID
POST
/:project/file-library/:library/copy/*
请求示例
{
"library"
"9y03" ,
"path"
"demo" 
}
响应示例
200
{
"library"
"mcc/demo" ,
"dir"
"/" ,
"title"
"0d9hdD" ,
"type"
"c53P" ,
"id"
"59101c5f42554b140e291991" ,
"ext"
"png" ,
"revision"
,
"isDir"
true,
"size"
"1024000" ,
"createdAt"
"2017-08-29T02:56:08.066Z" ,
"createdBy"
"59101c5f42554b140e291991" ,
"updatedAt"
"2017-08-29T02:56:08.066Z" ,
"updatedBy"
"sDPH" ,
"modifiedAt"
"2017-08-29T02:56:08.066Z" ,
"modifiedBy"
"Uu%NRl" ,
"deletedAt"
"2017-08-29T02:56:08.066Z" ,
"deletedBy"
"59101c5f42554b140e291991" 
}
移动文件或文件夹
稳定版 Since  1.0.0 已发布
接口地址
POST/:project/file-library/:library/move/*
路径参数
project
string必须
项目ID
library
string必须
文件库唯一标识符path的值
star
string必须
URL中的*,代表文件路径,
Body参数
path
string必须
源文件路径和文件名
rename
string
移动时更换名字
返回结果
200
File
library
string必须
所属文件库ID
dir
string
目录
title
string
文件名
type
string
文件类型
id
string
ext
string
文件格式
revision
number
当前版本
isDir
boolean
是否文件夹
size
string
文件大小MiB
createdAt
string格式:date-time
创建时间
createdBy
string
创建者ID
updatedAt
string格式:date-time
更新时间,
updatedBy
string
最后更新者ID,类似ctime,更新内容、标题、路径、Tag等
modifiedAt
string格式:date-time
更新时间,类似mtime,只有更新内容才会变化
modifiedBy
string
最后更新者ID,类似mtime,只有更新内容才会变化
deletedAt
string格式:date-time
删除时间
deletedBy
string
删除者ID
POST
/:project/file-library/:library/move/*
请求示例
{
"path"
"demo" ,
"rename"
"UU$LQ" 
}
响应示例
200
{
"library"
"mcc/demo" ,
"dir"
"/" ,
"title"
"0d9hdD" ,
"type"
"c53P" ,
"id"
"59101c5f42554b140e291991" ,
"ext"
"png" ,
"revision"
,
"isDir"
true,
"size"
"1024000" ,
"createdAt"
"2017-08-29T02:56:08.066Z" ,
"createdBy"
"59101c5f42554b140e291991" ,
"updatedAt"
"2017-08-29T02:56:08.066Z" ,
"updatedBy"
"sDPH" ,
"modifiedAt"
"2017-08-29T02:56:08.066Z" ,
"modifiedBy"
"Uu%NRl" ,
"deletedAt"
"2017-08-29T02:56:08.066Z" ,
"deletedBy"
"59101c5f42554b140e291991" 
}
删除文件
稳定版 Since  1.0.0 已发布

删除文件并将文件移动到回收站

接口地址
DELETE/:project/file-library/:library/file/*
路径参数
project
string必须
项目ID
library
string必须
文件库唯一标识符path的值
star
string
URL中的*,代表文件路径,
返回结果
200
DELETE
/:project/file-library/:library/file/*
响应示例
200
{ }
更新文件信息
稳定版 Since  1.0.0 已发布
接口地址
PATCH/:project/file-library/:library/file/:file
路径参数
project
string必须
项目ID
library
string必须
文件库唯一标识符path的值
file
string必须
文件路径和文件名
Body参数
title
string
新文件名
tags
string[]
标签
返回结果
200
File
library
string必须
所属文件库ID
dir
string
目录
title
string
文件名
type
string
文件类型
id
string
ext
string
文件格式
revision
number
当前版本
isDir
boolean
是否文件夹
size
string
文件大小MiB
createdAt
string格式:date-time
创建时间
createdBy
string
创建者ID
updatedAt
string格式:date-time
更新时间,
updatedBy
string
最后更新者ID,类似ctime,更新内容、标题、路径、Tag等
modifiedAt
string格式:date-time
更新时间,类似mtime,只有更新内容才会变化
modifiedBy
string
最后更新者ID,类似mtime,只有更新内容才会变化
deletedAt
string格式:date-time
删除时间
deletedBy
string
删除者ID
PATCH
/:project/file-library/:library/file/:file
请求示例
{
"title"
"新文件名" ,
"tags"[
 ... ] 
}
响应示例
200
{
"library"
"mcc/demo" ,
"dir"
"/" ,
"title"
"0d9hdD" ,
"type"
"c53P" ,
"id"
"59101c5f42554b140e291991" ,
"ext"
"png" ,
"revision"
,
"isDir"
true,
"size"
"1024000" ,
"createdAt"
"2017-08-29T02:56:08.066Z" ,
"createdBy"
"59101c5f42554b140e291991" ,
"updatedAt"
"2017-08-29T02:56:08.066Z" ,
"updatedBy"
"sDPH" ,
"modifiedAt"
"2017-08-29T02:56:08.066Z" ,
"modifiedBy"
"Uu%NRl" ,
"deletedAt"
"2017-08-29T02:56:08.066Z" ,
"deletedBy"
"59101c5f42554b140e291991" 
}
上传文件
稳定版 Since  1.0.0 已发布
接口地址
POST/:project/file-library/:library/upload
路径参数
project
string必须
项目ID
library
string必须
文件库唯一标识符path的值
Body参数
sign
string
文件签名
library
string
文件库ID
path
string必须
文件路径
sha1
string
加密摘要
size
number
文件大小
overwrite
string格式:any
'no', 'rename', 'overwrite' 三个值选1,分别为取消,重命名,覆盖。
返回结果
200
file
200
upload
object
200
file
POST
/:project/file-library/:library/upload
请求示例
{
"sign"
"K2@T" ,
"library"
"@I@[Ex" ,
"path"
"demo" ,
"sha1"
"ibF3zK" ,
"size"
8404835697117998 ,
"overwrite"
"7XjG" 
}
响应示例
200
200
200
{
"file"
{
 ... } 
}
分段上传
稳定版 Since  1.0.0 已发布
接口地址
POST/:project/file-library/:library/upload/:uploadId/part
路径参数
project
string必须
项目ID
library
string必须
文件库唯一标识符path的值
uploadId
string
返回结果
200
POST
/:project/file-library/:library/upload/:uploadId/part
响应示例
200
{ }
取消上传任务
Alpha版 Since  1.0.0 开发中
接口地址
POST/:project/file-library/:library/upload/:upload_id/cancel
路径参数
project
string必须
项目ID
library
string必须
文件库唯一标识符path的值
upload_id
string
POST
/:project/file-library/:library/upload/:upload_id/cancel
下载文件
稳定版 Since  1.0.0 已发布
接口地址
GET/:project/file-library/:library/thumb/*
路径参数
project
string必须
项目ID
library
string必须
文件库唯一标识符path的值
star
string
URL中的*,代表文件路径,
GET
/:project/file-library/:library/thumb/*
下载文件
稳定版 Since  1.0.0 已发布
接口地址
GET/:project/file-library/:library/download/*
路径参数
project
string必须
项目ID
library
string必须
文件库唯一标识符path的值
star
string
URL中的*,代表文件路径,
GET
/:project/file-library/:library/download/*
文件版本列表
稳定版 Since  1.0.0 已发布
接口地址
GET/:project/file-library/:library/revision/*
路径参数
project
string必须
项目ID
library
string必须
文件库唯一标识符path的值
star
string
URL中的*,代表文件路径,
返回结果
200
FileRevision[]
library
string必须
所属文件库
file
string
revision
number
当前版本
createdAt
string格式:date-time
用户创建时间
createdBy
string
创建者
size
number
文件大小
hash
string
文件hash值
GET
/:project/file-library/:library/revision/*
响应示例
200
[
{
 ... } 
]
回收站文件列表
稳定版 Since  1.0.0 已发布
接口地址
GET/:project/file-recycle
路径参数
project
string必须
项目ID
返回结果
200
File$Recycle[]
library
string必须
所属文件库ID
dir
string
目录
title
string
文件名
id
string
ext
string
文件格式
size
string
文件大小MiB
deletedAt
string格式:date-time
删除时间
deletedBy
string
删除者ID
GET
/:project/file-recycle
响应示例
200
[
{
 ... } 
]
恢复文件
稳定版 Since  1.0.0 已发布
接口地址
POST/:project/file-recycle/:id/restore
路径参数
project
string必须
项目ID
id
string
文件ID
返回结果
200
POST
/:project/file-recycle/:id/restore
响应示例
200
{ }
彻底删除文件
稳定版 Since  1.0.0 已发布
接口地址
DELETE/:project/file-recycle/:id
路径参数
project
string必须
项目ID
id
string
文件ID
返回结果
200
DELETE
/:project/file-recycle/:id
响应示例
200
{ }
项目管理

项目管理

创建项目
稳定版 Since  1.0.0 已发布

创建项目。同时可以根据传入的参数不同,去选择克隆不同类型的模板

接口地址
POST/project
Body参数
创建项目。同时可以根据传入的参数不同,去选择克隆不同类型的模板
path
string必须
唯一标识符
title
string
接口库标题
pic
string
图片地址
desc
string
描述
demo
string
demo项目ID。克隆demo项目,即脉冲云提供的示例项目,不需要有集群
template
string
一般模板ID。克隆一般模板项目,必须有集群
clone
string
项目ID。克隆自己的项目,必须有集群
cluster
string
集群ID
返回结果
200创建成功
Project
id
string必须格式:any
项目ID
title
string必须
项目标题
user
string必须
用户ID
members
项目成员列表
pic
string
图片
desc
string
项目描述
repositorySize
number默认值:0
仓库占用的磁盘空间大小
repositoryCount
number默认值:0
仓库数量
repositoryPush
string格式:date-time
仓库最后提交时间
builderCount
number
构建工程数量
builderSuccess
string
最后构建成功的工程
builderSuccessTask
number
最后构建成功的任务iid
builderFailed
string
最后构建失败的工程
builderFailedTask
number
最后构建失败的任务iid
imageCount
number默认值:0
镜像数量
imageSize
number
镜像总大小
deploymentCount
number默认值:0
部署数量
lastActiveAt
string格式:date-time
最后活动时间
resourceVersion
string
资源版本
lastTask
string
最后创建的任务iid
lastDocument
string
最后创建的文档iid
timeTotal
string
看板任务总工时
createdAt
string格式:date-time
创建时间
level
number
项目等级
POST
/project
请求示例
{
"path"
"demo" ,
"title"
"测试接口库" ,
"pic"
"wzlE" ,
"desc"
"描述" ,
"demo"
"demo" ,
"template"
"php" ,
"clone"
"mcc" ,
"cluster"
"5a2f3756c50d3300082ecf1e" 
}
响应示例
200创建成功
{
"id"
"mcc" ,
"title"
"脉冲云" ,
"user"
"59a4d7c750d1c01530157bdf" ,
"members"
{
 ... } ,
} ,
"pic"
"https://maichong.io/avatar/avatar.jpg" ,
"desc"
"脉冲云管理平台" ,
"repositorySize"
,
"repositoryCount"
,
"repositoryPush"
"2017-08-29T02:56:08.066Z" ,
"builderCount"
,
"builderSuccess"
"6Q^i4eu" ,
"builderSuccessTask"
15 ,
"builderFailed"
"N6)ue" ,
"builderFailedTask"
14 ,
"imageCount"
,
"imageSize"
10240000 ,
"deploymentCount"
,
"lastActiveAt"
"2017-08-29T02:56:08.066Z" ,
"resourceVersion"
"8796" ,
"lastTask"
"288" ,
"lastDocument"
"55" ,
"timeTotal"
"222" ,
"createdAt"
"2017-08-29T02:56:08.066Z" ,
"level"
}
项目列表
稳定版 Since  1.0.0 已发布

项目列表

接口地址
GET/project
返回结果
200项目列表
Project[]
id
string必须格式:any
项目ID
title
string必须
项目标题
user
string必须
用户ID
members
项目成员列表
pic
string
图片
desc
string
项目描述
repositorySize
number默认值:0
仓库占用的磁盘空间大小
repositoryCount
number默认值:0
仓库数量
repositoryPush
string格式:date-time
仓库最后提交时间
builderCount
number
构建工程数量
builderSuccess
string
最后构建成功的工程
builderSuccessTask
number
最后构建成功的任务iid
builderFailed
string
最后构建失败的工程
builderFailedTask
number
最后构建失败的任务iid
imageCount
number默认值:0
镜像数量
imageSize
number
镜像总大小
deploymentCount
number默认值:0
部署数量
lastActiveAt
string格式:date-time
最后活动时间
resourceVersion
string
资源版本
lastTask
string
最后创建的任务iid
lastDocument
string
最后创建的文档iid
timeTotal
string
看板任务总工时
createdAt
string格式:date-time
创建时间
level
number
项目等级
GET
/project
响应示例
200项目列表
[
{
 ... } 
]
更新项目信息
稳定版 Since  1.0.0 已发布

更新项目信息

接口地址
PATCH/project/:project
路径参数
project
string必须
项目ID
Body参数
Project$Base
title
string必须
项目标题
pic
string
图片
desc
string
项目描述
返回结果
200更新成功
Project
id
string必须格式:any
项目ID
title
string必须
项目标题
user
string必须
用户ID
members
项目成员列表
pic
string
图片
desc
string
项目描述
repositorySize
number默认值:0
仓库占用的磁盘空间大小
repositoryCount
number默认值:0
仓库数量
repositoryPush
string格式:date-time
仓库最后提交时间
builderCount
number
构建工程数量
builderSuccess
string
最后构建成功的工程
builderSuccessTask
number
最后构建成功的任务iid
builderFailed
string
最后构建失败的工程
builderFailedTask
number
最后构建失败的任务iid
imageCount
number默认值:0
镜像数量
imageSize
number
镜像总大小
deploymentCount
number默认值:0
部署数量
lastActiveAt
string格式:date-time
最后活动时间
resourceVersion
string
资源版本
lastTask
string
最后创建的任务iid
lastDocument
string
最后创建的文档iid
timeTotal
string
看板任务总工时
createdAt
string格式:date-time
创建时间
level
number
项目等级
PATCH
/project/:project
请求示例
{
"title"
"脉冲云" ,
"pic"
"https://maichong.io/avatar/avatar.jpg" ,
"desc"
"脉冲云管理平台" 
}
响应示例
200更新成功
{
"id"
"mcc" ,
"title"
"脉冲云" ,
"user"
"59a4d7c750d1c01530157bdf" ,
"members"
{
 ... } ,
} ,
"pic"
"https://maichong.io/avatar/avatar.jpg" ,
"desc"
"脉冲云管理平台" ,
"repositorySize"
,
"repositoryCount"
,
"repositoryPush"
"2017-08-29T02:56:08.066Z" ,
"builderCount"
,
"builderSuccess"
"6Q^i4eu" ,
"builderSuccessTask"
15 ,
"builderFailed"
"N6)ue" ,
"builderFailedTask"
14 ,
"imageCount"
,
"imageSize"
10240000 ,
"deploymentCount"
,
"lastActiveAt"
"2017-08-29T02:56:08.066Z" ,
"resourceVersion"
"8796" ,
"lastTask"
"288" ,
"lastDocument"
"55" ,
"timeTotal"
"222" ,
"createdAt"
"2017-08-29T02:56:08.066Z" ,
"level"
}
获取模版项目列表
稳定版 Since  1.0.0 已发布

获取模版项目列表

接口地址
GET/project-template
查询参数
type
string必须
需要查询的模板类型,其值为clone | template | demo。clone表示自己的项目,template表示一般模板,demo 表示脉冲云的示例模板
返回结果
200返回模板列表
Project[]
id
string必须格式:any
项目ID
title
string必须
项目标题
user
string必须
用户ID
members
项目成员列表
pic
string
图片
desc
string
项目描述
repositorySize
number默认值:0
仓库占用的磁盘空间大小
repositoryCount
number默认值:0
仓库数量
repositoryPush
string格式:date-time
仓库最后提交时间
builderCount
number
构建工程数量
builderSuccess
string
最后构建成功的工程
builderSuccessTask
number
最后构建成功的任务iid
builderFailed
string
最后构建失败的工程
builderFailedTask
number
最后构建失败的任务iid
imageCount
number默认值:0
镜像数量
imageSize
number
镜像总大小
deploymentCount
number默认值:0
部署数量
lastActiveAt
string格式:date-time
最后活动时间
resourceVersion
string
资源版本
lastTask
string
最后创建的任务iid
lastDocument
string
最后创建的文档iid
timeTotal
string
看板任务总工时
createdAt
string格式:date-time
创建时间
level
number
项目等级
GET
/project-template
响应示例
200返回模板列表
[
{
 ... } 
]
检查项目标识符
稳定版 Since  1.0.0 已发布

检查项目唯一标识符是否可用

接口地址
GET/project/check/:path
路径参数
path
string必须
项目唯一标识符
返回结果
200反馈查询结果
ok
boolean必须
当前项目path是否可用 true为可用,false为被占用,不可用
GET
/project/check/:path
响应示例
200反馈查询结果
{
"ok"
true
}
获取项目详情
稳定版 Since  1.0.0 已发布

获取项目详情

接口地址
GET/project/:project
路径参数
project
string必须
项目ID
返回结果
200项目详情
Project
id
string必须格式:any
项目ID
title
string必须
项目标题
user
string必须
用户ID
members
项目成员列表
pic
string
图片
desc
string
项目描述
repositorySize
number默认值:0
仓库占用的磁盘空间大小
repositoryCount
number默认值:0
仓库数量
repositoryPush
string格式:date-time
仓库最后提交时间
builderCount
number
构建工程数量
builderSuccess
string
最后构建成功的工程
builderSuccessTask
number
最后构建成功的任务iid
builderFailed
string
最后构建失败的工程
builderFailedTask
number
最后构建失败的任务iid
imageCount
number默认值:0
镜像数量
imageSize
number
镜像总大小
deploymentCount
number默认值:0
部署数量
lastActiveAt
string格式:date-time
最后活动时间
resourceVersion
string
资源版本
lastTask
string
最后创建的任务iid
lastDocument
string
最后创建的文档iid
timeTotal
string
看板任务总工时
createdAt
string格式:date-time
创建时间
level
number
项目等级
GET
/project/:project
响应示例
200项目详情
{
"id"
"mcc" ,
"title"
"脉冲云" ,
"user"
"59a4d7c750d1c01530157bdf" ,
"members"
{
 ... } ,
} ,
"pic"
"https://maichong.io/avatar/avatar.jpg" ,
"desc"
"脉冲云管理平台" ,
"repositorySize"
,
"repositoryCount"
,
"repositoryPush"
"2017-08-29T02:56:08.066Z" ,
"builderCount"
,
"builderSuccess"
"6Q^i4eu" ,
"builderSuccessTask"
15 ,
"builderFailed"
"N6)ue" ,
"builderFailedTask"
14 ,
"imageCount"
,
"imageSize"
10240000 ,
"deploymentCount"
,
"lastActiveAt"
"2017-08-29T02:56:08.066Z" ,
"resourceVersion"
"8796" ,
"lastTask"
"288" ,
"lastDocument"
"55" ,
"timeTotal"
"222" ,
"createdAt"
"2017-08-29T02:56:08.066Z" ,
"level"
}
更新项目信息
稳定版 Since  1.0.0 已发布

更新项目信息

接口地址
PATCH/project/:project
路径参数
project
string必须
项目ID
Body参数
Project$Base
title
string必须
项目标题
pic
string
图片
desc
string
项目描述
返回结果
200更新成功
Project
id
string必须格式:any
项目ID
title
string必须
项目标题
user
string必须
用户ID
members
项目成员列表
pic
string
图片
desc
string
项目描述
repositorySize
number默认值:0
仓库占用的磁盘空间大小
repositoryCount
number默认值:0
仓库数量
repositoryPush
string格式:date-time
仓库最后提交时间
builderCount
number
构建工程数量
builderSuccess
string
最后构建成功的工程
builderSuccessTask
number
最后构建成功的任务iid
builderFailed
string
最后构建失败的工程
builderFailedTask
number
最后构建失败的任务iid
imageCount
number默认值:0
镜像数量
imageSize
number
镜像总大小
deploymentCount
number默认值:0
部署数量
lastActiveAt
string格式:date-time
最后活动时间
resourceVersion
string
资源版本
lastTask
string
最后创建的任务iid
lastDocument
string
最后创建的文档iid
timeTotal
string
看板任务总工时
createdAt
string格式:date-time
创建时间
level
number
项目等级
PATCH
/project/:project
请求示例
{
"title"
"脉冲云" ,
"pic"
"https://maichong.io/avatar/avatar.jpg" ,
"desc"
"脉冲云管理平台" 
}
响应示例
200更新成功
{
"id"
"mcc" ,
"title"
"脉冲云" ,
"user"
"59a4d7c750d1c01530157bdf" ,
"members"
{
 ... } ,
} ,
"pic"
"https://maichong.io/avatar/avatar.jpg" ,
"desc"
"脉冲云管理平台" ,
"repositorySize"
,
"repositoryCount"
,
"repositoryPush"
"2017-08-29T02:56:08.066Z" ,
"builderCount"
,
"builderSuccess"
"6Q^i4eu" ,
"builderSuccessTask"
15 ,
"builderFailed"
"N6)ue" ,
"builderFailedTask"
14 ,
"imageCount"
,
"imageSize"
10240000 ,
"deploymentCount"
,
"lastActiveAt"
"2017-08-29T02:56:08.066Z" ,
"resourceVersion"
"8796" ,
"lastTask"
"288" ,
"lastDocument"
"55" ,
"timeTotal"
"222" ,
"createdAt"
"2017-08-29T02:56:08.066Z" ,
"level"
}
获取项目成员排行
稳定版 Since  1.0.0 已发布

获取项目成员排行

接口地址
GET/project/:project/stat/rank
路径参数
project
string必须
项目ID
查询参数
time
string必须
格式化后的时间例如20171112,如果查询的是月趋势,值就位月中任意一天的时间并格式化过,如果查询的是周趋势,就为要查询的周里任意一天的时间并格式化过,以此类推
particle
string必须
项目趋势类型 day表示今天的趋势 week表示本周的趋势 month表示本月的趋势 total表示总的趋势
返回结果
200项目成员排行
ProjectStatistic[]
project
string必须
所属项目ID
user
string必须
用户ID
lines
number
提交代码行数
commits
number
提交代码次数
documentUpdates
number
更新文档次数
fileUpdates
number
文件上传次数
taskCreations
number
创建任务个数
taskDones
number
任务完成量
timeUsed
number
实际工时
timeTotal
number
总工时
createdAt
string格式:date-time
用户创建时间
time
string
格式化后的时间
GET
/project/:project/stat/rank
响应示例
200项目成员排行
[
{
 ... } 
]
获取项目成员列表
稳定版 Since  1.0.0 已发布

获取项目成员列表

接口地址
GET/project/:project/member
路径参数
project
string必须
项目ID
返回结果
200项目成员列表
ProjectMember[]
project
string必须
所属项目ID
user
string必须
用户ID
projectAbility
number默认值:10
项目权限,owner 50;master 40;guest 10
documentAbility
number默认值:30
文档权限,owner 50;master 40;developer 30;reporter 20;guest 10
boardAbility
number默认值:30
看板权限
fileAbility
number默认值:30
文件权限
repositoryAbility
number默认值:30
仓库权限
builderAbility
number默认值:30
构建权限
imageAbility
number默认值:30
镜像权限
deploymentAbility
number默认值:30
部署权限
apiAbility
number默认值:30
接口管理权限
level
number
成员等级
resourceVersion
string
资源版本
GET
/project/:project/member
响应示例
200项目成员列表
[
{
 ... } 
]
删除项目成员
稳定版 Since  1.0.0 已发布

删除项目成员

接口地址
DELETE/project/:project/member/:uid
路径参数
project
string必须
项目ID
uid
string必须
用户ID
返回结果
200删除成功
DELETE
/project/:project/member/:uid
响应示例
200删除成功
{ }
邀请成员
稳定版 Since  1.0.0 已发布

邀请成员

接口地址
POST/project/:project/member
Body参数
邀请成员
projectAbility
number默认值:10
项目权限,owner 50;master 40;guest 10
documentAbility
number默认值:30
文档权限,owner 50;master 40;developer 30;reporter 20;guest 10
boardAbility
number默认值:30
看板权限
fileAbility
number默认值:30
文件权限
repositoryAbility
number默认值:30
仓库权限
builderAbility
number默认值:30
构建权限
imageAbility
number默认值:30
镜像权限
deploymentAbility
number默认值:30
部署权限
apiAbility
number默认值:30
接口管理权限
resourceVersion
string
资源版本
username
string必须
用户账号
返回结果
200邀请成功
ProjectMember
project
string必须
所属项目ID
user
string必须
用户ID
projectAbility
number默认值:10
项目权限,owner 50;master 40;guest 10
documentAbility
number默认值:30
文档权限,owner 50;master 40;developer 30;reporter 20;guest 10
boardAbility
number默认值:30
看板权限
fileAbility
number默认值:30
文件权限
repositoryAbility
number默认值:30
仓库权限
builderAbility
number默认值:30
构建权限
imageAbility
number默认值:30
镜像权限
deploymentAbility
number默认值:30
部署权限
apiAbility
number默认值:30
接口管理权限
level
number
成员等级
resourceVersion
string
资源版本
POST
/project/:project/member
请求示例
{
"projectAbility"
10 ,
"documentAbility"
30 ,
"boardAbility"
30 ,
"fileAbility"
30 ,
"repositoryAbility"
30 ,
"builderAbility"
30 ,
"imageAbility"
30 ,
"deploymentAbility"
30 ,
"apiAbility"
30 ,
"resourceVersion"
"8796" ,
"username"
"18700000000" 
}
响应示例
200邀请成功
{
"project"
"testPro" ,
"user"
"59a4d7c750d1c01530157bdf" ,
"projectAbility"
10 ,
"documentAbility"
30 ,
"boardAbility"
30 ,
"fileAbility"
30 ,
"repositoryAbility"
30 ,
"builderAbility"
30 ,
"imageAbility"
30 ,
"deploymentAbility"
30 ,
"apiAbility"
30 ,
"level"
,
"resourceVersion"
"8796" 
}
更新成员
稳定版 Since  1.0.0 已发布

更新成员

接口地址
PATCH/project/:project/member/:uid
路径参数
project
string必须
项目ID
uid
string必须
用户ID
Body参数
ProjectMember$Base
projectAbility
number默认值:10
项目权限,owner 50;master 40;guest 10
documentAbility
number默认值:30
文档权限,owner 50;master 40;developer 30;reporter 20;guest 10
boardAbility
number默认值:30
看板权限
fileAbility
number默认值:30
文件权限
repositoryAbility
number默认值:30
仓库权限
builderAbility
number默认值:30
构建权限
imageAbility
number默认值:30
镜像权限
deploymentAbility
number默认值:30
部署权限
apiAbility
number默认值:30
接口管理权限
返回结果
200更新成功
ProjectMember
project
string必须
所属项目ID
user
string必须
用户ID
projectAbility
number默认值:10
项目权限,owner 50;master 40;guest 10
documentAbility
number默认值:30
文档权限,owner 50;master 40;developer 30;reporter 20;guest 10
boardAbility
number默认值:30
看板权限
fileAbility
number默认值:30
文件权限
repositoryAbility
number默认值:30
仓库权限
builderAbility
number默认值:30
构建权限
imageAbility
number默认值:30
镜像权限
deploymentAbility
number默认值:30
部署权限
apiAbility
number默认值:30
接口管理权限
level
number
成员等级
resourceVersion
string
资源版本
PATCH
/project/:project/member/:uid
请求示例
{
"projectAbility"
10 ,
"documentAbility"
30 ,
"boardAbility"
30 ,
"fileAbility"
30 ,
"repositoryAbility"
30 ,
"builderAbility"
30 ,
"imageAbility"
30 ,
"deploymentAbility"
30 ,
"apiAbility"
30 
}
响应示例
200更新成功
{
"project"
"testPro" ,
"user"
"59a4d7c750d1c01530157bdf" ,
"projectAbility"
10 ,
"documentAbility"
30 ,
"boardAbility"
30 ,
"fileAbility"
30 ,
"repositoryAbility"
30 ,
"builderAbility"
30 ,
"imageAbility"
30 ,
"deploymentAbility"
30 ,
"apiAbility"
30 ,
"level"
,
"resourceVersion"
"8796" 
}
获取项目趋势
稳定版 Since  1.0.0 已发布

获取项目趋势

接口地址
GET/project/:project/stat/trend
路径参数
project
string必须
项目ID
查询参数
time
string必须
格式化后的时间例如20171112,如果查询的是月趋势,值就位月中任意一天的时间并格式化过,如果查询的是周趋势,就为要查询的周里任意一天的时间并格式化过,以此类推
particle
string必须
项目趋势类型 day表示今天的趋势 week表示本周的趋势 month表示本月的趋势 total表示总的趋势