PackagePushRequest | Salesforce および Lightning プラットフォームのオブジェクトリファレンス

サポートされているコール

create()、describeSObjects()、query()、retrieve()、update()、upsert()

項目

項目名	詳細
DurationSeconds	型 int プロパティ Group、Nillable 説明転送アップグレードの完了に要した時間の長さ (秒)。この項目は API バージョン 51.0 で新規追加されました。
EndTime	型 dateTime プロパティ Create、Nillable、Update 説明転送アップグレードが終了した ISO 8601 形式の日時 (UTC)。この項目は API バージョン 51.0 で新規追加されました。
PackageVersionId	型 reference プロパティ Create、Filter、Group、Nillable、Sort、Update 説明必須。パッケージがアップグレードされる、ベータでも非推奨でもないパッケージバージョン。
ScheduledStartTime	型 dateTime プロパティ Create、Filter、Nillable、Sort、Update 説明転送要求が処理される ISO 8601 形式の日時 (UTC)。Salesforce で転送の開始を試行する最も早い時間にこの値を設定します。日曜日の午前 1:00 など、ピーク時間外に転送をスケジュールすることをお勧めします。値を指定しないと、パッケージ転送要求の Status が `Pending` に設定されているときに転送が開始します。
StartTime	型 dateTime プロパティ Create、Nillable、Update 説明転送アップグレードが実際に開始した ISO 8601 形式の日時 (UTC)。この項目は API バージョン 51.0 で新規追加されました。
Status	型 picklist プロパティ Create、Filter、Group、Nillable、Restricted picklist、Sort、Update 説明転送の状況。有効な値は、次のとおりです。 Canceled Created (デフォルト) Failed In Progress Pending Succeeded 転送要求を作成する場合はこの値を指定しないでください。デフォルト値の [Created] が使用されます。後で状況を [Pending] に変更し、転送アップグレードをスケジュールします。

使用方法

パッケージのバージョン 3.4.6 をすべての組織に転送するとします。MetadataPackageVersion を使用して、アップグレード対象の組織をすでに特定しています。各対象組織の転送ジョブを保持する転送要求を作成するため、いくつかのコードを記述しましょう。

このコードサンプルは Web Services Connector (WSC) を使用しています。

または、REST API を使用している場合、次の例のように POST 要求を PackagePushRequest sObject エンドポイントに送信します。SOAP API もサポートされています。

この例は、転送ジョブの作成に必要な転送要求 ID (0DV で開始) を返します。

次のステップでは、PackagePushJob を使用して、アップグレードする各対象登録者の転送ジョブを作成します。

転送アップグレードのスケジュール

転送アップグレードの準備ができていることを示すには、転送要求の状況を Pending に変更します。ScheduledStartTime を設定していない場合、転送アップグレードは状況を変更した直後に開始されます。

次の Java の例を参照してください。

REST API を使用している場合、次の例のように PATCH 要求を PackagePushRequest sObject エンドポイントに送信します。SOAP API もサポートされています。

転送要求の状況の確認

PackagePushRequest の状況は、その関連付けられたすべてのジョブが成功した場合は Succeeded、1 つ以上のジョブが失敗した場合は Failed になります。

PackagePushJob の Status 項目を照会してジョブの状況を確認することもできます。

転送要求の中止

状況を [Canceled] に変更して、パッケージ転送要求を中止できます。

たとえば、REST API を使用している場合、PATCH 要求を PackagePushRequest sObject エンドポイントに送信します。

Java の例は次のとおりです。

状況が [Created] または [Pending] の場合のみパッケージ転送要求を中止できます。中止が成功すると、関連する転送ジョブもすべてキャンセルされます。現在の PackagePushRequest の状況が [Canceled]、[Succeeded]、[Failed]、または [In Progress] の場合、転送は中止されずにエラーメッセージが返されます。