SeaTable\Client\TablesApi¶
All URIs are relative to https://cloud.seatable.io, except if the operation defines another base path.
Method | HTTP request | Description |
---|---|---|
createTable() | POST /dtable-server/api/v1/dtables/{base_uuid}/tables/ | Create Table |
deleteTable() | DELETE /dtable-server/api/v1/dtables/{base_uuid}/tables/ | Delete Table |
duplicateTable() | POST /dtable-server/api/v1/dtables/{base_uuid}/tables/duplicate-table/ | Duplicate Table |
renameTable() | PUT /dtable-server/api/v1/dtables/{base_uuid}/tables/ | Rename Table |
createTable()
¶
Create Table
Creates a new table in a base. Optionally, you can already add some columns to the base. > 📘 The first column is special > > Please be aware, that the first column can only be the column type text
, number
, date
, single select
, formula
and autonumber
.
Example¶
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure Bearer authorization: BaseTokenAuth (use the right token for your request)
$config = SeaTable\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_TOKEN');
$apiInstance = new SeaTable\Client\Base\TablesApi(
new GuzzleHttp\Client(),
$config
);
$base_uuid = 5c264e76-0e5a-448a-9f34-580b551364ca; // string | The unique identifier of a base. Sometimes also called dtable_uuid.
$create_table_request = new \SeaTable\Client\Base\CreateTableRequest(); // \SeaTable\Client\Base\CreateTableRequest
try {
$result = $apiInstance->createTable($base_uuid, $create_table_request);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling TablesApi->createTable: ', $e->getMessage(), PHP_EOL;
}
Parameters¶
Name | Type | Description | Notes |
---|---|---|---|
base_uuid | string | The unique identifier of a base. Sometimes also called dtable_uuid. | |
create_table_request | \SeaTable\Client\Base\CreateTableRequest | [optional] |
Return type¶
Authorization¶
BaseTokenAuth
deleteTable()
¶
Delete Table
Delete an existing table identified by its name.
Example¶
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure Bearer authorization: BaseTokenAuth (use the right token for your request)
$config = SeaTable\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_TOKEN');
$apiInstance = new SeaTable\Client\Base\TablesApi(
new GuzzleHttp\Client(),
$config
);
$base_uuid = 5c264e76-0e5a-448a-9f34-580b551364ca; // string | The unique identifier of a base. Sometimes also called dtable_uuid.
$delete_table = new \SeaTable\Client\Base\DeleteTable(); // \SeaTable\Client\Base\DeleteTable
try {
$result = $apiInstance->deleteTable($base_uuid, $delete_table);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling TablesApi->deleteTable: ', $e->getMessage(), PHP_EOL;
}
Parameters¶
Name | Type | Description | Notes |
---|---|---|---|
base_uuid | string | The unique identifier of a base. Sometimes also called dtable_uuid. | |
delete_table | \SeaTable\Client\Base\DeleteTable | [optional] |
Return type¶
object
Authorization¶
BaseTokenAuth
duplicateTable()
¶
Duplicate Table
Duplicate an existing table in your base with or without the existing data in it. > 🚧 Rename the table in a second step > > If you duplicate one table, the name of this new table will always be the same like the original one plus the appendix (copy). To rename the table, you will need another call.
Example¶
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure Bearer authorization: BaseTokenAuth (use the right token for your request)
$config = SeaTable\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_TOKEN');
$apiInstance = new SeaTable\Client\Base\TablesApi(
new GuzzleHttp\Client(),
$config
);
$base_uuid = 5c264e76-0e5a-448a-9f34-580b551364ca; // string | The unique identifier of a base. Sometimes also called dtable_uuid.
$duplicate_table = new \SeaTable\Client\Base\DuplicateTable(); // \SeaTable\Client\Base\DuplicateTable
try {
$result = $apiInstance->duplicateTable($base_uuid, $duplicate_table);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling TablesApi->duplicateTable: ', $e->getMessage(), PHP_EOL;
}
Parameters¶
Name | Type | Description | Notes |
---|---|---|---|
base_uuid | string | The unique identifier of a base. Sometimes also called dtable_uuid. | |
duplicate_table | \SeaTable\Client\Base\DuplicateTable | [optional] |
Return type¶
object
Authorization¶
BaseTokenAuth
renameTable()
¶
Rename Table
Rename a table by providing it's original table_name
and the desired new_table_name
.
Example¶
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure Bearer authorization: BaseTokenAuth (use the right token for your request)
$config = SeaTable\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_TOKEN');
$apiInstance = new SeaTable\Client\Base\TablesApi(
new GuzzleHttp\Client(),
$config
);
$base_uuid = 5c264e76-0e5a-448a-9f34-580b551364ca; // string | The unique identifier of a base. Sometimes also called dtable_uuid.
$rename_table = new \SeaTable\Client\Base\RenameTable(); // \SeaTable\Client\Base\RenameTable
try {
$result = $apiInstance->renameTable($base_uuid, $rename_table);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling TablesApi->renameTable: ', $e->getMessage(), PHP_EOL;
}
Parameters¶
Name | Type | Description | Notes |
---|---|---|---|
base_uuid | string | The unique identifier of a base. Sometimes also called dtable_uuid. | |
rename_table | \SeaTable\Client\Base\RenameTable | [optional] |
Return type¶
object
Authorization¶
BaseTokenAuth