getProfileQueryDataModelObjectAndChildObjectWithSearchKey
GET {{baseUrl}}/ssot/profile/:dataModelName/:dataModelName/:id/:childDataModelName?batchSize=<integer>&fields=<string>&filters=<string>&offset=<integer>&orderby=<string>&searchKey=<string>
Query a Profile data model object and a child object using filters and a search key in Data Cloud.
Available Version: 52.0
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
batchSize | string | Number of items to return. Values are from 1-4,999. If unspecified, the default value is 100. |
Available Version: 52.0
|
| fields | string | | Comma-separated list of child object field names that you want to include in the result, for example, Id__c,EmailAddress__c. If unspecified, the first 10 alphabetically sorted fields are returned.
Available Version: 52.0
|
| filters | string | | Comma-separated list of equality expressions within square brackets, for example, [FirstName__c=DON]. Filters are applied to the parent object only.
Available Version: 52.0
|
| offset | string | | Number of rows to skip before returning results. If unspecified, no rows are skipped.
Available Version: 52.0
|
| orderby | string | | Sort order for the result set, such as GenderId__c ASC,​Occupation__c DESC. If unspecified, items are returned in the order they are retrieved.
Available Version: 52.0
|
| searchKey | string | | If a field other than the primary key is used, name of the key field, for example, FirstName__c. Parameter is required for secondary key.
Available Version: 52.0 |
RESPONSES
status: OK
{"done":"\u003cboolean\u003e","endTime":"\u003cstring\u003e","metadata":{"//":"\u003cobject\u003e"},"queryId":"\u003cstring\u003e","rowCount":"\u003cinteger\u003e","startTime":"\u003cstring\u003e"}