REST API 開発者ガイド
jリファレンス
次の表に、API でサポートされている REST リソースをリストし、それぞれのリソースについて簡単に説明します。それぞれの場合で、リソースの URI は、認証サービスから取得するベース URI (http://domain/services/data) に続きます。domain は、[私のドメイン] のログイン URL、または Salesforce 組織のインスタンス化された URL です。たとえば、バージョン 52.0 の Account オブジェクトに関する基本情報を取得する場合、https://MyDomainName.my.salesforce.com/services/data/v52.0/sobjects/Account/ または https://yourInstance.my.salesforce.com/services/data/52.0/sobjects/Account/ となります。
コール名をクリックすると、構文、使用方法、各コールの詳細情報を確認できます。
| リソース名 | URI および説明 |
|---|---|
| Versions |
/ バージョン、表示ラベル、および各バージョンのルートへのリンクなど、現在使用可能な各 Salesforce バージョンの概要情報をリストします。 |
| Resources by Version |
/vXX.X/ リソース名および URI を含む、指定された API バージョンで使用可能なリソースをリストします。 |
| Limits |
/vXX.X/limits/ 組織内の制限に関する情報をリストします。このリソースでは、各制限の最大割り当てと使用量に基づく残りの割り当てが返されます。 |
| Describe Global |
/vXX.X/sobjects/ 組織のデータで使用可能なオブジェクトとそのメタデータをリストします。 |
| sObject Basic Information |
/vXX.X/sobjects/sObject/ 指定されたオブジェクトの個別のメタデータを説明します。特定のオブジェクトの新規レコードの作成にも使用できます。 |
| sObject Describe |
/vXX.X/sobjects/sObject/describe/ 指定されたオブジェクトのすべてのレベルで、個別のメタデータを完全に説明します。 |
| sObject Get Deleted |
/vXX.X/sobjects/sObject/deleted/?start=startDateAndTime&end=endDateAndTime 指定されたオブジェクトについて、特定の期間内に削除された個々のレコードのリストを取得します。 |
| sObject Get Updated |
/vXX.X/sobjects/sObject/updated/?start=startDateAndTime&end=endDateAndTime 指定されたオブジェクトに対して指定された期間内に更新された (追加または変更された) 個別のレコードのリストを取得します。 |
| sObject Named Layouts |
/vXX.X/sobjects/sObject/describe/namedLayouts/layoutName 特定のオブジェクトの代替名前付きレイアウトに関する情報を取得します。 |
| sObject Rich Text Image Retrieve |
/vXX.X/sobjects/sObject/id/richTextImageFields/fieldName/contentReferenceId 特定のレコードの特定のリッチテキストエリア項目から、指定された画像データを取得します。 |
| sObject Rows |
/vXX.X/sobjects/sObject/id/ 指定されたオブジェクト ID に基づいてレコードにアクセスします。レコードを取得、更新、または削除します。このリソースは、項目値の取得にも使用できます。 |
| sObject Rows by External ID |
/vXX.X/sobjects/sObject/fieldName/fieldValue 指定された外部 ID 項目の値に基づいて、新しいレコードを作成するか、既存のレコードを更新 (レコードを Upsert) します。PATCH を使用して外部 ID を使用して更新/挿入します。更新/挿入では、外部 ID の値を使用して、新規レコードを作成するか、既存レコードを更新するかを判別します。 |
| sObject ApprovalLayouts |
/services/data/vXX.X/sobjects/sObject/describe/approvalLayouts/ 指定されたオブジェクトの承認レイアウトのリストを返します。 |
| sObject CompactLayouts |
/services/data/vXX.X/sobjects/sObject/describe/compactLayouts/ 特定のオブジェクトのコンパクトレイアウトのリストを返します。 |
| Describe Layouts |
/vXX.X/sobjects/global/describe/layouts/ /vXX.X/sobjects/sObject/describe/layouts/ レイアウトおよび説明のリストを返します。 |
| sObject PlatformAction |
/vXX.X/sobjects/PlatformAction PlatformAction は、参照のみの仮想オブジェクトです。ユーザ、コンテキスト、デバイス形式、レコード ID に応じて、UI に表示するアクションを照会できるようにします。たとえば、標準およびカスタムボタン、クイックアクション、生産性アクションなどを照会できます。 |
| Lightning Toggle Metrics |
/vXX.X/sobjects/LightningToggleMetrics Salesforce Classic から Lightning Experience に切り替えたユーザに関する詳細を返します。 |
| Lightning Usage by App Type |
/vXX.X/sobjects/LightningUsageByAppTypeMetrics Lightning Experience ユーザと Salesforce モバイルユーザの合計数を返します。 |
| Lightning Usage by Browser |
/vXX.X/sobjects/LightningUsageByBrowserMetrics ブラウザインスタンスによってグループ化された Lightning Experience 利用状況の結果を返します。 |
| Lightning Usage by Page |
/vXX.X/sobjects/LightningUsageByPageMetrics Lightning Experience でユーザが最も頻繁に表示した標準ページを示します。 |
| Lightning Usage by FlexiPage |
/vXX.X/sobjects/LightningUsageByFlexiPageMetrics Lightning Experience で最も頻繁に表示されたカスタムページに関する詳細を返します。 |
| Lightning Exit by Page Metrics |
/vXX.X/sobjects/LightningUsageByFlexiPageMetrics ユーザが Lightning Experience から Salesforce Classic に切り替える標準ページに関する頻度の総計値を返します。 |
| sObject Relationships |
/vXX.X/sobjects/sObject/id/relationshipName 使い慣れた URL を介してオブジェクトリレーションをトラバースし、レコードにアクセスします。トラバースされたリレーション項目に関連付けられたレコードを取得、更新、または削除できます。複数の関連レコードがある場合、関連付けられたレコードの完全なセットを取得できます。 |
| sObject Blob Retrieve |
/vXX.X/sobjects/sObject/id/blobField 個別のレコードから指定された blob 項目を取得します。 |
| sObject Quick Actions |
/vXX.X/sobjects/sObject/quickActions/ /vXX.X/sobjects/sObject/quickActions/actionName /vXX.X/sobjects/sObject/quickActions/actionName/describe/ /vXX.X/sobjects/sObject/quickActions/actionName/defaultValues/ /vXX.X/sobjects/sObject/quickActions/actionName/defaultValues/parentId アクションとその詳細のリストを返します。 |
| sObject Suggested Articles |
/services/data/vXX.X/sobjects/sObject/suggestedArticles?language=articleLanguage&subject=subject&description=description /services/data/vXX.X/sobjects/sObject/ID/suggestedArticles?language=articleLanguage ケース、作業指示、または作業指示品目について提案する Salesforce ナレッジの記事のリストを返します。 |
| sObject User Password |
/vXX.X/sobjects/User/userId/password /vXX.X/sobjects/SelfServiceUser/selfServiceUserId/password ユーザパスワードを設定またはリセットしたり、ユーザパスワードに関する情報を取得したりします。 |
| Platform Event Schema by Event Name |
/services/data/vXX.X/sobjects/eventName/eventSchema イベント名のプラットフォームイベントの定義を JSON 形式で取得します。 |
| Platform Event Schema by Schema ID |
/services/data/vXX.X/event/eventSchema/schemaId スキーマ名のプラットフォームイベントの定義を JSON 形式で取得します。 |
| AppMenu |
/services/data/vXX.X/appMenu/AppSwitcher/ /services/data/vXX.X/appMenu/Salesforce1/ Salesforce アプリケーションドロップダウンメニューまたは Salesforce for Android、Salesforce for iOS、Salesforce モバイル Web に表示されるナビゲーションメニューの項目のリストを返します。 |
| Compact Layouts |
/vXX.X/compactLayouts?q=objectList 複数のオブジェクトの Compact Layouts のリストを返します。 |
| Invocable Actions |
/services/data/vXX.X/actions/standard /services/data/vXX.X/actions/custom アクションを使用してアプリケーションに機能を追加します。Chatter への投稿やメールの送信などの標準アクションから選択するか、会社のニーズに基づいてアクションを作成します。 |
| Parameterized Search |
/services/data/vXX.X/parameterizedSearch/?q=searchString SOSL 句の代わりにパラメータを使用して簡単な RESTful 検索を実行します。GET メソッドの URL でパラメータを示します。または、より複雑な JSON 検索の場合は POST を使用します。 |
| Process Approvals |
/services/data/vXX.X/process/approvals/ すべての承認プロセスのリストを返します。特定のレコードが承認プロセスをサポートしていて、承認プロセスがすでに定義されている場合、そのレコードを送信するためにも使用できます。現在のユーザが割り当てられた承認者である場合、レコードを承認および却下できます。 |
| Process Rules |
/services/data/vXX.X/process/rules/ すべての有効なワークフロールールのリストを返します。ルールにアクションがある場合、アクションがルールの下にリストされます。指定したレコードに関連付けられたワークフロールールすべてをトリガするためにも使用できます。ルールのアクションは、ルール条件に一致した場合にのみ起動します。 |
| Query |
/vXX.X/query/?q=soql この API リソースでは、指定された SOQL クエリが実行されます。 |
| QueryAll |
/vXX.X/queryAll/?q=soql 指定された SOQL クエリを実行します。結果には削除されたレコード、マージされたレコード、およびアーカイブ済みレコードが含まれる場合があります。 |
| Quick Actions |
/vXX.X/quickActions/ グローバルクイックアクションとその種別のリスト、および Chatter フィードに表示されるカスタム項目とオブジェクトを返します。 |
| Recently Viewed Items |
/vXX.X/recent 現在のユーザが表示または参照した、最近参照された項目を取得します。 |
| Record Count |
/vXX.X/limits/recordCount 組織内のオブジェクトレコード件数に関する情報をリストします。 |
| Relevant Items | 現在のユーザに最も関連性の高い項目を取得します。関連性の高い項目には、ユーザのグローバル検索範囲のオブジェクトや、最後に使用した (MRU) オブジェクトのレコードなどがあります。 |
| Salesforce Surveys Translation Resources |
/vXX.X/localizedvalue/ REST API を使用して、アンケート項目を翻訳し、翻訳されたアンケート項目を表示、更新、または削除します。アンケート項目の翻訳された値は、フロー項目に保存されます。 |
| Search |
/vXX.X/search/?q=sosl 指定された SOSL 検索を実行します。検索文字列は URL 符号化されている必要があります。 |
| Search Scope and Order |
/vXX.X/search/scopeOrder ログインユーザのデフォルトのグローバル検索範囲内にあるオブジェクトの順序付きリストを返します。グローバル検索は、操作するオブジェクトとそれらを操作する頻度を追跡し、それに基づいて検索結果を編成します。最もよく使用されるオブジェクトは、リストの最上部に表示されます。 |
| Search Result Layouts |
/vXX.X/searchlayout/?q=commaDelimitedObjectList クエリ文字列に含まれるオブジェクトの検索結果レイアウトに関する情報を返します。このコールでは、検索結果ページに列として表示される項目のリスト、最初のページに表示される行数、および検索結果ページで使用される表示ラベルがオブジェクトごとに返されます。 |
| Search Suggested Article Title Matches |
/services/data/vXX.X/search/suggestTitleMatches?q=searchString&language=articleLanguage&publishStatus=articlePublicationStatus ユーザの検索クエリ文字列に一致する Salesforce ナレッジ記事タイトルのリストを返します。ユーザが検索を実行する前に、関連する可能性のある記事に直接移動するためのショートカットを提供します。 |
| Search Suggested Queries |
/services/data/vXX.X/search/suggestSearchQueries?q=searchString&language=languageOfQuery 他のユーザが Salesforce ナレッジで実行した検索に一致するユーザのクエリ文字列テキストに基づいて、提案する検索のリストを返します。ユーザが検索を実行する前に、検索の有効性を高める手段を提供します。 |
| Tabs |
/vXX.X/tabs ユーザが [すべてのタブ] ([+]) タブカスタマイズ機能を使用してタブを非表示にしているかどうかに関係なく、ログインユーザが使用できるすべてのタブ (Lightning ページタブを含む) のリストを返します。 |
| Themes |
/vXX.X/theme Salesforce アプリケーションのテーマで使用するアイコンと色のリストを取得します。 |
複合リソース
| リソース名 | URI |
|---|---|
| Composite |
/vXX.X/composite 一連の REST API 要求を単一のコールで実行します。1 つの要求の出力を、後続の要求の入力として使用できます。要求のレスポンスボディと HTTP 状況は、1 つのレスポンスボディで返されます。一連の要求全体が API の制限に単一のコールとして計上されます。 |
| Batch |
/vXX.X/composite/batch 1 回の要求で最大 25 個のサブ要求を実行します。 |
| sObject Tree |
/vXX.X/composite/tree 指定されたタイプのルートレコードを持つ 1 つ以上の sObject ツリーを作成します。sObject ツリーは、同じルートレコードを持つネストされた親-子レコードのコレクションです。 |
| sObject Collections |
使用する URI は操作によって異なります。
|