プロジェクト管理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 | リターンメッセージ |
4. アカウントの一括作成と単一プロジェクトの分析ロール設定
単一プロジェクトのアカウントを一括作成し、メンバーを追加して、分析ロールを全量設定します。同じリクエストで、そのプロジェクトのデータ権限も指定できます。プロジェクトトークンを使ってアカウント、ロール、データ権限を同期するプライベート環境向けのAPIです。SaaSには対応していません。
利用条件
対象プロジェクトのプロジェクトトークン、または対象プロジェクトが所属する会社の会社トークンを使用します。ユーザートークン、一時トークン、他のプロジェクトや会社のトークンは使用できません。トークンの取得方法とサービスアドレスは、このページ冒頭のOpen APIの呼び出し方法を参照してください。
POST /open/batch-set-project-roles?token=<TOKEN>
Content-Type: application/json
Queryパラメータのtokenを省略し、リクエストヘッダーにAuthorization: Bearer <TOKEN>を指定する方法も使用できます。Content-Typeはapplication/jsonです。
リクエストBodyパラメータ
| パラメータ | タイプ | 必須 | 説明 |
|---|---|---|---|
| authUsers | Array | はい | アカウントのリスト。空のリストやnullの要素は指定できません。 |
| authUsers[].loginName | String | はい | ログインアカウント名。形式はユーザー一括作成APIと同じです。同じリクエスト内で重複できず、大文字と小文字のみが異なる場合も重複と見なします。 |
| authUsers[].roles | Array | はい | 対象プロジェクトでアカウントに設定する分析ロールの完全なリスト。空のリストやnullの要素は指定できません。 |
| authUsers[].roles[].projectId | Integer | はい | 実在する0以上のプロジェクトID。リクエスト内の全アカウント、全ロールのprojectIdを同じ値にしてください。QueryパラメータでprojectIdを別途渡す必要はありません。 |
| authUsers[].roles[].roleDesc | String | はい | 対象プロジェクトで利用可能な既存の分析ロールの表示名。内部識別子ではありません。空の値は指定できません。重複するロールは1つにまとめられます。 |
| authUsers[].dataPowers | Array | いいえ | このアカウントのデータ権限設定。省略、null、空配列はいずれも既存のデータ権限を維持します。新規アカウントまたは新たにプロジェクトへ参加するアカウントで未指定の場合は、既定の全データ権限を使用します。配列の要素にnullは指定できません。 |
| authUsers[].dataPowers[].projectId | Integer | はい | このアカウントのrolesに指定した対象プロジェクトIDと同じ値にしてください。同じアカウントで同じプロジェクトを重複して設定できません。 |
| authUsers[].dataPowers[].dataPowerName | String | どちらか一方 | プロジェクト内に存在するカスタムデータ権限の元の完全な名称。完全一致する設定が1つだけ存在する必要があります。内部IDは指定できず、あいまい検索や自動作成にも対応していません。全データを意味する名称であっても、カスタム権限として解釈します。名称を指定する場合、allDataは省略するかnullにしてください。 |
| authUsers[].dataPowers[].allData | Boolean | どちらか一方 | 指定できる値はtrueのみで、リクエスト言語に関係なく全データ権限を明示的に付与します。この場合、dataPowerNameは省略するかnullにしてください。false、空白の名称、両方未指定、両方指定はいずれも拒否されます。 |
リクエスト例
以下の例では、プロジェクト57の2つのアカウントに分析ロールを全量設定し、api_user_1にはカスタムデータ権限、api_user_2には全データ権限を明示的に付与します。API Analyst、API Viewer、API Data Scopeは例示の名称です。対象プロジェクトに存在するロール名とデータ権限名に置き換えてください。ロールのみを設定する場合はdataPowersを省略できます。
{
"authUsers": [
{
"loginName": "api_user_1",
"roles": [
{
"projectId": 57,
"roleDesc": "API Analyst"
},
{
"projectId": 57,
"roleDesc": "API Viewer"
}
],
"dataPowers": [
{
"projectId": 57,
"dataPowerName": "API Data Scope"
}
]
},
{
"loginName": "api_user_2",
"roles": [
{
"projectId": 57,
"roleDesc": "API Viewer"
}
],
"dataPowers": [
{
"projectId": 57,
"allData": true
}
]
}
]
}
動作ルール
- アカウントが存在しない場合、対象プロジェクトが所属する会社にアカウントを作成します。初期パスワードはta2020です。既存アカウントがプロジェクトに未参加の場合は、メンバーとして追加します。新規参加メンバーはデフォルトユーザーグループに追加されます。
- 既存メンバーの対象プロジェクトの分析ロールは、追加ではなく全置換されます。例えば、元のロールがAとBで、今回Bだけを指定すると、成功後はBだけが残ります。保持したいロールを毎回すべて指定してください。空のリストでメンバーを削除することはできません。
- 明示的に指定した対象プロジェクトのデータ権限のみを変更します。dataPowersの省略、null、空配列はいずれも既存のデータ権限を維持します。カスタム権限名が存在しない、重複している、または別のプロジェクトにのみ存在する場合はバッチ全体が失敗し、全データ権限への置き換えは行いません。他のプロジェクトやプラットフォームのロール、パスワード、ロック状態は変更しません。会社設定でプロジェクト内のアカウント作成が無効な場合、新規アカウントは作成できませんが、既存アカウントのロールは設定できます。
- ルートアカウント、プロジェクトオーナー、システム管理者などの保護された権限は付与できません。対象の会社またはプロジェクトでこれらの権限を持つアカウントも変更できません。他の会社のアカウント、削除済みのアカウント、および他のプロジェクト・会社・プラットフォームのロールは拒否されます。
- バッチ全体を一括で処理します。パラメータ、権限、ロール、データ権限の検証に失敗した場合、変更は一切適用しません。書き込み中に失敗した場合は、アカウント、ロール、デフォルトグループ、データ権限をまとめてロールバックします。一部成功の結果は返しません。
- 前のリクエストが正常に完了した後、同じリクエストを再送すると、既存アカウントを再利用して同じロールを設定します。アカウントの重複作成やロールの累積は発生しません。同一プロジェクトへのバッチは順番に呼び出してください。同時リクエストの実行順序や最終的なロール集合は保証しません。
レスポンス
成功レスポンスの例:
{
"return_code": 0,
"return_message": "success"
}
return_codeが0の場合は成功、それ以外は失敗です。return_messageにエラー情報が返ります。主な原因は、空または重複するパラメータ、複数プロジェクトの混在、トークンの権限不足、利用できないロール、他の会社のアカウントや削除済みアカウントの指定、保護された権限を持つアカウントの変更です。

