Retrieve Supplemental Table member based on a query attribute
/rest/api/v1.3/folders/{folderName}/suppData/{tableName}/members
Request
- application/x-www-form-urlencoded
-
folderName: string
Folder name
-
tableName: string
Table name
-
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 Supplemental 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 Supplemental Table must be specified by repeating this parameter.
Response
- application/json
Default Response
object
Supplemental Table records
-
insertOnNoMatch:
boolean
Specifies whether a member record should be inserted into the Supplemental Table if it does not already exist.
-
matchColumnNames:
array matchColumnNames
The column names to be used to match the member record to the Supplemental Table records. Only used during the merge operation.
-
recordData:
object recordData
Record data that represents field names and corresponding values for the member.
-
updateOnMatch:
string
Allowed Values:
[ "REPLACE_ALL", "NO_UPDATE" ]
Specifies whether a member record should be updated in the Supplemental Table if it already exists.
array
object
-
fieldNames:
array fieldNames
Field names in the Supplemental Table
-
mapTemplateName(optional):
string
The map template in Responsys that can be used to map field names of the Supplemental Table to column names.
-
records:
array records
Array of values corresponding to the fieldNames. Each element in the array represents a single member.
array
-
Array of:
array items
Field values for the member in the Supplemental Table
Examples
This interface is to retrieve Supplemental Table Records by specifying the primary key values using the request parameters. Please note that the total length of the string passed in for the fs parameter (containing the comma separated field names) cannot exceed 150 characters. To retrieve values of all columns, you can specify only one field with value set to all
(if you have a column called all
, you should use two or more specific column names to avoid getting all of the columns).
FIELDS | DESCRIPTION |
---|---|
Authorization | <AUTH_TOKEN> |
FIELDS | DESCRIPTION |
---|---|
qa | Query Attribute-All the Primary Keys of the Supplemental Table must be specified by repeating this parameter. |
fs | Comma separated list of field names or all |
id | IDs corresponding to the query attribute. All the Primary Key Values of the Supplemental 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. |
Sample Request URL:
rest/api/v1.3/folders/DemoNewsLetter/suppData/CompositePKSuppTable/members?qa=PK1&qa=PK2&qa=PK3&fs=PK1,PK2,PK3,F1,F2&id=1&id=1&id=1
Sample Response: Success
NOTE: Other attributes in the response like mapTemplateName, insertOnNoMatch, updateOnMatch and matchColumn will have default values (null/false).
{ "recordData":{ "fieldNames":[ "PK1", "PK2", "PK3", "F1", "F2" ], "records":[ [ "1", "1", "1", "onerec", "onecol" ] ], "mapTemplateName":null }, "insertOnNoMatch":false, "updateOnMatch":null, "links":[ { "rel":"self", "href":"/rest/api/v1.3/folders/DemoNewsLetter/suppData/CompositePKSuppTable/members?qa=PK1&qa=PK2&qa=PK3&fs=PK1,PK2,PK3,F1,F2&id=1&id=1&id=1", "method":"GET" }, { "rel":"mergeTableMembers", "href":"/rest/api/v1.3/folders/DemoNewsLetter/suppData/CompositePKSuppTable/members", "method":"POST" } ] }
Sample Response: Failure
{ "type": "", "title": "Invalid field name", "errorCode": "INVALID_FIELD_NAME", "detail": "Column(s) [F1] is not indexed", "errorDetails": [] }
Sample Response in case not ALL Primary Key Columns are specified in the "qa" request parameter:
{ "type": "", "title": "Invalid request parameters", "errorCode": "INVALID_PARAMETER", "detail": "All and Only the Primary Keys in the Table [PK1, PK2, PK3] must be specified as Query Columns.", "errorDetails": [] }