この文章は Salesforce 機械翻訳システムを使用して翻訳されました。詳細はこちらをご参照ください。

Lightning Platform REST リソース

REST リソースは、1 つのデータレコード、レコードのコレクション、またはクエリなどの情報またはアクションを抽象化したものです。REST API の各リソースは、名前付きの Uniform Resource Identifier (URI) で識別され、標準 HTTP メソッド (HEAD、GET、POST、PATCH、DELETE) を使用してアクセスされます。REST API は、リソース、その URI、およびそれらの間のリンクの使用状況に基づきます。

リソースは、Salesforce 組織との連携に使用します。次のような操作が可能です。

使用できる API バージョンに関する概要情報を取得する。
Account (取引先)、User (ユーザ) などの Salesforce オブジェクトやカスタムオブジェクトに関する詳細情報を取得する。
クエリまたは検索を実行する。
レコードを更新または削除する。

たとえば、Salesforce バージョンに関する情報を取得するとします。Versions リソースに要求を送信します。

1curl https://yourInstance.salesforce.com/services/data/

この要求の出力は、次のとおりです。

1[
2    {
3        "version":"20.0",
4        "url":"/services/data/v20.0",
5        "label":"Winter '11"
6    }
7    ...
8]

Salesforce は複数のサーバインスタンス上で実行されます。このガイドの例では、特定のインスタンスの代わりに yourInstance を使用しています。このテキストを組織のインスタンスに置き換えてください。

メモ

Lightning Platform REST API リソースとアーキテクチャの重要な特性を次に示します。

ステートレス

クライアントからサーバへの各要求には、要求を理解するのに必要なすべての情報が含まれている必要があります。サーバに格納されたコンテキストは使用しないでください。ただし、リソースの表現は URL を使用して相互接続されるため、クライアントは状態が変わっても進行できます。

キャッシュの動作

応答にはキャッシュ可能かどうかを示すラベルが付加されます。

統一されたインターフェース

すべてのリソースには、HTTP を介した汎用インターフェースを使用してアクセスします。

名前付きリソース

すべてのリソースには、Lightning Platform URI に続くベース URI を使用して名前が付けられます。

階層化されたコンポーネント

Lightning Platform REST API アーキテクチャでは、クライアントとリソースの間にプロキシサーバやゲートウェイなどを介在させることができます。

認証

Lightning Platform REST API では、OAuth 2.0 (セキュアな API 認証を可能にするオープンプロ��コル) がサポートされています。詳細は「認証について」を参照してください。

JSON および XML のサポート

JSON がデフォルトです。HTTP ACCEPT ヘッダーを使用して、JSON または XML を選択するか、URI に .json または .xml を追加します (例: /Account/001D000000INjVe.json)。

JavaScript Object Notation (JSON) 形式は UTF-8 でサポートされます。日時情報は ISO8601 形式です。

XML 逐次化は SOAP API と類似しています。XML 要求は UTF-8 および UTF-16 でサポートされ、XML 応答は UTF-8 で提供されます。

フレンドリー URL

1 つの API コールで済むなら 2 つのコールを行う必要はありません。フレンドリー URL によって、直感的な方法で REST API 要求を作成し、アプリケーションと Salesforce 組織間の往復処理数を最小限に抑えられます。フレンドリー URL は、API バージョン 36.0 以降で使用できます。

フレンドリー URL なしで取引先責任者の親取引先にアクセスするには、SObject Rows リソースを使用して取引先責任者レコードを要求する必要があります。その後、取引先リレーション項目を調べて取引先 ID を取得し、SObject Rows への別のコールで取引先レコードを要求します。フレンドリー URL を使用すると、取引先責任者のパス /services/data/v36.0/sobjects/contact/id/account から直接 1 回のコールで取引先にアクセスできます。

この機能は、SObject Relationships リソースで公開されています。フレンドリー URL を使用してリレーション項目にアクセスするその他の例については、「フレンドリー URL を使用したリレーションのトラバース」を参照してください。

REST API 開発者ガイド

Lightning Platform REST リソース