メインコンテンツへスキップ
GET
「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

パスパラメータ

shuttle_report_id
string
必須

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

レスポンス

Shuttleレポートを返します。

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

id
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です。

例:
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

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

例:
users_scope
enum<string>

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

利用可能なオプション:
migrated,
all
例:

"migrated"

created_at
string<date-time>

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

例:

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

最終更新日 2026年11月4日