REST API 開発者ガイド
jsObject Rows
指定されたオブジェクト ID に基づいてレコードにアクセスします。レコードを取得、更新、または削除します。このリソースは、項目値の取得にも使用できます。レコードまたは項目を取得するには GET メソッド、レコードを削除するには DELETE メソッド、レコードを更新するには PATCH メソッドを使用します。
新規レコードを作成するには、sObject Basic Information リソースを使用します。
- URI
- /services/data/vXX.X/sobjects/sObject/id/
- 形式
- JSON、XML
- HTTP メソッド
- GET、PATCH、DELETE
- 認証
- Authorization: Bearer token
- パラメータ
-
パラメータ 説明 Content-Type PATCH のみで使用できる、要求と応答の形式を指定する省略可能なヘッダー。次から選択できます。- Content-Type: application/json
- Content-Type: application/xml
sObject オブジェクトの名前。たとえば、Account などです。
すべてのメソッド (GET、PATCH、DELETE) の必��のパラメータ。
id オブジェクトの識別子。たとえば、001R0000005hDFYIA2 のようになります。
すべてのメソッド (GET、PATCH、DELETE) の必須のパラメータ。
fields 値を取得する項目のカンマ区切りリスト。たとえば、?fields=name,description,numberofemployees,industry のようになります。
GET のみで使用できる省略可能なクエリパラメータ。
If-Match 1 つ以上の ETag のカンマ区切りリストを指定する省略可能なヘッダー。これは、Account オブジェクトで使用される場合にのみ影響します。要求は、Account の ETag がリストに含まれている ETag と一致する場合にのみ処理されます。 例: If-Match: "94C83JSreaVMGpL+lUzv8Dr3inI0kCvuKATVJcTuApA=--gzip", "ddpAdaTHz+GcV35e7NLJ9iKD3XXVqAzXT1Sl2ykkP7g=--gzip"。
If-None-Match 1 つ以上の ETag のカンマ区切りリストを指定する省略可能なヘッダー。これは、Account オブジェクトで使用される場合にのみ影響します。要求は、Account の ETag がリストに含まれている ETag と一致しない場合にのみ処理されます。 例: If-None-Match: "94C83JSreaVMGpL+lUzv8Dr3inI0kCvuKATVJcTuApA=--gzip", "ddpAdaTHz+GcV35e7NLJ9iKD3XXVqAzXT1Sl2ykkP7g=--gzip"。
If-Modified-Since 日時を指定する省略可能なヘッダー。この要求では、その日時以降に変更されたレコードが返されます。
形式は EEE, dd MMM yyyy HH:mm:ss z です。
例: If-Modified-Since: Mon, 30 Nov 2020 08:34:54 MST。
If-Unmodified-Since 日時を指定する省略可能なヘッダー。この要求では、その日時以降に変更されなかったレコードが返されます。
形式は EEE, dd MMM yyyy HH:mm:ss z です。
例: If-Unmodified-Since: Mon, 30 Nov 2020 08:34:54 MST。
- 使用方法
- このリソースは API バージョン 32.0 以降で外部オブジェクトに使用できます。
データが大量ではない外部データソースに関連付けられた外部オブジェクトは、id に 18 文字の Salesforce ID を使用します。それ以外の外部オブジェクトは、id に外部オブジェクトの外部 ID 標準項目を使用します。
レスポンスボディの項目についての詳細は、『SOAP API 開発者ガイド』の「DescribeSObjectResult」を参照してください。
オブジェクトが Account オブジェクトの場合、応答には ETag ヘッダーも含まれます。(例: ETag: "ddpAdaTHz+GcV35e7NLJ9iKD3XXVqAzXT1Sl2ykkP7g=--gzip") この ETag は If-Match ヘッダーと If-None-Match ヘッダーで使用できます。詳細は、「条件付き要求の使用」を参照してください。
- 例
-
- GET を使用して項目値を取得する例については、下記を参照してください。
- PATCH を使用してレコードを更新する例は、「レコードを更新する」を参照してください。
- DELETE を使用してレコードを削除する例は、「レコードを削除する」を参照してください。
- オブジェクトの blob データを更新する例は、「Blob データを挿入または更新する」を参照してください。