跳到主要内容

项目管理 API

最近更新 2026/10/03

调用方法请参见Open API文档中的调用方法描述。

建议先阅读 AE 使用手册了解项目管理相关功能:项目管理

1. 用户项目列表​

注意

根据登录名称获取该用户的项目列表

接口URL

/open/project-list?token=xxx&loginName=test007

请求方式

POST

Content-Type

application/json

请求Query参数

参数名示例值参数类型是否必填参数描述
tokenxxxString是查询密钥
loginNametest007String是登录名称

成功响应示例

{
"data": [
{
"companyId": 1,
"projectId": 2,
"projectName": "产品内测项目",
"projectType": 0,
"remark": "",
"roleName": "root"
},
{
"companyId": 1,
"projectId": 6,
"projectName": "thinkinggame官网线上",
"projectType": 0,
"remark": "",
"roleName": "root"
}
],
"return_code": 0,
"return_message": "success"
}
参数名示例值参数类型参数描述
data-Object返回数据
data.companyId1Integer公司ID
data.projectId2Integer项目ID
data.projectName产品内测项目String项目名称
data.projectType0Integer

项目类型

  • 0:正常项目
  • 1:中文DEMO项目
  • 2:英文DEMO项目
data.remark-String项目备注
data.roleNamerootString角色名称
return_code0Integer返回码
return_messagesuccessString返回信息

错误响应示例

{
"return_code": -1999,
"return_message": "无效用户"
}
参数名示例值参数类型参数描述
return_code-1999Integer返回码
return_message无效用户String返回信息

2. 更新项目信息​

注意

更新项目信息,当前仅支持项目名称更新

接口URL

/open/project/update-project-info?token=xxx&projectId=2

请求方式

POST

Content-Type

application/json

请求Query参数

参数名示例值参数类型是否必填参数描述
tokenxxxString是查询密钥
projectId2Integer是项目ID

请求Body参数

{
"projectName": "新项目名称"
}
参数名示例值参数类型是否必填参数描述
projectName新项目名称String是项目名称

成功响应示例

{
"return_code": 0,
"return_message": "success"
}
参数名示例值参数类型参数描述
return_code0Integer返回码
return_messagesuccessString返回信息

错误响应示例

{
"return_code": -1006,
"return_message": "您无权限操作,请检查token值是否正确"
}
参数名示例值参数类型参数描述
return_code-1006Integer返回码
return_message您无权限操作,请检查token值是否正确String返回信息

3. 创建新项目并生成appId​

注意
  • 会检查项目名称是否存在,若存在则创建失败,返回结果如错误响应示例

接口URL

/open/project/generate-project-app-id?token=xxx&projectName=test007&loadHistory=1

请求方式

POST

Content-Type

application/json

请求Query参数

参数名示例值参数类型是否必填参数描述
tokenxxxString是查询密钥
projectNametest007String是项目名称
loadHistory1Integer是

是否打开导入历史数据模式

  • 0:关闭
  • 1:打开

curl示例

curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' 'http://ta2:8992/open/project/generate-project-app-id?token=YOUR_TOKEN&projectName=test1222&loadHistory=1'

成功响应示例

{
"data": {
"appid": "2ec39af5e0db4be2a1371b44a7cbedc5",
"projectId": 2535
},
"return_code": 0,
"return_message": "success"
}
参数名示例值参数类型参数描述
data-Object返回数据
data.appid2ec39af5e0db4be2a1371b44a7cbedc5Stringappid
data.projectId2535Integer项目ID
return_code0Integer返回码
return_messagesuccessString返回信息

错误响应示例

{
"return_code": -1015,
"return_message": "test007已存在"
}
参数名示例值参数类型参数描述
return_code-1015Integer返回码
return_messagetest007已存在String返回信息
这篇文档对你有帮助吗?