メタデータ API 開発者ガイド
jcancelDeploy()
まだ完了していないリリースをキャンセルします。
構文
使用方法
deploy() 操作によって開始された組織内のリリースをキャンセルするには、cancelDeploy() 操作を使用します。これには、Lightning プラットフォーム移行ツールおよび Lightning Platform IDE によって開始されたリリースが含まれます。リリースは、キュー内で開始待ちの場合や進行中の場合があります。この操作は、キャンセルするリリースの ID を取り、CancelDeployResult オブジェクトを返します。リリースがキュー内にあり、まだ開始していない場合、cancelDeploy() をコールすると即座にリリースがキャンセルされます。リリースがすでに開始し、進行中の場合、すぐにはキャンセルされないこともあるため、checkDeployStatus() をコールしてキャンセル状況をチェックする必要があります。
リリースをキャンセルするには、次の手順を実行します。
- キャンセルするリリースの ID を取得します。たとえば、deploy() コールで AsyncResult オブジェクトの id 項目から ID を取得できます。または、Salesforce ユーザインターフェースで、[設定] から [クイック検索] ボックスに「リリース状況」と入力し、[リリース状況] を選択し、API で開始されたリリースの ID を確認しても ID を取得できます。
- cancelDeploy() コールを発行して、キャンセルプロセスを開始します。このコールは、CancelDeployResult オブジェクトを返します。
- 返された CancelDeployResult の done 項目の値をチェックします。done 項目値が true の場合、リリースはすでにキャンセルされており、作業は完了しています。done 項目値が false の場合、キャンセルは進行中であるため、次の手順に従ってキャンセル状況をチェックします。
- すでに取得したリリース ID を使用して checkDeployStatus() をコールします。
- 返された DeployResult オブジェクト内の status 項目をチェックします。状況が Canceling の場合、キャンセルは依然として進行中であるため、手順 a と b を繰り返します。状況が Canceled の場合、リリースはすでにキャンセルされており、作業は完了しています。
deploy() 操作は次の API 障害を発生させます。
- 「Invalid deploy ID」というメッセージを含む INVALID_ID_FIELD
- 指定された ID 引数が有効なリリースに対応していません。
- 「Deployment already completed」というメッセージを含む INVALID_ID_FIELD
- 指定されたリリースはすでに完了しています。
バージョン
API バージョン 30.0 以降で利用できます。
権限
クライアントアプリケーションは、「すべてのデータの編集」権限または「メタデータ API 関数を使用したメタデータを変更」権限でログインしている必要があります。
引数
| 名前 | 型 | 説明 |
|---|---|---|
| id | string | キャンセルするリリースの ID。 |