メタデータ API 開発者ガイド
jRetrieveResult
retrieve() コールは、RetrieveResult オブジェクトの配列を返します。
RetrieveResult オブジェクトには、次の項目があります。
| 名前 | 型 | 説明 |
|---|---|---|
| done | boolean | 必須。retrieve() コールが完了したか (true)、否か (false) を示します。この項目は、API バージョン 31.0 以降で利用できます。 |
| errorMessage | string | retrieve() コール中にエラーが発生した場合、この項目にはこのエラーを説明するメッセージが含まれます。この項目は、API バージョン 31.0 以降で利用できます。 |
| errorStatusCode | StatusCode |
retrieve() コール中にエラーが発生した場合、この項目にはこのエラーの状況コードが含まれます。この項目は、API バージョン 31.0 以降で利用できます。 各 StatusCode の値の説明については、『SOAP API 開発者ガイド』の「StatusCode」を参照してください。 |
| fileProperties | FileProperties[] | .zip ファイルの各コンポーネントのプロパティとマニフェストファイル package.xml に関する情報が含まれます。コンポーネントごとに 1 つのオブジェクトが返されます。 |
| id | ID | 取得されるコンポーネントの ID。 |
| messages | RetrieveMessage[] | retrieve() コールの成功または失敗に関する情報が含まれます。 |
| status | RetrieveStatus (string 型の列挙) |
retrieve() コールの状況。有効な値は、次のとおりです。
|
| success | boolean | retrieve() コールが正常に終了したか (true)、否か (false) を示します。この項目は、API バージョン 31.0 以降で利用できます。 |
| zipFile | base64Binary | retrieve 要求で返された zip ファイル。Base 64 で符号化されたバイナリデータ。API コールを行う前に、クライアントアプリケーションはバイナリ添付データを base64 に符号化する必要があります。応答を受信したら、クライアントアプリケーションは、base64 データをバイナリに復号化する必要があります。この変換は、SOAP クライアントによって処理されます。 |
FileProperties
このコンポーネントには、.zip ファイルの各コンポーネントのプロパティとマニフェストファイル package.xml に関する情報が含まれます。コンポーネントごとに 1 つのオブジェクトが返されます。このコンポーネントには、.zip ファイル内の関連付けられたメタデータファイルに関する情報は含まれず、コンポーネントファイルとマニフェストファイルに関する情報のみが含まれます。FileProperties には次のプロパティが含まれます。
| 名前 | 型 | 説明 |
|---|---|---|
| createdById | string | 必須。ファイルを作成したユーザーの ID。 |
| createdByName | string | 必須。ファイルを作成したユーザーの名前。 |
| createdDate | dateTime | 必須。ファイルが作成された日時。 |
| fileName | string | 必須。ファイルの名前。 |
| fullName | string | 必須。API アクセスの一意の識別子として使用される、ファイルの開発者名。値は fileName に基づいていますが、許容される文字はより制限されます。fullName には、アンダースコアと英数字のみを使用できます。一意であること、最初は文字であること、空白は使用しない、最後にアンダースコアを使用しない、2 つ続けてアンダースコアを使用しないという制約があります。 |
| id | string | 必須。ファイルの ID。 |
| lastModifiedById | string | 必須。ファイルを最後に更新したユーザーの ID。 |
| lastModifiedByName | string | 必須。ファイルを最後に更新したユーザーの名前。 |
| lastModifiedDate | dateTime | 必須。ファイルが最後に更新された日時。 |
| manageableState | ManageableState (string 型の列挙) | 指定されたコンポーネントがパッケージに含まれている場合、そのコンポーネントの管理可能な状態を示します。 |
| namespacePrefix | string | コンポーネントの名前空間プレフィックス (ある場合)。 |
| type | string | 必須。CustomObject、CustomField、または ApexClass などのメタデータ型。 |
RetrieveMessage
RetrieveResult はこのオブジェクトを返します。このオブジェクトには、retrieve() コールの成功または失敗に関する情報が含まれます。問題ごとに 1 つのオブジェクトが返されます。