REST API 開発者ガイド
jREST リソースと要求
- 利用可能な API バージョンの決定
- Salesforce 組織のアクセス制限
- オブジェクトのメタデータの取得
- レコードの作成、参照、更新、および削除
- データの照会と検索
- URI
- HTTP のメソッド
- ヘッダー
- リクエストボディ (GET 要求の場合は必須ではない)
URI
URI は、Salesforce のリソースへのパスです。URI はリソースごとに変わりますが、基本的な構造は同じです。
1https://MyDomainName.my.salesforce.com/services/data/vXX.X/resource/https:// を使用して安全にリソースにアクセスします。
MyDomainName は自分の Salesforce 組織のサブドメインで置き換えてください。Salesforce は複数のサーバーインスタンス上で動作するため、このガイドの例では特定のインスタンスの代わりに MyDomainName を使用しています。
XX.X は、使用する API のバージョンに置き換えます。利用可能なバージョンのリストについては、「バージョン」リソースにアクセスして確認できます。
resource をリソースへのパスの残り部分に置き換えます。リソースによっては、特定のレコードを識別するための ID などのパラメーターをパスに含めることができます。各リソースの URI は、このガイドの「リファレンス」セクションで確認できます。
sObject リソースは、Salesforce の標準オブジェクトやカスタムオブジェクトへアクセスします。オブジェクトについての詳細は、『Salesforce プラットフォームのオブジェクトリファレンス』を参照してください。
HTTP のメソッド
REST API は、https://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html の仕様に従った標準の HTTP 要求メソッド (HEAD、GET、POST、PATCH、PUT、DELETE) をサポートしています。
各メソッドの目的は、リソースによって異なります。各メソッドを使用する方法やタイミングについては、本ガイドの「リファレンス」セクションにある該当するリソースのページを確認してください。
ヘッダー
ヘッダーは、HTTP 要求のパラメーターを渡したり、オプションをカスタマイズしたりするために使用します。REST API では、いくつかの標準の HTTP ヘッダーに加えて、Salesforce 固有のカスタムヘッダーもサポートされています。
例で使用されている、一般的なヘッダーは次のとおりです。
- HTTP Accept — クライアントが受け入れるレスポンスボディの形式を示します。可能な���は application/json および application/xml です。値が欠落しているか、誤った形式である場合、デフォルトでは application/json が使用されます。
- HTTP Content-type — 要求に添付するリクエストボディの形式を示します。可能な値は application/json および application/xml です。
- HTTP Authorization — クライアントを認証するための OAuth 2.0 アクセストークンを提供します。REST API では、Bearer 認証タイプがサポートされています。
- 圧縮ヘッダー — 要求または応答を圧縮します。詳細は、「圧縮ヘッダー」を参照してください。
- 条件付き要求ヘッダー — アクセスしたレコードを前提条件と照らし合わせて検証します。詳細は、「条件付き要求ヘッダー」を参照してください。
リクエストのボディ
リクエストボディとは、要求に含めることができるリッチ入力のことで、レコードの作成や更新のための項目値など追加の情報を指定できます。リクエストボディには、JSON 形式または XML 形式を使用できます。
HTTP Content-Type ヘッダーは、リクエストボディのファイル形式を示すために使用します。cURL を使用して要求を送信する場合は、—data-binary または -d オプションを使用して、JSON または XML ファイルを要求に添付します。