スケジュールを更新
スケジュール(組織)
スケジュールを更新
既存のスケジュールを更新します。
PATCH
スケジュールを更新
権限
ManageOrgSchedules 権限を持つサービスユーザーが必要です。
注意事項
enabled を false に設定します。
playbook_id を null に設定すると、関連付けられているプレイブックが解除されます。
schedule_type は recurring と one_time の間で変更できます。one_time に変更する場合は、将来の日時を表す ISO 8601 形式の値を scheduled_at に指定してください。recurring に変更する場合は、有効な cron 式を frequency に指定してください。
実行アイデンティティ
run_as_user_id パラメータは、スケジュールをどのユーザーのアイデンティティとして実行するかを制御します。スケジュールがトリガーされると、そのユーザーのセッションとして作成され、そのユーザーに通知が送信され、そのセッションが当該ユーザーの履歴に表示されます。
- ユーザーを設定する: 実行アイデンティティを変更するには、有効なユーザー ID を指定します。これには以下が必要です:
- サービスユーザーが
ImpersonateOrgSessions権限を持っていること - 対象ユーザーがその組織のメンバーであること
- 対象ユーザーが
UseDevinSessions権限を持っていること
- サービスユーザーが
- クリア (
nullに設定) : スケジュールはデフォルトのボットユーザーとして実行される状態に戻ります - フィールドを省略する: 現在の実行アイデンティティは変更されません
承認
サービスユーザーの credential(プレフィックス: cog_)
パスパラメータ
スケジュール ID(接頭辞: sched-)
例:
"sched-abc123def456"
ボディ
application/json
利用可能なオプション:
devin, data_analyst 利用可能なオプション:
always, failure, never このスケジュールで生成されるセッションのVMプラットフォーム(例: 'windows')。省略した場合、プラットフォームは変更されません。値は組織に設定されているプラットフォームと一致している必要があります(大文字・小文字は区別されません)。不明な値は、利用可能なプラットフォームラベルを一覧表示する400エラーで拒否されます。
このスケジュールをどのユーザーIDとして実行するかを設定します。ImpersonateOrgSessions権限が必要です。nullに設定すると、デフォルトのボットユーザーに戻ります。フィールドを省略した場合、現在のIDは変更されません。
利用可能なオプション:
recurring, one_time レスポンス
成功レスポンス
利用可能なオプション:
devin, data_analyst 利用可能なオプション:
always, failure, never 利用可能なオプション:
recurring, one_time 