manuallatest製品マニュアル / プロジェクト管理API
プロジェクト管理API
呼び出し方法は、Open APIドキュメントの呼び出し方法の説明を参照してください。
プロジェクト管理関連の機能については、AE使用マニュアルを先に読んで理解しておくことをお勧めします:プロジェクト管理
1. ユーザーのプロジェクトリスト
注意
ログイン名に基づいて、そのユーザーのプロジェクトリストを取得します
インターフェース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 | レスポンスデータ |
| data.companyId | 1 | Integer | 会社ID |
| data.projectId | 2 | Integer | プロジェクトID |
| data.projectName | 製品内部テストプロジェクト | String | プロジェクト名 |
| data.projectType | 0 | Integer | プロジェクトタイプ
|
| data.remark | - | String | プロジェクトの備考 |
| data.roleName | root | String | ロール名 |
| return_code | 0 | Integer | リターンコード |
| return_message | success | String | リターンメッセージ |
エラーレスポンスの例
{
"return_code": -1999,
"return_message": "無効なユーザー"
}
| パラメータ名 | サンプル値 | パラメータタイプ | パラメータの説明 |
|---|---|---|---|
| return_code | -1999 | Integer | リターンコード |
| return_message | 無効なユーザー | String | リターンメッセージ |
2. プロジェクト情報の更新
注意
プロジェクト情報を更新します。現在はプロジェクト名の更新のみに対応しています
インターフェース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 | リターンメッセージ |
3. 新規プロジェクトを作成して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 | はい | 過去データインポートモードをオンにするかどうか
|
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.appid | 2ec39af5e0db4be2a1371b44a7cbedc5 | String | appid |
| data.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 | リターンメッセージ |
このページは役に立ちましたか?

