SeaTable\Client\BasesApi¶

basePassword($workspace_id, $base_name, $base_password_request): object

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer authorization: AccountTokenAuth (use the right token for your request)
$config = SeaTable\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_TOKEN');

$apiInstance = new SeaTable\Client\User\BasesApi(
    new GuzzleHttp\Client(),
    $config
);
$workspace_id = 127; // int | id of your workspace.
$base_name = My Projects; // string | name of your base.
$base_password_request = new \SeaTable\Client\User\BasePasswordRequest(); // \SeaTable\Client\User\BasePasswordRequest

try {
    $result = $apiInstance->basePassword($workspace_id, $base_name, $base_password_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BasesApi->basePassword: ', $e->getMessage(), PHP_EOL;
}

clearTrash(): object

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer authorization: AccountTokenAuth (use the right token for your request)
$config = SeaTable\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_TOKEN');

$apiInstance = new SeaTable\Client\User\BasesApi(
    new GuzzleHttp\Client(),
    $config
);

try {
    $result = $apiInstance->clearTrash();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BasesApi->clearTrash: ', $e->getMessage(), PHP_EOL;
}

createBase($name, $workspace_id, $icon, $color): object

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer authorization: AccountTokenAuth (use the right token for your request)
$config = SeaTable\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_TOKEN');

$apiInstance = new SeaTable\Client\User\BasesApi(
    new GuzzleHttp\Client(),
    $config
);
$name = 'name_example'; // string
$workspace_id = 'workspace_id_example'; // string | The workspace ID where your base is.
$icon = 'icon_example'; // string | The icon of the base. Optional. Refer to [\\\"Create A Base\\\"](/reference/post_api-v2-1-dtables) for the list of available icons.
$color = 'color_example'; // string | The icon color of the base. Optional. Refer to [\\\"Create A Base\\\"](/reference/post_api-v2-1-dtables) for the list of available icon colors.

try {
    $result = $apiInstance->createBase($name, $workspace_id, $icon, $color);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BasesApi->createBase: ', $e->getMessage(), PHP_EOL;
}

createFolder($workspace_id, $name): object

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer authorization: AccountTokenAuth (use the right token for your request)
$config = SeaTable\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_TOKEN');

$apiInstance = new SeaTable\Client\User\BasesApi(
    new GuzzleHttp\Client(),
    $config
);
$workspace_id = 127; // int | id of your workspace.
$name = 'name_example'; // string | Name of your folder. If the name already exists in the workspace, the system will add a \\\"(1)\\\" to it.

try {
    $result = $apiInstance->createFolder($workspace_id, $name);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BasesApi->createFolder: ', $e->getMessage(), PHP_EOL;
}

deleteBase($workspace_id): object

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer authorization: AccountTokenAuth (use the right token for your request)
$config = SeaTable\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_TOKEN');

$apiInstance = new SeaTable\Client\User\BasesApi(
    new GuzzleHttp\Client(),
    $config
);
$workspace_id = 127; // int | id of your workspace.

try {
    $result = $apiInstance->deleteBase($workspace_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BasesApi->deleteBase: ', $e->getMessage(), PHP_EOL;
}

deleteFolder($workspace_id, $folder_id): object

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer authorization: AccountTokenAuth (use the right token for your request)
$config = SeaTable\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_TOKEN');

$apiInstance = new SeaTable\Client\User\BasesApi(
    new GuzzleHttp\Client(),
    $config
);
$workspace_id = 127; // int | id of your workspace.
$folder_id = 'folder_id_example'; // string

try {
    $result = $apiInstance->deleteFolder($workspace_id, $folder_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BasesApi->deleteFolder: ', $e->getMessage(), PHP_EOL;
}

favoriteBase($dtable_uuid): object

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer authorization: AccountTokenAuth (use the right token for your request)
$config = SeaTable\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_TOKEN');

$apiInstance = new SeaTable\Client\User\BasesApi(
    new GuzzleHttp\Client(),
    $config
);
$dtable_uuid = 'dtable_uuid_example'; // string | The UUID of the base.

try {
    $result = $apiInstance->favoriteBase($dtable_uuid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BasesApi->favoriteBase: ', $e->getMessage(), PHP_EOL;
}

listBases(): object

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer authorization: AccountTokenAuth (use the right token for your request)
$config = SeaTable\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_TOKEN');

$apiInstance = new SeaTable\Client\User\BasesApi(
    new GuzzleHttp\Client(),
    $config
);

try {
    $result = $apiInstance->listBases();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BasesApi->listBases: ', $e->getMessage(), PHP_EOL;
}

listFavorites(): object

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer authorization: AccountTokenAuth (use the right token for your request)
$config = SeaTable\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_TOKEN');

$apiInstance = new SeaTable\Client\User\BasesApi(
    new GuzzleHttp\Client(),
    $config
);

try {
    $result = $apiInstance->listFavorites();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BasesApi->listFavorites: ', $e->getMessage(), PHP_EOL;
}

listGroupTrashedBases($group_id): object

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer authorization: AccountTokenAuth (use the right token for your request)
$config = SeaTable\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_TOKEN');

$apiInstance = new SeaTable\Client\User\BasesApi(
    new GuzzleHttp\Client(),
    $config
);
$group_id = 1; // int

try {
    $result = $apiInstance->listGroupTrashedBases($group_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BasesApi->listGroupTrashedBases: ', $e->getMessage(), PHP_EOL;
}

listTrashedBases($page, $per_page): object

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer authorization: AccountTokenAuth (use the right token for your request)
$config = SeaTable\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_TOKEN');

$apiInstance = new SeaTable\Client\User\BasesApi(
    new GuzzleHttp\Client(),
    $config
);
$page = 1; // int
$per_page = 2; // int

try {
    $result = $apiInstance->listTrashedBases($page, $per_page);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BasesApi->listTrashedBases: ', $e->getMessage(), PHP_EOL;
}

moveBaseIntoFolder($workspace_id, $item_type, $item_id, $from, $to): object

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer authorization: AccountTokenAuth (use the right token for your request)
$config = SeaTable\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_TOKEN');

$apiInstance = new SeaTable\Client\User\BasesApi(
    new GuzzleHttp\Client(),
    $config
);
$workspace_id = 127; // int | id of your workspace.
$item_type = 'item_type_example'; // string | Required.
$item_id = 'item_id_example'; // string | When moving a base, use its `UUID`. Required.
$from = 'from_example'; // string | From which folder are you moving the base out of? If from the root, use '/'. Otherwise use a `folder_id`. Required.
$to = 'to_example'; // string | The ID of the target folder. Required.

try {
    $result = $apiInstance->moveBaseIntoFolder($workspace_id, $item_type, $item_id, $from, $to);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BasesApi->moveBaseIntoFolder: ', $e->getMessage(), PHP_EOL;
}

restoreGroupTrashedBase($group_id, $base_uuid): object

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer authorization: AccountTokenAuth (use the right token for your request)
$config = SeaTable\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_TOKEN');

$apiInstance = new SeaTable\Client\User\BasesApi(
    new GuzzleHttp\Client(),
    $config
);
$group_id = 1; // int
$base_uuid = 5c264e76-0e5a-448a-9f34-580b551364ca; // string | The unique identifier of a base. Sometimes also called dtable_uuid.

try {
    $result = $apiInstance->restoreGroupTrashedBase($group_id, $base_uuid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BasesApi->restoreGroupTrashedBase: ', $e->getMessage(), PHP_EOL;
}

restoreTrashedBase($trashed_base_id): object

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer authorization: AccountTokenAuth (use the right token for your request)
$config = SeaTable\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_TOKEN');

$apiInstance = new SeaTable\Client\User\BasesApi(
    new GuzzleHttp\Client(),
    $config
);
$trashed_base_id = 497; // int | The ID of the trashed base.

try {
    $result = $apiInstance->restoreTrashedBase($trashed_base_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BasesApi->restoreTrashedBase: ', $e->getMessage(), PHP_EOL;
}

searchBaseOrApps($query_str, $query_type): object

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer authorization: AccountTokenAuth (use the right token for your request)
$config = SeaTable\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_TOKEN');

$apiInstance = new SeaTable\Client\User\BasesApi(
    new GuzzleHttp\Client(),
    $config
);
$query_str = test; // string | Search string. Substrings are allowed and capitalization does not matter.
$query_type = 'query_type_example'; // string

try {
    $result = $apiInstance->searchBaseOrApps($query_str, $query_type);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BasesApi->searchBaseOrApps: ', $e->getMessage(), PHP_EOL;
}

unfavoriteBase($dtable_uuid): object

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer authorization: AccountTokenAuth (use the right token for your request)
$config = SeaTable\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_TOKEN');

$apiInstance = new SeaTable\Client\User\BasesApi(
    new GuzzleHttp\Client(),
    $config
);
$dtable_uuid = 5c264e76-0e5a-448a-9f34-580b551364ca; // string | The unique identifier of a base. Sometimes also called dtable_uuid.

try {
    $result = $apiInstance->unfavoriteBase($dtable_uuid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BasesApi->unfavoriteBase: ', $e->getMessage(), PHP_EOL;
}

updateBase($workspace_id, $name, $new_name, $icon, $color): object

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer authorization: AccountTokenAuth (use the right token for your request)
$config = SeaTable\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_TOKEN');

$apiInstance = new SeaTable\Client\User\BasesApi(
    new GuzzleHttp\Client(),
    $config
);
$workspace_id = 127; // int | id of your workspace.
$name = 'name_example'; // string | The old name of the base. Required.
$new_name = 'new_name_example'; // string | The new name of the base. Optional.
$icon = 'icon_example'; // string | The icon of the base. Optional. Refer to [\\\"Create A Base\\\"](/reference/post_api-v2-1-dtables) for the list of available icons.
$color = 'color_example'; // string | The icon color of the base. Optional. Refer to [\\\"Create A Base\\\"](/reference/post_api-v2-1-dtables) for the list of available icon colors.

try {
    $result = $apiInstance->updateBase($workspace_id, $name, $new_name, $icon, $color);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BasesApi->updateBase: ', $e->getMessage(), PHP_EOL;
}

updateFolder($workspace_id, $folder_id, $name): object

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer authorization: AccountTokenAuth (use the right token for your request)
$config = SeaTable\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_TOKEN');

$apiInstance = new SeaTable\Client\User\BasesApi(
    new GuzzleHttp\Client(),
    $config
);
$workspace_id = 127; // int | id of your workspace.
$folder_id = 'folder_id_example'; // string
$name = 'name_example'; // string | Name of your folder. If the name already exists in the workspace, the system will add a \\\"(1)\\\" to it.

try {
    $result = $apiInstance->updateFolder($workspace_id, $folder_id, $name);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BasesApi->updateFolder: ', $e->getMessage(), PHP_EOL;
}