Autodesk Construction Cloud（ACC）Project Admin API の一般提供が開始されました。新しいエンドポイントを使用して、プロジェクトのゼロからの作成やテンプレートを利用した作成、プロジェクト内のユーザーを追加/更新/削除が出来るようになりました。ユーザーを追加する際には、適切なアクセスレベルを製品に割り当てることもできます。
以前、ACC Admin API: GET Projects と Project Users の記事で、GET Projects と GET Project Users が Public Beta として利用可能になったことをお知らせしましたが、これらのエンドポイントも現在 Beta から卒業しています。
今回のリリースでは、次の 5 つのエンドポイントが追加されています。
- POST projects – ACC プロジェクトのゼロからの作成、あるいはテンプレートからの作成
- POST projects/:projectId/users – プロジェクトに 1 人のユーザーを割り当て
- POST projects/:projectId/users:import – 複数のユーザーをプロジェクトにインポート
- PATCH projects/:projectId/users/:userId – プロジェクト内の特定ユーザー情報の更新
- DELETE projects/:projectId/users/:userId – プロジェクトからの特定ユーザーの削除
これらエンドポイントを使用すると、API を使用する一般的なワークフローの 1 つであるプロジェクトのセットアップなど、プロセスの一部を自動化できるようになります。多くの煩雑な作業を排除し、生産性を向上させるのに役立ちます。
潜在的な混乱を減らすために、注意すべき点がいくつかあります。
- 下位互換性があり、ACC プロジェクトと BIM 360 プロジェクトの両方で動作する GET API とは異なり、上記の 5 つの新しいエンドポイントは ACC プロジェクトでのみ機能します。書き込みエンドポイントは BIM 360 との互換性がありません。
- 3-legged token と 2-legged token (ユーザー指定 – user impersonation あり/なし) で動作する GET API とは異なり、上記の 5 つのエンドポイントはすべて、3-legged tokenと 2-legged token ユーザー指定ありのみで動作します。ユーザー指定なしの純粋な 2-legged token はサポートされていません。2-legged token ユーザー指定あり とは、ヘッダーで User-Id 指定することを意味します。
プロジェクト作成
- テンプレートからプロジェクトを作成する場合、プロジェクト管理者が最初に割り当てられない限り、テンプレートプロジェクトメンバーは複製されたプロジェクトに自動的に割り当てられません。この動作は UI とは異なります。Step 3 Option 3A: Import template project members（該当する場合）を参照してください。
- プロジェクトが作成されると、jobId で応答します。ただし、現在、ジョブ ID の状態を取得する API はありません。プロジェクトを「ポーリング」し、ステータスを確認する必要があります。Step 2: Check Project Activation Status by Polling を参照してください。
- 現在、プロジェクトを更新したり、プロジェクトを削除したりすることはできません。
- プロジェクト作成でユーザー コンテキスト – 3-legged token または 2-legged token (ユーザー指定 – user impersonation あり）– でエンドポイントを呼び出す際、同コンテキストのユーザーは Account Admin である必要があります。
プロジェクトユーザー
- ユーザーをプロジェクトに割り当てるには、ユーザーのロール (役割) を指定します（オプション）。ただし、現在、ACC プロジェクト ロールを取得するエンドポイントがありません。回避策として、Data Connector API を使用してプロジェクト ロールの情報を取得することが出来ます。
- 複数のユーザーをプロジェクトにインポートすると、jobId のみで応答します。ただし、ジョブの状態を取得する API はありません。GET project users を呼び出して、ユーザーがプロジェクトに正常に割り当てられているかどうかを確認する必要があります。 Step 4: Retrieve Information About the Project Members を参照してください。
ドキュメント：
- リファレンスガイド:
- Field Guide（フィールドガイド）
- Step-by-Step Tutorials: Create and Configure Projects（プロジェクトの作成と構成）
- Change History（変更履歴）
2023 年 12 月 13 日に、新しい ACC Project Admin API に焦点を当てたウェビナーを開催する予定です。新しい API を紹介し、追加情報を共有し、質問にお答えします。ここに登録へのリンクを追加する予定です。一週間ほど経ってからまたチェックしてください。
それまでの間、ご不明な点がございましたら、aps.help@autodesk.com からお問い合わせください。
※ 本記事は ACC Project Admin API: Project Creation and User Management | Autodesk Platform Services から転写・翻訳したものです。
By Toshiaki Isezaki
You must be logged in to post a comment.