README.md

openapi-java-client

TileDB Storage Platform API

• API version: 2.2.19

TileDB Storage Platform REST API

Automatically generated by the OpenAPI Generator

Documentation for API Endpoints

All URIs are relative to /v1

Class	Method	HTTP request	Description
ArrayApi	arrayActivityLog	GET /arrays/{namespace}/{array}/activity
ArrayApi	arraysBrowserOwnedGet	GET /arrays/browser/owned
ArrayApi	arraysBrowserOwnedSidebarGet	GET /arrays/browser/owned/sidebar
ArrayApi	arraysBrowserPublicGet	GET /arrays/browser/public
ArrayApi	arraysBrowserPublicSidebarGet	GET /arrays/browser/public/sidebar
ArrayApi	arraysBrowserSharedGet	GET /arrays/browser/shared
ArrayApi	arraysBrowserSharedSidebarGet	GET /arrays/browser/shared/sidebar
ArrayApi	arraysNamespaceArrayEndTimestampsGet	GET /arrays/{namespace}/{array}/end_timestamps
ArrayApi	consolidateArray	POST /arrays/{namespace}/{array}/consolidate
ArrayApi	createArray	POST /arrays/{namespace}/{array}
ArrayApi	deleteArray	DELETE /arrays/{namespace}/{array}
ArrayApi	deregisterArray	DELETE /arrays/{namespace}/{array}/deregister
ArrayApi	getActivityLogById	GET /arrays/{namespace}/{array}/activity/{id}
ArrayApi	getAllArrayMetadata	GET /arrays
ArrayApi	getArray	GET /arrays/{namespace}/{array}
ArrayApi	getArrayMaxBufferSizes	GET /arrays/{namespace}/{array}/max_buffer_sizes
ArrayApi	getArrayMetaDataJson	GET /arrays/{namespace}/{array}/metadata_json
ArrayApi	getArrayMetadata	GET /arrays/{namespace}/{array}/metadata
ArrayApi	getArrayMetadataCapnp	GET /arrays/{namespace}/{array}/array_metadata
ArrayApi	getArrayNonEmptyDomain	GET /arrays/{namespace}/{array}/non_empty_domain
ArrayApi	getArrayNonEmptyDomainJson	GET /arrays/{namespace}/{array}/non_empty_domain_json
ArrayApi	getArraySampleData	GET /arrays/{namespace}/{array}/sample
ArrayApi	getArraySharingPolicies	GET /arrays/{namespace}/{array}/share
ArrayApi	getArraysInNamespace	GET /arrays/{namespace}
ArrayApi	getFragmentEndTimestamp	GET /arrays/{namespace}/{array}/fragment_end_timestamp
ArrayApi	getLastAccessedArrays	GET /arrays/last_accessed
ArrayApi	registerArray	POST /arrays/{namespace}/{array}/register
ArrayApi	shareArray	PATCH /arrays/{namespace}/{array}/share
ArrayApi	updateArrayMetadata	PATCH /arrays/{namespace}/{array}/metadata
ArrayApi	updateArrayMetadataCapnp	POST /arrays/{namespace}/{array}/array_metadata
ArrayApi	vacuumArray	POST /arrays/{namespace}/{array}/vacuum
ArrayTasksApi	getArrayTasksSidebar	GET /tasks/sidebar
FavoritesApi	addArrayFavorite	POST /arrays/favorites/{namespace}/{name}
FavoritesApi	addMLModelFavorite	POST /ml_models/favorites/{namespace}/{name}
FavoritesApi	addNotebookFavorite	POST /notebooks/favorites/{namespace}/{name}
FavoritesApi	addUDFFavorite	POST /udfs/favorites/{namespace}/{name}
FavoritesApi	deleteArrayFavorite	DELETE /arrays/favorites/{namespace}/{name}
FavoritesApi	deleteMLModelFavorite	DELETE /ml_models/favorites/{namespace}/{name}
FavoritesApi	deleteNotebookFavorite	DELETE /notebooks/favorites/{namespace}/{name}
FavoritesApi	deleteUDFFavorite	DELETE /udfs/favorites/{namespace}/{name}
FavoritesApi	getArrayFavorite	GET /arrays/favorites/{namespace}/{name}
FavoritesApi	getMLModelFavorite	GET /ml_models/favorites/{namespace}/{name}
FavoritesApi	getNotebookFavorite	GET /notebooks/favorites/{namespace}/{name}
FavoritesApi	getUDFFavorite	GET /udfs/favorites/{namespace}/{name}
FavoritesApi	listArrayFavorites	GET /arrays/favorites
FavoritesApi	listArrayFavoritesUUIDs	GET /arrays/favorites/uuids
FavoritesApi	listMLModelFavorites	GET /ml_models/favorites
FavoritesApi	listMLModelFavoritesUUIDs	GET /ml_models/favorites/uuids
FavoritesApi	listNotebookFavorites	GET /notebooks/favorites
FavoritesApi	listNotebookFavoritesUUIDs	GET /notebooks/favorites/uuids
FavoritesApi	listUDFFavorites	GET /udfs/favorites
FavoritesApi	listUDFFavoritesUUIDs	GET /udfs/favorites/uuids
FilesApi	handleCreateFile	POST /files/{namespace}
FilesApi	handleExportFile	POST /files/{namespace}/{file}/export
FilesApi	handleUploadFile	POST /files/{namespace}/upload
GroupsApi	changeGroupContents	POST /groups/{group_namespace}/{group_name}/contents
GroupsApi	createGroup	POST /groups/{namespace}/create
GroupsApi	deleteGroup	DELETE /groups/{group_namespace}/{group_name}
GroupsApi	getGroup	GET /groups/{group_namespace}/{group_name}
GroupsApi	getGroupContents	GET /groups/{group_namespace}/{group_name}/contents
GroupsApi	getGroupSharingPolicies	GET /groups/{group_namespace}/{group_name}/share
GroupsApi	groupsBrowserOwnedFiltersGet	GET /groups/browser/owned/filters
GroupsApi	groupsBrowserPublicFiltersGet	GET /groups/browser/public/filters
GroupsApi	groupsBrowserSharedFiltersGet	GET /groups/browser/shared/filters
GroupsApi	groupsGroupNamespaceGroupNameContentsFiltersGet	GET /groups/{group_namespace}/{group_name}/contents/filters
GroupsApi	listOwnedGroups	GET /groups/browser/owned
GroupsApi	listPublicGroups	GET /groups/browser/public
GroupsApi	listSharedGroups	GET /groups/browser/shared
GroupsApi	registerGroup	POST /groups/{namespace}/{array}/register
GroupsApi	shareGroup	PATCH /groups/{group_namespace}/{group_name}/share
GroupsApi	updateGroup	PATCH /groups/{group_namespace}/{group_name}
InvitationApi	acceptInvitation	POST /invitations/{invitation}
InvitationApi	cancelJoinOrganization	DELETE /invitations/{invitation}/{organization}/join
InvitationApi	cancelShareArrayByInvite	DELETE /invitations/{invitation}/{namespace}/{array}/share
InvitationApi	fetchInvitations	GET /invitations
InvitationApi	joinOrganization	POST /invitations/{organization}/join
InvitationApi	shareArrayByInvite	POST /invitations/{namespace}/{array}/share
NotebookApi	getNotebookServerStatus	GET /notebooks/server/{namespace}/status
NotebookApi	handleCopyNotebook	POST /notebooks/{namespace}/{array}/copy
NotebookApi	handleUploadNotebook	POST /notebooks/{namespace}/upload
NotebookApi	shutdownNotebookServer	DELETE /notebooks/server/{namespace}
NotebookApi	updateNotebookName	PATCH /notebooks/{namespace}/{array}/rename
NotebooksApi	notebooksNamespaceArrayEndTimestampsGet	GET /notebooks/{namespace}/{array}/end_timestamps
OrganizationApi	addAWSAccessCredentials	POST /credentials/{namespace}/aws
OrganizationApi	addUserToOrganization	POST /organizations/{organization}/user
OrganizationApi	checkAWSAccessCredentials	GET /credentials/{namespace}/aws
OrganizationApi	checkAWSAccessCredentialsByName	GET /credentials/{namespace}/aws/{name}
OrganizationApi	createOrganization	POST /organization
OrganizationApi	deleteAWSAccessCredentials	DELETE /credentials/{namespace}/aws/{name}
OrganizationApi	deleteOrganization	DELETE /organizations/{organization}
OrganizationApi	deleteUserFromOrganization	DELETE /organizations/{organization}/{username}
OrganizationApi	getAllOrganizations	GET /organizations
OrganizationApi	getOrganization	GET /organizations/{organization}
OrganizationApi	getOrganizationUser	GET /organizations/{organization}/{username}
OrganizationApi	updateAWSAccessCredentials	PATCH /credentials/{namespace}/aws/{name}
OrganizationApi	updateOrganization	PATCH /organizations/{organization}
OrganizationApi	updateUserInOrganization	PATCH /organizations/{organization}/{username}
QueryApi	finalizeQuery	POST /arrays/{namespace}/{array}/query/finalize
QueryApi	getEstResultSizes	POST /arrays/{namespace}/{array}/query/est_result_sizes
QueryApi	getFile	GET /arrays/{namespace}/{array}/query/get_file
QueryApi	submitQuery	POST /arrays/{namespace}/{array}/query/submit
QueryApi	submitQueryJson	POST /arrays/{namespace}/{array}/query/submit_query_json
RegisteredTaskGraphsApi	deleteRegisteredTaskGraph	DELETE /taskgraphs/{namespace}/registered/{name}
RegisteredTaskGraphsApi	getRegisteredTaskGraph	GET /taskgraphs/{namespace}/registered/{name}
RegisteredTaskGraphsApi	getRegisteredTaskGraphSharingPolicies	GET /taskgraphs/{namespace}/registered/{name}/share
RegisteredTaskGraphsApi	registerRegisteredTaskGraph	POST /taskgraphs/{namespace}/registered/{name}
RegisteredTaskGraphsApi	shareRegisteredTaskGraph	PATCH /taskgraphs/{namespace}/registered/{name}/share
RegisteredTaskGraphsApi	updateRegisteredTaskGraph	PATCH /taskgraphs/{namespace}/registered/{name}
SqlApi	runSQL	POST /sql/{namespace}
StatsApi	getTiledbStats	GET /.stats
TaskGraphLogsApi	createTaskGraphLog	POST /taskgraphs/{namespace}/log
TaskGraphLogsApi	getTaskGraphLog	GET /taskgraphs/{namespace}/logs/{id}
TaskGraphLogsApi	listTaskGraphLogs	GET /taskgraphs/logs
TaskGraphLogsApi	reportClientNode	POST /taskgraphs/{namespace}/logs/{id}/report_client_node
TaskGraphLogsApi	updateTaskGraphLog	PATCH /taskgraphs/{namespace}/logs/{id}
TasksApi	runSQL	POST /sql/{namespace}
TasksApi	taskIdGet	GET /task/{id}
TasksApi	taskIdResultGet	GET /task/{id}/result
TasksApi	tasksGet	GET /tasks
UdfApi	deleteUDFInfo	DELETE /udf/{namespace}/{name}
UdfApi	getUDFInfo	GET /udf/{namespace}/{name}
UdfApi	getUDFInfoSharingPolicies	GET /udf/{namespace}/{name}/share
UdfApi	handleCopyUDF	POST /udf/{namespace}/{name}/copy
UdfApi	registerUDFInfo	POST /udf/{namespace}/{name}
UdfApi	shareUDFInfo	PATCH /udf/{namespace}/{name}/share
UdfApi	submitGenericUDF	POST /udfs/generic/{namespace}
UdfApi	submitMultiArrayUDF	POST /udfs/arrays/{namespace}
UdfApi	submitUDF	POST /arrays/{namespace}/{array}/udf/submit
UdfApi	udfNamespaceArrayEndTimestampsGet	GET /udf/{namespace}/{array}/end_timestamps
UdfApi	updateUDFInfo	PATCH /udf/{namespace}/{name}
UserApi	addAWSAccessCredentials	POST /credentials/{namespace}/aws
UserApi	addUserToOrganization	POST /organizations/{organization}/user
UserApi	checkAWSAccessCredentials	GET /credentials/{namespace}/aws
UserApi	checkAWSAccessCredentialsByName	GET /credentials/{namespace}/aws/{name}
UserApi	confirmEmail	POST /user/confirm_email
UserApi	createUser	POST /user
UserApi	deleteAWSAccessCredentials	DELETE /credentials/{namespace}/aws/{name}
UserApi	deleteUser	DELETE /users/{username}
UserApi	deleteUserFromOrganization	DELETE /organizations/{organization}/{username}
UserApi	getOrganizationUser	GET /organizations/{organization}/{username}
UserApi	getSession	GET /session
UserApi	getTokenScopes	GET /tokens/scopes
UserApi	getUser	GET /user
UserApi	getUserWithUsername	GET /users/{username}
UserApi	requestToken	POST /token
UserApi	resetUserPassword	POST /user/password_reset
UserApi	revokeToken	DELETE /tokens/{token}
UserApi	tokensGet	GET /tokens
UserApi	tokensSessionGet	GET /tokens/session
UserApi	updateAWSAccessCredentials	PATCH /credentials/{namespace}/aws/{name}
UserApi	updateUser	PATCH /users/{username}
UserApi	updateUserInOrganization	PATCH /organizations/{organization}/{username}

