REST API 開発者ガイド
jリファレンス
それぞれの場合で、リソースの URI は、ベース URI (https://MyDomainName.my.salesforce.com) に続きます。
たとえば、バージョン 60.0 の Account オブジェクトに関する基本情報を取得する場合、https://MyDomainName.my.salesforce.com/services/data/v60.0/sobjects/Account を使用します。
sObject リソースでアクセスする標準オブジェクトとカスタムオブジェクトについての詳細は、『Salesforce プラットフォームのオブジェクトリファレンス』を参照してください。
これらのリソースの一部は、対応するパッケージがインストールされているか、対応する機能が有効になっている場合にのみ使用できます。
| リソース名 | URI および説明 |
|---|---|
| Versions |
/services/data バージョン、表示ラベル、および各バージョンのルートへのリンクなど、現在使用可能な各 Salesforce バージョンの概要情報をリストします。 |
| Resources by Version |
/services/data/vXX.X リソース名および URI を含む、指定された API バージョンで使用可能なリソースをリストします。 |
| Invocable Actions |
/services/data/vXX.X/actions/standard /services/data/vXX.X/actions/custom アクションを使用してアプリケーションに機能を追加します。Chatter への投稿やメールの送信などの標準アクションから選択するか、会社のニーズに基づいてアクションを作成します。 |
| Analytics (Reports および Dashboards REST API にアクセス) |
/services/data/vXX.X/analytics Reports および Dashboards REST API リソースにアクセスします。『Salesforce Reports and Dashboards REST API Developer Guide (Salesforce Reports および Dashboards REST API 開発者ガイド)』を参照してください。 |
| Get AppMenu Types |
/services/data/vXX.X/appMenu/ Salesforce アプリケーションのドロップダウンメニューのアプリケーションメニュー種別にアクセスします。 |
| AppMenu Items |
/services/data/vXX.X/appMenu/AppSwitcher アプリケーションメニュー項目には、Salesforce アプリケーションのドロップダウンメニューからアクセスします。 |
| AppMenu Mobile Items |
/services/data/vXX.X/appMenu/Salesforce1/ アプリケーションメニュー項目に、Android および iOS の Salesforce モバイルアプリケーションおよびモバイル Web のナビゲーショ��メニューからアクセスします。 |
| Asset Management |
/services/data/vXX.X/asset-management Makes により、ライフサイクル管理される納入商品のデータを営業担当や取引先担当が Lightning Experience で表示できるようにします。『Connect REST API 開発者ガイド』の「顧客の納入商品ライフサイクル管理」を参照してください。 |
| Async Queries |
/services/data/vXX.X/async-queries 非同期で処理する SOQL クエリを送信します。次を参照してください。
|
| Chatter (Connect REST API) |
/services/data/vXX.X/chatter Connect REST API で機能にアクセスします。『Connect REST API 開発者ガイド』を参照してください。 |
| Commerce (注文実行 REST API) |
/services/data/vXX.X/commerce 注文実行 REST API で機能にアクセスします。『Place Order REST API Developer Guide (注文実行 REST API 開発者ガイド)』を参照してください。 |
| Compact Layouts |
/services/data/vXX.X/compactLayouts?q=objectList 複数のオブジェクトの Compact Layouts のリストを返します。 |
| Composite |
/services/data/vXX.X/composite 一連の REST API 要求を 1 回の POST 要求で実行するか、他の複合リソースのリストを GET 要求で取得します。 |
| Composite Batch |
/services/data/vXX.X/composite/batch 1 回の要求で最大 25 個のサブ要求を実行します。 |
| Using Composite Graphs |
/services/data/vXX.X/composite/graph 拡張された方法で Composite 要求を実行できます。 |
| sObject Tree |
/services/data/vXX.X/composite/tree 指定されたタイプのルートレコードを持つ 1 つ以上の sObject ツリーを作成します。sObject ツリーは、同じルートレコードを持つネストされた親-子レコードのコレクションです。 |
| sObject Collections |
/services/data/vXX.X/composite/sobjects 1 つの要求で複数のレコードに対してアクションを実行します。 |
| Connect REST API |
/services/data/vXX.X/connect Connect REST API で機能にアクセスします。『Connect REST API 開発者ガイド』を参照してください。 |
| Financial Services |
/services/data/vXX.X/connect/financialservices Financial Services オブジェクトにアクセスします。『Financial Services Cloud 開発者ガイド』を参照してください。 |
| Health Cloud |
/services/data/vXX.X/connect/health/care-services Health Cloud オブジェクトにアクセスします。『Health Cloud Developer Guide (Health Cloud 開発者ガイド)』を参照してください。 |
| Manufacturing |
/services/data/vXX.X/connect/manufacturing Manufacturing Cloud オブジェクトにアクセスします。『Manufacturing Cloud Developer Guide (Manufacturing Cloud 開発者ガイド)』を参照してください。 |
| Consumer Goods |
/services/data/vXX.X/connect/object-detection /services/data/vXX.X/connect/visit/recommendations Consumer Goods ビジネス API にアクセスします。『Consumer Goods Cloud 開発者ガイド』を参照してください。 |
| Consent |
/services/data/vXX.X/consent ユーザーの同意設定を追跡します。 |
| Contact Tracing |
/services/data/vXX.X/contact-tracing 健全性コンタクトを追跡します。『Emergency Response Management for Public Health Developer Guide (公衆衛生向け緊急時対応管理システム開発者ガイド)』を参照してください。 |
| Dedupe |
/services/data/vXX.X/dedupe 重複リソース、ジョブ定義、およびジョブをリストします。『Connect REST API 開発者ガイド』を参照してください。 |
| Domino |
/services/data/vXX.X/domino 組織内でのみ使用します。 |
| Eclair (geodata) |
/services/data/vXX.X/eclair geodata の定義にアクセスします。『Analytics REST API 開発者ガイド』の「Charts Geodata リソース」を参照してください。 |
| Email Connect |
/services/data/vXX.X/emailConnect 組織内でのみ使用します。 |
| Platform Event Schema by Schema ID |
/services/data/vXX.X/event/eventSchema/schemaId スキーマ名のプラットフォームイベントの定義を JSON 形式で取得します。このリソースは REST API バージョン 40.0 以降で使用できます。 |
| Folders |
/services/data/vXX.X/folders Analytics Folders API を使用して、レポートフォルダーとダッシュボードフォルダーを操作します。『Reports and Dashboards REST API Developer Guide (Reports および Dashboards REST API 開発者ガイド)』の「Folders (フォルダー)」を参照してください。 |
| Jobs (Bulk API 2.0) |
/services/data/vXX.X/jobs Bulk API 2.0 でジョブにアクセスします。『Bulk API 2.0 および Bulk API 開発者ガイド』を参照してください。 |
| jsonxform (Analytics REST API) |
/services/data/vXX.X/jsonxform Tableau テンプレートのルールの結果をテストします。『Analytics テンプレート開発者ガイド』の「Rules Testing with jsonxform/transformation endpoint (jsonxform/transformation エンドポイントでテストするルール)」を参照してください。 |
| Knowledge Management |
/services/data/vXX.X/knowledgeManagement Salesforce ナレッジ機能にアクセスします。『ナレッジ開発者ガイド』を参照してください。 |
| Licensing |
/services/data/vXX.X/licensing 組織内でのみ使用します。 |
| Limits |
/services/data/vXX.X/limits 組織内の制限に関する情報をリストします。このリソースでは、各制限の最大割り当てと使用量に基づく残りの割り当てが返されます。 |
| Record Count |
/services/data/vXX.X/limits/recordCount 組織内のオブジェクトレコード件数に関する情報をリストします。 |
| Salesforce Surveys Translation Resources |
/services/data/vXX.X/localizedvalue REST API を使用して、アンケート項目を翻訳し、翻訳されたアンケート項目を表示、更新、または削除します。アンケート項目の翻訳された値は、フロー項目に保存されます。 |
| Metadata |
/services/data/vXX.X/metadata Metadata API で機能にアクセスします。『メタデータ API 開発者ガイド』を参照してください。 |
| Parameterized Search |
/services/data/vXX.X/parameterizedSearch/?q=searchString SOSL 句の代わりにパラメーターを使用して簡単な REST 検索を実行します。GET メソッドで URI にパラメーターを指定します。または POST メソッドを使用してリクエストボディに複雑な検索を作成します。 |
| Payments |
/services/data/vXX.X/payments 組織内でのみ使用します。 |
| Process Approvals |
/services/data/vXX.X/process/approvals すべての承認プロセスにアクセスします。特定のレコードが承認プロセスをサポートしていて、承認プロセスがすでに定義されている場合、そのレコードを送信するためにも使用できます。現在のユーザーが割り当てられた承認者である場合、レコードを承認および却下できます。 |
| Process Rules |
/services/data/vXX.X/process/rules すべての有効なワークフロールールのリストにアクセスします。レコードまたは項目を取得するには、GET メソッドを使用します。HTTP ヘッダーの情報を取得するには、HEAD メソッドを使用します。すべての有効なワークフロールールをトリガーするには、POST メソッドを使用します。 |
|
Query (SOQL) |
/services/data/vXX.X/query/?q=soql 指定された SOQL クエリを実行します。 |
|
QueryAll (SOQL) |
/services/data/vXX.X/queryAll/?q=soql 指定された SOQL クエリを実行します。結果には削除されたレコード、マージされたレコード、およびアーカイブ済みレコードが含まれる場合があります。 |
| Quick Actions |
/services/data/vXX.X/quickActions グローバルクイックアクションとその種別のリスト、および Chatter フィードに表示されるカスタム項目とオブジェクトを返します。 |
| Recently Viewed Items |
/services/data/vXX.X/recent 現在のユーザーが表示または参照した、最近参照された項目を取得します。 |
| Salesforce Scheduler Resources |
/services/data/vXX.X/scheduling/ Scheduler REST API にアクセスし、作業種別グループおよびサービステリトリーに基づいて、予定の時間枠または利用可能なサービスリソースを取得します。 |
|
Search (SOSL) |
/services/data/vXX.X/search/?q=sosl 指定された SOSL 検索を実行します。検索文字列は URL 符号化されている必要があります。 |
| Search Scope and Order |
/services/data/vXX.X/search/scopeOrder ログインユーザーのデフォルトのグローバル検索範囲内にあるオブジェクトの順序付きリストを返します。グローバル検索は、操作するオブジェクトとそれらを操作する頻度を追跡し、それに基づいて検索結果を編成します。最もよく使用されるオブジェクトは、リストの最上部に表示されます。 |
| Search Suggested Queries |
/services/data/vXX.X/search/suggestSearchQueries?q=searchString&language=languageOfQuery 他のユーザーが Salesforce ナレッジで実行した検索に一致するユーザーのクエリ文字列テキストに基づいて、提案する検索のリストを返します。ユーザーが検索を実行する前に、検索の有効性を高める手段を提供します。このリソースは REST API バージョン 30.0 以降で使用できます。 |
| Search Suggested Article Title Matches |
/services/data/vXX.X/search/suggestTitleMatches?q=searchString&language=articleLanguage&publishStatus=articlePublicationStatus ユーザーの検索クエリ文字列に一致する Salesforce ナレッジ記事タイトルのリストを返します。ユーザーが検索を実行する前に、関連する可能性のある記事に直接移動するためのショートカットを提供します。 |
| Search Result Layouts |
/services/data/vXX.X/searchlayout/?q=commaDelimitedObjectList クエリ文字列に含まれるオブジェクトの検索結果レイアウトに関する情報を返します。このコールでは、検索結果ページに列として表示される項目のリスト、最初のページに表示される行数、および検索結果ページで使用される表示ラベルがオブジェクトごとに返されます。 |
| Service Templates |
/services/data/vXX.X/serviceTemplates 組織内でのみ使用します。 |
| Smart Data Discovery (インサイト API) |
/services/data/vXX.X/smartdatadiscovery インサイト API を使用して、インサイトを Web サイト、アプリケーション、またはダッシュボードに埋め込みます。『プログラムによる説明的インサイトと診断的インサイトの取得』を参照してください。 |
| Describe Global |
/services/data/vXX.X/sobjects |
| Platform Event Schema by Event Name |
/services/data/vXX.X/sobjects/eventName/eventSchema イベント名のプラットフォームイベントの定義を JSON 形式で取得します。 |
| Lightning Exit by Page Metrics |
/services/data/vXX.X/sobjects/LightningExitByPageMetrics ユーザーが Lightning Experience から Salesforce Classic に切り替える標準ページに関する頻度の総計値を返します。 |
| Lightning Toggle Metrics |
/services/data/vXX.X/sobjects/LightningToggleMetrics Salesforce Classic から Lightning Experience に切り替えたユーザーに関する詳細を返します。 |
| Lightning Usage by App Type |
/services/data/vXX.X/sobjects/LightningUsageByAppTypeMetrics Lightning Experience ユーザーと Salesforce モバイルユーザーの合計数を返します。このリソースは REST API バージョン 44.0 以降で使用できます。 |
| Lightning Usage by Browser |
/services/data/vXX.X/sobjects/LightningUsageByBrowserMetrics ブラウザーインスタンスによってグループ化された Lightning Experience 利用状況の結果を返します。 |
| Lightning Usage by FlexiPage |
/services/data/vXX.X/sobjects/LightningUsageByFlexiPageMetrics Lightning Experience で最も頻繁に表示されたカスタムページに関する詳細を返します。 |
| Lightning Usage by Page |
/services/data/vXX.X/sobjects/LightningUsageByPageMetrics Lightning Experience でユーザーが最も頻繁に表示した標準ページを示します。 |
| sObject PlatformAction |
/services/data/vXX.X/sobjects/PlatformAction ユーザー、コンテキスト、デバイス形式、レコード ID に応じて、UI に表示するアクションを照会します。たとえば、標準およびカスタムボタン、クイックアクション、生産性アクションなどを照会できます。 |
| sObject Relevant Items | 現在のユーザーに最も関連性の高い項目を取得します。関連性の高い項目には、ユーザーのグローバル検索範囲のオブジェクトや、最後に使用した (MRU) オブジェクトのレコードなどがあります。 |
| sObject Basic Information |
/services/data/vXX.X/sobjects/sObject 指定されたオブジェクトの基本メタデータを取得するか、指定されたオブジェクトの新規レコードを作成します。 |
| sObject Get Deleted |
/services/data/vXX.X/sobjects/sObject/deleted/?start=startDateAndTime&end=endDateAndTime 指定されたオブジェクトについて、特定の期間内に削除された個々のレコードのリストを取得します。 |
| sObject Describe |
/services/data/vXX.X/sobjects/sObject/describe 指定されたオブジェクトのすべてのレベルで、個別のメタデータを完全に説明します。たとえば、これは、Account オブジェクトの項目、URL、および子リレーションを取得するために使用できます。 |
| sObject ApprovalLayouts |
/services/data/vXX.X/sobjects/sObject/describe/approvalLayouts 指定されたオブジェクトの承認レイアウトのリストを取得します。このリソースは REST API バージョン 30.0 以降で使用できます。 |
| sObject CompactLayouts |
/services/data/vXX.X/sobjects/sObject/describe/compactLayouts 特定のオブジェクトのコンパクトレイアウトのリストを取得します。このリソースは REST API バージョン 29.0 以降で使用できます。 |
| sObject Layouts |
/services/data/vXX.X/sobjects/sObject/describe/layouts /services/data/vXX.X/sobjects/Global/describe/layouts ページレイアウトとその説明のリストを取得します。特定のオブジェクトのすべてのレイアウト、または特定のオブジェクトの指定されたレコードタイプに関連するレイアウトの情報を要求できます。 |
| sObject Named Layouts |
/services/data/vXX.X/sobjects/sObject/describe/namedLayouts/layoutName 特定のオブジェクトの代替名前付きレイアウトに関する情報を取得します。このリソースは REST API バージョン 31.0 以降で使用できます。 |
| sObject Rows by External ID |
/services/data/vXX.X/sobjects/sObject/fieldName/fieldValue 指定された外部 ID 項目の値に基づいて、レコードを作成するか、既存のレコードを更新 (レコードを Upsert) します。 |
| List Views for an Object |
/services/data/vXX.X/sobjects/sObject/listviews /services/data/vXX.X/sobjects/sObject/listviews/listViewId 指定された sObject のリストビューのリストを返します。各リストビューの ID とその他の基本情報も含まれます。ID で特定のリストビューの基本情報を取得することもできます。 |
| List View Results |
/services/data/vXX.X/sobjects/sObject/listviews/listViewID/results リストビューに対する SOQL クエリを実行し、結果のデータと表示情報を返します。 |
| List View Describe |
/services/data/vXX.X/sobjects/sObject/listviews/queryLocator/describe ID、列、SOQL クエリなど、リストビューに関する詳細な情報を返します。 |
| Recent List Views |
/services/data/vXX.X/sobjects/sObject/listviews/recent 特定のオブジェクトに最近使用されたリストビューのリストを返します。 |
| sObject Quick Actions |
/services/data/vXX.X/sobjects/sObject/quickActions/ オブジェクトのアクションとアクションの詳細にアクセスします。 |
| sObject Get Updated |
/services/data/vXX.X/sobjects/sObject/updated/?start=startDateAndTime&end=endDateAndTime |
| sObject Rows |
/services/data/vXX.X/sobjects/sObject/id 指定されたオブジェクトとレコード ID に基づいてレコードにアクセスします。HTTP メソッドに従ってレコードを取得、更新、または削除します。レコードまたは特定の項目値を取得するには GET メソッド、レコードを削除するには DELETE メソッド、レコードを更新するには PATCH メソッドを使用します。 |
| sObject Blob Get |
/services/data/vXX.X/sobjects/sObject/id/blobField 個別のレコードから指定された blob 項目を取得して、バイナリデータとして返します。 |
| sObject Relationships |
/services/data/vXX.X/sobjects/sObject/id/relationshipName 使い慣れた URL を介してオブジェクトリレーションをトラバースし、レコードにアクセスします。トラバースされたリレーション項目に関連付けられたレコードを取得、更新、または削除できます。複数の関連レコードがある場合、関連付けられたレコードの完全なセットを取得できます。 |
| sObject Rich Text Image Get |
/services/data/vXX.X/sobjects/sObject/id/richTextImageFields/fieldName/contentReferenceId 特定のレコードの特定のリッチテキストエリア項目から、指定された画像データを取得します。 |
| Delete Lightning Experience Event Series |
/services/data/vXX.X/sobjects/Event/id/fromThisEventOnwards 一連の IsRecurrence2 行動から 1 つ以上を削除します。 |
| Streaming Channel Push (ストリーミング API) |
/services/data/vXX.X/sobjects/StreamingChannel/channelId/push 登録者情報を取得し、ストリーミングチャネルの通知を転送します。『ストリーミング API 開発者ガイド』を参照してください。 |
| sObject User Password |
/services/data/vXX.X/sobjects/User/userId/password 指定されたユーザー ID に基づいてユーザーパスワードにアクセスします。HTTP メソッドに基づき、ユーザーパスワードの有効期限の状況を設定、リセット、または取得します。パスワードの有効期限の状況を取得するには GET メソッド、パスワードを設定するには POST メソッド、パスワードのリセットを開始するには DELETE メソッドを使用します。 |
| sObject Self-Service User Password |
/services/data/vXX.X/sobjects/SelfServiceUser/selfServiceUserId/password 指定されたユーザー ID に基づいてセルフサービスユーザーパスワードにアクセスします。HTTP メソッドに基づき、セルフサービスユーザーパスワードの有効期限の状況を設定、リセット、または取得します。パスワードの有効期限の状況を取得するには GET メソッド、パスワードを設定するには POST メソッド、パスワードのリセットを開始するには DELETE メソッドを使用します。 |
| Data Category Groups |
/services/data/vXX.X/support/dataCategoryGroups 現在のユーザーが参照可能なデータカテゴリグループを取得します。 |
| Data Category Detail |
/services/data/vXX.X/support/dataCategoryGroups/group/dataCategories/category 指定されたカテゴリのデータカテゴリの詳細と子カテゴリを取得します。 |
| Embedded Service Configuration Describe |
/services/data/vXX.X/support/embeddedservice/configuration/serviceName フィールドサービスの 1 つ以上のサービスレポートテンプレートに対応する情報を返します。 |
| Field Service Flow |
/services/data/vXX.X/support/fieldservice/Flow?developerNames=flowName Field Service フローに対応する情報を返します。『Field Service 開発者ガイド』の「Field Service フロー」を参照してください。 |
| Field Service Report Template |
/services/data/vXX.X/support/fieldservice/ServiceReportTemplate フィールドサービスの 1 つ以上のサービスレポートテンプレートに対応する情報を返します。『Field Service 開発者ガイド』の「サービスレポートテンプレート」を参照してください。 |
| Articles Details |
/services/data/vXX.X/support/knowledgeArticles/articleId /services/data/vXX.X/support/knowledgeArticles/articleUrlName ユーザーがアクセスできるすべての記事項目を取得します。 |
| Tabs |
/services/data/vXX.X/tabs ユーザーが [すべてのタブ] ([+]) タブカスタマイズ機能を使用してタブを非表示にしているかどうかに関係なく、ログインユーザーが使用できるすべてのタブ (Lightning ページタブを含む) のリストを返します。 |
| Themes |
/services/data/vXX.X/theme Salesforce アプリケーションのテーマで使用するアイコンと色のリストを取得します。 |
| Tooling API |
/services/data/vXX.X/tooling Tooling API で機能にアクセスします。『Tooling API 開発者ガイド』を参照してください。 |
| UI API |
/services/data/vXX.X/ui-api UI API で機能にアクセスします。『ユーザーインターフェース API 開発者ガイド』を参照してください。 |
| Wave (Analytics REST API) |
/services/data/vXX.X/wave Analytics REST API で機能にアクセスします。『Analytics REST API 開発者ガイド』を参照してください。 |