Retrieve all supplemental tables

Use this interface to get all supplemental table data for your account.

Service URL:

/rest/api/v1.3/suppData

Request Method:

GET

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)

Request Header:

Authorization=<AUTH_TOKEN>

Content-Type=application/json

Sample Request Body:

Not applicable

Sample Response in case of success:

RESPONSE NOTES:

  • The system returns an array of suppData objects. These objects contain the data for the supplemental table:
    • objectName: Name of the supplemental table
    • folderName: Name of the folder containing the supplemental table
    • fields: An array containing the supplemental table’s field properties. Key-value pairs are fieldname and fieldType (data type of the field).
  • 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.
[
    {
        "suppData": {
            "objectName": "MY_SUPPLEMENTAL",
            "folderName": "myExample"
        },
        "fields": [
            {
                "fieldName": "EMAIL_ADDRESS",
                "fieldType": "STR500"
            },
            {
                "fieldName": "AGE",
                "fieldType": "NUMBER"
            },
            {
                "fieldName": "ARRIVAL",
                "fieldType": "TIMESTAMP"
            },
            {
                "fieldName": "DEPARTURE",
                "fieldType": "TIMESTAMP"
            },
            {
                "fieldName": "CITY",
                "fieldType": "STR25"
            },
            {
                "fieldName": "STATE",
                "fieldType": "STR25"
            },
            {
                "fieldName": "EVENT",
                "fieldType": "STR25"
            },
            {
                "fieldName": "EVENT_ID",
                "fieldType": "INTEGER"
            },
            {
                "fieldName": "CREATED_DATE_",
                "fieldType": "TIMESTAMP"
            },
            {
                "fieldName": "MODIFIED_DATE_",
                "fieldType": "TIMESTAMP"
            }
        ]
    },
    {
        "suppData": {
            "objectName": "jmp supp table",
            "folderName": "JMP test"
        },
        "fields": [
            {
                "fieldName": "ANIMAL",
                "fieldType": "STR25"
            },
            {
                "fieldName": "VEGETABLE",
                "fieldType": "STR100"
            },
            {
                "fieldName": "MINERAL",
                "fieldType": "STR25"
            },
            {
                "fieldName": "NUMERAL",
                "fieldType": "INTEGER"
            },
            {
                "fieldName": "CREATED_DATE_",
                "fieldType": "TIMESTAMP"
            },
            {
                "fieldName": "MODIFIED_DATE_",
                "fieldType": "TIMESTAMP"
            }
        ]
    },
    {
        "suppData": {
            "objectName": "example_supp",
            "folderName": "ExampleFolder"
        },
        "fields": [
            {
                "fieldName": "ORDER_ID",
                "fieldType": "NUMBER"
            },
            {
                "fieldName": "PRICE",
                "fieldType": "NUMBER"
            },
            {
                "fieldName": "RIID_",
                "fieldType": "NUMBER"
            },
            {
                "fieldName": "CREATED_DATE_",
                "fieldType": "TIMESTAMP"
            },
            {
                "fieldName": "MODIFIED_DATE_",
                "fieldType": "TIMESTAMP"
            }
        ]
    }  
]