{
  "id": "6a3ba8d14f2c91e8370b4d12",
  "type": "shuttle_report",
  "run_id": "6a3ba68e810d9156194530a1:42",
  "status": "complete",
  "format": "xlsx",
  "output": {
    "id": "12345678",
    "type": "file"
  },
  "completed_at": "2026-03-15T06:36:12Z",
  "sections": [
    "event_log",
    "transfer_overview"
  ],
  "users_scope": "migrated",
  "created_at": "2026-03-15T06:35:00Z"
}

{
  "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"
}

{
  "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"
}

Shuttle

Shuttleレポートを作成

Shuttle実行のレポートの非同期的生成をリクエストします。レポートはpendingまたはprocessingステータスで即座に返されます。statusがpendingまたはprocessingの間に、GET /shuttle_reports/{shuttle_report_id}をポーリングします。statusがcomplete、failed、canceled、unknownのいずれかになると停止します。同じパラメータを使ってこのリクエストを再実行すると、重複するレポートが作成されるのではなく既存のレポートが再利用されます。

POST

shuttle_reports

{
  "id": "6a3ba8d14f2c91e8370b4d12",
  "type": "shuttle_report",
  "run_id": "6a3ba68e810d9156194530a1:42",
  "status": "complete",
  "format": "xlsx",
  "output": {
    "id": "12345678",
    "type": "file"
  },
  "completed_at": "2026-03-15T06:36:12Z",
  "sections": [
    "event_log",
    "transfer_overview"
  ],
  "users_scope": "migrated",
  "created_at": "2026-03-15T06:35:00Z"
}

{
  "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"
}

{
  "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実行のレポートを生成するために使用するリクエスト本文。生成は非同期で行われます。作成されたレポートは、pendingまたはprocessingステータスですぐに返されます。statusがpendingまたはprocessingの間はGET /shuttle_reports/{shuttle_report_id}をポーリングします。statusがcomplete、failed、canceled、またはunknownになると停止します。同じパラメータでこのリクエストを繰り返した場合、重複するレポートを新たに作成する代わりに、既存のレポートが再利用されます。

run_id

string

必須

レポートを生成するShuttle実行の一意の識別子。

例:

"6a3ba68e810d9156194530a1:42"

format

enum<string>

必須

レポートの出力ファイル形式。

利用可能なオプション:

xlsx,

csv

例:

"xlsx"

sections

string[]

必須

レポートに含めるセクション。実行のavailable_report_sectionsの空でないサブセットである必要があります。これは取り得る値が固定されていないリストで、今後新しい値が追加されることが想定されています。現在ドキュメント化されている値には、files_and_folders、event_log、transfer_overview、source_users、target_users、source_collaborators、target_collaborators、source_collaborations、target_collaborationsがあります。

Minimum array length: 1

レポートに含めるセクション。

例:

["event_log", "transfer_overview"]

users_scope

enum<string>

デフォルト:migrated

ユーザー関連のレポートセクションに含めるユーザー。省略した場合、デフォルトでmigratedに設定されます。

利用可能なオプション:

migrated,

all

例:

"migrated"

レスポンス

レポートの生成が許可されています。Shuttleレポートが返され、非同期的に生成が続行されます。同じパラメータを使ってこのリクエストを再実行すると、重複するレポートが作成されるのではなく既存のレポートが再利用されます。

Shuttleジョブの実行について非同期で生成されるレポート。statusがpendingまたはprocessingの間はポーリングを継続します。statusがcomplete、failed、canceled、またはunknownになると停止します。生成されるBoxファイルまたはフォルダは、生成が完了するまでnullです。

string

必須

Shuttleレポートの一意の識別子。

例:

"6a3ba8d14f2c91e8370b4d12"

type

enum<string>

必須

値は常にshuttle_reportになります。

利用可能なオプション:

shuttle_report

例:

"shuttle_report"

run_id

string

必須

このレポートの生成対象となったShuttle実行の一意の識別子。

例:

"6a3ba68e810d9156194530a1:42"

status

string

必須

レポートの生成ステータス。これは取り得る値が固定されていない文字列で、今後新しい値が追加されることが想定されています。現在ドキュメント化されている値には、pending、processing、complete、failed、canceled、unknownがあります。pendingまたはprocessingの場合はポーリングを継続します。complete、failed、canceled、unknownの場合は停止します。認識できない値はすべてunknownと同様に扱います。認識されない値が返されても、分析を失敗させたり、ポーリングを継続したりしないでください。

例:

"complete"

format

enum<string>

必須

レポートの出力ファイル形式。

利用可能なオプション:

xlsx,

csv

例:

"xlsx"

output

Shuttleレポート出力 · object

必須

生成されたBoxファイルまたはフォルダ。常に存在しますが、statusがcompleteになるまではnullです。

Shuttleレポート出力
OpenAPI 3.0 null schema type

Show child attributes

例:

{ "id": "12345678", "type": "file" }

completed_at

string<date-time> | null

必須

レポートの生成が完了した日時。常に存在しますが、生成中はnullです。

例:

"2026-03-15T06:36:12Z"

sections

string[]

レポートに含まれているセクション。作成時にリクエストされたセクションがそのまま返されます。これは取り得る値が固定されていないリストで、今後新しい値が追加されることが想定されています。現在ドキュメント化されている値には、files_and_folders、event_log、transfer_overview、source_users、target_users、source_collaborators、target_collaborators、source_collaborations、target_collaborationsがあります。セクションリストが保存されていない古いレポートでは省略されます。新しいレポートには常にこのフィールドが含まれます。

Minimum array length: 1

レポートに含まれているセクション。

例:

["event_log", "transfer_overview"]

users_scope

enum<string>

ユーザー関連のレポートセクションに含まれているユーザー。

利用可能なオプション:

migrated,

all

例:

"migrated"

created_at

string<date-time>

レポートの生成がリクエストされた日時。

例:

"2026-03-15T06:35:00Z"

最終更新日 2026年11月4日

APIリファレンス

v2025.0

v2026.0

APIリファレンス

APIリファレンス

Shuttleレポートを作成

承認

ヘッダー

ボディ

レスポンス