SOAP API 開発者ガイド
j基本となる API コール
次の表は、API がサポートしているコールをアルファベット順に表示し、それぞれの簡単な説明を示しています。コール名をクリックすると、構文、使用方法、各コールの詳細情報を確認できます。
| コール | 説明 |
|---|---|
| convertLead() | Lead を Account、Contact または必要に応じて Opportunity に変換します。 |
| create() | 組織のデータに 1 つ以上の個別オブジェクトを追加します。 |
| delete() |
組織のデータから 1 つ以上の個別オブジェクトを削除します。 |
| deleteByExample() |
削除��象を指定するテンプレートとして sObject を使用して組織のデータからオブジェクトを削除します。sObject テンプレートと一致する Big Object 内のすべてのデータが削除されます。 |
| emptyRecycleBin() |
ごみ箱からレコードを直ちに削除します。 |
| executeListView() | リストビューの SOQL クエリを実行して、リストビューからデータ、表示ラベル、およびアクションを取得します。 |
| findDuplicates() | ルールに基づいて、重複レコードの検索を実行します。入力は sObject の配列で、それぞれが検索する値と重複ルールを示すオブジェクトの種別を指定します。重複ルールを示すオブジェクトごとに、検出された重複が出力で識別されます。findDuplicates() はルールを値に適用し、検索を実行します。sObject ごとに、検出された重複が出力で識別されます。 |
| findDuplicatesByIds() | ルールに基づいて、重複レコードの検索を実行します。入力は ID の配列で、各要素は重複を検索するレコードを指定します。重複ルールを示すオブジェクトごとに、検出された重複が出力で識別されます。findDuplicatesByIds() はルールをレコード ID に適用し、検索を実行します。ID ごとに、検出された重複が出力で識別されます。 |
| getDeleted() | 指定された時間以降削除された、指定されたオブジェクトの個別オブジェクトの ID を取得します。ID についての詳細は、「ID データ型」を参照してください。 |
| getUpdated() | 指定された時間以降更新された、指定されたオブジェクトの個別オブジェクトの ID を取得します。ID についての詳細は、「ID データ型」を参照してください。 |
| invalidateSessions() |
sessionId で指定された 1 つ以上のセッションを終了します。 |
| login() | ログインサーバにログインし、クライアントセッションを開始します。 |
| logout() |
ログインユーザのセッションを終了します。 |
| merge() |
同じオブジェクト種別のレコードをマージします。 |
| performQuickActions() | 種別が create または update のクイックアクションを実行します。 |
| process() | 承認のために承認プロセスインスタンスの配列を送信します。または、承認、却下、削除される承認プロセスインスタンスの配列を処理します。 |
| query() | 指定のオブジェクトに対してクエリを実行して、指定の条件に一致したデータを返します。 |
| queryAll() | query() と同様ですが、削除されたアイテムとアーカイブされたアイテムを含みます。 |
| queryMore() | クエリから次のオブジェクトのバッチを取得します。 |
| retrieve() | 指定したオブジェクト ID に基づいて 1 つ以上のオブジェクトを取得します。 |
| search() | 組織のデータをテキスト検索します。 |
| undelete() | queryAll() で指定されたレコードを復元します。 |
| update() | 組織のデータ内にある 1 つ以上の既存オブジェクトを更新します。 |
| upsert() | 新しいオブジェクトを作成するか、既存のオブジェクトを更新します。既存オブジェクトの存在を確認するために、カスタムオブジェクトの一致を確認します。 |
サンプル
このセクションのサンプルは、Enterprise WSDL ファイルに基づいてます。これらのサンプルでは、WSDL ファイルがインポート済みであり、接続が作成済みであることを前提としています。これを実行する方法の詳細については、「クイックスタート」のチュートリアルを参照してください。