Asynchronous Merge Supplemental Table Records API
This endpoint is used to add new members to an existing supplemental table, or update data for existing members within the table. For a given supplemental table in a specific folder, an array of record data that contains field names and their corresponding field values are specified. This endpoint is the asynchronous alternative to Merge Table Records.
A maximum of 200 records can be merged in one request.
Note: The Asynchronous API is generally available for all Responsys customers.
Service URL:
/rest/asyncApi/v1.3/folders/{folderName}/suppData/{suppTable}/members
Required Path Parameters:
folderName - Name of the folder where the supplemental table is found.
suppTable - Name of the supplemental table.
Request Method:
POST
Request Header:
Authorization=<AUTH_TOKEN>
Content-Type=application/json
Request Body - Required Properties:
recordData – Record data that represents field names and corresponding values for the member.
For more information about forming a request, see the Merge Table Records REST Endpoints page in the Oracle Responsys REST API Guide. View the Request section of the topic.
Request Body - Optional Properties
-
insertOnNoMatch– Boolean value that specifies whether a member record should be inserted into the Supplemental Table if it does not already exist. -
updateOnMatch– Specifies whether a member record should be updated in the Supplemental Table if it already exists. Allowed values: REPLACE_ALL and NO_UPDATE.
For more information about forming a request, see the Merge Table Records REST Endpoints.
Sample Request Body:
{
"recordData": {
"fieldNames": [
"EMAIL_ADDRESS_",
"INTEGER_FIELD"
],
"records": [
[
"email.address@oracle.com",
"10"
],
[
"email.address@oracle.com",
"11"
],
[
"email.address@oracle.com",
"12"
],
[
"email.address@oracle.com",
"13"
]
],
"mapTemplateName": "Map_Template_Name"
},
"insertOnNoMatch": true,
"updateOnMatch": "REPLACE_ALL"
}
Response Notes:
- A successful response for the asynchronous API returns an HTTPS status code of 202 Accepted.
- A successful response returns a requestId, to be used in the Polling API endpoint to retrieve the status of your request.
- See Common error responses for the Asynchronous API for details about the error responses.
Sample Response:
{
"requestId": "TzJGZ0w50joxNTc2MDg1Mzk4",
"apiName": "asyncMergeTableRecords",
"status": "REQUEST_ACCEPTED",
"links": [
{
"rel": "self",
"href": "/rest/asyncApi/v1.3/folders/My_Folder_Name/suppData/My_Table_Name/members",
"method": "POST"
},
{
"rel": "asyncResponse",
"href": "/rest/asyncApi/v1.3/requests/TzJGZ0w50joxNTc2MDg1Mzk4",
"method": "GET"
}
]
}