Fetch All Supplemental Tables
get
/rest/api/v1.3/suppData
Use this endpoint to get all Supplemental Tables for your account.
Request
There are no request parameters for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
Supplemental Data Tables
Nested Schema : items
Type:
Show Source
array
-
Array of:
object Supplemental Data table
Title:
Supplemental Data table
Nested Schema : Supplemental Data table
Type:
object
Title:
Show Source
Supplemental Data table
-
fields:
array fields
The Supplemental data table Fields
-
folderName:
string
The name of the folder in which the Supplemental data table exists
-
name:
string
The name of the Supplemental data table
Nested Schema : items
Type:
Show Source
object
-
fieldName(optional):
string
The Supplemental data Field Name
-
fieldType(optional):
string
The Supplemental data Field Type
Examples
The following example shows how to retrieve all supplemental data tables for an account.
FIELDS | DESCRIPTION |
---|---|
Authorization | <AUTH_TOKEN> |
Accept | application/json |
Optional Query Parameters
offset
: starts at 0 and indicates the record number for the response result set (defaults to 0)limit
: number of Supplemental Table records to return in the response (defaults to 200 and cannot exceed 200)
Sample Request URL:
/rest/api/v1.3/suppData
Response Notes
- If your Responsys account does not have supplemental tables defined, then the response is an empty array.
- For accounts enabled for Organizational Access Control, the organization filter is applied before sending the response.
Sample Response: Success
[ { "fields": [ { "fieldType": "STR100", "fieldName": "TEST23" }, { "fieldType": "NUMBER", "fieldName": "TEST244" }, { "fieldType": "TIMESTAMP", "fieldName": "CREATED_DATE_" }, { "fieldType": "TIMESTAMP", "fieldName": "MODIFIED_DATE_" } ], "suppData": { "objectName": "vklist", "folderName": "vk" } }, { "fields": [ { "fieldType": "STR100", "fieldName": "VK1223" }, { "fieldType": "INTEGER", "fieldName": "VKHERO" }, { "fieldType": "TIMESTAMP", "fieldName": "CREATED_DATE_" }, { "fieldType": "TIMESTAMP", "fieldName": "MODIFIED_DATE_" } ], "suppData": { "objectName": "vklist1", "folderName": "vk1" } }, { "fields": [ { "fieldType": "STR100", "fieldName": "A1" }, { "fieldType": "STR25", "fieldName": "A2" }, { "fieldType": "NUMBER", "fieldName": "A3" }, { "fieldType": "TIMESTAMP", "fieldName": "CREATED_DATE_" }, { "fieldType": "TIMESTAMP", "fieldName": "MODIFIED_DATE_" } ], "suppData": { "objectName": "asupp2", "folderName": "abhaytest" } } ]