项目管理 API

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

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

用户项目列表

注意

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

接口 URL

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

请求方式

POST

Content-Type

application/json

请求 Query 参数

参数名	示例值	参数类型	是否必填	参数描述
token	xxx	String	是	查询密钥
loginName	test007	String	是	登录名称

成功响应示例

{
    "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	返回数据
∟ companyId	1	Integer	公司ID
∟ projectId	2	Integer	项目ID
∟ projectName	产品内测项目	String	项目名称
∟ projectType	0	Integer	项目类型 0：正常项目 1：中文DEMO项目 2：英文DEMO项目
∟ remark	-	String	项目备注
∟ roleName	root	String	角色名称
return_code	0	Integer	返回码
return_message	success	String	返回信息

错误响应示例

{
    "return_code": -1999,
    "return_message": "无效用户"
}

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

---

更新项目信息

注意

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

接口 URL

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

请求方式

POST

Content-Type

application/json

请求 Query 参数

参数名	示例值	参数类型	是否必填	参数描述
token	xxx	String	是	查询密钥
projectId	2	Integer	是	项目ID

请求 Body 参数

{
    "projectName": "新项目名称"
}

参数名	示例值	参数类型	是否必填	参数描述
projectName	项目新名称	String	是	雷霆战将

成功响应示例

{
    "return_code": 0,
    "return_message": "success"
}

参数名	示例值	参数类型	参数描述
return_code	0	Integer	返回码
return_message	success	String	返回信息

错误响应示例

{
    "return_code": -1006,
    "return_message": "您无权限操作，请检查token值是否正确"
}

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

---

创建新项目并生成 appId

注意

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

接口 URL

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

请求方式

POST

Content-Type

application/json

请求 Query 参数

参数名	示例值	参数类型	是否必填	参数描述
token	xxx	String	是	查询密钥
projectName	test007	String	是	项目名称
loadHistory	1	Integer	是	是否打开导入历史数据模式 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=bTOzKiTIozG4e19FgXphcA8dDV3DIY8RwdHTO7aSnBsRqSNaIk19BnBMecJDWibD&projectName=test1222&loadHistory=111'

成功响应示例

{
    "data": {
        "appid": "2ec39af5e0db4be2a1371b44a7cbedc5",
        "projectId": 2535
    },
    "return_code": 0,
    "return_message": "success"
}

参数名	示例值	参数类型	参数描述
data	-	Object	返回数据
∟ appid	2ec39af5e0db4be2a1371b44a7cbedc5	String	appid
∟ projectId	2535	Integer	项目ID
return_code	0	Integer	返回码
return_message	success	String	返回信息

错误响应示例

{
    "return_code": -1015,
    "return_message": "test007已存在"
}

参数名	示例值	参数类型	参数描述
return_code	-1015	Integer	返回码
return_message	test007已存在	String	返回信息

---