Shuttleジョブを作成

{
  "id": "6a3ba68e810d9156194530a1",
  "type": "shuttle_job",
  "name": "Q4 SharePoint to Box",
  "job_type": "transfer",
  "state": "created",
  "mapping_state": "awaiting_path_mapping",
  "source_system": {
    "type": "shuttle_system",
    "id": "6a3ba68e810d9156194530a1",
    "name": "SharePoint"
  },
  "comment": "Migrating the finance department archives.",
  "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
  }
}

{
  "type": "error",
  "status": 400,
  "code": "item_name_invalid",
  "message": "Method Not Allowed",
  "context_info": {
    "message": "Something went wrong"
  },
  "help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
  "request_id": "abcdef123456"
}

{
  "type": "error",
  "status": 400,
  "code": "item_name_invalid",
  "message": "Method Not Allowed",
  "context_info": {
    "message": "Something went wrong"
  },
  "help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
  "request_id": "abcdef123456"
}

{
  "type": "error",
  "status": 400,
  "code": "item_name_invalid",
  "message": "Method Not Allowed",
  "context_info": {
    "message": "Something went wrong"
  },
  "help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
  "request_id": "abcdef123456"
}

{
  "type": "error",
  "status": 400,
  "code": "item_name_invalid",
  "message": "Method Not Allowed",
  "context_info": {
    "message": "Something went wrong"
  },
  "help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
  "request_id": "abcdef123456"
}

{
  "type": "error",
  "status": 400,
  "code": "item_name_invalid",
  "message": "Method Not Allowed",
  "context_info": {
    "message": "Something went wrong"
  },
  "help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
  "request_id": "abcdef123456"
}

{
  "type": "error",
  "status": 400,
  "code": "item_name_invalid",
  "message": "Method Not Allowed",
  "context_info": {
    "message": "Something went wrong"
  },
  "help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
  "request_id": "abcdef123456"
}

POST

shuttle_jobs

{
  "id": "6a3ba68e810d9156194530a1",
  "type": "shuttle_job",
  "name": "Q4 SharePoint to Box",
  "job_type": "transfer",
  "state": "created",
  "mapping_state": "awaiting_path_mapping",
  "source_system": {
    "type": "shuttle_system",
    "id": "6a3ba68e810d9156194530a1",
    "name": "SharePoint"
  },
  "comment": "Migrating the finance department archives.",
  "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
  }
}

{
  "type": "error",
  "status": 400,
  "code": "item_name_invalid",
  "message": "Method Not Allowed",
  "context_info": {
    "message": "Something went wrong"
  },
  "help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
  "request_id": "abcdef123456"
}

{
  "type": "error",
  "status": 400,
  "code": "item_name_invalid",
  "message": "Method Not Allowed",
  "context_info": {
    "message": "Something went wrong"
  },
  "help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
  "request_id": "abcdef123456"
}

{
  "type": "error",
  "status": 400,
  "code": "item_name_invalid",
  "message": "Method Not Allowed",
  "context_info": {
    "message": "Something went wrong"
  },
  "help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
  "request_id": "abcdef123456"
}

{
  "type": "error",
  "status": 400,
  "code": "item_name_invalid",
  "message": "Method Not Allowed",
  "context_info": {
    "message": "Something went wrong"
  },
  "help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
  "request_id": "abcdef123456"
}

{
  "type": "error",
  "status": 400,
  "code": "item_name_invalid",
  "message": "Method Not Allowed",
  "context_info": {
    "message": "Something went wrong"
  },
  "help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
  "request_id": "abcdef123456"
}

{
  "type": "error",
  "status": 400,
  "code": "item_name_invalid",
  "message": "Method Not Allowed",
  "context_info": {
    "message": "Something went wrong"
  },
  "help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
  "request_id": "abcdef123456"
}

「Box SDKのバージョニング戦略について詳しく学ぶ。」

承認

Authorization

string

header

必須

The access token received from the authorization server in the OAuth 2.0 flow.

ヘッダー

box-version

enum<string>

必須

Version header.

利用可能なオプション:

2026.0

ボディ

application/json

新しいShuttleジョブを作成するために使用されるリクエスト本文。

name

string

必須

人間が判読できるShuttleジョブ名。

Minimum string length: 1

例:

"Q4 SharePoint to Box"

job_type

enum<string>

必須

Shuttleジョブが実行する作業のタイプ。

利用可能なオプション:

transfer,

analysis

例:

"transfer"

source_system_id

string

必須

移行元のソースシステムの一意の識別子。

例:

"6a3ba68e810d9156194530a1"

comment

string

Shuttleジョブについて説明した自由形式のコメント (省略可)。

例:

"Migrating the finance department archives."

レスポンス

新しく作成されたShuttleジョブを返します。

ShuttleジョブのStandard版の表示。Shuttleジョブは、ソースシステムからBoxへのコンテンツ移行について、現在の状態、マッピング準備状態、マッピング構成を含めて記述します。

string

必須

Shuttleジョブの一意の識別子。

例:

"6a3ba68e810d9156194530a1"

type

enum<string>

必須

値は常にshuttle_jobになります。

利用可能なオプション:

shuttle_job

例:

"shuttle_job"

name

string

必須

人間が判読できるShuttleジョブ名。

例:

"Q4 SharePoint to Box"

job_type

enum<string>

必須

Shuttleジョブが実行する作業のタイプ。

利用可能なオプション:

transfer,

analysis

例:

"transfer"

state

string

必須

Shuttleジョブの現在の状態。これは取り得る値が固定されていない文字列で、今後新しい値が追加されることが想定されています。現在ドキュメント化されている値にはcreated、started、stopped、completed、failed、invalid、unknownがあります。クライアントは識別できない値をすべてunknownとして扱う必要があります。

例:

"created"

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は、前回のサブジェクトマッピングスプレッドシートが拒否されたか失敗し、それ以来サブジェクトマッピングが変更されていないことを示します。これは、次回のインポート時または次回の手動サブジェクトマッピング変更の際にクリアされます。

例:

"awaiting_path_mapping"

source_system

object

必須

Shuttleジョブによってコンテンツを移行させるソースシステム。

Show child attributes

comment

string | null

Shuttleジョブについて説明した自由形式のコメント (省略可)。

例:

"Migrating the finance department archives."

account_mapping

object

ソースの識別子および権限をBox用に変換する方法を制御する、アカウントマッピング構成。

Show child attributes

APIリファレンス

v2025.0

v2026.0

APIリファレンス

APIリファレンス

Shuttleジョブを作成

承認

ヘッダー

ボディ

レスポンス