メインコンテンツへスキップ
POST
「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ジョブスケジュールを作成するために使用するリクエスト本文。

job_id
string
必須

このスケジュールが属しているShuttleジョブの一意の識別子。

例:

"6a3ba68e810d9156194530a1"

run_mode
enum<string>
必須

スケジュールが開始する実行の種類。scanは有効なスケジュール実行モードではありません。

利用可能なオプション:
transfer,
simulation,
analysis
例:

"transfer"

trigger
時間によるShuttleジョブスケジュールトリガー · object
必須

特定の実時間にスケジュールを開始し、必要に応じて繰り返す時間ベースのトリガー。

state
enum<string>
デフォルト:enabled

スケジュールがアクティブかどうか。省略した場合、デフォルトでenabledに設定されます。

利用可能なオプション:
enabled,
paused
例:

"enabled"

description
string | null

人間が判読できる、スケジュールの説明 (省略可)。

例:

"Nightly finance share replay."

レスポンス

新しく作成されたShuttleジョブスケジュールを返します。

Shuttleジョブの実行を開始するスケジュール。スケジュールは日時に基づくものか、他のジョブの実行によってトリガーされるものになります。スケジュールではscanモードでの実行を開始することはできません。

id
string
必須

Shuttleジョブスケジュールの一意の識別子。

例:

"7c1ba68e810d9156194530b2"

type
enum<string>
必須

値は常にshuttle_job_scheduleになります。

利用可能なオプション:
shuttle_job_schedule
例:

"shuttle_job_schedule"

job_id
string
必須

このスケジュールが属しているShuttleジョブの一意の識別子。

例:

"6a3ba68e810d9156194530a1"

state
enum<string>
必須

スケジュールがアクティブかどうか。

利用可能なオプション:
enabled,
paused
例:

"enabled"

run_mode
enum<string>
必須

スケジュールが開始する実行の種類。scanは有効なスケジュール実行モードではありません。

利用可能なオプション:
transfer,
simulation,
analysis
例:

"transfer"

trigger
時間によるShuttleジョブスケジュールトリガー · object
必須

特定の実時間にスケジュールを開始し、必要に応じて繰り返す時間ベースのトリガー。

description
string | null

人間が判読できる、スケジュールの説明 (省略可)。

例:

"Nightly finance share replay."

last_attempt_at
string<date-time> | null

スケジュールが最後に実行の開始を試みた日時。スケジュールが一度も実行を開始していない場合はnull。

例:

"2026-03-16T09:00:12Z"

最終更新日 2026年11月4日