メタデータ API 開発者ガイド
jAsyncResult
API バージョン 31.0 以前
API バージョン 31.0 では、メタデータを取得するプロセスが簡略化され、取得プロパティが RetrieveResult に移動しました。また、非同期 create()、update()、および delete() コールが削除されました。そのため、AsyncResult の id 項目のみが使用されます。id 項目は、リリースまたは取得の ID です。
AsyncResult は、次の非同期コールによって返されます。
AsyncResult では、次の項目が使用されています。
| 名前 | 型 | 説明 |
|---|---|---|
| id | ID | 必須。リリースまたは取得されるコンポーネントの ID。 |
AsyncResult の id 以外のすべての項目は、API バージョン 31.0 で廃止されました。次の項目は存在しますが、使用されません。
- done
- message
- state
- statusCode
API バージョン 29.0 および 30.0
API バージョン 29.0 では、Salesforce はリリースに関する情報を取得するプロセスを改善するために AsyncResult オブジェクトから DeployResult オブジェクトにいくつかのプロパティを移動し、いくつかの新しいプロパティを追加しました。これらの変更についての詳細は、「deploy()」 を参照してください。
API バージョン 29.0 および 30.0 では、API バージョン 28.0 以前と同じ非同期コールで AsyncResult が返されますが、項目は異なります。
| 名前 | 型 | 説明 |
|---|---|---|
| done | boolean | 必須。コールが完了したか (true)、否か (false) を示します。 |
| id | ID | 必須。作成、更新、削除、リリース、または取得されるコンポーネントの ID。 |
| message | string | 返される statusCode 項目に対応するメッセージ (存在する場合)。 |
| state | AsyncRequestState (string 型の列挙) | 必須。AsyncRequestState オブジェクトの値は、次の 4 つの値のいずれかです。
|
| statusCode | StatusCode (string 型の列挙) |
create()、update()、または delete() コール中にエラーが発生した場合、状況コードが返され、その状況コードに対応するメッセージが message 項目に返されます。 各 StatusCode の値の説明については、『SOAP API 開発者ガイド』の「StatusCode」を参照してください。 |
API バージョン 28.0 以前
API バージョン 28.0 以前では、AsyncResult は、次の非同期コールによって返されます。
各オブジェクトに対して checkStatus() コールを発行し、そのオブジェクトのコールが完了するタイミングを検出します。Salesforce は、コール完了時またはエラー発生時に、各 AsyncResult オブジェクトを更新します。
同様に、deploy() および retrieve() コールは AsyncResult を使用しますが、リリースまたは取得の状況情報をさらに取得するには、それぞれのコールの後に checkDeployStatus() または checkRetrieveStatus() を使用する必要があります。
AsyncResult には次の項目があります。
| 名前 | 型 | 説明 |
|---|---|---|
| checkOnly | boolean | 組織で一切の変更を行わず、リリースされたファイルの有効性を確認するためにこのリリースが使用されているか (true)、否か (false) を示します。確認のみのリリースでは、いずれのコンポーネントもリリースせず、組織の変更も一切行いません。この項目は API バージョン 16.0 以降で使用でき、deploy() コールのみに関連します。 |
| done | boolean | 必須。コールが完了したか (true)、否か (false) を示します。 |
| id | ID | 必須。作成、更新、削除、リリース、または取得されるコンポーネントの ID。 |
| message | string | 返される statusCode 項目に対応するメッセージ (存在する場合)。 |
| numberComponentErrors | int | このリリース中にエラーを生成したコンポーネントの数。この項目は API バージョン 16.0 以降で使用でき、deploy() コールのみに関連します。 |
| numberComponentsDeployed | int | このリリースについて、リリースされたコンポーネントの数。この項目は、numberComponentsTotal 項目と併せて、リリースの進行状況を示します。この項目は API バージョン 16.0 以降で使用でき、deploy() コールのみに関連します。 |
| numberComponentsTotal | int | リリースのコンポーネントの合計数。この項目は、numberComponentsDeployed 項目と併せて、リリースの進行状況を示します。この項目は API バージョン 16.0 以降で使用でき、deploy() コールのみに関連します。 |
| numberTestErrors | int | このリリース中にエラーを生成した Apex テストの数。この項目は API バージョン 16.0 以降で使用でき、deploy() コールのみに関連します。 |
| numberTestsCompleted | int | このリリースの完了した Apex テスト数。この項目は、numberTestsTotal 項目と併せて、リリースのテストの進行状況を示します。この項目は API バージョン 16.0 以降で使用でき、deploy() コールのみに関連します。 |
| numberTestsTotal | int | リリースの Apex テストの合計数。この項目は、numberTestsCompleted 項目と併せて、リリースのテストの進行状況を示します。この項目の値は、リリースされるコンポーネントのテストが開始されるまで正確ではありません。この項目は API バージョン 16.0 以降で使用でき、deploy() コールのみに関連します。 |
| secondsToWait | int | この項目は API バージョン 13.0 以降ではサポートされていません。後方互換性を確保するためにのみ提供されています。この項目は API バージョン 17.0 で削除されました。 コールが完了するまでにかかるおおよその秒数を示します。これは推定のみです。checkStatus() をコールする前に少し待って、操作が完了したかを確認するのが合理的なアプローチです。以降の checkStatus() コールの各反復については、操作が完了するまでの待機時間を 2 倍にします。 |
| state | AsyncRequestState (string 型の列挙) | 必須。AsyncRequestState オブジェクトの値は、次の 4 つの値のいずれかです。
|
| stateDetail | string | リリースされているコンポーネント、または実行している Apex テストクラスを示します。この項目は API バージョン 16.0 以降で使用でき、deploy() コールのみに関連します。 |
| stateDetailLastModifiedDate | dateTime | stateDetail 項目が最後に更新された日時。この項目は API バージョン 16.0 以降で使用でき、deploy() コールのみに関連します。 |
| statusCode | StatusCode (string 型の列挙) |
create()、update()、delete()、または deploy() コール中にエラーが発生した場合、状況コードが返され、その状況コードに対応するメッセージが message 項目に返されます。 各 StatusCode の値の説明については、『SOAP API 開発者ガイド』の「StatusCode」を参照してください。 |