项目相关
更新时间: 2022-12-05 15:26:02
阅读 3329
1. 新增项目
接口说明:
新建一个项目,必须指定至少一个项目成员
基本信息:
属性 | 值 |
---|---|
API | /api/dash/project/add |
Method | POST |
请求参数:
字段名称 | 参数类型 | 参数说明 |
---|---|---|
token | String | 鉴权token,必须是超管 |
name | String | 项目名称 |
description | Option(String) | 项目描述 |
receiverList | Arr(Object) | 成员列表,要填写用户的uniqueId,具体看例子 |
domainId | Option(Number) | 域ID,企业域用户可指定 |
domainName | Option(String) | 域名,企业域用户可指定 |
输入样例:
{
"token": "1503575355359c4fdea8ec1683ed10edd91ae",
"name": "项目A",
"description": "描述",
"receiverList": [
{
"type": "user",
"name": "xxx1@xxx.com"// uniqueId
},
{
"type": "user",
"name": "xxx2@xxx.com" // uniqueId
}
]
}
成功数据返回:
{
"code": 200,
"logPath": "http://127.0.0.1:8009/operation/log/fNy78UctuDQ3geEsBJAm6m"
}
2. 修改项目名称
接口说明:
修改项目信息
基本信息:
属性 | 值 |
---|---|
API | /api/dash/project/update |
Method | POST |
请求参数:
字段名称 | 参数类型 | 参数说明 |
---|---|---|
token | String | 鉴权token,必须是超管 |
name | Optional(String) | 项目名称 |
Id | Number | 项目ID |
description | Optional(String) | 项目描述 |
输入样例:
{
"token": "1503575355359c4fdea8ec1683ed10edd91ae",
"id": 1,
"name": "新项目A",
"description": "新描述"
}
成功数据返回:
{
"code": 200,
"logPath": "http://127.0.0.1:8009/operation/log/fNy78UctuDQ3geEsBJAm6m"
}
3. 删除项目
接口说明:
删除项目。
基本信息:
属性 | 值 |
---|---|
API | /api/dash/project/del |
Method | DELETE |
请求参数:
字段名称 | 参数类型 | 参数说明 |
---|---|---|
token | String | 鉴权token,必须是超管 |
projectId | Number | 项目ID |
输入样例:
{
"token": "1503575355359c4fdea8ec1683ed10edd91ae",
"projectId": 1
}
成功数据返回:
{
"code": 200,
"logPath": "http://127.0.0.1:8009/operation/log/fNy78UctuDQ3geEsBJAm6m"
}
文档反馈
以上内容对您是否有帮助?