管理パッケージによる Enterprise WSDL の生成
| 使用可能なインターフェース: Salesforce Classic |
| 使用可能なエディション: Enterprise Edition、Performance Edition、Unlimited Edition、および Developer Edition |
| 必要なユーザ権限 | |
|---|---|
| WSDL をダウンロードする | 「アプリケーションのカスタマイズ」 |
Enterprise WSDL をダウンロードし、管理パッケージを組織にインストールする場合、生成された WSDL に追加するインストールパッケージのバージョンを選択するという、追加のステップを実行する必要があります。Enterprise WSDL は非常に強い型付けであるため、コールは int や string など特定のデータ型のオブジェクトや項目を含みます。
パッケージバージョンは、パッケージでアップロードされる一連のコンポーネントを特定する番号です。バージョン番号の形式は majorNumber.minorNumber.patchNumber (例: 2.1.3) です。メジャー番号とマイナー番号は、メジャーリリース時に選択した値に増えます。patchNumber は、パッチリリースにのみ生成および更新されます。公開者は、パッケージバージョンを使用して、パッケージを使用する既存の連携に影響を与えることなく後続のパッケージバージョンをリリースすることにより、管理パッケージのコンポーネントを発展させることができます。後続バージョンのパッケージをインストールしても API クライアントが引き続き特定の、かつ既知の動作ができるように、登録ユーザはインストールする管理パッケージのパッケージバージョンを選択できます。各パッケージバージョンでは、オブジェクトや項目の構成にバリエーションがあるため、強い型付けをされた WSDL を生成する場合、特定のバージョンを選択する必要があります。
- [設定] から、[クイック検索] ボックスに「API」と入力し、[API] を選択します。
- [Enterprise WSDL の生成] をクリックします。
- インストールした管理パッケージの [パッケージバージョン] を選択します。選択するパッケージバージョンがわからない場合、デフォルトの選択内容 (最新パッケージバージョン) に従います。
- [作成] をクリックします。
- ブラウザの [ファイル] メニューを選択し、WSDL をコンピュータに保存します。
- コンピュータで、WSDL ドキュメントのローカルコピーを開発環境にインポートします。
- それぞれの管理パッケージバージョンの選択内容は、WSDL の最上部にあるコ��ントに記載されています。
- 生成された WSDL には、選択されたバージョンのインストールパッケージで使用できるものなど、組織内のオブジェクトや項目が含まれています。項目またはオブジェクトが今後のパッケージバージョンに追加される場合、API インテグレーションのオブジェクトまたは項目と連動するよう、そのパッケージバージョンで Enterprise WSDL を生成する必要があります。
- WSDL の末尾の SOAP エンドポイントには、serverName/services/Soap/c/api_version/ID という形式の URL が指定されています。api_version は、 など API のバージョンを示し、ID は、Salesforce との通信時のパッケージバージョンの選択内容を符号化したものです。
[設定] の API ページから WSDL をダウンロードせずに、Enterprise WSDL のデフォルトのパッケージバージョンを選択することもできます。パッケージバージョンが API コールで指定されていない場合、API コールのデフォルトのパッケージバージョンによって代替システム設定が指定されます。多くの API クライアントにはパッケージのバージョン情報がないため、デフォルトの設定がこれらのクライアントの既存の動作を保持します。