All URIs are relative to http://localhost
| Method | HTTP request | Description |
|---|---|---|
| AddCollaboratorInstancesInstanceIdCollaboratorsAccountIdPut | PUT /instances/{instance_id}/collaborators/{account_id} | Add Collaborator |
| CreateInstanceInstancesPut | PUT /instances | Create Instance |
| CreateRecordInstancesInstanceIdModulesModuleNameModelNamePut | PUT /instances/{instance_id}/modules/{module_name}/{model_name} | Create Record |
| DeleteCollaboratorInstancesInstanceIdCollaboratorsAccountIdDelete | DELETE /instances/{instance_id}/collaborators/{account_id} | Delete Collaborator |
| DeleteInstanceInstancesInstanceIdDelete | DELETE /instances/{instance_id} | Delete Instance |
| DeleteRecordInstancesInstanceIdModulesModuleNameModelNameUidDelete | DELETE /instances/{instance_id}/modules/{module_name}/{model_name}/{uid} | Delete Record |
| GeneratePasswordInstancesInstanceIdDbPasswordGet | GET /instances/{instance_id}/db/password | Generate Password |
| GenerateUrlInstancesInstanceIdDbUrlGet | GET /instances/{instance_id}/db/url | Generate Url |
| GetInstanceStatisticsInstancesInstanceIdStatisticsGet | GET /instances/{instance_id}/statistics | Get Instance Statistics |
| GetNonEmptyTablesInstancesInstanceIdNonEmptyTablesGet | GET /instances/{instance_id}/non_empty_tables | Get Non Empty Tables |
| GetRecordInstancesInstanceIdModulesModuleNameModelNameIdOrUidPost | POST /instances/{instance_id}/modules/{module_name}/{model_name}/{id_or_uid} | Get Record |
| GetRecordsInstancesInstanceIdModulesModuleNameModelNamePost | POST /instances/{instance_id}/modules/{module_name}/{model_name} | Get Records |
| GetRelationsInstancesInstanceIdSchemaModuleNameModelNameGet | GET /instances/{instance_id}/schema/{module_name}/{model_name} | Get Relations |
| GetSchemaInstancesInstanceIdSchemaGet | GET /instances/{instance_id}/schema | Get Schema |
| GetValuesInstancesInstanceIdModulesModuleNameModelNameFieldsFieldPathPost | POST /instances/{instance_id}/modules/{module_name}/{model_name}/fields/{field_path} | Get Values |
| GrantS3PermissionsStoragesS3BucketNamePermissionsPut | PUT /storages/s3/{bucket_name}/permissions | Grant S3 Permissions |
| GroupByInstancesInstanceIdModulesModuleNameModelNameGroupByPost | POST /instances/{instance_id}/modules/{module_name}/{model_name}/group-by | Group By |
| TransferOwnershipInstancesInstanceIdOwnerHandlePatch | PATCH /instances/{instance_id}/owner/{handle} | Transfer Ownership |
| UpdateCollaboratorInstancesInstanceIdCollaboratorsAccountIdPatch | PATCH /instances/{instance_id}/collaborators/{account_id} | Update Collaborator |
| UpdateRecordInstancesInstanceIdModulesModuleNameModelNameUidPatch | PATCH /instances/{instance_id}/modules/{module_name}/{model_name}/{uid} | Update Record |
AnyType AddCollaboratorInstancesInstanceIdCollaboratorsAccountIdPut(instance_id, account_id, schema_id, role = "read", authorization = var.authorization)
Add Collaborator
library(laminr.api)
# Add Collaborator
#
# prepare function argument(s)
var_instance_id <- "instance_id_example" # character |
var_account_id <- "account_id_example" # character |
var_schema_id <- "schema_id_example" # character |
var_role <- "read" # character | (Optional)
var_authorization <- "authorization_example" # character | (Optional)
api_instance <- DefaultApi$new()| Name | Type | Description | Notes |
|---|---|---|---|
| instance_id | character | ||
| account_id | character | ||
| schema_id | character | ||
| role | Enum [admin, write, read] | [optional] [default to "read"] | |
| authorization | character | [optional] |
AnyType
No authorization required
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful Response | - |
| 422 | Validation Error | - |
AnyType CreateInstanceInstancesPut(name, storage = "create-s3", schema_str = var.schema_str, db_server_key = var.db_server_key, db_server_url = var.db_server_url, authorization = var.authorization)
Create Instance
library(laminr.api)
# Create Instance
#
# prepare function argument(s)
var_name <- "name_example" # character |
var_storage <- "create-s3" # character | (Optional)
var_schema_str <- "schema_str_example" # character | (Optional)
var_db_server_key <- "db_server_key_example" # character | (Optional)
var_db_server_url <- "db_server_url_example" # character | (Optional)
var_authorization <- "authorization_example" # character | (Optional)
api_instance <- DefaultApi$new()| Name | Type | Description | Notes |
|---|---|---|---|
| name | character | ||
| storage | character | [optional] [default to "create-s3"] | |
| schema_str | character | [optional] | |
| db_server_key | character | [optional] | |
| db_server_url | character | [optional] | |
| authorization | character | [optional] |
AnyType
No authorization required
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful Response | - |
| 422 | Validation Error | - |
AnyType CreateRecordInstancesInstanceIdModulesModuleNameModelNamePut(instance_id, module_name, model_name, schema_id, body, authorization = var.authorization)
Create Record
library(laminr.api)
# Create Record
#
# prepare function argument(s)
var_instance_id <- "instance_id_example" # character |
var_module_name <- "module_name_example" # character |
var_model_name <- "model_name_example" # character |
var_schema_id <- "schema_id_example" # character |
var_body <- TODO # AnyType |
var_authorization <- "authorization_example" # character | (Optional)
api_instance <- DefaultApi$new()| Name | Type | Description | Notes |
|---|---|---|---|
| instance_id | character | ||
| module_name | character | ||
| model_name | character | ||
| schema_id | character | ||
| body | AnyType | ||
| authorization | character | [optional] |
AnyType
No authorization required
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful Response | - |
| 422 | Validation Error | - |
AnyType DeleteCollaboratorInstancesInstanceIdCollaboratorsAccountIdDelete(instance_id, account_id, authorization = var.authorization)
Delete Collaborator
library(laminr.api)
# Delete Collaborator
#
# prepare function argument(s)
var_instance_id <- "instance_id_example" # character |
var_account_id <- "account_id_example" # character |
var_authorization <- "authorization_example" # character | (Optional)
api_instance <- DefaultApi$new()| Name | Type | Description | Notes |
|---|---|---|---|
| instance_id | character | ||
| account_id | character | ||
| authorization | character | [optional] |
AnyType
No authorization required
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful Response | - |
| 422 | Validation Error | - |
AnyType DeleteInstanceInstancesInstanceIdDelete(instance_id, instance_name, authorization = var.authorization)
Delete Instance
library(laminr.api)
# Delete Instance
#
# prepare function argument(s)
var_instance_id <- "instance_id_example" # character |
var_instance_name <- "instance_name_example" # character |
var_authorization <- "authorization_example" # character | (Optional)
api_instance <- DefaultApi$new()| Name | Type | Description | Notes |
|---|---|---|---|
| instance_id | character | ||
| instance_name | character | ||
| authorization | character | [optional] |
AnyType
No authorization required
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful Response | - |
| 422 | Validation Error | - |
AnyType DeleteRecordInstancesInstanceIdModulesModuleNameModelNameUidDelete(instance_id, module_name, model_name, uid, schema_id, authorization = var.authorization)
Delete Record
library(laminr.api)
# Delete Record
#
# prepare function argument(s)
var_instance_id <- "instance_id_example" # character |
var_module_name <- "module_name_example" # character |
var_model_name <- "model_name_example" # character |
var_uid <- "uid_example" # character |
var_schema_id <- "schema_id_example" # character |
var_authorization <- "authorization_example" # character | (Optional)
api_instance <- DefaultApi$new()| Name | Type | Description | Notes |
|---|---|---|---|
| instance_id | character | ||
| module_name | character | ||
| model_name | character | ||
| uid | character | ||
| schema_id | character | ||
| authorization | character | [optional] |
AnyType
No authorization required
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful Response | - |
| 422 | Validation Error | - |
AnyType GeneratePasswordInstancesInstanceIdDbPasswordGet(instance_id, authorization = var.authorization)
Generate Password
library(laminr.api)
# Generate Password
#
# prepare function argument(s)
var_instance_id <- "instance_id_example" # character |
var_authorization <- "authorization_example" # character | (Optional)
api_instance <- DefaultApi$new()| Name | Type | Description | Notes |
|---|---|---|---|
| instance_id | character | ||
| authorization | character | [optional] |
AnyType
No authorization required
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful Response | - |
| 422 | Validation Error | - |
AnyType GenerateUrlInstancesInstanceIdDbUrlGet(instance_id, authorization = var.authorization)
Generate Url
library(laminr.api)
# Generate Url
#
# prepare function argument(s)
var_instance_id <- "instance_id_example" # character |
var_authorization <- "authorization_example" # character | (Optional)
api_instance <- DefaultApi$new()| Name | Type | Description | Notes |
|---|---|---|---|
| instance_id | character | ||
| authorization | character | [optional] |
AnyType
No authorization required
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful Response | - |
| 422 | Validation Error | - |
AnyType GetInstanceStatisticsInstancesInstanceIdStatisticsGet(instance_id, schema_id, q = var.q, authorization = var.authorization)
Get Instance Statistics
library(laminr.api)
# Get Instance Statistics
#
# prepare function argument(s)
var_instance_id <- "instance_id_example" # character |
var_schema_id <- "schema_id_example" # character |
var_q <- c("inner_example") # array[character] | In ${module}.${model} format (case-sensitive) (Optional)
var_authorization <- "authorization_example" # character | (Optional)
api_instance <- DefaultApi$new()| Name | Type | Description | Notes |
|---|---|---|---|
| instance_id | character | ||
| schema_id | character | ||
| q | list( character ) | In ${module}.${model} format (case-sensitive) | [optional] |
| authorization | character | [optional] |
AnyType
No authorization required
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful Response | - |
| 422 | Validation Error | - |
AnyType GetNonEmptyTablesInstancesInstanceIdNonEmptyTablesGet(instance_id, schema_id, authorization = var.authorization)
Get Non Empty Tables
library(laminr.api)
# Get Non Empty Tables
#
# prepare function argument(s)
var_instance_id <- "instance_id_example" # character |
var_schema_id <- "schema_id_example" # character |
var_authorization <- "authorization_example" # character | (Optional)
api_instance <- DefaultApi$new()| Name | Type | Description | Notes |
|---|---|---|---|
| instance_id | character | ||
| schema_id | character | ||
| authorization | character | [optional] |
AnyType
No authorization required
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful Response | - |
| 422 | Validation Error | - |
AnyType GetRecordInstancesInstanceIdModulesModuleNameModelNameIdOrUidPost(instance_id, module_name, model_name, id_or_uid, schema_id, limit_to_many = 10, include_foreign_keys = FALSE, authorization = var.authorization, get_record_request_body = var.get_record_request_body)
Get Record
library(laminr.api)
# Get Record
#
# prepare function argument(s)
var_instance_id <- "instance_id_example" # character |
var_module_name <- "module_name_example" # character |
var_model_name <- "model_name_example" # character |
var_id_or_uid <- "id_or_uid_example" # character |
var_schema_id <- "schema_id_example" # character |
var_limit_to_many <- 10 # integer | (Optional)
var_include_foreign_keys <- FALSE # character | (Optional)
var_authorization <- "authorization_example" # character | (Optional)
var_get_record_request_body <- GetRecordRequestBody$new(c("select_example")) # GetRecordRequestBody | (Optional)
api_instance <- DefaultApi$new()| Name | Type | Description | Notes |
|---|---|---|---|
| instance_id | character | ||
| module_name | character | ||
| model_name | character | ||
| id_or_uid | character | ||
| schema_id | character | ||
| limit_to_many | integer | [optional] [default to 10] | |
| include_foreign_keys | character | [optional] [default to FALSE] | |
| authorization | character | [optional] | |
| get_record_request_body | GetRecordRequestBody | [optional] |
AnyType
No authorization required
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful Response | - |
| 422 | Validation Error | - |
AnyType GetRecordsInstancesInstanceIdModulesModuleNameModelNamePost(instance_id, module_name, model_name, schema_id, limit = 50, offset = 0, limit_to_many = 10, include_foreign_keys = FALSE, authorization = var.authorization, get_records_request_body = var.get_records_request_body)
Get Records
library(laminr.api)
# Get Records
#
# prepare function argument(s)
var_instance_id <- "instance_id_example" # character |
var_module_name <- "module_name_example" # character |
var_model_name <- "model_name_example" # character |
var_schema_id <- "schema_id_example" # character |
var_limit <- 50 # integer | (Optional)
var_offset <- 0 # integer | (Optional)
var_limit_to_many <- 10 # integer | (Optional)
var_include_foreign_keys <- FALSE # character | (Optional)
var_authorization <- "authorization_example" # character | (Optional)
var_get_records_request_body <- GetRecordsRequestBody$new(c("select_example"), 123, c(OrderByColumn$new("field_example", "descending_example")), "search_example") # GetRecordsRequestBody | (Optional)
api_instance <- DefaultApi$new()| Name | Type | Description | Notes |
|---|---|---|---|
| instance_id | character | ||
| module_name | character | ||
| model_name | character | ||
| schema_id | character | ||
| limit | integer | [optional] [default to 50] | |
| offset | integer | [optional] [default to 0] | |
| limit_to_many | integer | [optional] [default to 10] | |
| include_foreign_keys | character | [optional] [default to FALSE] | |
| authorization | character | [optional] | |
| get_records_request_body | GetRecordsRequestBody | [optional] |
AnyType
No authorization required
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful Response | - |
| 422 | Validation Error | - |
AnyType GetRelationsInstancesInstanceIdSchemaModuleNameModelNameGet(module_name, model_name, instance_id, authorization = var.authorization)
Get Relations
library(laminr.api)
# Get Relations
#
# prepare function argument(s)
var_module_name <- "module_name_example" # character |
var_model_name <- "model_name_example" # character |
var_instance_id <- "instance_id_example" # character |
var_authorization <- "authorization_example" # character | (Optional)
api_instance <- DefaultApi$new()| Name | Type | Description | Notes |
|---|---|---|---|
| module_name | character | ||
| model_name | character | ||
| instance_id | character | ||
| authorization | character | [optional] |
AnyType
No authorization required
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful Response | - |
| 422 | Validation Error | - |
AnyType GetSchemaInstancesInstanceIdSchemaGet(instance_id, authorization = var.authorization)
Get Schema
library(laminr.api)
# Get Schema
#
# prepare function argument(s)
var_instance_id <- "instance_id_example" # character |
var_authorization <- "authorization_example" # character | (Optional)
api_instance <- DefaultApi$new()| Name | Type | Description | Notes |
|---|---|---|---|
| instance_id | character | ||
| authorization | character | [optional] |
AnyType
No authorization required
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful Response | - |
| 422 | Validation Error | - |
AnyType GetValuesInstancesInstanceIdModulesModuleNameModelNameFieldsFieldPathPost(instance_id, module_name, model_name, field_path, schema_id, limit = 50, offset = 0, authorization = var.authorization, get_values_request_body = var.get_values_request_body)
Get Values
library(laminr.api)
# Get Values
#
# prepare function argument(s)
var_instance_id <- "instance_id_example" # character |
var_module_name <- "module_name_example" # character |
var_model_name <- "model_name_example" # character |
var_field_path <- "field_path_example" # character |
var_schema_id <- "schema_id_example" # character |
var_limit <- 50 # integer | (Optional)
var_offset <- 0 # integer | (Optional)
var_authorization <- "authorization_example" # character | (Optional)
var_get_values_request_body <- GetValuesRequestBody$new(123, c(OrderByColumn$new("field_example", "descending_example")), "search_example") # GetValuesRequestBody | (Optional)
api_instance <- DefaultApi$new()| Name | Type | Description | Notes |
|---|---|---|---|
| instance_id | character | ||
| module_name | character | ||
| model_name | character | ||
| field_path | character | ||
| schema_id | character | ||
| limit | integer | [optional] [default to 50] | |
| offset | integer | [optional] [default to 0] | |
| authorization | character | [optional] | |
| get_values_request_body | GetValuesRequestBody | [optional] |
AnyType
No authorization required
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful Response | - |
| 422 | Validation Error | - |
AnyType GrantS3PermissionsStoragesS3BucketNamePermissionsPut(bucket_name, s3_permissions_request, aws_account_id = "767398070972", aws_user_name = "lamin-manager", authorization = var.authorization)
Grant S3 Permissions
library(laminr.api)
# Grant S3 Permissions
#
# prepare function argument(s)
var_bucket_name <- "bucket_name_example" # character |
var_s3_permissions_request <- S3PermissionsRequest$new("aws_access_key_id_example", "aws_secret_access_key_example", "region_example") # S3PermissionsRequest |
var_aws_account_id <- "767398070972" # character | (Optional)
var_aws_user_name <- "lamin-manager" # character | (Optional)
var_authorization <- "authorization_example" # character | (Optional)
api_instance <- DefaultApi$new()| Name | Type | Description | Notes |
|---|---|---|---|
| bucket_name | character | ||
| s3_permissions_request | S3PermissionsRequest | ||
| aws_account_id | character | [optional] [default to "767398070972"] | |
| aws_user_name | character | [optional] [default to "lamin-manager"] | |
| authorization | character | [optional] |
AnyType
No authorization required
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful Response | - |
| 422 | Validation Error | - |
AnyType GroupByInstancesInstanceIdModulesModuleNameModelNameGroupByPost(instance_id, module_name, model_name, schema_id, group_by_request_body, authorization = var.authorization)
Group By
library(laminr.api)
# Group By
#
# prepare function argument(s)
var_instance_id <- "instance_id_example" # character |
var_module_name <- "module_name_example" # character |
var_model_name <- "model_name_example" # character |
var_schema_id <- "schema_id_example" # character |
var_group_by_request_body <- GroupByRequestBody$new(c(Dimension$new("field_name_example", "count")), c(Measure$new("field_name_example", "count", "alias_example")), 123) # GroupByRequestBody |
var_authorization <- "authorization_example" # character | (Optional)
api_instance <- DefaultApi$new()| Name | Type | Description | Notes |
|---|---|---|---|
| instance_id | character | ||
| module_name | character | ||
| model_name | character | ||
| schema_id | character | ||
| group_by_request_body | GroupByRequestBody | ||
| authorization | character | [optional] |
AnyType
No authorization required
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful Response | - |
| 422 | Validation Error | - |
AnyType TransferOwnershipInstancesInstanceIdOwnerHandlePatch(instance_id, handle, schema_id, authorization = var.authorization)
Transfer Ownership
library(laminr.api)
# Transfer Ownership
#
# prepare function argument(s)
var_instance_id <- "instance_id_example" # character |
var_handle <- "handle_example" # character |
var_schema_id <- "schema_id_example" # character |
var_authorization <- "authorization_example" # character | (Optional)
api_instance <- DefaultApi$new()| Name | Type | Description | Notes |
|---|---|---|---|
| instance_id | character | ||
| handle | character | ||
| schema_id | character | ||
| authorization | character | [optional] |
AnyType
No authorization required
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful Response | - |
| 422 | Validation Error | - |
AnyType UpdateCollaboratorInstancesInstanceIdCollaboratorsAccountIdPatch(instance_id, account_id, role, authorization = var.authorization)
Update Collaborator
library(laminr.api)
# Update Collaborator
#
# prepare function argument(s)
var_instance_id <- "instance_id_example" # character |
var_account_id <- "account_id_example" # character |
var_role <- "role_example" # character |
var_authorization <- "authorization_example" # character | (Optional)
api_instance <- DefaultApi$new()| Name | Type | Description | Notes |
|---|---|---|---|
| instance_id | character | ||
| account_id | character | ||
| role | Enum [admin, write, read] | ||
| authorization | character | [optional] |
AnyType
No authorization required
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful Response | - |
| 422 | Validation Error | - |
AnyType UpdateRecordInstancesInstanceIdModulesModuleNameModelNameUidPatch(instance_id, module_name, model_name, uid, schema_id, body, authorization = var.authorization)
Update Record
library(laminr.api)
# Update Record
#
# prepare function argument(s)
var_instance_id <- "instance_id_example" # character |
var_module_name <- "module_name_example" # character |
var_model_name <- "model_name_example" # character |
var_uid <- "uid_example" # character |
var_schema_id <- "schema_id_example" # character |
var_body <- TODO # AnyType |
var_authorization <- "authorization_example" # character | (Optional)
api_instance <- DefaultApi$new()| Name | Type | Description | Notes |
|---|---|---|---|
| instance_id | character | ||
| module_name | character | ||
| model_name | character | ||
| uid | character | ||
| schema_id | character | ||
| body | AnyType | ||
| authorization | character | [optional] |
AnyType
No authorization required
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful Response | - |
| 422 | Validation Error | - |