Retrieve Custom Table Member based on a query attribute
get
/rest/api/v1.3/lists/{listName}/customTable/{tableName}/members
Request
Supported Media Types
- application/x-www-form-urlencoded
Path Parameters
-
listName: string
List name
-
tableName: string
Table name
Query Parameters
-
fs: string
Comma separated list of fields to retrieve or 'all'
-
id: string
IDs corresponding to the query attribute. All the Primary Key Values of the Custom Table must be specified by repeating this parameter. The order of the values must match the order of the Primary Keys specified in the 'qa' parameter.
-
qa: string
Query Attribute. All of the Primary Key values of the Custom Table must be specified by repeating this parameter.
Response
Supported Media Types
- application/json
Default Response
Root Schema : Custom Table Members with PK
Type:
object
Title:
Show Source
Custom Table Members with PK
-
insertOnNoMatch(optional):
boolean
Specifies whether a member record should be inserted into the Custom Table if it does not already exist.
-
recordData(optional):
object recordData
Record data that represents Field Names and corresponding values for the member.
-
required(optional):
-
updateOnMatch(optional):
string
Allowed Values:
[ "REPLACE_ALL", "NO_UPDATE" ]
Specifies whether a member record should be updated in the Custom Table if it already exists.
Nested Schema : recordData
Type:
object
Record data that represents Field Names and corresponding values for the member.
Show Source
-
fieldNames:
array fieldNames
Field Names in the Custom Table
-
mapTemplateName(optional):
string
The Map Template in CX Audience that can be used to map Field Names of the Custom Table to Column Names.
-
records:
array records
Array of values corresponding to the fieldNames. Each element in the array represents a single member.
Nested Schema : records
Type:
array
Array of values corresponding to the fieldNames. Each element in the array represents a single member.
Show Source
-
Array of:
array items
Field Values for the member in the Custom Table