Documentation for Models

• AWSAccessCredentials
• ActivityEventType
• Array
• ArrayActions
• ArrayActivityLog
• ArrayBrowserData
• ArrayBrowserSidebar
• ArrayEndTimestampData
• ArrayFavorite
• ArrayFavoritesData
• ArrayInfo
• ArrayInfoUpdate
• ArrayMetadata
• ArrayMetadataEntry
• ArraySample
• ArraySchema
• ArraySharing
• ArrayTask
• ArrayTaskBrowserSidebar
• ArrayTaskData
• ArrayTaskLog
• ArrayTaskStatus
• ArrayTaskType
• ArrayType
• Attribute
• AttributeBufferHeader
• AttributeBufferSize
• Datatype
• Dimension
• DimensionCoordinate
• DimensionTileExtent
• Domain
• DomainArray
• Error
• FileCreate
• FileCreated
• FileExport
• FileExported
• FilePropertyName
• FileType
• FileUploaded
• Filter
• FilterData
• FilterOption
• FilterPipeline
• FilterType
• GenericUDF
• GroupActions
• GroupBrowserData
• GroupBrowserFilterData
• GroupChanges
• GroupContents
• GroupContentsFilterData
• GroupCreate
• GroupEntry
• GroupInfo
• GroupMember
• GroupMemberAssetType
• GroupMemberType
• GroupRegister
• GroupSharing
• GroupSharingRequest
• GroupUpdate
• InlineObject
• InlineResponse200
• Invitation
• InvitationArrayShareEmail
• InvitationData
• InvitationOrganizationJoinEmail
• InvitationStatus
• InvitationType
• LastAccessedArray
• Layout
• MLModelFavorite
• MLModelFavoritesData
• MaxBufferSizes
• MultiArrayUDF
• NamespaceActions
• NonEmptyDomain
• NotebookCopied
• NotebookCopy
• NotebookFavorite
• NotebookFavoritesData
• NotebookStatus
• Organization
• OrganizationRoles
• OrganizationUser
• PaginationMetadata
• Pricing
• PricingAggregateUsage
• PricingCurrency
• PricingInterval
• PricingType
• PricingUnitLabel
• PublicShareFilter
• Query
• QueryJson
• QueryRanges
• QueryReader
• Querystatus
• Querytype
• ReadState
• RegisteredTaskGraph
• RegisteredTaskGraphNode
• ResultFormat
• SQLParameters
• SSOProvider
• Subarray
• SubarrayPartitioner
• SubarrayPartitionerCurrent
• SubarrayPartitionerState
• SubarrayRanges
• Subscription
• TGInputNodeData
• TGSQLNodeData
• TGUDFArgument
• TGUDFEnvironment
• TGUDFNodeData
• TaskGraphActions
• TaskGraphClientNodeStatus
• TaskGraphLog
• TaskGraphLogRunLocation
• TaskGraphLogStatus
• TaskGraphLogsData
• TaskGraphNodeMetadata
• TaskGraphSharing
• TileDBConfig
• Token
• TokenRequest
• TokenScope
• UDFActions
• UDFArrayDetails
• UDFCopied
• UDFCopy
• UDFFavorite
• UDFFavoritesData
• UDFImage
• UDFImageVersion
• UDFInfo
• UDFInfoUpdate
• UDFLanguage
• UDFSharing
• UDFSubarray
• UDFSubarrayRange
• UDFType
• User
• Writer

Documentation for Authorization

Authentication schemes defined for the API:

ApiKeyAuth

• Type: API key
• API key parameter name: X-TILEDB-REST-API-KEY
• Location: HTTP header

BasicAuth

• Type: HTTP basic authentication

OAuth2

• Type: OAuth
• Flow: accessCode
• Authorization URL: https://oauth2.tiledb.com/oauth2/authorize
• Scopes:
  • read: Grants read access
  • write: Grants write access
  • admin: Grants read and write access to administrative information

Recommendation

It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.

Author