Newer Version Available
POST /api/v1/query
この API は、データモデルオブジェクト、レイクオブジェクト、統合オブジェクト、リンクされたオブジェクト全体で Salesforce CDP データレイクを照会します。
構文
- HTTP のメソッド
- POST
- 使用可能なバージョン
- Salesforce CDP v1.0、Salesforce v51.0
- 形式
- REST
- URI
- /api/v1/query
要求パラメータ
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| limit | int | 返すレコード数。例: 10 |
| offset | int | 結果を返す最初の行までスキップする行数。例: 100 |
| orderby | string | 結果セットを昇順または降順に並び替えるための値のカンマ区切りリスト。例: GenderId__c ASC,Occupation__c DESC |
例
- 要求
-
1 { 2 "sql": "select BirthDate__c, DataSourceId__c, DataSourceObjectId__c, ExternalRecordId__c, FirstName__c, GenderId__c, Id__c, InternalOrganizationId__c, LastName__c from Individual__dlm where Id__c='100470169'” 3 } 4 - 応答
-
1{ 2 "data": [ 3 { 4 "Id__c": "100470169", 5 "GenderId__c": "M", 6 "FirstName__c": "Joshua", 7 "LastName__c": "Carrier", 8 "BirthDate__c": "1994-01-21T00:00:00", 9 "ExternalRecordId__c": "003f200002a3227163", 10 "DataSourceId__c": "SubscribedUsers", 11 "InternalOrganizationId__c": "", 12 "DataSourceObjectId__c": "Subscribers_for_CDP" 13 } 14 ], 15 "startTime": "2020-12-19T06:50:05.251Z", 16 "endTime": "2020-12-19T06:50:05.251Z", 17 "rowCount": 1, 18 "queryId": "3442db1a-ecef-42b3-b0d8-971ee459efa4", 19 "done": true, 20 "metadata": { 21 "BirthDate__c": { 22 "type": "TIMESTAMP", 23 "placeInOrder": 3, 24 "typeCode": 93 25 }, 26 "LastName__c": { 27 "type": "VARCHAR", 28 "placeInOrder": 2, 29 "typeCode": 12 30 }, 31 "FirstName__c": { 32 "type": "VARCHAR", 33 "placeInOrder": 1, 34 "typeCode": 12 35 }, 36 "InternalOrganizationId__c": { 37 "type": "VARCHAR", 38 "placeInOrder": 5, 39 "typeCode": 12 40 }, 41 "Id__c": { 42 "type": "VARCHAR", 43 "placeInOrder": 0, 44 "typeCode": 12 45 }, 46 "DataSourceObjectId__c": { 47 "type": "VARCHAR", 48 "placeInOrder": 6, 49 "typeCode": 12 50 }, 51 "DataSourceId__c": { 52 "type": "VARCHAR", 53 "placeInOrder": 4, 54 "typeCode": 12 55 }, 56 "GenderId__c": { 57 "type": "VARCHAR", 58 "placeInOrder": 7, 59 "typeCode": 12 60 }, 61 "ExternalRecordId__c": { 62 "type": "VARCHAR", 63 "placeInOrder": 8, 64 "typeCode": 12 65 } 66}
HTTP 応答
| 応答 | 理由 |
|---|---|
| 200 OK | コールバックが正常に検証されました。 |
| 400 Bad Request | 無効な要求です。 |
| 403 Forbidden | 承認の受け渡しに失敗しました。 |
| 404 Not Found | コールバック ID または検証キー、あるいはその両方が正しくありません。 |
| 422 Unprocessable Entity | 項目/検索条件パラメータで使用されている属性名が存在しません。 |
| 500 Server Error | 内部エラーです。 |