md-docs/FavoritesApi.md

In TileDB-Inc/TileDB-Cloud-R: TileDB Cloud Platform R Client Package

FavoritesApi

All URIs are relative to http://localhost/v1

Method | HTTP request | Description ------------- | ------------- | ------------- DeleteFavoriteId | DELETE /favorites/{id} | GetFavorite | GET /favorites/{id} | GetFavorites | GET /favorites | PostFavorite | POST /favorites |

DeleteFavoriteId

DeleteFavoriteId(id)

Delete specific favorite

Example

library(tiledbcloud)

var.id <- 'id_example' # character | The uuid of the favorite

api.instance <- FavoritesApi$new()
# Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';
# Configure HTTP basic authorization: BasicAuth
api.instance$apiClient$username <- 'TODO_YOUR_USERNAME';
api.instance$apiClient$password <- 'TODO_YOUR_PASSWORD';
api.instance$DeleteFavoriteId(var.id)

Parameters

Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- id | character| The uuid of the favorite |

Return type

void (empty response body)

Authorization

ApiKeyAuth, BasicAuth

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

HTTP response details

| Status code | Description | Response headers | |-------------|-------------|------------------| | 200 | OK | - |

GetFavorite

Favorite GetFavorite(id)

Fetch specific favorite of a user

Example

library(tiledbcloud)

var.id <- 'id_example' # character | The uuid of the favorite

api.instance <- FavoritesApi$new()
# Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';
# Configure HTTP basic authorization: BasicAuth
api.instance$apiClient$username <- 'TODO_YOUR_USERNAME';
api.instance$apiClient$password <- 'TODO_YOUR_PASSWORD';
result <- api.instance$GetFavorite(var.id)
dput(result)

Parameters

Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- id | character| The uuid of the favorite |

Return type

Favorite

Authorization

ApiKeyAuth, BasicAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

| Status code | Description | Response headers | |-------------|-------------|------------------| | 200 | OK | - |

GetFavorites

array[Favorite] GetFavorites(type=var.type)

Fetch all favorites of connected user

Example

library(tiledbcloud)

var.type <- 'type_example' # character | The type of the desired favorites e.g. arrays

api.instance <- FavoritesApi$new()
# Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';
# Configure HTTP basic authorization: BasicAuth
api.instance$apiClient$username <- 'TODO_YOUR_USERNAME';
api.instance$apiClient$password <- 'TODO_YOUR_PASSWORD';
result <- api.instance$GetFavorites(type=var.type)
dput(result)

Parameters

Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- type | character| The type of the desired favorites e.g. arrays | [optional]

Return type

array[Favorite]

Authorization

ApiKeyAuth, BasicAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

| Status code | Description | Response headers | |-------------|-------------|------------------| | 200 | OK | - |

PostFavorite

PostFavorite(body=var.body)

Add a new favorite

Example

library(tiledbcloud)

var.body <- FavoriteUpdate$new("name_example", "namespace_example", FavoriteType$new()) # FavoriteUpdate | 

api.instance <- FavoritesApi$new()
# Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';
# Configure HTTP basic authorization: BasicAuth
api.instance$apiClient$username <- 'TODO_YOUR_USERNAME';
api.instance$apiClient$password <- 'TODO_YOUR_PASSWORD';
api.instance$PostFavorite(body=var.body)

Parameters

Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- body | FavoriteUpdate| | [optional]

Return type

void (empty response body)

Authorization

ApiKeyAuth, BasicAuth

HTTP request headers

• Content-Type: application/json
• Accept: Not defined

HTTP response details

| Status code | Description | Response headers | |-------------|-------------|------------------| | 200 | OK | - |

TileDB-Inc/TileDB-Cloud-R documentation built on July 18, 2024, 3:33 p.m.