{"id":3731,"date":"2023-08-31T07:15:00","date_gmt":"2023-08-31T06:15:00","guid":{"rendered":"https:\/\/help.expertsender.com\/?post_type=es&p=3731"},"modified":"2024-03-19T13:24:29","modified_gmt":"2024-03-19T12:24:29","slug":"get-list-of-tables","status":"publish","type":"es","link":"https:\/\/help.expertsender.com\/pl\/emp\/api\/methods\/data-tables\/get-list-of-tables\/","title":{"rendered":"Get list of tables"},"content":{"rendered":"\n

Request data format<\/strong><\/h3>\n\n\n\n

Request URL parameters:<\/p>\n\n\n\n

Parameter<\/th>Type<\/th>Notes<\/th><\/tr><\/thead>
apiKey<\/td>string<\/td>Your API key, required for authentication. Required.<\/td><\/tr>
name<\/td>string<\/td>Name of Data Table. Optional.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

Examples:<\/p>\n\n\n\n

<\/path><\/path><\/svg><\/span>
https:\/\/api.esv2.com\/v2\/Api\/DataTablesGetTables?apiKey=YOUR_API_KEY_HERE<\/span><\/span>\n<\/span>\nhttps:\/\/api.esv2.com\/v2\/Api\/DataTablesGetTables?apiKey=YOUR_API_KEY_HERE&name=TABLE_NAME<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
Response<\/strong><\/h3>\n\n\n\n
Response Table element (if request doesn’t contain name):<\/p>\n\n\n\n
Element\/attribute<\/th>Type<\/th>Notes<\/th><\/tr><\/thead>
Id<\/td>int<\/td>Table ID.<\/td><\/tr>
Name<\/td>string<\/td>Table name.<\/td><\/tr>
ColumnsCount<\/td>int<\/td>Number of columns in table.<\/td><\/tr>
RelationshipsCount<\/td>int<\/td>Number of relationships.<\/td><\/tr>
RelationshipsDestinationCount<\/td>int<\/td>Number of relationships with other table.<\/td><\/tr>
Rows<\/td>int<\/td>Number of rows in table.<\/td><\/tr>
Size<\/td>int<\/td>Size of table in megabytes.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Examples:<\/p>\n\n\n\n
<\/path><\/path><\/svg><\/span>
HTTP\/1.1 200 OK<\/span><\/span>\nCache-Control: private<\/span><\/span>\nContent-Type: text\/xml; charset=utf-8<\/span><\/span>\nServer: Microsoft-IIS\/7.5<\/span><\/span>\nX-AspNetMvc-Version: 3.0<\/span><\/span>\nX-AspNet-Version: 4.0.30319<\/span><\/span>\nX-Powered-By: ASP.NET<\/span><\/span>\nDate: Mon, 10 Jun 2013 16:02:49 GMT<\/span><\/span>\nContent-Length: 320<\/span><\/span>\n<\/span>\n<<\/span>ApiResponse<\/span> <\/span>xmlns<\/span>:<\/span>xsd<\/span>=<\/span>"<\/span>http:\/\/www.w3.org\/2001\/XMLSchema<\/span>"<\/span> <\/span>xmlns<\/span>:<\/span>xsi<\/span>=<\/span>"<\/span>http:\/\/www.w3.org\/2001\/XMLSchema-instance<\/span>"<\/span>><\/span><\/span>\n   <\/span><<\/span>TableList<\/span>><\/span><\/span>\n      <\/span><<\/span>Tables<\/span>><\/span><\/span>\n         <\/span><<\/span>Table<\/span>><\/span><\/span>\n            <\/span><<\/span>Id<\/span>><\/span>1<\/span><\/<\/span>Id<\/span>><\/span><\/span>\n            <\/span><<\/span>Name<\/span>><\/span>Table1<\/span><\/<\/span>Name<\/span>><\/span><\/span>\n            <\/span><<\/span>ColumnsCount<\/span>><\/span>8<\/span><\/<\/span>ColumnsCount<\/span>><\/span><\/span>\n            <\/span><<\/span>RelationshipsCount<\/span>><\/span>0<\/span><\/<\/span>RelationshipsCount<\/span>><\/span><\/span>\n            <\/span><<\/span>RelationshipsDestinationCount<\/span>><\/span>1<\/span><\/<\/span>RelationshipsDestinationCount<\/span>><\/span><\/span>\n            <\/span><<\/span>Rows<\/span>><\/span>5<\/span><\/<\/span>Rows<\/span>><\/span><\/span>\n            <\/span><<\/span>Size<\/span>><\/span>0.05<\/span><\/<\/span>Size<\/span>><\/span><\/span>\n         <\/span><\/<\/span>Table<\/span>><\/span><\/span>\n      <\/span><\/<\/span>Tables<\/span>><\/span><\/span>\n   <\/span><\/<\/span>TableList<\/span>><\/span><\/span>\n<\/<\/span>ApiResponse<\/span>><\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
Response Details element (if request contain name):<\/p>\n\n\n\n
Element\/attribute<\/th>Type<\/th>Notes<\/th><\/tr><\/thead>
Id<\/td>int<\/td>Table ID.<\/td><\/tr>
Name<\/td>string<\/td>Table name.<\/td><\/tr>
ColumnsCount<\/td>int<\/td>Number of columns in table.<\/td><\/tr>
RelationshipsCount<\/td>int<\/td>Number of relationships.<\/td><\/tr>
RelationshipsDestinationCount<\/td>int<\/td>Number of relationships with other table.<\/td><\/tr>
Rows<\/td>int<\/td>Number of rows in table.<\/td><\/tr>
Columns<\/td>complex<\/td>Collection of columns information in table (TableColumn elements).<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
TableColumn (children of Columns element) element children:<\/p>\n\n\n\n
Element\/attribute<\/th>Type<\/th>Notes<\/th><\/tr><\/thead>
Name<\/td>string<\/td>Column name.<\/td><\/tr>
ColumnsType<\/td>string<\/td>Type of column.<\/td><\/tr>
Length<\/td>int<\/td>Length for string type columns.<\/td><\/tr>
DefaultValue<\/td>string<\/td>Default value. Omitted if column has no default value.<\/td><\/tr>
IsPrimaryKey<\/td>boolean<\/td>“true” if column is a part of primary key (PK). Omitted if not.<\/td><\/tr>
IsRequired<\/td>boolean<\/td>“true” if column is required. Omitted if not. <\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Examples:<\/p>\n\n\n\n
<\/path><\/path><\/svg><\/span>
HTTP\/1.1 200 OK<\/span><\/span>\nCache-Control: private<\/span><\/span>\nContent-Type: text\/xml; charset=utf-8<\/span><\/span>\nServer: Microsoft-IIS\/7.5<\/span><\/span>\nX-AspNetMvc-Version: 3.0<\/span><\/span>\nX-AspNet-Version: 4.0.30319<\/span><\/span>\nX-Powered-By: ASP.NET<\/span><\/span>\nDate: Mon, 10 Jun 2013 16:01:58 GMT<\/span><\/span>\nContent-Length: 1826<\/span><\/span>\n<\/span>\n<<\/span>ApiResponse<\/span> <\/span>xmlns<\/span>:<\/span>xsd<\/span>=<\/span>"<\/span>http:\/\/www.w3.org\/2001\/XMLSchema<\/span>"<\/span> <\/span>xmlns<\/span>:<\/span>xsi<\/span>=<\/span>"<\/span>http:\/\/www.w3.org\/2001\/XMLSchema-instance<\/span>"<\/span>><\/span><\/span>\n  <\/span><<\/span>Details<\/span>><\/span><\/span>\n     <\/span><<\/span>Id<\/span>><\/span>1<\/span><\/<\/span>Id<\/span>><\/span><\/span>\n     <\/span><<\/span>Name<\/span>><\/span>Table1<\/span><\/<\/span>Name<\/span>><\/span><\/span>\n     <\/span><<\/span>ColumnsCount<\/span>><\/span>0<\/span><\/<\/span>ColumnsCount<\/span>><\/span><\/span>\n     <\/span><<\/span>RelationshipsCount<\/span>><\/span>0<\/span><\/<\/span>RelationshipsCount<\/span>><\/span><\/span>\n     <\/span><<\/span>RelationshipsDestinationCount<\/span>><\/span>0<\/span><\/<\/span>RelationshipsDestinationCount<\/span>><\/span><\/span>\n     <\/span><<\/span>Rows<\/span>><\/span>0<\/span><\/<\/span>Rows<\/span>><\/span><\/span>\n     <\/span><<\/span>Description<\/span>><\/span>Table1 description<\/span><\/<\/span>Description<\/span>><\/span><\/span>\n     <\/span><<\/span>Columns<\/span>><\/span><\/span>\n        <\/span><<\/span>TableColumn<\/span>><\/span><\/span>\n           <\/span><<\/span>Name<\/span>><\/span>Column1<\/span><\/<\/span>Name<\/span>><\/span><\/span>\n           <\/span><<\/span>ColumnType<\/span>><\/span>String<\/span><\/<\/span>ColumnType<\/span>><\/span><\/span>\n           <\/span><<\/span>Length<\/span>><\/span>4000<\/span><\/<\/span>Length<\/span>><\/span><\/span>\n           <\/span><<\/span>DefaultValue<\/span>><\/span>test<\/span><\/<\/span>DefaultValue<\/span>><\/span><\/span>\n           <\/span><<\/span>IsPrimaryKey<\/span>><\/span>true<\/span><\/<\/span>IsPrimaryKey<\/span>><\/span><\/span>\n        <\/span><\/<\/span>TableColumn<\/span>><\/span><\/span>\n        <\/span><<\/span>TableColumn<\/span>><\/span><\/span>\n           <\/span><<\/span>Name<\/span>><\/span>Column2<\/span><\/<\/span>Name<\/span>><\/span><\/span>\n           <\/span><<\/span>ColumnType<\/span>><\/span>Number<\/span><\/<\/span>ColumnType<\/span>><\/span><\/span>\n           <\/span><<\/span>Length<\/span>><\/span>0<\/span><\/<\/span>Length<\/span>><\/span><\/span>\n           <\/span><<\/span>IsRequired<\/span>><\/span>true<\/span><\/<\/span>IsRequired<\/span>><\/span><\/span>\n        <\/span><\/<\/span>TableColumn<\/span>><\/span><\/span>\n        <\/span><<\/span>TableColumn<\/span>><\/span><\/span>\n           <\/span><<\/span>Name<\/span>><\/span>Column3<\/span><\/<\/span>Name<\/span>><\/span><\/span>\n           <\/span><<\/span>ColumnType<\/span>><\/span>Number<\/span><\/<\/span>ColumnType<\/span>><\/span><\/span>\n           <\/span><<\/span>Length<\/span>><\/span>0<\/span><\/<\/span>Length<\/span>><\/span><\/span>\n        <\/span><\/<\/span>TableColumn<\/span>><\/span><\/span>\n        <\/span><<\/span>TableColumn<\/span>><\/span><\/span>\n           <\/span><<\/span>Name<\/span>><\/span>Column4<\/span><\/<\/span>Name<\/span>><\/span><\/span>\n           <\/span><<\/span>ColumnType<\/span>><\/span>Date<\/span><\/<\/span>ColumnType<\/span>><\/span><\/span>\n           <\/span><<\/span>Length<\/span>><\/span>0<\/span><\/<\/span>Length<\/span>><\/span><\/span>\n           <\/span><<\/span>DefaultValue<\/span>><\/span>2012-11-20<\/span><\/<\/span>DefaultValue<\/span>><\/span><\/span>\n        <\/span><\/<\/span>TableColumn<\/span>><\/span><\/span>\n        <\/span><<\/span>TableColumn<\/span>><\/span><\/span>\n           <\/span><<\/span>Name<\/span>><\/span>Column5<\/span><\/<\/span>Name<\/span>><\/span><\/span>\n           <\/span><<\/span>ColumnType<\/span>><\/span>DateTime<\/span><\/<\/span>ColumnType<\/span>><\/span><\/span>\n           <\/span><<\/span>Length<\/span>><\/span>0<\/span><\/<\/span>Length<\/span>><\/span><\/span>\n           <\/span><<\/span>DefaultValue<\/span>><\/span>2012-11-20 11:08:33.565<\/span><\/<\/span>DefaultValue<\/span>><\/span><\/span>\n        <\/span><\/<\/span>TableColumn<\/span>><\/span><\/span>\n        <\/span><<\/span>TableColumn<\/span>><\/span><\/span>\n           <\/span><<\/span>Name<\/span>><\/span>Column6<\/span><\/<\/span>Name<\/span>><\/span><\/span>\n           <\/span><<\/span>ColumnType<\/span>><\/span>Boolean<\/span><\/<\/span>ColumnType<\/span>><\/span><\/span>\n           <\/span><<\/span>Length<\/span>><\/span>0<\/span><\/<\/span>Length<\/span>><\/span><\/span>\n           <\/span><<\/span>DefaultValue<\/span>><\/span>False<\/span><\/<\/span>DefaultValue<\/span>><\/span><\/span>\n        <\/span><\/<\/span>TableColumn<\/span>><\/span><\/span>\n        <\/span><<\/span>TableColumn<\/span>><\/span><\/span>\n           <\/span><<\/span>Name<\/span>><\/span>Column7<\/span><\/<\/span>Name<\/span>><\/span><\/span>\n           <\/span><<\/span>ColumnType<\/span>><\/span>Double<\/span><\/<\/span>ColumnType<\/span>><\/span><\/span>\n           <\/span><<\/span>Length<\/span>><\/span>0<\/span><\/<\/span>Length<\/span>><\/span><\/span>\n        <\/span><\/<\/span>TableColumn<\/span>><\/span><\/span>\n        <\/span><<\/span>TableColumn<\/span>><\/span><\/span>\n           <\/span><<\/span>Name<\/span>><\/span>Column8<\/span><\/<\/span>Name<\/span>><\/span><\/span>\n           <\/span><<\/span>ColumnType<\/span>><\/span>SubscriberEmail<\/span><\/<\/span>ColumnType<\/span>><\/span><\/span>\n           <\/span><<\/span>Length<\/span>><\/span>0<\/span><\/<\/span>Length<\/span>><\/span><\/span>\n        <\/span><\/<\/span>TableColumn<\/span>><\/span><\/span>\n     <\/span><\/<\/span>Columns<\/span>><\/span><\/span>\n  <\/span><\/<\/span>Details<\/span>><\/span><\/span>\n<\/<\/span>ApiResponse<\/span>><\/span><\/span><\/code><\/pre><\/div>\n","protected":false},"author":5,"featured_media":0,"parent":3729,"menu_order":272,"template":"","format":"standard","emp-category":[],"class_list":["post-3731","es","type-es","status-publish","format-standard","hentry"],"acf":[],"_links":{"self":[{"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/3731","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es"}],"about":[{"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/types\/es"}],"author":[{"embeddable":true,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/users\/5"}],"version-history":[{"count":2,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/3731\/revisions"}],"predecessor-version":[{"id":8844,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/3731\/revisions\/8844"}],"up":[{"embeddable":true,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/3729"}],"wp:attachment":[{"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/media?parent=3731"}],"wp:term":[{"taxonomy":"emp-category","embeddable":true,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/emp-category?post=3731"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}