Data Bundleの概要
Data Bundleは、1回のキャプチャのコンテナです。生の入力ファイル(点群、軌跡、画像など)と、プラットフォームがそれらから生成する処理済み出力を含みます。RealityConnect APIは、Prevu3D UIと同じBundleライフサイクルを公開しているため、統合はブラウザなしでBundleの作成、データのアップロード、処理の開始、進捗の追跡、入力ファイルの取得ができます。
このドキュメントでは、OAuthフローを完了し、access_token、リージョンのapi_url、organization_idを保持していることを前提としています。まだの場合は、フローガイドを参照してください。
すべてのData Bundleワークフローエンドポイント(/v1/bundles/...、/v1/organization/.../data-bundle-input-tree、/v1/nodes/.../bundle)は実験的とマークされています。安定版に昇格するまで、契約が進化することを想定してください。実験的エンドポイントを参照してください。
必要なスコープ
Section titled “必要なスコープ”| スコープ | 用途 |
|---|---|
read:bundle | デバイス入力ツリーの取得、アップロードセッションの一覧、処理オプションの一覧、処理レコードの一覧、入力ファイルダウンロードURLの一覧 |
write:bundle | Bundleの作成、アップロードセッションの開始と完了、処理の開始 |
Bundleを作成する親ノード、および後続のステップ用のBundle自体に対して、コンテンツアクセスとノード権限も必要です。
エンドツーエンドフロー
Section titled “エンドツーエンドフロー”flowchart LR A["1. Get input tree"] --> B["2. Create bundle"] B --> C["3. Upload input files"] C --> D["4. List processing options"] D --> E["5. Start processing"] E --> F["6. Poll processing records"]
各番号付きステップは専用ガイドに対応しています:
| ステップ | ガイド | 概要 |
|---|---|---|
| 1–2 | Data Bundleの作成 | デバイス入力ツリーを取得し、リーフのdbuPathを選択し、親ノードの下にBundleを作成する |
| 3 | Data Bundleへのデータアップロード | アップロードセッションを開始し、各ファイルをS3にマルチパートアップロードし、完了する |
| 4–6 | 処理とモニタリング | 利用可能な出力を一覧表示し、処理を開始し、すべてのジョブが終端状態に達するまでポーリングする |
入力ファイルのダウンロードは任意です。Bundleのアップロード済み入力ファイルを再度取得する必要がある場合にのみ使用してください。
構造ルール(必須ファイルタイプ、許可される拡張子、タイプ間の依存関係、多重度)は、アップロードセッションを開始したときに返されるrequirements配列に記載されています。アップロード前および処理開始前に、その構造に従うのはユーザーの責任です。
アップロードAPIは、指定したtypeの下に各ファイルを記録し、件数のみでセッションを完了します。深いコンテンツ検証(.lasが本物のデバイスキャプチャであるか、メタデータJSONが画像を正しく参照しているか)は、処理を開始した後に行われ、アップロード時ではありません。正しい名前だが不正な形式のファイルはエラーなくアップロードされ、後で処理中に失敗します。
不正なアップロード構造(必須タイプの欠落、依存関係の破損、誤った拡張子など)による処理失敗は返金されません。