> ## Documentation Index > Fetch the complete documentation index at: https://developer.box.com/llms.txt > Use this file to discover all available pages before exploring further. # Shuttle リソース 外部ソースからBoxにコンテンツを移行するサービスであるBox Shuttleを管理するためのエンドポイント。これらのエンドポイントを使用して、Shuttleがコンテンツの移行元として使用するシステム、およびShuttleが実行する移行ジョブを管理します。 ## Shuttleエージェント資格情報 Windows Shuttleシステムに発行されたインストール資格情報。エージェントをシステムに登録するために、登録トークンがWindowsエージェントインストーラに貼り付けられます。 > [accordion] 属性と例 > > | プロパティ | 型 | 必須 | 説明 | > | - | - | - | - | > | `registration_token` | `string` | はい | エージェントを登録するためにWindowsエージェントインストーラに貼り付けるインストールトークン。 | > | `expires_at` | `string` | はい | 登録トークンが期限切れになって使用できなくなる日時。 | > > ```json 例 theme={null} > { > "registration_token": "eyJhbGciOi...", > "expires_at": "2026-03-16T12:00:00Z" > } > ``` ## Shuttleサブジェクト ユーザーやグループなど、移行元のソースシステムで検出されたサブジェクト。 > [accordion] 属性と例 > > | プロパティ | 型 | 必須 | 説明 | > | - | - | - | - | > | `type` | `enum` | はい | このサブジェクトがユーザーかグループか。 使用可能なオプション: `user`, `group`. | > | `id` | `string` | いいえ | サブジェクトのプラットフォーム固有の識別子。システムから識別子が提供されない場合は`null`。 `null` を指定できます。 | > | `email` | `string` | いいえ | サブジェクトのメールアドレス。不明な場合は`null`。 `null` を指定できます。 | > | `name` | `string` | いいえ | サブジェクトの表示名。不明な場合は`null`。 `null` を指定できます。 | > | `roles` | array of `Shuttleサブジェクトロール` | いいえ | このサブジェクトがソースで持っているロール。既知のロールがない場合は`null`。 `null` を指定できます。 | > > ```json 例 theme={null} > { > "type": "user", > "id": "sp-user-001", > "email": "user@example.com", > "name": "Jane Doe", > "roles": [ > "owner" > ] > } > ``` ## Shuttleサブジェクトマッピング ShuttleサブジェクトマッピングのStandard版の表示。サブジェクトマッピングは、検出されたソースサブジェクトをBoxのユーザーまたはグループに対応付けるか、そのサブジェクトをスキップ対象として設定します。 > [accordion] 属性と例 > > | プロパティ | 型 | 必須 | 説明 | > | - | - | - | - | > | `id` | `string` | はい | Shuttleサブジェクトマッピングの一意の識別子。 | > | `type` | `enum` | はい | 値は常に`shuttle_subject_mapping`になります。 使用可能なオプション: `shuttle_subject_mapping`. | > | `job_id` | `string` | はい | このマッピングが属しているShuttleジョブの一意の識別子。 | > | `discovered_subject_id` | `string` | いいえ | このマッピングの対象となる、検出されたサブジェクトの一意の識別子。このフィールドが追跡されるようになる前に作成された従来のマッピングでは`null`。 `null` を指定できます。 | > | `revision` | `integer` | いいえ | このマッピングの解決に使用された検出要件のリビジョン。従来のマッピングでは`null`。 `null` を指定できます。 | > | `is_subject_skipped` | `boolean` | はい | 移行時にこのサブジェクトをスキップするかどうか。 | > | `source` | [Shuttleサブジェクト](#shuttle) | はい | マッピング対象のソースサブジェクト。 | > | `target` | [Shuttleターゲットサブジェクト](#shuttle) | いいえ | Boxのターゲットサブジェクト。サブジェクトをスキップする場合、またはまだ割り当てられていない場合は`null`。 `null` を指定できます。 | > > ```json 例 theme={null} > { > "id": "6a3ba7b12ea17bc9461eeace", > "type": "shuttle_subject_mapping", > "job_id": "6a3ba68e810d9156194530a1", > "discovered_subject_id": "6a3ba7c02ea17bc9461eeacf", > "revision": 3, > "is_subject_skipped": false, > "source": { > "type": "user", > "id": "sp-user-001", > "email": "user@example.com", > "name": "Jane Doe", > "roles": [ > "owner" > ] > }, > "target": { > "type": "user", > "id": "12345678", > "email": "jane.doe@company.box.com", > "name": "Jane Doe" > } > } > ``` ## Shuttleサブジェクトマッピング Shuttleサブジェクトマッピングのページ割りされたリスト。 > [accordion] 属性と例 > > | プロパティ | 型 | 必須 | 説明 | > | - | - | - | - | > | `entries` | array of [Shuttleサブジェクトマッピング](#shuttle) | はい | Shuttleサブジェクトマッピングのリスト。 | > | `limit` | `integer` | いいえ | これらのエントリで使用された制限値。許容される最大値を超えていない限り、クエリパラメータの`limit`と等しくなります。最大値はAPIによって異なります。 | > | `next_marker` | `string` | いいえ | 次の検索結果ページの開始場所のマーカー。 `null` を指定できます。 | > | `prev_marker` | `string` | いいえ | 前の検索結果ページの開始場所のマーカー。 `null` を指定できます。 | > > ```json 例 theme={null} > { > "entries": [ > { > "id": "6a3ba7b12ea17bc9461eeace", > "type": "shuttle_subject_mapping", > "job_id": "6a3ba68e810d9156194530a1", > "discovered_subject_id": "6a3ba7c02ea17bc9461eeacf", > "revision": 3, > "is_subject_skipped": false, > "source": { > "type": "user", > "id": "sp-user-001", > "email": "user@example.com", > "name": "Jane Doe", > "roles": [ > "owner" > ] > }, > "target": { > "type": "user", > "id": "12345678", > "email": "jane.doe@company.box.com", > "name": "Jane Doe" > } > } > ], > "limit": 1000, > "next_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii", > "prev_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih" > } > ``` ## Shuttleサブジェクトマッピングインポート作成リクエスト Boxに保存済みのスプレッドシートからShuttleジョブのサブジェクトマッピングをインポートするために使用するリクエスト本文。 > [accordion] 属性と例 > > | プロパティ | 型 | 必須 | 説明 | > | - | - | - | - | > | `job_id` | `string` | はい | サブジェクトマッピングが置き換えられるShuttleジョブの一意の識別子。 | > | `file_id` | `string` | はい | マッピングワークブックが格納されているBoxファイルの一意の識別子。このファイルは呼び出し元ユーザーとして読み取られるため、そのユーザーがダウンロードできる場所に保存されている必要があります。 | > > ```json 例 theme={null} > { > "job_id": "6a3ba68e810d9156194530a1", > "file_id": "12345678901" > } > ``` ## Shuttleサブジェクトマッピング更新リクエスト 既存のShuttleサブジェクトマッピングを更新するために使用するリクエスト本文。リクエスト本文で指定されたフィールドのみが変更されます。`job_id`、`id`、`type`、`source`、`discovered_subject_id`、`revision`は変更できません。 > [accordion] 属性と例 > > | プロパティ | 型 | 必須 | 説明 | > | - | - | - | - | > | `is_subject_skipped` | `boolean` | いいえ | 移行時にこのサブジェクトをスキップするかどうか。 | > | `target` | [Shuttleターゲットサブジェクトの入力](#shuttle) | いいえ | マッピング先のBoxターゲット。スキップするサブジェクトの場合にのみ`null`に設定します。マッピングが有効な状態で`null`に設定すると、検証に失敗します。`is_subject_skipped`のみを更新する場合、既存のターゲットが維持されます。 `null` を指定できます。 | > > ```json 例 theme={null} > { > "is_subject_skipped": true, > "target": { > "type": "user", > "id": "12345678" > } > } > ``` ## Shuttleサブジェクトマッピング作成リクエスト 新しいShuttleサブジェクトマッピングを作成するために使用するリクエスト本文。 > [accordion] 属性と例 > > | プロパティ | 型 | 必須 | 説明 | > | - | - | - | - | > | `job_id` | `string` | はい | このマッピングが属しているShuttleジョブの一意の識別子。 | > | `discovered_subject_id` | `string` | はい | マッピングする、検出されたサブジェクトの一意の識別子。 | > | `revision` | `integer` | いいえ | 解決に使用する検出要件のリビジョン。省略した場合は最新のリビジョンが使用されます。 | > | `is_subject_skipped` | `boolean` | いいえ | 移行時にこのサブジェクトをスキップするかどうか。デフォルトで`false`に設定されます。 | > | `target` | [Shuttleターゲットサブジェクトの入力](#shuttle) | いいえ | マッピング先のBoxターゲット。サブジェクトをスキップする場合、省略するか`null`に設定します。 `null` を指定できます。 | > > ```json 例 theme={null} > { > "job_id": "6a3ba68e810d9156194530a1", > "discovered_subject_id": "6a3ba7c02ea17bc9461eeacf", > "revision": 3, > "is_subject_skipped": false, > "target": { > "type": "user", > "id": "12345678" > } > } > ``` ## Shuttleシステム ShuttleシステムのStandard版の表示。Shuttleシステムは、Shuttleがコンテンツを移行する際の移行元または移行先と、その現在の接続状態を表します。 > [accordion] 属性と例 > > | プロパティ | 型 | 必須 | 説明 | > | - | - | - | - | > | `id` | `string` | はい | Shuttleシステムの一意の識別子。 | > | `type` | `enum` | はい | 値は常に`shuttle_system`になります。 使用可能なオプション: `shuttle_system`. | > | `name` | `string` | はい | Shuttleシステムの表示名。 | > | `system_type` | `string` | はい | このシステムが表す移行元または移行先の種類を識別します。たとえば、`box`、`windows`、`sharepoint`、`amazon_s3`などです。随時新しいシステムタイプが追加されるため、クライアントはこれを固定された値の集合として扱わず、認識できない値も許容する必要があります。 | > | `label` | `string` | いいえ | サーバーによって算出される、システムの表示ラベル。 | > | `state` | `enum` | はい | Shuttleシステムの現在の接続状態。 使用可能なオプション: `connected`, `disconnected`, `unknown`. | > > ```json 例 theme={null} > { > "id": "6a315c0754833bfc5df067bf", > "type": "shuttle_system", > "name": "BoxProd", > "system_type": "box", > "label": "Box (Production)", > "state": "connected" > } > ``` ## Shuttleシステム Shuttleシステムのページ割りされたリスト。 > [accordion] 属性と例 > > | プロパティ | 型 | 必須 | 説明 | > | - | - | - | - | > | `entries` | array of [Shuttleシステム](#shuttle) | はい | Shuttleシステムのリスト。 | > | `limit` | `integer` | いいえ | これらのエントリで使用された制限値。許容される最大値を超えていない限り、クエリパラメータの`limit`と等しくなります。最大値はAPIによって異なります。 | > | `next_marker` | `string` | いいえ | 次の検索結果ページの開始場所のマーカー。 `null` を指定できます。 | > | `prev_marker` | `string` | いいえ | 前の検索結果ページの開始場所のマーカー。 `null` を指定できます。 | > > ```json 例 theme={null} > { > "entries": [ > { > "id": "6a315c0754833bfc5df067bf", > "type": "shuttle_system", > "name": "BoxProd", > "system_type": "box", > "label": "Box (Production)", > "state": "connected" > } > ], > "limit": 1000, > "next_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii", > "prev_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih" > } > ``` ## Shuttleシステム更新リクエスト Shuttleシステムを更新するためのリクエスト本文。指定されたフィールドのみが変更されます。 > [accordion] 属性と例 > > | プロパティ | 型 | 必須 | 説明 | > | - | - | - | - | > | `name` | `string` | いいえ | Shuttleシステムの更新後の表示名。 | > > ```json 例 theme={null} > { > "name": "NYC File Server (Primary)" > } > ``` ## Shuttleシステム作成リクエスト Shuttleシステムを作成するためのリクエスト本文。公開APIを使用して作成できるのはWindowsエージェントシステムのみであるため、`system_type`は`windows`でなければなりません。 > [accordion] 属性と例 > > | プロパティ | 型 | 必須 | 説明 | > | - | - | - | - | > | `name` | `string` | はい | 新しいShuttleシステムの表示名。 | > | `system_type` | `enum` | はい | 新しいShuttleシステムの公開システムタイプ識別子。現在、公開APIでは`windows`のみがサポートされています。 使用可能なオプション: `windows`. | > > ```json 例 theme={null} > { > "name": "NYC File Server", > "system_type": "windows" > } > ``` ## Shuttleジョブ ShuttleジョブのStandard版の表示。Shuttleジョブは、ソースシステムからBoxへのコンテンツ移行について、現在の状態、マッピング準備状態、マッピング構成を含めて記述します。 > [accordion] 属性と例 > > | プロパティ | 型 | 必須 | 説明 | > | - | - | - | - | > | `id` | `string` | はい | Shuttleジョブの一意の識別子。 | > | `type` | `enum` | はい | 値は常に`shuttle_job`になります。 使用可能なオプション: `shuttle_job`. | > | `name` | `string` | はい | 人間が判読できるShuttleジョブ名。 | > | `comment` | `string` | いいえ | Shuttleジョブについて説明した自由形式のコメント (省略可)。 `null` を指定できます。 | > | `job_type` | `enum` | はい | Shuttleジョブが実行する作業のタイプ。 使用可能なオプション: `transfer`, `analysis`. | > | `state` | `string` | はい | Shuttleジョブの現在の状態。これは取り得る値が固定されていない文字列で、今後新しい値が追加されることが想定されています。現在ドキュメント化されている値には`created`、`started`、`stopped`、`completed`、`failed`、`invalid`、`unknown`があります。クライアントは識別できない値をすべて`unknown`として扱う必要があります。 | > | `mapping_state` | `string` | はい | ジョブの現在のマッピング準備状態。これは取り得る値が固定されていない文字列で、今後新しい値が追加されることが想定されています。現在ドキュメント化されている値には`awaiting_path_mapping`、`importing_paths`、`paths_import_rejected`、`paths_invalid`、`paths_ready`、`scanning_source`、`source_scan_failed`、`source_scan_out_of_date`、`awaiting_subject_mapping`、`importing_subjects`、`subjects_import_rejected`、`mapping_complete`、`building_map`、`map_build_failed`、`map_out_of_date`、`ready`があります。`paths_import_rejected`は、前回のパスマッピングスプレッドシートが拒否されたか失敗し、それ以来パスマッピングが変更されていないことを示します。これは、次回のインポート時または次回の手動パスマッピング変更の際にクリアされます。`subjects_import_rejected`は、前回のサブジェクトマッピングスプレッドシートが拒否されたか失敗し、それ以来サブジェクトマッピングが変更されていないことを示します。これは、次回のインポート時または次回の手動サブジェクトマッピング変更の際にクリアされます。 | > | `source_system` | `object` | はい | Shuttleジョブによってコンテンツを移行させるソースシステム。 | > | `account_mapping` | `object` | いいえ | ソースの識別子および権限をBox用に変換する方法を制御する、アカウントマッピング構成。 | > | `tags` | array of `string` | いいえ | Shuttleジョブに関連付けられている自由形式タグのリスト。 | > | `settings` | `object` | いいえ | Shuttleジョブが実行される方法を制御する、調整可能な設定。 | > > ```json 例 theme={null} > { > "id": "6a3ba68e810d9156194530a1", > "type": "shuttle_job", > "name": "Q4 SharePoint to Box", > "comment": "Migrating the finance department archives.", > "job_type": "transfer", > "state": "created", > "mapping_state": "awaiting_path_mapping", > "source_system": { > "type": "shuttle_system", > "id": "6a3ba68e810d9156194530a1", > "name": "SharePoint" > }, > "account_mapping": { > "is_enabled": true, > "permission_conflict_strategy": "preserve_structure_restrict_sharing", > "are_external_shares_mapped": false, > "are_permissions_mapped": true > }, > "tags": [ > "q4", > "hr" > ], > "settings": { > "bandwidth_limit_bytes_per_sec": 10485760, > "are_deletions_mirrored": false, > "are_file_versions_synced": true, > "max_file_versions": 10, > "is_overwrite_enabled": false, > "are_completed_mappings_skipped_on_rerun": true, > "is_content_scanning_enabled": false, > "include_shared_source_folders": true, > "include_shared_destination_folders": false > } > } > ``` ## Shuttleジョブ Shuttleジョブのページ割りされたリスト。 > [accordion] 属性と例 > > | プロパティ | 型 | 必須 | 説明 | > | - | - | - | - | > | `entries` | array of [Shuttleジョブ](#shuttle) | はい | Shuttleジョブのリスト。 | > | `limit` | `integer` | いいえ | これらのエントリで使用された制限値。許容される最大値を超えていない限り、クエリパラメータの`limit`と等しくなります。最大値はAPIによって異なります。 | > | `next_marker` | `string` | いいえ | 次の検索結果ページの開始場所のマーカー。 `null` を指定できます。 | > | `prev_marker` | `string` | いいえ | 前の検索結果ページの開始場所のマーカー。 `null` を指定できます。 | > > ```json 例 theme={null} > { > "entries": [ > { > "id": "6a3ba68e810d9156194530a1", > "type": "shuttle_job", > "name": "Q4 SharePoint to Box", > "comment": "Migrating the finance department archives.", > "job_type": "transfer", > "state": "created", > "mapping_state": "awaiting_path_mapping", > "source_system": { > "type": "shuttle_system", > "id": "6a3ba68e810d9156194530a1", > "name": "SharePoint" > }, > "account_mapping": { > "is_enabled": true, > "permission_conflict_strategy": "preserve_structure_restrict_sharing", > "are_external_shares_mapped": false, > "are_permissions_mapped": true > }, > "tags": [ > "q4", > "hr" > ], > "settings": { > "bandwidth_limit_bytes_per_sec": 10485760, > "are_deletions_mirrored": false, > "are_file_versions_synced": true, > "max_file_versions": 10, > "is_overwrite_enabled": false, > "are_completed_mappings_skipped_on_rerun": true, > "is_content_scanning_enabled": false, > "include_shared_source_folders": true, > "include_shared_destination_folders": false > } > } > ], > "limit": 1000, > "next_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii", > "prev_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih" > } > ``` ## Shuttleジョブスケジュール Shuttleジョブの実行を開始するスケジュール。スケジュールは日時に基づくものか、他のジョブの実行によってトリガーされるものになります。スケジュールでは`scan`モードでの実行を開始することはできません。 > [accordion] 属性と例 > > | プロパティ | 型 | 必須 | 説明 | > | - | - | - | - | > | `id` | `string` | はい | Shuttleジョブスケジュールの一意の識別子。 | > | `type` | `enum` | はい | 値は常に`shuttle_job_schedule`になります。 使用可能なオプション: `shuttle_job_schedule`. | > | `job_id` | `string` | はい | このスケジュールが属しているShuttleジョブの一意の識別子。 | > | `state` | `enum` | はい | スケジュールがアクティブかどうか。 使用可能なオプション: `enabled`, `paused`. | > | `run_mode` | `enum` | はい | スケジュールが開始する実行の種類。`scan`は有効なスケジュール実行モードではありません。 使用可能なオプション: `transfer`, `simulation`, `analysis`. | > | `description` | `string` | いいえ | 人間が判読できる、スケジュールの説明 (省略可)。 `null` を指定できます。 | > | `last_attempt_at` | `string` | いいえ | スケジュールが最後に実行の開始を試みた日時。スケジュールが一度も実行を開始していない場合は`null`。 `null` を指定できます。 | > | `trigger` | [Shuttleジョブスケジュールトリガー](#shuttle) | はい | | > > ```json 例 theme={null} > { > "id": "7c1ba68e810d9156194530b2", > "type": "shuttle_job_schedule", > "job_id": "6a3ba68e810d9156194530a1", > "state": "enabled", > "run_mode": "transfer", > "description": "Nightly finance share replay.", > "last_attempt_at": "2026-03-16T09:00:12Z", > "trigger": { > "type": "by_time", > "start_at": "2026-03-16T09:00:00", > "time_zone": "America/Los_Angeles", > "repeat": "daily" > } > } > ``` ## Shuttleジョブスケジュール Shuttleジョブスケジュールのページ割りされたリスト。 > [accordion] 属性と例 > > | プロパティ | 型 | 必須 | 説明 | > | - | - | - | - | > | `entries` | array of [Shuttleジョブスケジュール](#shuttle) | はい | Shuttleジョブスケジュールのリスト。 | > | `limit` | `integer` | いいえ | これらのエントリで使用された制限値。許容される最大値を超えていない限り、クエリパラメータの`limit`と等しくなります。最大値はAPIによって異なります。 | > | `next_marker` | `string` | いいえ | 次の検索結果ページの開始場所のマーカー。 `null` を指定できます。 | > | `prev_marker` | `string` | いいえ | 前の検索結果ページの開始場所のマーカー。 `null` を指定できます。 | > > ```json 例 theme={null} > { > "entries": [ > { > "id": "7c1ba68e810d9156194530b2", > "type": "shuttle_job_schedule", > "job_id": "6a3ba68e810d9156194530a1", > "state": "enabled", > "run_mode": "transfer", > "description": "Nightly finance share replay.", > "last_attempt_at": "2026-03-16T09:00:12Z", > "trigger": { > "type": "by_time", > "start_at": "2026-03-16T09:00:00", > "time_zone": "America/Los_Angeles", > "repeat": "daily" > } > } > ], > "limit": 1000, > "next_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii", > "prev_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih" > } > ``` ## Shuttleジョブスケジュールトリガー Shuttleジョブスケジュールが実行を開始するタイミング。`type`によって識別されるトリガーバリアントが必ず1つだけ存在します。 > [accordion] 属性と例 > > ```json 例 theme={null} > { > "type": "by_time", > "start_at": "2026-03-16T09:00:00", > "time_zone": "America/Los_Angeles", > "repeat": "daily" > } > ``` ## Shuttleジョブスケジュール更新リクエスト 既存のShuttleジョブスケジュールを更新するために使用するリクエスト本文。リクエスト本文で指定されたフィールドのみが変更されます。 > [accordion] 属性と例 > > | プロパティ | 型 | 必須 | 説明 | > | - | - | - | - | > | `state` | `enum` | いいえ | スケジュールがアクティブかどうか。 使用可能なオプション: `enabled`, `paused`. | > | `run_mode` | `enum` | いいえ | スケジュールが開始する実行の種類。`scan`は有効なスケジュール実行モードではありません。 使用可能なオプション: `transfer`, `simulation`, `analysis`. | > | `description` | `string` | いいえ | 人間が判読できる、スケジュールの説明 (省略可)。 `null` を指定できます。 | > | `trigger` | [Shuttleジョブスケジュールトリガー](#shuttle) | いいえ | | > > ```json 例 theme={null} > { > "state": "paused", > "run_mode": "simulation", > "description": "Nightly finance share replay.", > "trigger": { > "type": "by_time", > "start_at": "2026-03-16T09:00:00", > "time_zone": "America/Los_Angeles", > "repeat": "daily" > } > } > ``` ## Shuttleジョブスケジュール作成リクエスト Shuttleジョブスケジュールを作成するために使用するリクエスト本文。 > [accordion] 属性と例 > > | プロパティ | 型 | 必須 | 説明 | > | - | - | - | - | > | `job_id` | `string` | はい | このスケジュールが属しているShuttleジョブの一意の識別子。 | > | `run_mode` | `enum` | はい | スケジュールが開始する実行の種類。`scan`は有効なスケジュール実行モードではありません。 使用可能なオプション: `transfer`, `simulation`, `analysis`. | > | `state` | `enum` | いいえ | スケジュールがアクティブかどうか。省略した場合、デフォルトで`enabled`に設定されます。 使用可能なオプション: `enabled`, `paused`. | > | `description` | `string` | いいえ | 人間が判読できる、スケジュールの説明 (省略可)。 `null` を指定できます。 | > | `trigger` | [Shuttleジョブスケジュールトリガー](#shuttle) | はい | | > > ```json 例 theme={null} > { > "job_id": "6a3ba68e810d9156194530a1", > "run_mode": "transfer", > "state": "enabled", > "description": "Nightly finance share replay.", > "trigger": { > "type": "by_time", > "start_at": "2026-03-16T09:00:00", > "time_zone": "America/Los_Angeles", > "repeat": "daily" > } > } > ``` ## Shuttleジョブ開始リクエスト Shuttleジョブを開始するために使用するリクエスト本文。 > [accordion] 属性と例 > > | プロパティ | 型 | 必須 | 説明 | > | - | - | - | - | > | `mode` | `enum` | いいえ | 実行モード。省略した場合、デフォルトでsimulationに設定されます。 使用可能なオプション: `transfer`, `simulation`, `scan`, `analysis`. | > > ```json 例 theme={null} > { > "mode": "simulation" > } > ``` ## Shuttleジョブ権限競合戦略 競合する権限を調整するために使用される戦略。 > [accordion] 属性と例 > > ```json 例 theme={null} > "preserve_structure_restrict_sharing" > ``` ## Shuttleジョブ更新リクエスト 既存のShuttleジョブを更新するために使用するリクエスト本文。リクエスト本文で指定されたフィールドのみが変更されます。 > [accordion] 属性と例 > > | プロパティ | 型 | 必須 | 説明 | > | - | - | - | - | > | `name` | `string` | いいえ | 人間が判読できるShuttleジョブ名。 | > | `comment` | `string` | いいえ | Shuttleジョブについて説明した自由形式のコメント (省略可)。 `null` を指定できます。 | > | `tags` | array of `string` | いいえ | Shuttleジョブに関連付けられている自由形式タグのリスト。 | > | `account_mapping` | `object` | いいえ | ソースの識別子および権限をBox用に変換する方法を制御する、アカウントマッピング構成。 | > | `settings` | `object` | いいえ | Shuttleジョブが実行される方法を制御する、調整可能な設定。 | > > ```json 例 theme={null} > { > "name": "Q4 SharePoint to Box", > "comment": "Migrating the finance department archives.", > "tags": [ > "q4", > "hr" > ], > "account_mapping": { > "is_enabled": true, > "permission_conflict_strategy": "preserve_structure_restrict_sharing", > "are_external_shares_mapped": false, > "are_permissions_mapped": true > }, > "settings": { > "bandwidth_limit_bytes_per_sec": 10485760, > "are_deletions_mirrored": false, > "are_file_versions_synced": true, > "max_file_versions": 10, > "is_overwrite_enabled": false, > "are_completed_mappings_skipped_on_rerun": true, > "is_content_scanning_enabled": false, > "include_shared_source_folders": true, > "include_shared_destination_folders": false > } > } > ``` ## Shuttleジョブ作成リクエスト 新しいShuttleジョブを作成するために使用されるリクエスト本文。 > [accordion] 属性と例 > > | プロパティ | 型 | 必須 | 説明 | > | - | - | - | - | > | `name` | `string` | はい | 人間が判読できるShuttleジョブ名。 | > | `job_type` | `enum` | はい | Shuttleジョブが実行する作業のタイプ。 使用可能なオプション: `transfer`, `analysis`. | > | `source_system_id` | `string` | はい | 移行元のソースシステムの一意の識別子。 | > | `comment` | `string` | いいえ | Shuttleジョブについて説明した自由形式のコメント (省略可)。 | > | `tags` | array of `string` | いいえ | Shuttleジョブに関連付けられている自由形式タグのリスト。 | > | `account_mapping` | `object` | いいえ | ソースの識別子および権限をBox用に変換する方法を制御する、アカウントマッピング構成。このオブジェクトを省略した場合、`is_enabled`が`false`に設定された状態でジョブが作成されます。 | > | `settings` | `object` | いいえ | Shuttleジョブが実行される方法を制御する、調整可能な設定。 | > > ```json 例 theme={null} > { > "name": "Q4 SharePoint to Box", > "job_type": "transfer", > "source_system_id": "6a3ba68e810d9156194530a1", > "comment": "Migrating the finance department archives.", > "tags": [ > "q4", > "hr" > ], > "account_mapping": { > "is_enabled": true, > "permission_conflict_strategy": "preserve_structure_restrict_sharing", > "are_external_shares_mapped": false, > "are_permissions_mapped": true > }, > "settings": { > "bandwidth_limit_bytes_per_sec": 10485760, > "are_deletions_mirrored": false, > "are_file_versions_synced": true, > "max_file_versions": 10, > "is_overwrite_enabled": false, > "are_completed_mappings_skipped_on_rerun": true, > "is_content_scanning_enabled": false, > "include_shared_source_folders": true, > "include_shared_destination_folders": false > } > } > ``` ## Shuttleターゲットサブジェクト ソースサブジェクトのマッピング先となるBoxユーザーまたはグループ。 > [accordion] 属性と例 > > | プロパティ | 型 | 必須 | 説明 | > | - | - | - | - | > | `type` | `enum` | はい | Boxターゲットがユーザーかグループか。 使用可能なオプション: `user`, `group`. | > | `id` | `string` | いいえ | BoxユーザーまたはグループのID。このAPIを介してマッピングが作成されておらず、代わりにメールアドレス (ユーザー) または名前 (グループ) によって識別される場合は`null`。スキップは、`id`の欠落ではなく、`target: null`によって表されます。作成および更新では常に`id`を送信します。 `null` を指定できます。 | > | `email` | `string` | いいえ | ターゲットのメールアドレス。不明な場合は`null`。 `null` を指定できます。 | > | `name` | `string` | いいえ | ターゲットの表示名。不明な場合は`null`。 `null` を指定できます。 | > > ```json 例 theme={null} > { > "type": "user", > "id": "12345678", > "email": "user@example.com", > "name": "Jane Doe" > } > ``` ## Shuttleターゲットサブジェクトの入力 ソースサブジェクトのマッピング先となるBoxユーザーまたはグループ。 > [accordion] 属性と例 > > | プロパティ | 型 | 必須 | 説明 | > | - | - | - | - | > | `type` | `enum` | はい | Boxターゲットがユーザーかグループか。 使用可能なオプション: `user`, `group`. | > | `id` | `string` | はい | ターゲットとなるBoxサブジェクトの識別子。 | > > ```json 例 theme={null} > { > "type": "user", > "id": "12345678" > } > ``` ## Shuttleパスエントリ Shuttleパスエントリのページ割りされたリスト。 > [accordion] 属性と例 > > | プロパティ | 型 | 必須 | 説明 | > | - | - | - | - | > | `entries` | array of [Shuttleパスエントリ](#shuttle) | はい | Shuttleパスエントリのリスト。 | > | `limit` | `integer` | いいえ | これらのエントリで使用された制限値。許容される最大値を超えていない限り、クエリパラメータの`limit`と等しくなります。最大値はAPIによって異なります。 | > | `next_marker` | `string` | いいえ | 次の検索結果ページの開始場所のマーカー。 `null` を指定できます。 | > | `prev_marker` | `string` | いいえ | 前の検索結果ページの開始場所のマーカー。 `null` を指定できます。 | > > ```json 例 theme={null} > { > "entries": [ > { > "id": "6a3ba7c02ea17bc9461eeacf", > "type": "shuttle_path_entry", > "name": "Projects", > "path": "/Shared Documents/Projects", > "path_id": "01ABCDEF23456789", > "parent_path": "/Shared Documents", > "scope": { > "type": "shared_space", > "space": "HR Team Site" > }, > "is_directory": true, > "can_map": true > } > ], > "limit": 1000, > "next_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii", > "prev_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih" > } > ``` ## Shuttleパスエントリ Shuttleパスマッピングを作成するために使用する、ソースシステムまたはターゲットシステム上の参照可能なエントリ。共通フィールドはノードを表します。`scope`はマッピング名前空間を識別する識別済みオブジェクトであるため、この行から追加の参照状態なしでパスマッピングを作成できます。 > [accordion] 属性と例 > > | プロパティ | 型 | 必須 | 説明 | > | - | - | - | - | > | `id` | `string` | はい | この参照行の一意の識別子。これはアカウント識別子ではありません。`scope.type`が`account`の場合、アカウント識別子は`scope.id`です。 | > | `type` | `enum` | はい | 値は常に`shuttle_path_entry`になります。 使用可能なオプション: `shuttle_path_entry`. | > | `name` | `string` | はい | パスエントリの表示名。 | > | `path` | `string` | はい | 人間が判読できる、エントリのパス。 | > | `path_id` | `string` | いいえ | パスのシステム固有の識別子。選択したシステムから識別子が提供されない場合は`null`。パスマッピングの場所における`path_id`に対応します。 `null` を指定できます。 | > | `parent_path` | `string` | いいえ | 人間が判読できる、親エントリのパス。ルートエントリの場合は`null`。 `null` を指定できます。 | > | `scope` | [Shuttleパスエントリのスコープ](#shuttle) | はい | このエントリのマッピング名前空間。`type`によって識別されるバリアントが必ず1つだけ存在します。`account`スコープでは、所有アカウントがこのオブジェクトにフラット化されます。`shared_space`スコープでは、コンテナ名が含まれます。エントリがファイルかフォルダかは、`scope`ではなく、`is_directory`で示されます。 | > | `is_directory` | `boolean` | はい | エントリがディレクトリ (`true`) か単一ファイル (`false`) か。パスマッピングの場所における`is_directory`に対応します。 | > | `can_map` | `boolean` | はい | パスマッピングでこのエントリを選択できるかどうか。 | > > ```json 例 theme={null} > { > "id": "6a3ba7c02ea17bc9461eeacf", > "type": "shuttle_path_entry", > "name": "Projects", > "path": "/Shared Documents/Projects", > "path_id": "01ABCDEF23456789", > "parent_path": "/Shared Documents", > "scope": { > "type": "shared_space", > "space": "HR Team Site" > }, > "is_directory": true, > "can_map": true > } > ``` ## Shuttleパスエントリのアカウントスコープ ユーザーアカウントまたはサービスアカウント配下にあるパスエントリのマッピングスコープ。`type`は識別子です。残りのフィールドはアカウント自体を表し、このオブジェクトにフラット化されています。つまり、ネストされた`account`ラッパーではありません。ここでの`id`はアカウント識別子であって、パスエントリの`id`ではありません。アカウントスコープのパスマッピングを作成する際には、これらのフィールドを`account`にコピーします。 > [accordion] 属性と例 > > | プロパティ | 型 | 必須 | 説明 | > | - | - | - | - | > | `type` | `enum` | はい | 値は常に`account`になります。 使用可能なオプション: `account`. | > | `id` | `string` | いいえ | このエントリを所有するアカウントのプラットフォーム固有の識別子。システムから識別子が提供されない場合は`null`。これはパスエントリの`id`ではありません。アカウントスコープのパスマッピングの場所における`account.id`に対応します。 `null` を指定できます。 | > | `email` | `string` | いいえ | このエントリを所有するアカウントのメールアドレス。これはシステム固有の識別子です。必ずしもRFC 5322形式のアドレスとは限りません。不明な場合は`null`。アカウントスコープのパスマッピングの場所における`account.email`に対応します。 `null` を指定できます。 | > | `name` | `string` | いいえ | このエントリを所有するアカウントの表示名。不明な場合は`null`。アカウントスコープのパスマッピングの場所における`account.name`に対応します。 `null` を指定できます。 | > > ```json 例 theme={null} > { > "type": "account", > "id": "123456", > "email": "user@example.com", > "name": "Jane Doe" > } > ``` ## Shuttleパスエントリのスコープ このパスエントリが属しているマッピング名前空間。`type`によって識別されます。`account`の場合、所有アカウントがこのオブジェクトにフラット化されます。`shared_space`の場合、共有コンテナ名が含まれます。ファイルかフォルダかはスコープには含まれません。パスエントリの`is_directory`を使用します。 > [accordion] 属性と例 > > ```json 例 theme={null} > { > "type": "account", > "id": "123456", > "email": "user@example.com", > "name": "Jane Doe" > } > ``` ## Shuttleパスエントリの共有スペーススコープ サイト、チームドライブ、バケット、ファイル共有などの共有コンテナ配下にあるパスエントリのマッピングスコープ。`type`は識別子です。この行からマッピングを作成する際は、`space`を共有スペースのパスマッピングの場所にコピーします。 > [accordion] 属性と例 > > | プロパティ | 型 | 必須 | 説明 | > | - | - | - | - | > | `type` | `enum` | はい | 値は常に`shared_space`になります。 使用可能なオプション: `shared_space`. | > | `space` | `string` | いいえ | このエントリが属している共有コンテナの表示名。システムに暗黙のコンテナが1つしかない場合は`null`。共有スペースのパスマッピングの場所における`space`に対応します。 `null` を指定できます。 | > > ```json 例 theme={null} > { > "type": "shared_space", > "space": "HR Team Site" > } > ``` ## Shuttleパスマッピング ShuttleパスマッピングのStandard版の表示。パスマッピングは、移行元システム上のソースの場所をBoxの移行先に対応付けるか、ソースパスをスキップ対象として設定します。 > [accordion] 属性と例 > > | プロパティ | 型 | 必須 | 説明 | > | - | - | - | - | > | `id` | `string` | はい | Shuttleパスマッピングの一意の識別子。 | > | `type` | `enum` | はい | 値は常に`shuttle_path_mapping`になります。 使用可能なオプション: `shuttle_path_mapping`. | > | `job_id` | `string` | はい | このマッピングが属しているShuttleジョブの一意の識別子。 | > | `is_path_skipped` | `boolean` | はい | 移行時にこのソースパスをスキップするかどうか。 | > | `source` | [Shuttleパスマッピングの場所](#shuttle) | はい | マッピング対象のソースの場所。 | > | `target` | [Shuttleパスマッピングの場所](#shuttle) | いいえ | 移行先の場所。ソースパスをスキップする場合、または分析ジョブなど、ジョブに移行先がない場合は`null`。 `null` を指定できます。 | > > ```json 例 theme={null} > { > "id": "6a3ba7a24ea17bc9461eeacd", > "type": "shuttle_path_mapping", > "job_id": "6a3ba68e810d9156194530a1", > "is_path_skipped": false, > "source": { > "type": "account", > "path": "/HR Migration", > "path_id": "1234567890", > "account": { > "id": "123456", > "email": "admin@company.box.com", > "name": "Box Admin" > }, > "is_directory": true > }, > "target": { > "type": "account", > "path": "/HR Migration", > "path_id": "1234567890", > "account": { > "id": "123456", > "email": "admin@company.box.com", > "name": "Box Admin" > }, > "is_directory": true > } > } > ``` ## Shuttleパスマッピング Shuttleパスマッピングのページ割りされたリスト。 > [accordion] 属性と例 > > | プロパティ | 型 | 必須 | 説明 | > | - | - | - | - | > | `entries` | array of [Shuttleパスマッピング](#shuttle) | はい | Shuttleパスマッピングのリスト。 | > | `limit` | `integer` | いいえ | これらのエントリで使用された制限値。許容される最大値を超えていない限り、クエリパラメータの`limit`と等しくなります。最大値はAPIによって異なります。 | > | `next_marker` | `string` | いいえ | 次の検索結果ページの開始場所のマーカー。 `null` を指定できます。 | > | `prev_marker` | `string` | いいえ | 前の検索結果ページの開始場所のマーカー。 `null` を指定できます。 | > > ```json 例 theme={null} > { > "entries": [ > { > "id": "6a3ba7a24ea17bc9461eeacd", > "type": "shuttle_path_mapping", > "job_id": "6a3ba68e810d9156194530a1", > "is_path_skipped": false, > "source": { > "type": "account", > "path": "/HR Migration", > "path_id": "1234567890", > "account": { > "id": "123456", > "email": "admin@company.box.com", > "name": "Box Admin" > }, > "is_directory": true > }, > "target": { > "type": "account", > "path": "/HR Migration", > "path_id": "1234567890", > "account": { > "id": "123456", > "email": "admin@company.box.com", > "name": "Box Admin" > }, > "is_directory": true > } > } > ], > "limit": 1000, > "next_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii", > "prev_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih" > } > ``` ## Shuttleパスマッピングアカウント アカウントスコープのパスマッピングの場所を所有するアカウント。 > [accordion] 属性と例 > > | プロパティ | 型 | 必須 | 説明 | > | - | - | - | - | > | `id` | `string` | いいえ | アカウントのプラットフォーム固有の識別子。システムから識別子が提供されない場合は`null`。 `null` を指定できます。 | > | `email` | `string` | いいえ | アカウントのメールアドレス。不明な場合は`null`。 `null` を指定できます。 | > | `name` | `string` | いいえ | アカウントの表示名。不明な場合は`null`。 `null` を指定できます。 | > > ```json 例 theme={null} > { > "id": "123456", > "email": "admin@company.box.com", > "name": "Box Admin" > } > ``` ## Shuttleパスマッピングアカウントの場所 ユーザーアカウントまたはサービスアカウントをスコープとするパスマッピングの場所。 > [accordion] 属性と例 > > | プロパティ | 型 | 必須 | 説明 | > | - | - | - | - | > | `type` | `enum` | はい | 値は常に`account`になります。 使用可能なオプション: `account`. | > | `path` | `string` | はい | 人間が判読できる、アカウントのルートを基準とした相対パス。 | > | `path_id` | `string` | いいえ | 場所の安定した識別子。システムから識別子が提供されない場合は`null`。 `null` を指定できます。 | > | `account` | [Shuttleパスマッピングアカウント](#shuttle) | いいえ | この場所を所有するアカウント。 | > | `is_directory` | `boolean` | いいえ | この場所がディレクトリかどうか。不明な場合は`null`。 `null` を指定できます。 | > > ```json 例 theme={null} > { > "type": "account", > "path": "/HR Migration", > "path_id": "1234567890", > "account": { > "id": "123456", > "email": "admin@company.box.com", > "name": "Box Admin" > }, > "is_directory": true > } > ``` ## Shuttleパスマッピングアカウントの場所のターゲットの入力 パスマッピングの作成または更新時に指定する、アカウントスコープの移行先の場所。 > [accordion] 属性と例 > > | プロパティ | 型 | 必須 | 説明 | > | - | - | - | - | > | `type` | `enum` | はい | 値は常に`account`になります。 使用可能なオプション: `account`. | > | `path` | `string` | はい | 人間が判読できる、アカウントのルートを基準とした相対パス。 | > | `path_id` | `string` | いいえ | 参照によって取得された場合の、場所の安定した識別子 (省略可)。 | > | `account` | [Shuttleパスマッピングアカウントの入力](#shuttle) | はい | この場所を所有するアカウント。`id`または`email`の少なくとも一方を指定します。 | > > ```json 例 theme={null} > { > "type": "account", > "path": "/HR Migration", > "path_id": "1234567890", > "account": { > "id": "123456", > "email": "admin@company.box.com" > } > } > ``` ## Shuttleパスマッピングアカウントの場所の入力 パスマッピングの作成または更新時に指定する、アカウントスコープのソースの場所。 > [accordion] 属性と例 > > | プロパティ | 型 | 必須 | 説明 | > | - | - | - | - | > | `type` | `enum` | はい | 値は常に`account`になります。 使用可能なオプション: `account`. | > | `path` | `string` | はい | 人間が判読できる、アカウントのルートを基準とした相対パス。 | > | `path_id` | `string` | いいえ | 参照によって取得された場合の、場所の安定した識別子 (省略可)。 | > | `account` | [Shuttleパスマッピングアカウントの入力](#shuttle) | はい | この場所を所有するアカウント。`id`または`email`の少なくとも一方を指定します。 | > | `is_directory` | `boolean` | いいえ | この場所がディレクトリかどうか。設定する場合、移行先も同じ種類のオブジェクトである必要があります。 | > > ```json 例 theme={null} > { > "type": "account", > "path": "/Shared Documents", > "path_id": "sp-folder-001", > "account": { > "id": "123456", > "email": "admin@company.box.com" > }, > "is_directory": true > } > ``` ## Shuttleパスマッピングアカウントの入力 アカウントスコープのパスマッピングの場所を所有するアカウント。`id`または`email`の少なくとも一方を指定します。 > [accordion] 属性と例 > > | プロパティ | 型 | 必須 | 説明 | > | - | - | - | - | > | `id` | `string` | いいえ | アカウントのプラットフォーム固有の識別子。 | > | `email` | `string` | いいえ | アカウントのメールアドレス。 | > > ```json 例 theme={null} > { > "id": "123456", > "email": "admin@company.box.com" > } > ``` ## Shuttleパスマッピングインポート作成リクエスト Boxに保存済みのスプレッドシートからShuttleジョブのパスマッピングをインポートするために使用するリクエスト本文。 > [accordion] 属性と例 > > | プロパティ | 型 | 必須 | 説明 | > | - | - | - | - | > | `job_id` | `string` | はい | パスマッピングが置き換えられるShuttleジョブの一意の識別子。 | > | `file_id` | `string` | はい | マッピングワークブックが格納されているBoxファイルの一意の識別子。このファイルは呼び出し元ユーザーとして読み取られるため、そのユーザーがダウンロードできる場所に保存されている必要があります。 | > > ```json 例 theme={null} > { > "job_id": "6a3ba68e810d9156194530a1", > "file_id": "12345678901" > } > ``` ## Shuttleパスマッピングターゲットの場所の入力 パスマッピングの作成または更新時に指定する移行先の場所。オブジェクトの構造は`type`によって決まります。移行先の入力には`is_directory`を含めません。このフラグはソースから取得されます。 > [accordion] 属性と例 > > ```json 例 theme={null} > { > "type": "account", > "path": "/HR Migration", > "path_id": "1234567890", > "account": { > "id": "123456", > "email": "admin@company.box.com" > } > } > ``` ## Shuttleパスマッピングの場所 パスマッピングの一方の側。オブジェクトの構造は`type`によって決まります。 > [accordion] 属性と例 > > ```json 例 theme={null} > { > "type": "account", > "path": "/HR Migration", > "path_id": "1234567890", > "account": { > "id": "123456", > "email": "admin@company.box.com", > "name": "Box Admin" > }, > "is_directory": true > } > ``` ## Shuttleパスマッピングの場所の入力 パスマッピングの作成または更新時に指定するソースの場所。オブジェクトの構造は`type`によって決まります。 > [accordion] 属性と例 > > ```json 例 theme={null} > { > "type": "account", > "path": "/Shared Documents", > "path_id": "sp-folder-001", > "account": { > "id": "123456", > "email": "admin@company.box.com" > }, > "is_directory": true > } > ``` ## Shuttleパスマッピング共有スペースの場所 サイト、チームドライブ、バケット、ファイル共有などの共有コンテナをスコープとするパスマッピングの場所。 > [accordion] 属性と例 > > | プロパティ | 型 | 必須 | 説明 | > | - | - | - | - | > | `type` | `enum` | はい | 値は常に`shared_space`になります。 使用可能なオプション: `shared_space`. | > | `space` | `string` | いいえ | 共有コンテナの表示名。システムに暗黙のコンテナが1つしかない場合は`null`。 `null` を指定できます。 | > | `path` | `string` | はい | 人間が判読できる、共有コンテナを基準とした相対パス。 | > | `path_id` | `string` | いいえ | 場所の安定した識別子。システムから識別子が提供されない場合は`null`。 `null` を指定できます。 | > | `is_directory` | `boolean` | いいえ | この場所がディレクトリかどうか。不明な場合は`null`。 `null` を指定できます。 | > > ```json 例 theme={null} > { > "type": "shared_space", > "space": "HR Team Site", > "path": "/Shared Documents", > "path_id": "sp-folder-001", > "is_directory": true > } > ``` ## Shuttleパスマッピング共有スペースの場所のターゲットの入力 パスマッピングの作成または更新時に指定する、共有コンテナの移行先の場所。 > [accordion] 属性と例 > > | プロパティ | 型 | 必須 | 説明 | > | - | - | - | - | > | `type` | `enum` | はい | 値は常に`shared_space`になります。 使用可能なオプション: `shared_space`. | > | `space` | `string` | いいえ | 共有コンテナの表示名。複数のコンテナが存在するシステムでは必須です。 | > | `path` | `string` | はい | 人間が判読できる、共有コンテナを基準とした相対パス。 | > | `path_id` | `string` | いいえ | 参照によって取得された場合の、場所の安定した識別子 (省略可)。 | > > ```json 例 theme={null} > { > "type": "shared_space", > "space": "HR Team Site", > "path": "/HR Migration", > "path_id": "1234567890" > } > ``` ## Shuttleパスマッピング共有スペースの場所の入力 パスマッピングの作成または更新時に指定する、共有コンテナのソースの場所。 > [accordion] 属性と例 > > | プロパティ | 型 | 必須 | 説明 | > | - | - | - | - | > | `type` | `enum` | はい | 値は常に`shared_space`になります。 使用可能なオプション: `shared_space`. | > | `space` | `string` | いいえ | 共有コンテナの表示名。複数のコンテナが存在するシステムでは必須です。 | > | `path` | `string` | はい | 人間が判読できる、共有コンテナを基準とした相対パス。 | > | `path_id` | `string` | いいえ | 参照によって取得された場合の、場所の安定した識別子 (省略可)。 | > | `is_directory` | `boolean` | いいえ | この場所がディレクトリかどうか。設定する場合、移行先も同じ種類のオブジェクトである必要があります。 | > > ```json 例 theme={null} > { > "type": "shared_space", > "space": "HR Team Site", > "path": "/Shared Documents", > "path_id": "sp-folder-001", > "is_directory": true > } > ``` ## Shuttleパスマッピング更新リクエスト 既存のShuttleパスマッピングを更新するために使用するリクエスト本文。リクエスト本文で指定されたフィールドのみが変更されます。`job_id`、`id`、`type`は変更できません。 > [accordion] 属性と例 > > | プロパティ | 型 | 必須 | 説明 | > | - | - | - | - | > | `is_path_skipped` | `boolean` | いいえ | 移行時にこのソースパスをスキップするかどうか。 | > | `source` | [Shuttleパスマッピングの場所の入力](#shuttle) | いいえ | 移行元のソースの場所。 | > | `target` | [Shuttleパスマッピングターゲットの場所の入力](#shuttle) | いいえ | 移行先の場所。ソースパスをスキップする場合などに、移行先をクリアするには、`null`に設定します。 `null` を指定できます。 | > > ```json 例 theme={null} > { > "is_path_skipped": true, > "source": { > "type": "account", > "path": "/Shared Documents", > "path_id": "sp-folder-001", > "account": { > "id": "123456", > "email": "admin@company.box.com" > }, > "is_directory": true > }, > "target": { > "type": "account", > "path": "/HR Migration", > "account": { > "email": "admin@company.box.com" > } > } > } > ``` ## Shuttleパスマッピング作成リクエスト 新しいShuttleパスマッピングを作成するために使用するリクエスト本文。 > [accordion] 属性と例 > > | プロパティ | 型 | 必須 | 説明 | > | - | - | - | - | > | `job_id` | `string` | はい | このマッピングが属しているShuttleジョブの一意の識別子。 | > | `is_path_skipped` | `boolean` | いいえ | 移行時にこのソースパスをスキップするかどうか。デフォルトで`false`に設定されます。 | > | `source` | [Shuttleパスマッピングの場所の入力](#shuttle) | はい | 移行元のソースの場所。 | > | `target` | [Shuttleパスマッピングターゲットの場所の入力](#shuttle) | いいえ | 移行先の場所。ソースパスをスキップする場合、省略するか`null`に設定します。 `null` を指定できます。 | > > ```json 例 theme={null} > { > "job_id": "6a3ba68e810d9156194530a1", > "is_path_skipped": false, > "source": { > "type": "account", > "path": "/Shared Documents", > "path_id": "sp-folder-001", > "account": { > "id": "123456", > "email": "admin@company.box.com" > }, > "is_directory": true > }, > "target": { > "type": "account", > "path": "/HR Migration", > "account": { > "email": "admin@company.box.com" > } > } > } > ``` ## Shuttleマッピングエラー Shuttleジョブのパス、サブジェクト、または権限のマッピングを準備する際に発生した問題。 > [accordion] 属性と例 > > | プロパティ | 型 | 必須 | 説明 | > | - | - | - | - | > | `id` | `string` | はい | マッピングエラーの一意の識別子。 | > | `type` | `enum` | はい | 値は常に`shuttle_mapping_error`になります。 使用可能なオプション: `shuttle_mapping_error`. | > | `job_id` | `string` | はい | このエラーが属しているShuttleジョブの一意の識別子。 | > | `revision` | `integer` | はい | このエラーが属しているマッピングリビジョン。 | > | `category` | `string` | はい | エラーが発生したマッピング処理のカテゴリ。これは取り得る値が固定されていない文字列で、今後新しい値が追加される可能性があります。 | > | `path` | `string` | はい | マッピングエラーの対象となるパスまたはサブジェクト。 | > | `messages` | array of `string` | はい | 人間が判読できる、マッピングエラーについての説明メッセージ。 | > > ```json 例 theme={null} > { > "id": "6a3ba7c02ea17bc9461eeacf", > "type": "shuttle_mapping_error", > "job_id": "6a3ba68e810d9156194530a1", > "revision": 3, > "category": "path", > "path": "/Shared Documents/Projects", > "messages": [ > "The source path could not be resolved." > ] > } > ``` ## Shuttleマッピングエラー Shuttleマッピングエラーのページ割りされたリスト。 > [accordion] 属性と例 > > | プロパティ | 型 | 必須 | 説明 | > | - | - | - | - | > | `entries` | array of [Shuttleマッピングエラー](#shuttle) | はい | Shuttleマッピングエラーのリスト。 | > | `limit` | `integer` | いいえ | これらのエントリで使用された制限値。許容される最大値を超えていない限り、クエリパラメータの`limit`と等しくなります。最大値はAPIによって異なります。 | > | `next_marker` | `string` | いいえ | 次の検索結果ページの開始場所のマーカー。 `null` を指定できます。 | > | `prev_marker` | `string` | いいえ | 前の検索結果ページの開始場所のマーカー。 `null` を指定できます。 | > > ```json 例 theme={null} > { > "entries": [ > { > "id": "6a3ba7c02ea17bc9461eeacf", > "type": "shuttle_mapping_error", > "job_id": "6a3ba68e810d9156194530a1", > "revision": 3, > "category": "path", > "path": "/Shared Documents/Projects", > "messages": [ > "The source path could not be resolved." > ] > } > ], > "limit": 1000, > "next_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii", > "prev_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih" > } > ``` ## Shuttleレポート Shuttleジョブの実行について非同期で生成されるレポート。`status`が`pending`または`processing`の間はポーリングを継続します。`status`が`complete`、`failed`、`canceled`、または`unknown`になると停止します。生成されるBoxファイルまたはフォルダは、生成が完了するまで`null`です。 > [accordion] 属性と例 > > | プロパティ | 型 | 必須 | 説明 | > | - | - | - | - | > | `id` | `string` | はい | Shuttleレポートの一意の識別子。 | > | `type` | `enum` | はい | 値は常に`shuttle_report`になります。 使用可能なオプション: `shuttle_report`. | > | `run_id` | `string` | はい | このレポートの生成対象となったShuttle実行の一意の識別子。 | > | `status` | `string` | はい | レポートの生成ステータス。これは取り得る値が固定されていない文字列で、今後新しい値が追加されることが想定されています。現在ドキュメント化されている値には、`pending`、`processing`、`complete`、`failed`、`canceled`、`unknown`があります。`pending`または`processing`の場合はポーリングを継続します。`complete`、`failed`、`canceled`、`unknown`の場合は停止します。認識できない値はすべて`unknown`と同様に扱います。認識されない値が返されても、分析を失敗させたり、ポーリングを継続したりしないでください。 | > | `format` | `enum` | はい | レポートの出力ファイル形式。 使用可能なオプション: `xlsx`, `csv`. | > | `sections` | array of `string` | いいえ | レポートに含まれているセクション。作成時にリクエストされたセクションがそのまま返されます。これは取り得る値が固定されていないリストで、今後新しい値が追加されることが想定されています。現在ドキュメント化されている値には、`files_and_folders`、`event_log`、`transfer_overview`、`source_users`、`target_users`、`source_collaborators`、`target_collaborators`、`source_collaborations`、`target_collaborations`があります。セクションリストが保存されていない古いレポートでは省略されます。新しいレポートには常にこのフィールドが含まれます。 | > | `users_scope` | `enum` | いいえ | ユーザー関連のレポートセクションに含まれているユーザー。 使用可能なオプション: `migrated`, `all`. | > | `output` | [Shuttleレポート出力](#shuttle) | はい | 生成されたBoxファイルまたはフォルダ。常に存在しますが、`status`が`complete`になるまでは`null`です。 `null` を指定できます。 | > | `created_at` | `string` | いいえ | レポートの生成がリクエストされた日時。 | > | `completed_at` | `string` | はい | レポートの生成が完了した日時。常に存在しますが、生成中は`null`です。 `null` を指定できます。 | > > ```json 例 theme={null} > { > "id": "6a3ba8d14f2c91e8370b4d12", > "type": "shuttle_report", > "run_id": "6a3ba68e810d9156194530a1:42", > "status": "complete", > "format": "xlsx", > "sections": [ > "event_log", > "transfer_overview" > ], > "users_scope": "migrated", > "output": { > "id": "12345678", > "type": "file" > }, > "created_at": "2026-03-15T06:35:00Z", > "completed_at": "2026-03-15T06:36:12Z" > } > ``` ## Shuttleレポート Shuttleレポートのページ割りされたリスト。 > [accordion] 属性と例 > > | プロパティ | 型 | 必須 | 説明 | > | - | - | - | - | > | `entries` | array of [Shuttleレポート](#shuttle) | はい | Shuttleレポートのリスト。 | > | `limit` | `integer` | いいえ | これらのエントリで使用された制限値。許容される最大値を超えていない限り、クエリパラメータの`limit`と等しくなります。最大値はAPIによって異なります。 | > | `next_marker` | `string` | いいえ | 次の検索結果ページの開始場所のマーカー。 `null` を指定できます。 | > | `prev_marker` | `string` | いいえ | 前の検索結果ページの開始場所のマーカー。 `null` を指定できます。 | > > ```json 例 theme={null} > { > "entries": [ > { > "id": "6a3ba8d14f2c91e8370b4d12", > "type": "shuttle_report", > "run_id": "6a3ba68e810d9156194530a1:42", > "status": "complete", > "format": "xlsx", > "sections": [ > "event_log", > "transfer_overview" > ], > "users_scope": "migrated", > "output": { > "id": "12345678", > "type": "file" > }, > "created_at": "2026-03-15T06:35:00Z", > "completed_at": "2026-03-15T06:36:12Z" > } > ], > "limit": 1000, > "next_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii", > "prev_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih" > } > ``` ## Shuttleレポート作成リクエスト Shuttle実行のレポートを生成するために使用するリクエスト本文。生成は非同期で行われます。作成されたレポートは、`pending`または`processing`ステータスですぐに返されます。`status`が`pending`または`processing`の間は`GET /shuttle_reports/{shuttle_report_id}`をポーリングします。`status`が`complete`、`failed`、`canceled`、または`unknown`になると停止します。同じパラメータでこのリクエストを繰り返した場合、重複するレポートを新たに作成する代わりに、既存のレポートが再利用されます。 > [accordion] 属性と例 > > | プロパティ | 型 | 必須 | 説明 | > | - | - | - | - | > | `run_id` | `string` | はい | レポートを生成するShuttle実行の一意の識別子。 | > | `format` | `enum` | はい | レポートの出力ファイル形式。 使用可能なオプション: `xlsx`, `csv`. | > | `sections` | array of `string` | はい | レポートに含めるセクション。実行の`available_report_sections`の空でないサブセットである必要があります。これは取り得る値が固定されていないリストで、今後新しい値が追加されることが想定されています。現在ドキュメント化されている値には、`files_and_folders`、`event_log`、`transfer_overview`、`source_users`、`target_users`、`source_collaborators`、`target_collaborators`、`source_collaborations`、`target_collaborations`があります。 | > | `users_scope` | `enum` | いいえ | ユーザー関連のレポートセクションに含めるユーザー。省略した場合、デフォルトで`migrated`に設定されます。 使用可能なオプション: `migrated`, `all`. | > > ```json 例 theme={null} > { > "run_id": "6a3ba68e810d9156194530a1:42", > "format": "xlsx", > "sections": [ > "event_log", > "transfer_overview" > ], > "users_scope": "migrated" > } > ``` ## Shuttleレポート出力 生成されたBoxファイルまたはフォルダへの参照。 > [accordion] 属性と例 > > | プロパティ | 型 | 必須 | 説明 | > | - | - | - | - | > | `id` | `string` | はい | 生成されたBoxファイルまたはフォルダの一意の識別子。 | > | `type` | `enum` | はい | 生成されたファイルまたはフォルダのBoxオブジェクトタイプ。 使用可能なオプション: `file`, `folder`. | > > ```json 例 theme={null} > { > "id": "12345678", > "type": "file" > } > ``` ## Shuttle検出済みサブジェクト スキャン中にソースシステムで検出されたサブジェクト。オプションで、推奨されるBoxターゲットが含まれます。 > [accordion] 属性と例 > > | プロパティ | 型 | 必須 | 説明 | > | - | - | - | - | > | `id` | `string` | はい | 検出されたサブジェクトの一意の識別子。 | > | `type` | `enum` | はい | 値は常に`shuttle_discovered_subject`になります。 使用可能なオプション: `shuttle_discovered_subject`. | > | `job_id` | `string` | はい | このサブジェクトが属しているShuttleジョブの一意の識別子。 | > | `revision` | `integer` | はい | この検出済みサブジェクトが属しているスキャンのリビジョン。 | > | `source` | [Shuttleサブジェクト](#shuttle) | はい | 検出時のソースオブジェクト。 | > | `suggested_target` | [Shuttleターゲットサブジェクト](#shuttle) | いいえ | スキャン時に推論された、推奨Boxターゲット。何も推奨されなかった場合は`null`。 `null` を指定できます。 | > > ```json 例 theme={null} > { > "id": "6a315c0754833bfc5df067bf", > "type": "shuttle_discovered_subject", > "job_id": "6a3ba68e810d9156194530a1", > "revision": 3, > "source": { > "type": "user", > "id": "sp-user-001", > "email": "user@example.com", > "name": "Jane Doe", > "roles": [ > "owner" > ] > }, > "suggested_target": { > "type": "user", > "id": "12345678", > "email": "user@example.com", > "name": "Jane Doe" > } > } > ``` ## Shuttle検出済みサブジェクト ソースシステムで検出されたサブジェクトのページ割りされたリスト。 > [accordion] 属性と例 > > | プロパティ | 型 | 必須 | 説明 | > | - | - | - | - | > | `entries` | array of [Shuttle検出済みサブジェクト](#shuttle) | はい | 検出されたサブジェクトのリスト。 | > | `limit` | `integer` | いいえ | これらのエントリで使用された制限値。許容される最大値を超えていない限り、クエリパラメータの`limit`と等しくなります。最大値はAPIによって異なります。 | > | `next_marker` | `string` | いいえ | 次の検索結果ページの開始場所のマーカー。 `null` を指定できます。 | > | `prev_marker` | `string` | いいえ | 前の検索結果ページの開始場所のマーカー。 `null` を指定できます。 | > > ```json 例 theme={null} > { > "entries": [ > { > "id": "6a315c0754833bfc5df067bf", > "type": "shuttle_discovered_subject", > "job_id": "6a3ba68e810d9156194530a1", > "revision": 3, > "source": { > "type": "user", > "id": "sp-user-001", > "email": "user@example.com", > "name": "Jane Doe", > "roles": [ > "owner" > ] > }, > "suggested_target": { > "type": "user", > "id": "12345678", > "email": "user@example.com", > "name": "Jane Doe" > } > } > ], > "limit": 1000, > "next_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii", > "prev_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih" > } > ``` ## Shuttle実行 Shuttleジョブの過去の実行インスタンス。ジョブが開始されるたびに実行が作成されます。実行IDの形式は`{job_id}:{run_number}`です。 > [accordion] 属性と例 > > | プロパティ | 型 | 必須 | 説明 | > | - | - | - | - | > | `id` | `string` | はい | Shuttle実行の一意の識別子 (`{job_id}:{run_number}`形式)。 | > | `type` | `enum` | はい | 値は常に`shuttle_run`になります。 使用可能なオプション: `shuttle_run`. | > | `job_id` | `string` | はい | この実行が属しているShuttleジョブの一意の識別子。 | > | `run_mode` | `string` | はい | 実行を開始したときのモード。これは取り得る値が固定されていない文字列で、今後新しい値が追加されることが想定されています。現在ドキュメント化されている値には、`transfer`、`simulation`、`analysis`、`scan`、`unknown`があります。クライアントは、認識できない値をすべて`unknown`として扱う必要があります。 | > | `state` | `string` | はい | Shuttle実行の現在の状態。これは取り得る値が固定されていない文字列で、今後新しい値が追加されることが想定されています。現在ドキュメント化されている値には、`running`、`stopping`、`completed`、`completed_with_errors`、`stopped`、`failed`、`timed_out`、`unknown`があります。クライアントは、認識できない値をすべて`unknown`として扱う必要があります。 | > | `started_at` | `string` | いいえ | 実行が開始された日時。 | > | `ended_at` | `string` | いいえ | 実行が終了した日時。実行中は`null`。 `null` を指定できます。 | > | `duration_seconds` | `integer` | いいえ | 実行の合計所要時間 (秒)。実行中は`null`。 `null` を指定できます。 | > | `stats` | `object` | いいえ | 実行中に収集された転送に関する統計情報。 | > | `created_by` | `ユーザー (Base)` | いいえ | 実行を開始したユーザー。スケジュールまたはシステムによって開始された実行の場合は`null`。 `null` を指定できます。 | > | `available_report_sections` | array of `string` | いいえ | この実行についてリクエストできるレポートセクション。これは取り得る値が固定されていないリストで、今後新しい値が追加されることが想定されています。現在ドキュメント化されている値には、`files_and_folders`、`event_log`、`transfer_overview`、`source_users`、`target_users`、`source_collaborators`、`target_collaborators`、`source_collaborations`、`target_collaborations`があります。 | > > ```json 例 theme={null} > { > "id": "6a3ba68e810d9156194530a1:42", > "type": "shuttle_run", > "job_id": "6a3ba68e810d9156194530a1", > "run_mode": "transfer", > "state": "completed", > "started_at": "2026-03-15T02:00:00Z", > "ended_at": "2026-03-15T06:30:00Z", > "duration_seconds": 16200, > "stats": { > "bytes_sent": 1073741824, > "files_sent": 4200, > "folders_created": 350, > "is_estimated": false > }, > "created_by": { > "id": "11446498", > "type": "user" > }, > "available_report_sections": [ > "event_log", > "files_and_folders" > ] > } > ``` ## Shuttle実行 Shuttle実行のページ割りされたリスト。 > [accordion] 属性と例 > > | プロパティ | 型 | 必須 | 説明 | > | - | - | - | - | > | `entries` | array of [Shuttle実行](#shuttle) | はい | Shuttle実行のリスト。 | > | `limit` | `integer` | いいえ | これらのエントリで使用された制限値。許容される最大値を超えていない限り、クエリパラメータの`limit`と等しくなります。最大値はAPIによって異なります。 | > | `next_marker` | `string` | いいえ | 次の検索結果ページの開始場所のマーカー。 `null` を指定できます。 | > | `prev_marker` | `string` | いいえ | 前の検索結果ページの開始場所のマーカー。 `null` を指定できます。 | > > ```json 例 theme={null} > { > "entries": [ > { > "id": "6a3ba68e810d9156194530a1:42", > "type": "shuttle_run", > "job_id": "6a3ba68e810d9156194530a1", > "run_mode": "transfer", > "state": "completed", > "started_at": "2026-03-15T02:00:00Z", > "ended_at": "2026-03-15T06:30:00Z", > "duration_seconds": 16200, > "stats": { > "bytes_sent": 1073741824, > "files_sent": 4200, > "folders_created": 350, > "is_estimated": false > }, > "created_by": { > "id": "11446498", > "type": "user" > }, > "available_report_sections": [ > "event_log", > "files_and_folders" > ] > } > ], > "limit": 1000, > "next_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii", > "prev_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih" > } > ``` ## ジョブによるShuttleジョブスケジュールトリガー 別のShuttleジョブの実行が条件を満たした後に、このスケジュールを開始するジョブベースのトリガー。 > [accordion] 属性と例 > > | プロパティ | 型 | 必須 | 説明 | > | - | - | - | - | > | `type` | `enum` | はい | 値は常に`by_job`になります。 使用可能なオプション: `by_job`. | > | `triggered_by_job_id` | `string` | はい | その実行を契機としてこのスケジュールを開始するShuttleジョブの一意の識別子。 | > | `last_run_condition` | `enum` | はい | トリガーとなるジョブの直前の実行を基準として、このスケジュールが実行を開始するタイミング。 使用可能なオプション: `always`, `on_success`, `on_finish`. | > > ```json 例 theme={null} > { > "type": "by_job", > "triggered_by_job_id": "8d2ca68e810d9156194530c3", > "last_run_condition": "on_success" > } > ``` ## 時間によるShuttleジョブスケジュールトリガー 特定の実時間にスケジュールを開始し、必要に応じて繰り返す時間ベースのトリガー。 > [accordion] 属性と例 > > | プロパティ | 型 | 必須 | 説明 | > | - | - | - | - | > | `type` | `enum` | はい | 値は常に`by_time`になります。 使用可能なオプション: `by_time`. | > | `start_at` | `string` | はい | スケジュールが最初の実行を開始するローカルの実時間。オフセットや`Z`サフィックスは含めません。`time_zone`と組み合わせて、DSTを考慮した実際の時間が決定されます。 | > | `time_zone` | `string` | はい | `start_at`をローカル日時として解釈するためのIANAタイムゾーン (例: `America/Los_Angeles`)。繰り返しおよびDSTの切り替えは、このタイムゾーンに基づいて決定されます。 | > | `repeat` | `enum` | はい | `start_at`の後にスケジュールを繰り返す頻度。 使用可能なオプション: `none`, `daily`, `weekly`, `weekdays`, `weekends`. | > > ```json 例 theme={null} > { > "type": "by_time", > "start_at": "2026-03-16T09:00:00", > "time_zone": "America/Los_Angeles", > "repeat": "daily" > } > ```