Table
Overview
The Table endpoint is used to request information about the tables in your database.
Note: You can't create a new table, or modify an existing table, through this API endpoint. To create or modify a table, you'll need to use the Tables screen within the application.
Endpoint (North America): https://api.eccmp.com/services2/api/Table
Endpoint (Europe): https://api.ccmp.eu/services2/api/Table
Endpoint (Japan): https://api.marketingsuite.jp/services2/api/Table
For more details on how to set up a Table API request, please see the Table API Technical Guide.
GET Method
The Table endpoint supports the following GET operations. These operations are intended to retrieve information about the tables in your Messaging database.
Retrieve a Table -- via Object Reference ID
This endpoint allows you to search for and retrieve a list of all the fields in a table, by providing the table's Object Reference ID.
Click hereClick here to see a sample response message in JSON format.
[
{
"viewId": 2196,
"entityId": 305,
"displayName": "Prefix",
"propId": 17438,
"columnName": "prefix"
},
{
"viewId": 2196,
"entityId": 305,
"displayName": "Ship Date",
"propId": 17442,
"columnName": "ship_date"
},
{
"viewId": 2196,
"entityId": 305,
"displayName": "AccNo",
"displaySequence": 1,
"propId": 12467,
"columnName": "ac"
},
{
"viewId": 2196,
"entityId": 305,
"displayName": "Email",
"displaySequence": 2,
"propId": 14875,
"columnName": "email"
},
{
"viewId": 2196,
"entityId": 305,
"displayName": "ak_recipient",
"displaySequence": 3,
"propId": 12465,
"columnName": "ak_recipient"
},
{
"viewId": 2196,
"entityId": 305,
"displayName": "pk_recipient_id",
"displaySequence": 4,
"propId": 12464,
"columnName": "pk_recipient_id"
},
{
"viewId": 2196,
"entityId": 305,
"displayName": "Phone 64207 - CNV Shared Short Code (29) Status ID",
"displaySequence": 5,
"propId": 12470,
"columnName": "phone_sp29_status_id"
},
{
"viewId": 2196,
"entityId": 305,
"displayName": "Order Date",
"displaySequence": 6,
"propId": 17443,
"columnName": "order_date"
},
{
"viewId": 2196,
"entityId": 305,
"displayName": "Date of Birth",
"displaySequence": 7,
"propId": 17441,
"columnName": "date_of_birth"
},
{
"viewId": 2196,
"entityId": 305,
"displayName": "Score",
"displaySequence": 8,
"propId": 17439,
"columnName": "score"
},
{
"viewId": 2196,
"entityId": 305,
"displayName": "Phone",
"displaySequence": 9,
"propId": 17440,
"columnName": "phone"
},
{
"viewId": 2196,
"entityId": 305,
"displayName": "Gender",
"displaySequence": 10,
"propId": 17437,
"columnName": "gender"
},
{
"viewId": 2196,
"entityId": 305,
"displayName": "Order Join",
"displaySequence": 11,
"propId": 18473,
"columnName": "order_join"
}
]
Retrieve a Table -- via Table Name
This endpoint is the same as the one described above, except you must provide the full, exact Table Name for the table you want to retrieve, instead of the Object Reference ID. You must use the reader-friendly name of the table, as its displayed within the user interface, and not the system name for the table. For example, let's say you have a table with a display name of "Order Item Table." By default, the platform will automatically generate the system name for this table as "order_item_table." When you're submitting a request message using this GET method, you must use the display name: "Order Item Table."
Retrieve All Tables
This endpoint allows you to retrieve a list of all the tables in your database.
Click hereClick here to see a sample response message in JSON format.
[
{
"viewId": 2444,
"viewName": "Order",
"entityId": 551,
"tableName": "order"
},
{
"viewId": 2445,
"viewName": "Order_Item",
"entityId": 552,
"tableName": "order_item"
},
{
"viewId": 2380,
"viewName": "Recipient",
"entityId": 489,
"tableName": "recipient"
}
]
Back to API Category - Data Management