スケジュール

Schedules のドキュメント

Schedules

ベースパス: /api/v1/schedules

スケジュールは Temporal によって駆動されるワークフローの定期実行計画を表します。認証済みユーザーの全スケジュールを一覧でき、スケジュール済みワークフローの入力パラメータを更新できます。

スケジュールの作成、一時停止/再開、削除には /api/v1/workflows/:workflowId/schedule 配下のワークフロー固有スケジュールエンドポイントを使用してください。workflows.md を参照。

すべてのエンドポイントには JWT 認証と x-active-org ヘッダーが必要です。

Method	Path	Auth	Description
GET	`/api/v1/schedules`	JWT	認証済みユーザーの全スケジュールを一覧
PUT	`/api/v1/schedules/:scheduleId/workflow-params`	JWT	スケジュールの入力と環境変数を更新

アクティブな組織内で認証済みユーザーが所有する全ワークフロースケジュールを一覧します。

Parameter	Type	Default	Description
`page`	number	`1`	ページ番号（最小: 1）
`limit`	number	`20`	1 ページあたり件数（最小: 1、最大: 100）
`search`	string	–	ワークフロー名で検索（大文字小文字を区別しない部分一致）

json

スケジュールオブジェクトフィールド:

Field	Type	Description
`id`	string (UUID)	スケジュール ID
`workflowId`	string (UUID)	関連ワークフローの ID
`workflowName`	string \| null	ワークフロー名
`workflowDescription`	string \| null	ワークフローの説明
`description`	string \| null	人間が読めるスケジュール説明
`definition`	object \| null	スケジュール仕様オブジェクト（下記 Schedule Definition 参照）
`isPaused`	boolean	スケジュールが現在一時停止中か
`createdAt`	string (ISO 8601)	スケジュール作成日時
`updatedAt`	string (ISO 8601)	最終更新日時

definition フィールドはワークフローの実行タイミングを記述します。

Field	Type	Description
`intervals`	array	インターバルベース: `[{ "every": "1h", "offset": "0" }]`
`calendars`	array	カレンダーベース（cron 風）
`timezone`	string \| null	IANA タイムゾーン文字列、例: `"America/New_York"`
`jitter`	string \| number \| null	負荷分散のランダム遅延（期間文字列または秒）
`startAt`	string \| null	ISO 8601 開始日時
`endAt`	string \| null	ISO 8601 終了日時
`description`	string \| null	人間が読める説明

カレンダーエントリフィールド: second、minute、hour、dayOfMonth、month、year、dayOfWeek — 各々単一値、範囲（{ start, end, step }）、または値の配列を受け付けます。

スケジュールがワークフローをトリガーする際に使用する入力値と環境変数を更新します。変更は Temporal スケジュールへ即座に反映されます。

Parameter	Type	Description
`scheduleId`	string (UUID)	スケジュール ID

Field	Type	Required	Default	Description
`inputs`	JSON object	No	`{}`	スケジュール実行の入力値（入力名をキー）
`envs`	JSON object	No	`{}`	環境変数の上書き（文字列から文字列へのマップ）

javascript

json

Status	Reason
`404 Not Found`	DB または Temporal にスケジュールが存在しない