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

GET /api/v1/profile/{dataModelName}/{Id}

インデックスと検索条件に基づいてデータモデルオブジェクトを返します。この API コールは、プライマリキーまたはセカンダリキーに基づいてオブジェクトレコードを取得します。レコードが見つからない場合は空のリストを返します。

構文

HTTP のメソッド: GET
使用可能なバージョン: Salesforce CDP v1.0、Salesforce v51.0
形式: REST
URI: /api/v1/profile/{dataModelName}/{Id}

要求パラメータ

項目名	項目の型	説明
dataModelName	string	必須。データモデルオブジェクトの API 参照名。例: UnifiedIndividual__dlm
fields	string	省略可能。結果に含める個別の項目名のカンマ区切りリスト。このパラメータを指定しないと、任意の項目のセットが返されます。例: Id__c,FirstName__c,GenderId__c,Occupation__c
filters	string	各括弧内に指定した等式のカンマ区切りリスト。例: [FirstName__c=DON]
Id	string	必須。プライマリ/セカンダリキー項目の値。指定しなかった場合のデフォルトはプライマリキーになります。例: John
limit	int	返すレコード数。例: 10
offset	int	結果を返す最初の行までスキップする行数。例: 100 この項目は、API バージョン 52.0 以降で使用できます。
orderby	string	結果セットを昇順または降順に並び替えるための値のカンマ区切りリスト。例: GenderId__c ASC,Occupation__c DESC この項目は、API バージョン 52.0 以降で使用できます。
searchKey	string	プライマリキー以外を使用する場合のキー項目の名前。例: FirstName__c

例

要求

1https://{TSE}.360a.salesforce.com/api/v1/profile/{dataModelName}/{Id}

応答

1{
2  "data": [
3    {
4      "GenderId__c": "F",
5      "Id__c": "05d01a06-0c61-3990-808d-2aa602dd3e7f",
6      "Occupation__c": "Staffing",
7      "FirstName__c": "Don"
8    },
9    {
10      "GenderId__c": "M",
11      "Id__c": "11bcc846-1a80-3293-8cc4-3449835d8d4c",
12      "Occupation__c": "Operational",
13      "FirstName__c": "Don"
14    },
15    {
16      "GenderId__c": "M",
17      "Id__c": "18213566-df86-34a8-97aa-2cb75b70ae3b",
18      "Occupation__c": "Organizational",
19      "FirstName__c": "Don"
20    }
21  ],
22  "done": false
23}

HTTP 応答

応答	理由
200 OK	コールバックが正常に検証されました。
400 Bad Request	無効な要求です。
403 Forbidden	承認の受け渡しに失敗しました。
404 Not Found	コールバック ID または検証キー、あるいはその両方が正しくありません。
422 Unprocessable Entity	項目/検索条件パラメータで使用されている属性名が存在しません。
500 Server Error	内部エラーです。

カスタマーデータプラットフォーム開発者ガイド

GET /api/v1/profile/{dataModelName}/{Id}

構文

要求パラメータ

例

HTTP 応答