メタデータ API 開発者ガイド
jDeployResult
| 名前 | 型 | 説明 |
|---|---|---|
| id | ID | リリースされるコンポーネントの ID。 |
| canceledBy | ID |
リリースをキャンセルしたユーザーの ID。 この項目は、API バージョン 30.0 以降で使用できます。 |
| canceledByName | string |
リリースをキャンセルしたユーザーの氏名。 この項目は、API バージョン 30.0 以降で使用できます。 |
| checkOnly | boolean | 組織を変更することなくリリースされたファイルの有効性を確認するために、このリリースが使用されているか (true)、否か (false) を示します。確認のみのリリースでは、いずれのコンポーネントもリリースせず、組織の変更も一切行いません。 |
| completedDate | dateTime | リリースプロセスの終了時期を示すタイムスタンプ。 |
| createdBy | ID |
リリースを作成したユーザーの ID。 この項目は、API バージョン 30.0 以降で使用できます。 |
| createdByName | string |
リリースを作成したユーザーの氏名。 この項目は、API バージョン 30.0 以降で使用できます。 |
| createdDate | dateTime | deploy() コールの受信時期を示すタイムスタンプ。 |
| details | DeployDetails[] | checkDeployStatus() コールの includeDetails パラメーターが true に設定されている場合は、進行中または終了済みのリリースの詳細を示します。 |
| done | boolean | 指定された id に対する deploy() コールの処理がサーバーで完了したかどうかを示します。 |
| errorMessage | string | errorStatusCode 項目に値がある場合は、それに対応するメッセージ。 |
| errorStatusCode | string |
deploy() コール中にエラーが発生した場合、状況コードが返され、その状況コードに対応するメッセージが errorMessage 項目に返されます。 各 StatusCode の値の説明については、『SOAP API 開発者ガイド』の「StatusCode」を参照してください。 |
| ignoreWarnings | boolean | 省略可能。デフォルトは false です。リリース中に警告が発生しても処理を続行するかどうかを指定します。本番組織へのリリースでは、この引数を true に設定することはできません。 |
| lastModifiedDate | dateTime | リリースプロセスの最後の更新時期を示すタイムスタンプ。 |
| numberComponentErrors | int | このリリース中にエラーを生成したコンポーネントの数。 |
| numberComponentsDeployed | int | リリースプロセスでリリースされたコンポーネントの数。リリースの進行状況を見積もるには、この値を numberComponentsTotal 値で使用します。 |
| numberComponentsTotal | int | リリースのコンポーネントの合計数。リリースの進行状況を見積もるには、この値を numberComponentsDeployed 値で使用します。 |
| numberTestErrors | int | このリリース中にエラーを生成した Apex テストの数。 |
| numberTestsCompleted | int | このリリースで完了した Apex テストの数。リリースのテストの進行状況を見積もるには、この値を numberTestsTotal 値で使用します。 |
| numberTestsTotal | int | このリリースの Apex テストの合計数。リリースのテストの進行状況を見積もるには、この値を numberTestsCompleted 値で使用します。この項目の値は、リリースされるコンポーネントのテストが開始されるまで正確ではありません。 |
| runTestsEnabled | boolean |
Apex テストがこのリリースの一部として実行されたか (true)、否か (false) を示します。テストは、リリースの一部として自動的に実行されるか、deploy() コールの DeployOptions で実行するように設定できます。テストがいつ自動的に実行されるかについては、「リリースでのテストの実行」を参照してください。 この項目は、API バージョン 30.0 以降で使用できます。 |
| rollbackOnError | boolean | 省略可能。デフォルトは true です。エラーが発生した場合、ロールバックを完了するか (true)、否か (false) を示します。false の場合、エラーなしで実行できるアクションのセットはすべて実行され、残りのアクションではエラーが返されます。本番組織にリリースする場合は、このパラメーターは true に設定されている必要があります。 |
| startDate | dateTime | リリースプロセスの開始時期を示すタイムスタンプ。 |
| stateDetail | string | リリースされているコンポーネント、または実行している Apex テストクラスを示します。 |
| status | DeployStatus (string 型の列挙) |
リリースの現在の状況を示します。有効な値は、次のとおりです。
|
| success | boolean | リリースが正常に行われたか (true)、否か (false) を示します。 |
DeployDetails
deploy() コールで includeDetails パラメーターが true に設定されている場合、これらの項目では、DeployResult オブジェクトの details 項目の詳細情報を提供します。
| 名前 | 型 | 説明 |
|---|---|---|
| componentFailures | DeployMessage[] | 各コンポーネントのリリースエラーを含む 1 つ以上の DeployMessage オブジェクト。 |
| componentSuccesses | DeployMessage[] | 各コンポーネントの成功したリリースの詳細を含む 1 つ以上の DeployMessage オブジェクト。 |
| retrieveResult | RetrieveResult | deploy() コールに performRetrieve パラメーターが指定されていた場合、deploy() プロセスの完了直後に retrieve() コールが実行されます。この項目にはその取得の���果が含まれます。 |
| runTestResult | RunTestsResult | deploy() コールのテストが実行された場合、この項目にはテスト結果が含まれます。リリースが引き続き処理中である場合、この項目にはエラーデータのみが含まれます。リリースプロセスの完了後は、この項目にリリース全体のデータが入力されます。 |
| 名前 | 型 | 説明 |
|---|---|---|
| id | ID | リリースされるコンポーネントの ID。 |
| messages | DeployMessage[] | deploy() コールの成功または失敗の情報が含まれます。 |
| retrieveResult | RetrieveResult | deploy() コールに performRetrieve パラメーターが指定されていた場合、deploy() プロセスの完了直後に retrieve() コールが実行されます。この項目にはその取得の結果が含まれます。 |
| runTestResult | RunTestsResult | deploy() コールのテストが実行された場合、この項目にはテスト結果が含まれます。 |
| success | boolean | リリースが正常に行われたか (true)、否か (false) を示します。 |
DeployMessage
各 DeployResult オブジェクトには 1 つ以上の DeployMessage オブジェクトが含まれます。各 DeployMessage オブジェクトにはリリース .zip ファイルのコンポーネントのリリースの成功または失敗の情報が含まれます。
Spring '20 リリース以降は、認証済みユーザーのみが DeployMessage オブジェクトにアクセスできます。
| 名前 | 型 | 説明 |
|---|---|---|
| changed | boolean | true の場合、このリリースの結果としてコンポーネントが変更されました。false の場合、リリースされたコンポーネントは組織内にすでにある対応するコンポーネントと同じものです。 |
| columnNumber | int | テキストファイルで各コンポーネントが表されます。リリース中にエラーが発生した場合、この項目はエラーが発生したテキストファイルの列を表します。 |
| componentType | string |
このリリースでのコンポーネントのメタデータ型。 この項目は、API バージョン 30.0 以降で使用できます。 |
| created | boolean | true の場合、このリリースの結果としてコンポーネントが作成されました。false の場合、このリリースの結果としてコンポーネントが削除されたか、または変更されたかのいずれかです。 |
| createdDate | dateTime |
このリリースの結果としてコンポーネントが作成された日時。 この項目は、API バージョン 30.0 以降で使用できます。 |
| deleted | boolean | true の場合、このリリースの結果としてコンポーネントが削除されました。false の場合、このリリースの結果としてコンポーネントが新規作成されたか、または変更されたかのいずれかです。 |
| fileName | string | このコンポーネントのリリースに使用される .zip ファイル内のファイルの名前。 |
| fullName | string | コンポーネントの完全名です。 Metadata から継承されるこの項目は、このメタデータ型の WSDL で定義されます。作成時、更新時、または削除時に指定する必要があります。コールにおけるこの項目の例を確認するには、「createMetadata()」を参照してください。 |
| id | ID | リリースされるコンポーネントの ID。 |
| lineNumber | int | テキストファイルで各コンポーネントが表されます。リリース中にエラーが発生した場合、この項目はエラーが発生したテキストファイルの行番号を表します。 |
| problem | string | エラーまたは警告が発生した場合、この項目にはコンパイルの失敗を引き起こした問題の説明が含まれます。 |
| problemType | DeployProblemType (string 型の列挙) | 問題の種別を示します。問題の詳細は problem 項目で追跡されます。有効な値は、次のとおりです。
この項目は、API バージョン 18.0 以降で使用できます。バージョン 18.0 より前では、警告とエラーは区別されていませんでした。すべての問題はエラーとして処理され、リリースの成功を妨げていました。 |
| success | boolean | コンポーネントのリリースが正常に行われたか (true)、否か (false) を示します。 |
RunTestsResult
単体テストが正常に完了したかどうか、コードカバー率の結果、エラーなど、単体テストの実行に関する情報が含まれます。
RunTestsResult オブジェクトには、次のプロパティがあります。
| 名前 | 型 | 説明 |
|---|---|---|
| apexLogId | string |
テスト実行の終了時に作成される ApexLog オブジェクトの ID。ApexLog オブジェクトは、Apex テストを実行しているユーザーや、実行されているクラスまたはトリガーに有効な追跡フラグがある場合に作成されます。 この項目は、API バージョン 35.0 以降で使用できます。 |
| codeCoverage | CodeCoverageResult[] |
単体テストのコードカバー率の詳細を含む 1 つ以上の CodeCoverageResult オブジェクトの配列。 |
| codeCoverageWarnings | CodeCoverageWarning[] |
テストの実行について警告する 1 つ以上のコード範囲の配列。結果には、実行された行の合計数、実行されなかったコードの数、行、列の位置が含まれています。 |
| failures | RunTestFailure[] |
単体テストの失敗があれば、それについての情報を含む 1 つ以上の RunTestFailure オブジェクトの配列。 |
| flowCoverage | FlowCoverageResult[] | フローを実行したテスト実行の結果の配列。この項目は、API バージョン 44.0 以降で使用できます。 |
| flowCoverageWarnings | FlowCoverageWarning[] | フローを実行したテスト実行によって生成された警告の配列。この項目は、API バージョン 44.0 以降で使用できます。 |
| numFailures | int |
単体テストの失敗数。 |
| numTestsRun | int |
実行された単体テストの数。 |
| successes | RunTestSuccess[] |
成功についての情報があればその情報を含む 1 つ以上の RunTestSuccess オブジェクトの配列。 |
| totalTime | double |
テストの実行に費やした累積時間の合計 (ミリ秒単位)。パフォーマンスの監視に役立つ場合があります。 |
CodeCoverageResult
このオブジェクトを含む RunTestsResult オブジェクト。指定された Apex のコンパイルと単体テストの実行が正常に行われたかどうかの情報が含まれています。
| 名前 | 型 | 説明 |
|---|---|---|
| dmlInfo | CodeLocation[] |
このプロパティには、テストされた各クラスまたはトリガーについて、また、テストされたコードの各部分について、DML ステートメントの場所、コードが実行された回数、これらのコールに費やした累積時間の合計が含まれています。パフォーマンスの監視に役立つ場合があります。 |
| id | ID |
CodeLocation の ID。ID は組織内で一意です。 |
| locationsNotCovered | CodeLocation[] |
テストされた各クラスまたはトリガーについて、コードが一切カバーされていない場合、テストされていないコードの行および列、コードが実行された回数。 |
| methodInfo | CodeLocation[] |
テストされた各クラスまたはトリガーについて、メソッド呼び出しの場所、コードが実行された回数、これらのコールに費やした累積時間の合計。パフォーマンスの監視に役立つ場合があります。 |
| name | string |
カバーされているクラスまたはトリガーの名前。 |
| namespace | string |
指定されている場合、単体テストを含む名前空間。 |
| numLocations | int |
コードの場所の合計数。 |
| soqlInfo | CodeLocation[] |
テストされた各クラスまたはトリガーについて、コードの SOQL ステートメントの場所、コードが実行された回数、これらのコールに費やした累積時間の合計。パフォーマンスの監視に役立つ場合があります。 |
| type | string |
使用しません。以前のサポートされていないリリースでは、クラスまたはパッケージの指定に使用されていました。 |
CodeCoverageWarning
このオブジェクトを含む RunTestsResult オブジェクト。警告を生成した Apex クラスに関する情報が含まれています。
このオブジェクトには次のプロパティがあります。
| 名前 | 型 | 説明 |
|---|---|---|
| id | ID | CodeLocation の ID。ID は組織内で一意です。 |
| message | string |
生成された警告のメッセージ。 |
| name | string |
指定されている場合、単体テストを含む名前空間。 |
| namespace | string |
指定されている場合、単体テストを含む名前空間。 |
RunTestFailure
RunTestsResult オブジェクトは、単体テスト実行時の失敗に関する情報を返します。
このオブジェクトには次のプロパティがあります。
| 名前 | 型 | 説明 |
|---|---|---|
| id | ID |
失敗を生成したクラスの ID。 |
| message | string |
失敗のメッセージ。 |
| methodName | string |
失敗したメソッドの名前。 |
| name | string |
失敗したクラスの名前。 |
| namespace | string |
指定されている場合、クラスを含む名前空間。 |
| seeAllData | boolean | テストメソッドに組織データへのアクセス権があるか (true)、否か (false) を示します。 この項目は、API バージョン 33.0 以降で使用できます。 |
| stackTrace | string |
失敗についてのスタック追跡。 |
| time | double |
失敗した処理についてテストの実行に費やした時間 (ミリ秒単位)。パフォーマンスの監視に役立つ場合があります。 |
| type | string |
使用しません。以前のサポートされていないリリースでは、クラスまたはパッケージの指定に使用されていました。 |
FlowCoverageResult
このオブジェクトには、テスト実行で実行されたフローバージョンと要素数に関する情報が含まれます。このオブジェクトは API バージョン 44.0 以降で使用できます。
RunTestSuccess
RunTestsResult オブジェクトは、単体テスト実行時の成功に関する情報を返します。
このオブジェクトには次のプロパティがあります。
| 名前 | 型 | 説明 |
|---|---|---|
| id | ID |
成功を生成したクラスの ID。 |
| methodName | string |
成功したメソッドの名前。 |
| name | string |
成功したクラスの名前。 |
| namespace | string |
指定されている場合、単体テストを含む名前空間。 |
| seeAllData | boolean | テストメソッドに組織データへのアクセス権があるか (true)、否か (false) を示します。 この項目は、API バージョン 33.0 以降で使用できます。 |
| time | double |
この操作についてテストの実行に費やした時間。パフォーマンスの監視に役立つ場合があります。 |
CodeLocation
RunTestsResult オブジェクトは、多数の項目にこのオブジェクトを含みます。
このオブジェクトには次のプロパティがあります。
| 名前 | 型 | 説明 |
|---|---|---|
| column | int |
テストされた Apex の列の場所。 |
| line | int |
テストされた Apex の行の場所。 |
| numExecutions | int |
テスト実行時に Apex が実行された回数。 |
| time | double |
この場所で費やした累積時間の合計。パフォーマンスの監視に役立つ場合があります。 |