R API client for odmApi

This swagger page describes the variantUser API endpoints for ODM. These are typically used to find and retrieve variant data and metadata.

Before carrying out any API calls you will need an API token. API tokens can be obtained under your profile within the Genestack software.

To try out calls in this swagger page:

1. Click the 'Authorize' button below to enter your API token
2. Scroll to the 'Parameters' section for the method you wish to try out and click the 'Try it out' button
3. Enter parameter values that you wish to try
4. Scroll to the bottom of the Parameters section and click the 'Execute' bar that appears

The server response will be in the section that follows.

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI spec from a remote server, you can easily generate an API client.

• API version: default-released
• Package version: 1.62.5
• Generator version: 7.20.0
• Build package: org.openapitools.codegen.languages.RClientCodegen

Installation

Prerequisites

Install the dependencies

install.packages("jsonlite")
install.packages("httr")
install.packages("base64enc")

Build the package

git clone https://github.com/genestack/openapi
cd openapi
R CMD build .
R CMD check odmApi_1.62.5.tar.gz --no-manual
R CMD INSTALL --preclean odmApi_1.62.5.tar.gz

Install the package

install.packages("odmApi")

To install directly from Github, use devtools:

install.packages("devtools")
library(devtools)
install_github("genestack/openapi")

To install the package from a local file:

install.packages("odmApi_1.62.5.tar.gz", repos = NULL, type = "source")

Usage

library(odmApi)

Reformat code

To reformat code using styler, please run the following in the R console:

install.packages("remotes")
remotes::install_github("r-lib/styler@v1.7.0.9003")
library("styler")
style_dir()

Documentation for API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
BETAAnalyticsOmicsQueriesAsCuratorApi	CellRatioAsCurator	POST /api/v1/as-curator/omics/cells/analytics/cell-ratio	[BETA] Compute cell ratio statistics across groups or metadata attributes in single-cell data.
BETAAnalyticsOmicsQueriesAsCuratorApi	DifferentialExpressionAsCurator	POST /api/v1/as-curator/omics/cells/analytics/differential-expression	[BETA] Perform differential gene expression analytics between case and control cell groups
BETAAnalyticsOmicsQueriesAsCuratorApi	GeneSummaryAsCurator	POST /api/v1/as-curator/omics/cells/analytics/gene-summary	[BETA] Compute and retrieve descriptive statistics and visual summaries for single-cell data.
BETAAnalyticsOmicsQueriesAsUserApi	CellRatioAsUser	POST /api/v1/as-user/omics/cells/analytics/cell-ratio	[BETA] Compute cell ratio statistics across groups or metadata attributes in single-cell data.
BETAAnalyticsOmicsQueriesAsUserApi	DifferentialExpressionAsUser	POST /api/v1/as-user/omics/cells/analytics/differential-expression	[BETA] Perform differential gene expression analytics between case and control cell groups
BETAAnalyticsOmicsQueriesAsUserApi	GeneSummaryAsUser	POST /api/v1/as-user/omics/cells/analytics/gene-summary	[BETA] Compute and retrieve descriptive statistics and visual summaries for single-cell data.
CellIntegrationAsCuratorApi	CreateCellGroupLibraryGroupLinkAsCurator	POST /api/v1/as-curator/integration/link/cell/group/{sourceId}/to/library/group/{targetId}	Create links between cells and libraries
CellIntegrationAsCuratorApi	CreateCellGroupPreparationGroupLinkAsCurator	POST /api/v1/as-curator/integration/link/cell/group/{sourceId}/to/preparation/group/{targetId}	Create links between cells and preparations
CellIntegrationAsCuratorApi	CreateCellGroupSampleGroupLinkAsCurator	POST /api/v1/as-curator/integration/link/cell/group/{sourceId}/to/sample/group/{targetId}	Create links between cells and samples
CellsAsCuratorApi	GetCellByIdAsCurator	GET /api/v1/as-curator/cells/{id}	Retrieve a cell by ID
CellsAsCuratorApi	GetCellsByGroupAsCurator	GET /api/v1/as-curator/cells/by/group/{id}	Retrieve cells from a given group
CellsAsUserApi	GetCellByIdAsUser	GET /api/v1/as-user/cells/{id}	Retrieve a cell by ID
CellsAsUserApi	GetCellsByGroupAsUser	GET /api/v1/as-user/cells/by/group/{id}	Retrieve cells from a given group
DataImportJobsApi	StartImportAFile	POST /api/v1/jobs/import/file	Import file as an attachment
DataImportJobsApi	StartImportCells	POST /api/v1/jobs/import/cells	Import a group of cell data objects from a TSV file
DataImportJobsApi	StartImportExpression	POST /api/v1/jobs/import/expression	Import any tabular data from TSV or GCT files
DataImportJobsApi	StartImportFlowCytometry	POST /api/v1/jobs/import/flow-cytometry	Import flow-cytometry data and metadata from FACS and TSV files
DataImportJobsApi	StartImportLibraries	POST /api/v1/jobs/import/libraries	Import a group of library metadata objects from a TSV file
DataImportJobsApi	StartImportPreparations	POST /api/v1/jobs/import/preparations	Import a group of preparation metadata objects from a TSV file
DataImportJobsApi	StartImportSamples	POST /api/v1/jobs/import/samples	Import a group of sample metadata objects from a TSV file
DataImportJobsApi	StartImportStudy	POST /api/v1/jobs/import/study	Import study metadata from a TSV file
DataImportJobsApi	StartImportVariant	POST /api/v1/jobs/import/variant	Import variation data and metadata from VCF and TSV files
DataImportViaDirectFileUploadApi	StartImportAFileMultipart	POST /api/v1/jobs/import/file/multipart	Import a file as an attachment, optionally with a separate TSV metadata file via multipart/form-data upload
DataImportViaDirectFileUploadApi	StartImportCellsMultipart	POST /api/v1/jobs/import/cells/multipart	Import a group of cell data objects from a TSV file via multipart/form-data upload
DataImportViaDirectFileUploadApi	StartImportExpressionMultipart	POST /api/v1/jobs/import/expression/multipart	Import a TSV file containing any tabular data, optionally with a separate TSV metadata file via multipart/form-data upload
DataImportViaDirectFileUploadApi	StartImportFlowCytometryMultipart	POST /api/v1/jobs/import/flow-cytometry/multipart	Import a FACS file containing flow-cytometry data, optionally with a separate TSV metadata file via multipart/form-data upload
DataImportViaDirectFileUploadApi	StartImportLibrariesMultipart	POST /api/v1/jobs/import/libraries/multipart	Import a group of library metadata objects from a TSV file via multipart/form-data upload
DataImportViaDirectFileUploadApi	StartImportPreparationsMultipart	POST /api/v1/jobs/import/preparations/multipart	Import a group of preparation metadata objects from a TSV file via multipart/form-data upload
DataImportViaDirectFileUploadApi	StartImportSamplesMultipart	POST /api/v1/jobs/import/samples/multipart	Import a group of sample metadata objects from a TSV file via multipart/form-data upload
DataImportViaDirectFileUploadApi	StartImportVariantMultipart	POST /api/v1/jobs/import/variant/multipart	Import a VCF file containing variant data, optionally with a separate TSV metadata file via multipart/form-data
ExpressionIntegrationAsCuratorApi	CreateExpressionGroupCellGroupLinkAsCurator	POST /api/v1/as-curator/integration/link/expression/group/{sourceId}/to/cell/group/{targetId}	Create a link between a group of cell expression objects and a group of cell metadata.
ExpressionIntegrationAsCuratorApi	CreateExpressionGroupLibraryGroupLinkAsCurator	POST /api/v1/as-curator/integration/link/expression/group/{sourceId}/to/library/group/{targetId}	Create a link between a group of expression objects and a group of library objects
ExpressionIntegrationAsCuratorApi	CreateExpressionGroupPreparationGroupLinkAsCurator	POST /api/v1/as-curator/integration/link/expression/group/{sourceId}/to/preparation/group/{targetId}	Create a link between a group of expression objects and a group of preparation objects
ExpressionIntegrationAsCuratorApi	CreateExpressionGroupSampleGroupLinkAsCurator	POST /api/v1/as-curator/integration/link/expression/group/{sourceId}/to/sample/group/{targetId}	Create a link between a group of expression objects and a group of sample objects
ExpressionIntegrationAsCuratorApi	CreateExpressionLibraryLinkAsCurator	POST /api/v1/as-curator/integration/link/expression/{sourceId}/to/library/{targetId}	Create a link between an expression object and a library
ExpressionIntegrationAsCuratorApi	CreateExpressionPreparationLinkAsCurator	POST /api/v1/as-curator/integration/link/expression/{sourceId}/to/preparation/{targetId}	Create a link between an expression object and a preparation
ExpressionIntegrationAsCuratorApi	CreateExpressionSampleLinkAsCurator	POST /api/v1/as-curator/integration/link/expression/{sourceId}/to/sample/{targetId}	Create a link between an expression object and a sample
ExpressionIntegrationAsCuratorApi	DeleteExpressionGroupLibraryGroupLinkAsCurator	DELETE /api/v1/as-curator/integration/link/expression/group/{sourceId}/to/library/group/{targetId}	Delete link between a group of expression objects and a group of library objects
ExpressionIntegrationAsCuratorApi	DeleteExpressionGroupPreparationGroupLinkAsCurator	DELETE /api/v1/as-curator/integration/link/expression/group/{sourceId}/to/preparation/group/{targetId}	Delete link between a group of expression objects and a group of preparation objects
ExpressionIntegrationAsCuratorApi	DeleteExpressionGroupSampleGroupLinkAsCurator	DELETE /api/v1/as-curator/integration/link/expression/group/{sourceId}/to/sample/group/{targetId}	Delete link between a group of expression objects and a group of sample objects
ExpressionIntegrationAsCuratorApi	DeleteExpressionLibraryLinkAsCurator	DELETE /api/v1/as-curator/integration/link/expression/{sourceId}/to/library/{targetId}	Delete link between an expression object and a library
ExpressionIntegrationAsCuratorApi	DeleteExpressionPreparationLinkAsCurator	DELETE /api/v1/as-curator/integration/link/expression/{sourceId}/to/preparation/{targetId}	Delete link between an expression object and a preparation
ExpressionIntegrationAsCuratorApi	DeleteExpressionSampleLinkAsCurator	DELETE /api/v1/as-curator/integration/link/expression/{sourceId}/to/sample/{targetId}	Delete link between an expression object and a sample
ExpressionIntegrationAsCuratorApi	GetExpressionByLibraryAsCurator	GET /api/v1/as-curator/integration/link/expression/by/library/{id}	Retrieve expression run-level data by querying related library ID (accession)
ExpressionIntegrationAsCuratorApi	GetExpressionByPreparation	GET /api/v1/as-curator/integration/link/expression/by/preparation/{id}	Retrieve expression run-level data by querying related preparation ID (accession)
ExpressionIntegrationAsCuratorApi	GetExpressionBySampleAsCurator	GET /api/v1/as-curator/integration/link/expression/by/sample/{id}	Retrieve expression run-level data by querying related sample ID (accession)
ExpressionIntegrationAsCuratorApi	GetExpressionGroupsByStudyAsCurator	GET /api/v1/as-curator/integration/link/expression/group/by/study/{id}	Retrieve group metadata by querying study ID (accession)
ExpressionIntegrationAsCuratorApi	GetExpressionRunToLibraryPairsAsCurator	GET /api/v1/as-curator/integration/link/expression/run-to-libraries/by/group/{id}	Retrieve run-library pairs by group id. Pagination is based on unique runs, not unique pairs.
ExpressionIntegrationAsCuratorApi	GetExpressionRunToPreparationPairsAsCurator	GET /api/v1/as-curator/integration/link/expression/run-to-preparations/by/group/{id}	Retrieve run-preparation pairs by group id. Pagination is based on unique runs, not unique pairs.
ExpressionIntegrationAsCuratorApi	GetExpressionRunToSamplePairsAsCurator	GET /api/v1/as-curator/integration/link/expression/run-to-samples/by/group/{id}	Retrieve run-sample pairs by group id. Pagination is based on unique runs, not unique pairs.
ExpressionIntegrationAsUserApi	GetExpressionByLibraryAsUser	GET /api/v1/as-user/integration/link/expression/by/library/{id}	Retrieve expression run-level data by querying related library ID (accession)
ExpressionIntegrationAsUserApi	GetExpressionByPreparationAsUser	GET /api/v1/as-user/integration/link/expression/by/preparation/{id}	Retrieve expression run-level data by querying related preparation ID (accession)
ExpressionIntegrationAsUserApi	GetExpressionBySampleAsUser	GET /api/v1/as-user/integration/link/expression/by/sample/{id}	Retrieve expression run-level data by querying related sample ID (accession)
ExpressionIntegrationAsUserApi	GetExpressionGroupsByStudyAsUser	GET /api/v1/as-user/integration/link/expression/group/by/study/{id}	Retrieve group metadata by querying study ID (accession)
ExpressionIntegrationAsUserApi	GetExpressionRunToLibraryPairsAsUser	GET /api/v1/as-user/integration/link/expression/run-to-libraries/by/group/{id}	Retrieve run-library pairs by group id. Pagination is based on unique runs, not unique pairs.
ExpressionIntegrationAsUserApi	GetExpressionRunToPreparationPairsAsUser	GET /api/v1/as-user/integration/link/expression/run-to-preparations/by/group/{id}	Retrieve run-preparation pairs by group id. Pagination is based on unique runs, not unique pairs.
ExpressionIntegrationAsUserApi	GetExpressionRunToSamplePairsAsUser	GET /api/v1/as-user/integration/link/expression/run-to-samples/by/group/{id}	Retrieve run-sample pairs by group id. Pagination is based on unique runs, not unique pairs.
ExpressionSPoTAsCuratorApi	GetExpressionAsCurator	GET /api/v1/as-curator/expressions/{id}	Retrieve a single expression object by ID (itemId)
ExpressionSPoTAsCuratorApi	GetExpressionByVersionAsCurator	GET /api/v1/as-curator/expressions/{id}/versions/{version}	Retrieve a single expression object by run ID and its version
ExpressionSPoTAsCuratorApi	GetExpressionDataAsCurator	GET /api/v1/as-curator/expressions	Retrieve multiple expression data and metadata objects
ExpressionSPoTAsCuratorApi	GetExpressionGroupAsCurator	GET /api/v1/as-curator/expressions/group/{id}	Retrieve a single expression group by ID (groupId)
ExpressionSPoTAsCuratorApi	GetExpressionGroupByRunAsCurator	GET /api/v1/as-curator/expressions/group/by/run/{id}	Retrieve a single group object by run ID (runId)
ExpressionSPoTAsCuratorApi	GetExpressionVersionsAsCurator	GET /api/v1/as-curator/expressions/{id}/versions	Retrieve a list of expression object versions by run ID (runId)
ExpressionSPoTAsCuratorApi	SearchExpressionGroupsAsCurator	GET /api/v1/as-curator/expressions/group	Retrieve groups that match a query
ExpressionSPoTAsCuratorApi	SearchExpressionRunsAsCurator	GET /api/v1/as-curator/expressions/runs/by/group/{id}	Retrieve run objects related to the given group
ExpressionSPoTAsCuratorApi	UpdateExpressionRunAsCurator	PATCH /api/v1/as-curator/expressions/{id}	Update metadata object by expression object run ID (runId)
ExpressionSPoTAsUserApi	GetExpressionAsUser	GET /api/v1/as-user/expressions/{id}	Retrieve a single expression object by ID (itemId)
ExpressionSPoTAsUserApi	GetExpressionByVersionAsUser	GET /api/v1/as-user/expressions/{id}/versions/{version}	Retrieve a single expression object by run ID and its version
ExpressionSPoTAsUserApi	GetExpressionDataAsUser	GET /api/v1/as-user/expressions	Retrieve multiple expression data and metadata objects
ExpressionSPoTAsUserApi	GetExpressionGroupAsUser	GET /api/v1/as-user/expressions/group/{id}	Retrieve a single expression group by ID (groupId)
ExpressionSPoTAsUserApi	GetExpressionGroupByRunAsUser	GET /api/v1/as-user/expressions/group/by/run/{id}	Retrieve a single group object by run ID (runId)
ExpressionSPoTAsUserApi	GetExpressionVersionsAsUser	GET /api/v1/as-user/expressions/{id}/versions	Retrieve a list of expression object versions by run ID (runId)
ExpressionSPoTAsUserApi	SearchExpressionGroupsAsUser	GET /api/v1/as-user/expressions/group	Retrieve groups that match a query
ExpressionSPoTAsUserApi	SearchExpressionRunsAsUser	GET /api/v1/as-user/expressions/runs/by/group/{id}	Retrieve run objects related to the given group
FilesAsCuratorApi	GetFileAsCurator	GET /api/v1/as-curator/files/{id}/download	Retrieve a file by ID (accession)
FilesAsCuratorApi	GetFileMetadataByIdAsCurator	GET /api/v1/as-curator/files/{id}	Retrieve file's metadata by ID (accession)
FilesAsCuratorApi	GetFilesMetadataAsCurator	GET /api/v1/as-curator/files	Retrieve file's metadata by its fields
FilesAsCuratorApi	HeadFileAsCurator	HEAD /api/v1/as-curator/files/{id}/download
FilesAsUserApi	GetFileAsUser	GET /api/v1/as-user/files/{id}/download	Retrieve a file by ID (accession)
FilesAsUserApi	GetFileMetadataByIdAsUser	GET /api/v1/as-user/files/{id}	Retrieve file's metadata by ID (accession)
FilesAsUserApi	GetFilesMetadataAsUser	GET /api/v1/as-user/files	Retrieve file's metadata by its fields
FilesAsUserApi	HeadFileAsUser	HEAD /api/v1/as-user/files/{id}/download	Check if a file exists by ID (accession).
FilesIntegrationAsCuratorApi	GetFilesByStudyAsCurator	GET /api/v1/as-curator/integration/link/files/by/study/{id}	Retrieve file's metadata by study ID
FilesIntegrationAsUserApi	GetFilesByStudyAsUser	GET /api/v1/as-user/integration/link/files/by/study/{id}	Retrieve file's metadata by study ID
FlowCytometryFACSIntegrationAsCuratorApi	CreateFlowCytometryGroupSampleGroupLinkAsCurator	POST /api/v1/as-curator/integration/link/flow-cytometry/group/{sourceId}/to/sample/group/{targetId}	Create a link between a group of flow-cytometry objects and a group of sample objects
FlowCytometryFACSIntegrationAsCuratorApi	CreateFlowCytometrySampleLinkAsCurator	POST /api/v1/as-curator/integration/link/flow-cytometry/{sourceId}/to/sample/{targetId}	Create a link between a flow-cytometry object and a sample
FlowCytometryFACSIntegrationAsCuratorApi	DeleteFlowCytometryGroupSampleGroupLinkAsCurator	DELETE /api/v1/as-curator/integration/link/flow-cytometry/group/{sourceId}/to/sample/group/{targetId}	Delete link between a group of flow-cytometry objects and a group of sample objects
FlowCytometryFACSIntegrationAsCuratorApi	DeleteFlowCytometrySampleLinkAsCurator	DELETE /api/v1/as-curator/integration/link/flow-cytometry/{sourceId}/to/sample/{targetId}	Delete link between a flow-cytometry object and a sample
FlowCytometryFACSIntegrationAsCuratorApi	GetFlowCytometryBySampleAsCurator	GET /api/v1/as-curator/integration/link/flow-cytometry/by/sample/{id}	Retrieve flow cytometry run-level data by querying related sample ID (accession)
FlowCytometryFACSIntegrationAsCuratorApi	GetFlowCytometryGroupsByStudyAsCurator	GET /api/v1/as-curator/integration/link/flow-cytometry/group/by/study/{id}	Retrieve group metadata by querying study ID (accession)
FlowCytometryFACSIntegrationAsCuratorApi	GetFlowCytometryRunToSamplePairsAsCurator	GET /api/v1/as-curator/integration/link/flow-cytometry/run-to-samples/by/group/{id}	Retrieve run-sample pairs by group id. Pagination is based on unique runs, not unique pairs.
FlowCytometryFACSIntegrationAsUserApi	GetFlowCytometryBySampleAsUser	GET /api/v1/as-user/integration/link/flow-cytometry/by/sample/{id}	Retrieve flow cytometry run-level data by querying related sample ID (accession)
FlowCytometryFACSIntegrationAsUserApi	GetFlowCytometryGroupsByStudyAsUser	GET /api/v1/as-user/integration/link/flow-cytometry/group/by/study/{id}	Retrieve group metadata by querying study ID (accession)
FlowCytometryFACSIntegrationAsUserApi	GetFlowCytometryRunToSamplePairsAsUser	GET /api/v1/as-user/integration/link/flow-cytometry/run-to-samples/by/group/{id}	Retrieve run-sample pairs by group id. Pagination is based on unique runs, not unique pairs.
FlowCytometrySPoTAsCuratorApi	GetFlowCytometryAsCurator	GET /api/v1/as-curator/flow-cytometries/{id}	Retrieve a single sample flow cytometry by ID (accession)
FlowCytometrySPoTAsCuratorApi	GetFlowCytometryByVersionAsCurator	GET /api/v1/as-curator/flow-cytometries/{id}/versions/{version}	Retrieve a single sample flow cytometry by ID (accession)
FlowCytometrySPoTAsCuratorApi	GetFlowCytometryDataAsCurator	GET /api/v1/as-curator/flow-cytometries	Retrieve multiple flow cytometry data and metadata objects
FlowCytometrySPoTAsCuratorApi	GetFlowCytometryGroupAsCurator	GET /api/v1/as-curator/flow-cytometries/group/{id}	Retrieve a single group object by ID (accession)
FlowCytometrySPoTAsCuratorApi	GetFlowCytometryGroupByRunAsCurator	GET /api/v1/as-curator/flow-cytometries/group/by/run/{id}	Retrieve a single group object by run ID (accession)
FlowCytometrySPoTAsCuratorApi	GetFlowCytometryVersionsAsCurator	GET /api/v1/as-curator/flow-cytometries/{id}/versions	Retrieve a list of object versions by ID
FlowCytometrySPoTAsCuratorApi	SearchFlowCytometryGroupsAsCurator	GET /api/v1/as-curator/flow-cytometries/group	Retrieve groups that match a query
FlowCytometrySPoTAsCuratorApi	SearchFlowCytometryRunsAsCurator	GET /api/v1/as-curator/flow-cytometries/runs/by/group/{id}	Retrieve run objects related to the given group
FlowCytometrySPoTAsCuratorApi	UpdateFlowCytometryAsCurator	PATCH /api/v1/as-curator/flow-cytometries/{id}	Update object metadata
FlowCytometrySPoTAsUserApi	GetFlowCytometryAsUser	GET /api/v1/as-user/flow-cytometries/{id}	Retrieve a single sample flow cytometry by ID (accession)
FlowCytometrySPoTAsUserApi	GetFlowCytometryByVersionAsUser	GET /api/v1/as-user/flow-cytometries/{id}/versions/{version}	Retrieve a single sample flow cytometry by ID (accession)
FlowCytometrySPoTAsUserApi	GetFlowCytometryDataAsUser	GET /api/v1/as-user/flow-cytometries	Retrieve multiple flow cytometry data and metadata objects
FlowCytometrySPoTAsUserApi	GetFlowCytometryGroupAsUser	GET /api/v1/as-user/flow-cytometries/group/{id}	Retrieve a single group object by ID (accession)
FlowCytometrySPoTAsUserApi	GetFlowCytometryGroupByRunAsUser	GET /api/v1/as-user/flow-cytometries/group/by/run/{id}	Retrieve a single group object by run ID (accession)
FlowCytometrySPoTAsUserApi	GetFlowCytometryVersionsAsUser	GET /api/v1/as-user/flow-cytometries/{id}/versions	Retrieve a list of object versions by ID
FlowCytometrySPoTAsUserApi	SearchFlowCytometryGroupsAsUser	GET /api/v1/as-user/flow-cytometries/group	Retrieve groups that match a query
FlowCytometrySPoTAsUserApi	SearchFlowCytometryRunsAsUser	GET /api/v1/as-user/flow-cytometries/runs/by/group/{id}	Retrieve run objects related to the given group
GroupsApi	CreateGroup	POST /api/v1/scim/Groups	Add a new user group
GroupsApi	DeleteGroup	DELETE /api/v1/scim/Groups/{id}	Delete a group
GroupsApi	FindGroups	GET /api/v1/scim/Groups	Retrieve a list of available groups
GroupsApi	GetGroup	GET /api/v1/scim/Groups/{id}	Retrieve a group by id
GroupsApi	PatchGroup	PATCH /api/v1/scim/Groups/{id}	Update a group
JobOperationsApi	Info	GET /api/v1/jobs/{jobExecId}/info	get information about one particular job execution
JobOperationsApi	Output	GET /api/v1/jobs/{jobExecId}/output	retrieve job output (result)
JobOperationsApi	Restart	PUT /api/v1/jobs/{jobExecId}/restart	restart stopped (failed) job
JobOperationsApi	Stop	PUT /api/v1/jobs/{jobExecId}/stop	stop running job
LibraryIntegrationAsCuratorApi	CreateLibraryGroupSampleGroupLinkAsCurator	POST /api/v1/as-curator/integration/link/library/group/{sourceId}/to/sample/group/{targetId}	Create links between samples and libraries
LibraryIntegrationAsCuratorApi	CreateLibrarySampleLinkAsCurator	POST /api/v1/as-curator/integration/link/library/{sourceId}/to/sample/{targetId}	Create a link between a library and a sample
LibraryIntegrationAsCuratorApi	DeleteLibraryGroupSampleGroupLinkAsCurator	DELETE /api/v1/as-curator/integration/link/library/group/{sourceId}/to/sample/group/{targetId}	Delete links between samples and libraries related to the specified group
LibraryIntegrationAsCuratorApi	DeleteLibrarySampleLinkAsCurator	DELETE /api/v1/as-curator/integration/link/library/{sourceId}/to/sample/{targetId}	Delete a link between a library and a sample
LibraryIntegrationAsCuratorApi	GetLibrariesBySamplesAsCurator	GET /api/v1/as-curator/integration/link/libraries/by/samples	Retrieve library metadata by querying related samples
LibraryIntegrationAsCuratorApi	GetLibraryBySampleAsCurator	GET /api/v1/as-curator/integration/link/library/by/sample/{id}	Retrieve library metadata by querying related sample ID (accession)
LibraryIntegrationAsCuratorApi	GetLibraryGroupsByStudyAsCurator	GET /api/v1/as-curator/integration/link/library/group/by/study/{id}	Retrieve group metadata by querying study ID (accession)
LibraryIntegrationAsCuratorApi	GetLibraryLinksToSamplesAsCurator	GET /api/v1/as-curator/integration/link/library/libraries-to-samples/by/group/{id}	Retrieve library-samples pairs by group id. Pagination is based on unique libraries, not unique pairs.
LibraryIntegrationAsUserApi	GetLibrariesBySamplesAsUser	GET /api/v1/as-user/integration/link/libraries/by/samples	Retrieve library metadata by querying related samples
LibraryIntegrationAsUserApi	GetLibraryBySampleAsUser	GET /api/v1/as-user/integration/link/library/by/sample/{id}	Retrieve library metadata by querying related sample ID (accession)
LibraryIntegrationAsUserApi	GetLibraryGroupsByStudyAsUser	GET /api/v1/as-user/integration/link/library/group/by/study/{id}	Retrieve group metadata by querying study ID (accession)
LibraryIntegrationAsUserApi	GetLibraryLinksToSamplesAsUser	GET /api/v1/as-user/integration/link/library/libraries-to-samples/by/group/{id}	Retrieve library-samples pairs by group id. Pagination is based on unique libraries, not unique pairs.
LibrarySPoTAsCuratorApi	GetLibrariesByGroupAsCurator	GET /api/v1/as-curator/libraries/by/group/{id}	Retrieve libraries related to the given group
LibrarySPoTAsCuratorApi	GetLibraryAsCurator	GET /api/v1/as-curator/libraries/{id}	Retrieve a single library object by ID (accession)
LibrarySPoTAsCuratorApi	GetLibraryByVersionAsCurator	GET /api/v1/as-curator/libraries/{id}/versions/{version}	Retrieve a single library object by ID (accession)
LibrarySPoTAsCuratorApi	GetLibraryVersionsAsCurator	GET /api/v1/as-curator/libraries/{id}/versions	Retrieve a list of object versions by ID
LibrarySPoTAsCuratorApi	SearchLibrariesAsCurator	GET /api/v1/as-curator/libraries	List or search for library metadata objects
LibrarySPoTAsCuratorApi	UpdateLibraryAsCurator	PATCH /api/v1/as-curator/libraries/{id}	Update a library object
LibrarySPoTAsUserApi	GetLibrariesByGroupAsUser	GET /api/v1/as-user/libraries/by/group/{id}	Retrieve libraries related to the given group
LibrarySPoTAsUserApi	GetLibraryAsUser	GET /api/v1/as-user/libraries/{id}	Retrieve a single library object by ID (accession)
LibrarySPoTAsUserApi	GetLibraryByVersionAsUser	GET /api/v1/as-user/libraries/{id}/versions/{version}	Retrieve a single library object by ID (accession)
LibrarySPoTAsUserApi	GetLibraryVersionsAsUser	GET /api/v1/as-user/libraries/{id}/versions	Retrieve a list of object versions by ID
LibrarySPoTAsUserApi	SearchLibrariesAsUser	GET /api/v1/as-user/libraries	List or search for library metadata objects
LinkageAsCuratorApi	DeleteLinkAsCurator	DELETE /api/v1/as-curator/links	Deletes existing links matching the specified criteria.
LinkageAsCuratorApi	GetDataTypesAsCurator	GET /api/v1/as-curator/data-types	Lists all available data types.
LinkageAsCuratorApi	GetDataTypesLinksAsCurator	GET /api/v1/as-curator/data-types/links	List all possible links between data types that match the specified criteria.
LinkageAsCuratorApi	GetLinksByIdsAsCurator	POST /api/v1/as-curator/links/get-batch	Finds existing links by passing many IDs. Pagination goes through all links matched the criteria.
LinkageAsCuratorApi	GetLinksByParamsAsCurator	GET /api/v1/as-curator/links	Finds existing links matching the specified criteria.
LinkageAsCuratorApi	SaveLinksAsCurator	POST /api/v1/as-curator/links	Creates new links between objects.
LinkageAsUserApi	GetDataTypesAsUser	GET /api/v1/as-user/data-types	Lists all available data types.
LinkageAsUserApi	GetDataTypesLinksAsUser	GET /api/v1/as-user/data-types/links	List all possible links between data types that match the specified criteria.
LinkageAsUserApi	GetLinksByIdsAsUser	POST /api/v1/as-user/links/get-batch	Finds existing links by passing many IDs. Pagination goes through all links matched the criteria.
LinkageAsUserApi	GetLinksByParamsAsUser	GET /api/v1/as-user/links	Finds existing links matching the specified criteria.
ManageDataApi	DeleteData	DELETE /api/v1/manage-data/data	Delete objects from ODM
ManageDataApi	GetDetachedObjects	GET /api/v1/manage-data/detached-objects	Retrieve a list of detached objects
MetadataVersioningAsCuratorApi	PublishStudyByAccessionAsCurator	POST /api/v1/as-curator/integration/studies/{id}/tasks/publish-versions	Asynchronous task that publishes all pending versions for a single study.
OmicsQueriesAsCuratorApi	OmicsSearchCellsAsCurator	GET /api/v1/as-curator/omics/cells	Retrieve Cell objects by searching across multiple data types
OmicsQueriesAsCuratorApi	OmicsSearchCellsExpressionDataAsCurator	GET /api/v1/as-curator/omics/cells/expression/data	Retrieve cell expression objects by searching across multiple metadata types
OmicsQueriesAsCuratorApi	OmicsSearchExpressionDataAsCurator	GET /api/v1/as-curator/omics/expression/data	Retrieve data objects by searching across multiple data types
OmicsQueriesAsCuratorApi	OmicsSearchExpressionGroupsAsCurator	GET /api/v1/as-curator/omics/expression/group	Retrieve group objects by searching across multiple data types
OmicsQueriesAsCuratorApi	OmicsSearchFlowCytometryDataAsCurator	GET /api/v1/as-curator/omics/flow-cytometry/data	Retrieve flow cytometry data objects by searching across multiple data types
OmicsQueriesAsCuratorApi	OmicsSearchFlowCytometryGroupsAsCurator	GET /api/v1/as-curator/omics/flow-cytometry/group	Retrieve group objects by searching across multiple data types
OmicsQueriesAsCuratorApi	OmicsSearchSamplesAsCurator	GET /api/v1/as-curator/omics/samples	Retrieve sample metadata objects by searching across multiple data types
OmicsQueriesAsCuratorApi	OmicsSearchStreamedExpressionDataAsCurator	GET /api/v1/as-curator/omics/expression/streamed-data	Stream data from a given tabular file
OmicsQueriesAsCuratorApi	OmicsSearchStreamedVariantDataAsCurator	GET /api/v1/as-curator/omics/variant/streamed-data	Stream data from a given VCF file
OmicsQueriesAsCuratorApi	OmicsSearchVariantDataAsCurator	GET /api/v1/as-curator/omics/variant/data	Retrieve variant data objects by searching across multiple data types
OmicsQueriesAsCuratorApi	OmicsSearchVariantGroupsAsCurator	GET /api/v1/as-curator/omics/variant/group	Retrieve group objects by searching across multiple data types
OmicsQueriesAsUserApi	OmicsSearchCellsAsUser	GET /api/v1/as-user/omics/cells	Retrieve Cell objects by searching across multiple data types
OmicsQueriesAsUserApi	OmicsSearchCellsExpressionDataAsUser	GET /api/v1/as-user/omics/cells/expression/data	Retrieve cell expression objects by searching across multiple metadata types
OmicsQueriesAsUserApi	OmicsSearchExpressionDataAsUser	GET /api/v1/as-user/omics/expression/data	Retrieve data objects by searching across multiple data types
OmicsQueriesAsUserApi	OmicsSearchExpressionGroupsAsUser	GET /api/v1/as-user/omics/expression/group	Retrieve group objects by searching across multiple data types
OmicsQueriesAsUserApi	OmicsSearchFlowCytometryDataAsUser	GET /api/v1/as-user/omics/flow-cytometry/data	Retrieve flow cytometry data objects by searching across multiple data types
OmicsQueriesAsUserApi	OmicsSearchFlowCytometryGroupsAsUser	GET /api/v1/as-user/omics/flow-cytometry/group	Retrieve group objects by searching across multiple data types
OmicsQueriesAsUserApi	OmicsSearchSamplesAsUser	GET /api/v1/as-user/omics/samples	Retrieve sample metadata objects by searching across multiple data types
OmicsQueriesAsUserApi	OmicsSearchStreamedExpressionDataAsUser	GET /api/v1/as-user/omics/expression/streamed-data	Stream data from a given tabular file
OmicsQueriesAsUserApi	OmicsSearchStreamedVariantDataAsUser	GET /api/v1/as-user/omics/variant/streamed-data	Stream data from a given VCF file
OmicsQueriesAsUserApi	OmicsSearchVariantDataAsUser	GET /api/v1/as-user/omics/variant/data	Retrieve variant data objects by searching across multiple data types
OmicsQueriesAsUserApi	OmicsSearchVariantGroupsAsUser	GET /api/v1/as-user/omics/variant/group	Retrieve group objects by searching across multiple data types
PreparationIntegrationAsCuratorApi	CreatePreparationGroupSampleGroupLinkAsCurator	POST /api/v1/as-curator/integration/link/preparation/group/{sourceId}/to/sample/group/{targetId}	Create links between samples and preparations
PreparationIntegrationAsCuratorApi	CreatePreparationSampleLinkAsCurator	POST /api/v1/as-curator/integration/link/preparation/{sourceId}/to/sample/{targetId}	Create a link between a preparation and a sample
PreparationIntegrationAsCuratorApi	DeletePreparationGroupSampleGroupLinkAsCurator	DELETE /api/v1/as-curator/integration/link/preparation/group/{sourceId}/to/sample/group/{targetId}	Delete links between samples and preparations related to the specified group
PreparationIntegrationAsCuratorApi	DeletePreparationSampleLinkAsCurator	DELETE /api/v1/as-curator/integration/link/preparation/{sourceId}/to/sample/{targetId}	Delete a link between a preparation and a sample
PreparationIntegrationAsCuratorApi	GetPreparationBySampleAsCurator	GET /api/v1/as-curator/integration/link/preparation/by/sample/{id}	Retrieve preparation metadata by querying related sample ID (accession)
PreparationIntegrationAsCuratorApi	GetPreparationGroupsByStudyAsCurator	GET /api/v1/as-curator/integration/link/preparation/group/by/study/{id}	Retrieve group metadata by querying study ID (accession)
PreparationIntegrationAsCuratorApi	GetPreparationLinksToSamplesAsCurator	GET /api/v1/as-curator/integration/link/preparation/preparations-to-samples/by/group/{id}	Retrieve run-sample pairs by group id. Pagination is based on unique preparations, not unique pairs.
PreparationIntegrationAsCuratorApi	GetPreparationsBySamplesAsCurator	GET /api/v1/as-curator/integration/link/preparations/by/samples	Retrieve preparation metadata by querying related samples
PreparationIntegrationAsUserApi	GetPreparationBySampleAsUser	GET /api/v1/as-user/integration/link/preparation/by/sample/{id}	Retrieve preparation metadata by querying related sample ID (accession)
PreparationIntegrationAsUserApi	GetPreparationGroupsByStudyAsUser	GET /api/v1/as-user/integration/link/preparation/group/by/study/{id}	Retrieve group metadata by querying study ID (accession)
PreparationIntegrationAsUserApi	GetPreparationLinksToSamplesAsUser	GET /api/v1/as-user/integration/link/preparation/preparations-to-samples/by/group/{id}	Retrieve run-sample pairs by group id. Pagination is based on unique preparations, not unique pairs.
PreparationIntegrationAsUserApi	GetPreparationsBySamplesAsUser	GET /api/v1/as-user/integration/link/preparations/by/samples	Retrieve preparation metadata by querying related samples
PreparationSPoTAsCuratorApi	GetPreparationAsCurator	GET /api/v1/as-curator/preparations/{id}	Retrieve a single preparation object by ID (accession)
PreparationSPoTAsCuratorApi	GetPreparationByVersionAsCurator	GET /api/v1/as-curator/preparations/{id}/versions/{version}	Retrieve a single preparation object by ID (accession)
PreparationSPoTAsCuratorApi	GetPreparationVersionsAsCurator	GET /api/v1/as-curator/preparations/{id}/versions	Retrieve a list of object versions by ID
PreparationSPoTAsCuratorApi	GetPreparationsByGroupAsCurator	GET /api/v1/as-curator/preparations/by/group/{id}	Retrieve preparations related to the given group
PreparationSPoTAsCuratorApi	SearchPreparationsAsCurator	GET /api/v1/as-curator/preparations	List or search for preparation metadata objects
PreparationSPoTAsCuratorApi	UpdatePreparationAsCurator	PATCH /api/v1/as-curator/preparations/{id}	Update a preparation object
PreparationSPoTAsUserApi	GetPreparationAsUser	GET /api/v1/as-user/preparations/{id}	Retrieve a single preparation object by ID (accession)
PreparationSPoTAsUserApi	GetPreparationByVersionAsUser	GET /api/v1/as-user/preparations/{id}/versions/{version}	Retrieve a single preparation object by ID (accession)
PreparationSPoTAsUserApi	GetPreparationVersionsAsUser	GET /api/v1/as-user/preparations/{id}/versions	Retrieve a list of object versions by ID
PreparationSPoTAsUserApi	GetPreparationsByGroupAsUser	GET /api/v1/as-user/preparations/by/group/{id}	Retrieve preparations related to the given group
PreparationSPoTAsUserApi	SearchPreparationsAsUser	GET /api/v1/as-user/preparations	List or search for preparation metadata objects
ReferenceGenomeApi	GetReferenceGenomeByAccession	GET /api/v1/reference-genomes/{id}	Retrieve a single Reference Genome object by ID (accession)
ReferenceGenomeApi	SearchReferenceGenomes	GET /api/v1/reference-genomes	List or search for Reference Genome objects
ReferenceGenomeApi	Upload	POST /api/v1/reference-genomes	Upload reference genome to ODM
SampleIntegrationAsCuratorApi	CreateSampleGroupStudyLinkAsCurator	POST /api/v1/as-curator/integration/link/sample/group/{sourceId}/to/study/{targetId}	Create a link between a group of sample objects and a study
SampleIntegrationAsCuratorApi	CreateSampleStudyLinkAsCurator	POST /api/v1/as-curator/integration/link/sample/{sourceId}/to/study/{targetId}	Create a link between a sample and a study
SampleIntegrationAsCuratorApi	DeleteSampleGroupStudyLinkAsCurator	DELETE /api/v1/as-curator/integration/link/sample/group/{sourceId}/to/study/{targetId}	Delete link between a group of sample objects and a study
SampleIntegrationAsCuratorApi	DeleteSampleStudyLinkAsCurator	DELETE /api/v1/as-curator/integration/link/sample/{sourceId}/to/study/{targetId}	Delete link between a sample and a study
SampleIntegrationAsCuratorApi	GetSamplesByLibrariesAsCurator	GET /api/v1/as-curator/integration/link/samples/by/libraries	Retrieve sample metadata by querying related libraries
SampleIntegrationAsCuratorApi	GetSamplesByPreparationsAsCurator	GET /api/v1/as-curator/integration/link/samples/by/preparations	Retrieve sample metadata by querying related preparations
SampleIntegrationAsCuratorApi	GetSamplesByStudyAsCurator	GET /api/v1/as-curator/integration/link/samples/by/study/{id}	Retrieve sample metadata by querying related study ID (accession)
SampleIntegrationAsUserApi	GetSamplesByLibrariesAsUser	GET /api/v1/as-user/integration/link/samples/by/libraries	Retrieve sample metadata by querying related libraries
SampleIntegrationAsUserApi	GetSamplesByPreparationsAsUser	GET /api/v1/as-user/integration/link/samples/by/preparations	Retrieve sample metadata by querying related preparations
SampleIntegrationAsUserApi	GetSamplesByStudyAsUser	GET /api/v1/as-user/integration/link/samples/by/study/{id}	Retrieve sample metadata by querying related study ID (accession)
SampleSPoTAsCuratorApi	GetSampleAsCurator	GET /api/v1/as-curator/samples/{id}	Retrieve a single sample object by ID (accession)
SampleSPoTAsCuratorApi	GetSampleByVersionAsCurator	GET /api/v1/as-curator/samples/{id}/versions/{version}	Retrieve a single sample object by ID (accession)
SampleSPoTAsCuratorApi	GetSampleVersionsAsCurator	GET /api/v1/as-curator/samples/{id}/versions	Retrieve a list of object versions by ID
SampleSPoTAsCuratorApi	SearchSamplesAsCurator	GET /api/v1/as-curator/samples	List or search for sample metadata objects
SampleSPoTAsCuratorApi	UpdateSampleAsCurator	PATCH /api/v1/as-curator/samples/{id}	Update a sample object
SampleSPoTAsUserApi	GetSampleAsUser	GET /api/v1/as-user/samples/{id}	Retrieve a single sample object by ID (accession)
SampleSPoTAsUserApi	GetSampleByVersionAsUser	GET /api/v1/as-user/samples/{id}/versions/{version}	Retrieve a single sample object by ID (accession)
SampleSPoTAsUserApi	GetSampleVersionsAsUser	GET /api/v1/as-user/samples/{id}/versions	Retrieve a list of object versions by ID
SampleSPoTAsUserApi	SearchSamplesAsUser	GET /api/v1/as-user/samples	List or search for sample metadata objects
StudyIntegrationAsCuratorApi	GetStudiesByFilesAsCurator	GET /api/v1/as-curator/integration/link/studies/by/files	Retrieve study metadata objects by querying related attachment files
StudyIntegrationAsCuratorApi	GetStudiesByLibrariesAsCurator	GET /api/v1/as-curator/integration/link/studies/by/libraries	Retrieve study metadata objects by querying related libraries
StudyIntegrationAsCuratorApi	GetStudiesByPreparationsAsCurator	GET /api/v1/as-curator/integration/link/studies/by/preparations	Retrieve study metadata objects by querying related preparations
StudyIntegrationAsCuratorApi	GetStudiesBySamplesAsCurator	GET /api/v1/as-curator/integration/link/studies/by/samples	Retrieve study metadata objects by querying related samples
StudyIntegrationAsCuratorApi	GetStudyByFileAsCurator	GET /api/v1/as-curator/integration/link/study/by/file/{id}	Retrieve study metadata by querying attachment file ID (accession)
StudyIntegrationAsCuratorApi	GetStudyBySampleAsCurator	GET /api/v1/as-curator/integration/link/study/by/sample/{id}	Retrieve study metadata by querying sample ID (accession)
StudyIntegrationAsCuratorApi	SearchStudiesByFilterAsCurator	POST /api/v1/as-curator/integration/fulltext/search/studies	Find and retrieve studies by full-text or facet query
StudyIntegrationAsUserApi	GetStudiesByFilesAsUser	GET /api/v1/as-user/integration/link/studies/by/files	Retrieve study metadata objects by querying related attachment files
StudyIntegrationAsUserApi	GetStudiesByLibrariesAsUser	GET /api/v1/as-user/integration/link/studies/by/libraries	Retrieve study metadata objects by querying related libraries
StudyIntegrationAsUserApi	GetStudiesByPreparationsAsUser	GET /api/v1/as-user/integration/link/studies/by/preparations	Retrieve study metadata objects by querying related preparations
StudyIntegrationAsUserApi	GetStudiesBySamplesAsUser	GET /api/v1/as-user/integration/link/studies/by/samples	Retrieve study metadata objects by querying related samples
StudyIntegrationAsUserApi	GetStudyByFileAsUser	GET /api/v1/as-user/integration/link/study/by/file/{id}	Retrieve study metadata by querying attachment file ID (accession)
StudyIntegrationAsUserApi	GetStudyBySampleAsUser	GET /api/v1/as-user/integration/link/study/by/sample/{id}	Retrieve study metadata by querying sample ID (accession)
StudyIntegrationAsUserApi	SearchStudiesByFilterAsUser	POST /api/v1/as-user/integration/fulltext/search/studies	Find and retrieve studies by full-text or facet query
StudySPoTAsCuratorApi	GetStudyAsCurator	GET /api/v1/as-curator/studies/{id}	Retrieve a single study object by ID (accession)
StudySPoTAsCuratorApi	GetStudyByVersionAsCurator	GET /api/v1/as-curator/studies/{id}/versions/{version}	Retrieve a single study object by ID (accession)
StudySPoTAsCuratorApi	GetStudyVersionsAsCurator	GET /api/v1/as-curator/studies/{id}/versions	Retrieve a list of object versions by ID
StudySPoTAsCuratorApi	SearchStudiesAsCurator	GET /api/v1/as-curator/studies	List or search for study metadata objects
StudySPoTAsCuratorApi	UpdateStudyAsCurator	PATCH /api/v1/as-curator/studies/{id}	Update a study object
StudySPoTAsUserApi	GetStudyAsUser	GET /api/v1/as-user/studies/{id}	Retrieve a single study object by ID (accession)
StudySPoTAsUserApi	GetStudyByVersionAsUser	GET /api/v1/as-user/studies/{id}/versions/{version}	Retrieve a single study object by ID (accession)
StudySPoTAsUserApi	GetStudyVersionsAsUser	GET /api/v1/as-user/studies/{id}/versions	Retrieve a list of object versions by ID
StudySPoTAsUserApi	SearchStudiesAsUser	GET /api/v1/as-user/studies	List or search for study metadata objects
TasksAPIApi	GetTaskInfo	GET /api/v1/tasks/{id}	Retrieve information about any ODM task.
TasksAPIApi	PublishAllStudies	POST /api/v1/tasks/publish-versions	Asynchronous task that publishes all pending versions across all studies in the instance.
TransformationConfigurationsApi	DeleteApiV1TransformationsConfigurationsById	DELETE /api/v1/transformations/configurations/{id}	Delete an existing transformation configuration.
TransformationConfigurationsApi	GetApiV1TransformationsConfigurationsById	GET /api/v1/transformations/configurations/{id}	Get details of a specific transformation configuration.
TransformationConfigurationsApi	ListApiV1TransformationsConfigurations	GET /api/v1/transformations/configurations	List available transformation configurations.
TransformationConfigurationsApi	PostApiV1TransformationsConfigurations	POST /api/v1/transformations/configurations	Create a new transformation configuration.
TransformationConfigurationsApi	PutApiV1TransformationsConfigurationsById	PUT /api/v1/transformations/configurations/{id}	Update an existing transformation configuration.
TransformationImagesApi	ListApiV1TransformationsImages	GET /api/v1/transformations/images	List available transformation images with their metadata.
TransformationJobsApi	DeleteApiV1TransformationsJobsById	DELETE /api/v1/transformations/jobs/{id}	Delete a transformation job by ID.
TransformationJobsApi	GetApiV1TransformationsJobsById	GET /api/v1/transformations/jobs/{id}	Get details of a specific transformation job.
TransformationJobsApi	ListApiV1TransformationsJobs	GET /api/v1/transformations/jobs	List submitted transformation jobs.
TransformationJobsApi	PostApiV1TransformationsJobs	POST /api/v1/transformations/jobs	Submit a new transformation job with optional configuration and version.
TransformationJobsApi	PostApiV1TransformationsJobsByIdLogs	POST /api/v1/transformations/jobs/{id}/logs	Retrieve logs for a transformation job.
TransformationJobsApi	PostApiV1TransformationsJobsByIdStop	POST /api/v1/transformations/jobs/{id}/stop	Stop a running transformation job.
UsersApi	CreateUser	POST /api/v1/scim/Users	Add a new user
UsersApi	DeleteUser	DELETE /api/v1/scim/Users/{id}	Deactivate a user
UsersApi	FindUsers	GET /api/v1/scim/Users	Retrieve a list of all active users
UsersApi	GetUser	GET /api/v1/scim/Users/{id}	Retrieve a user by id
UsersApi	PatchUser	PATCH /api/v1/scim/Users/{id}	Update a user
ValidationSummaryAsCuratorApi	GetStudyValidationSummary	GET /api/v1/as-curator/integration/studies/{id}/validation-summary	Retrieve validation summary by querying study ID (accession)
VariantIntegrationAsCuratorApi	CreateVariantGroupSampleGroupLinkAsCurator	POST /api/v1/as-curator/integration/link/variant/group/{sourceId}/to/sample/group/{targetId}	Create a link between a group of variant objects and a group of sample objects
VariantIntegrationAsCuratorApi	CreateVariantSampleLinkAsCurator	POST /api/v1/as-curator/integration/link/variant/{sourceId}/to/sample/{targetId}	Create a link between a variant object and a sample
VariantIntegrationAsCuratorApi	DeleteVariantGroupSampleGroupLinkAsCurator	DELETE /api/v1/as-curator/integration/link/variant/group/{sourceId}/to/sample/group/{targetId}	Delete link between a group of variant objects and a group of sample objects
VariantIntegrationAsCuratorApi	DeleteVariantSampleLinkAsCurator	DELETE /api/v1/as-curator/integration/link/variant/{sourceId}/to/sample/{targetId}	Delete link between a variant object and a sample
VariantIntegrationAsCuratorApi	GetVariantBySampleAsCurator	GET /api/v1/as-curator/integration/link/variant/by/sample/{id}	Retrieve variant run-level data by querying related sample ID (accession)
VariantIntegrationAsCuratorApi	GetVariantGroupsByStudyAsCurator	GET /api/v1/as-curator/integration/link/variant/group/by/study/{id}	Retrieve group metadata by querying study ID (accession)
VariantIntegrationAsCuratorApi	GetVariantRunToSamplePairsAsCurator	GET /api/v1/as-curator/integration/link/variant/run-to-samples/by/group/{id}	Retrieve run-sample pairs by group id. Pagination is based on unique runs, not unique pairs.
VariantIntegrationAsUserApi	GetVariantBySampleAsUser	GET /api/v1/as-user/integration/link/variant/by/sample/{id}	Retrieve variant run-level data by querying related sample ID (accession)
VariantIntegrationAsUserApi	GetVariantGroupsByStudyAsUser	GET /api/v1/as-user/integration/link/variant/group/by/study/{id}	Retrieve group metadata by querying study ID (accession)
VariantIntegrationAsUserApi	GetVariantRunToSamplePairsAsUser	GET /api/v1/as-user/integration/link/variant/run-to-samples/by/group/{id}	Retrieve run-sample pairs by group id. Pagination is based on unique runs, not unique pairs.
VariantSPoTAsCuratorApi	GetAllVariantsAsCurator	GET /api/v1/as-curator/variants	Retrieve multiple variant data and metadata objects
VariantSPoTAsCuratorApi	GetVariantAsCurator	GET /api/v1/as-curator/variants/{id}	Retrieve a single variant object by ID (itemId)
VariantSPoTAsCuratorApi	GetVariantByVersionAsCurator	GET /api/v1/as-curator/variants/{id}/versions/{version}	Retrieve a single variant object by run ID and its version
VariantSPoTAsCuratorApi	GetVariantGroupAsCurator	GET /api/v1/as-curator/variants/group/{id}	Retrieve a single variant group by ID (groupId)
VariantSPoTAsCuratorApi	GetVariantGroupByRunAsCurator	GET /api/v1/as-curator/variants/group/by/run/{id}	Retrieve a single group object by run ID (runId)
VariantSPoTAsCuratorApi	GetVariantVersionsAsCurator	GET /api/v1/as-curator/variants/{id}/versions	Retrieve a list of variant object versions by run ID (runId)
VariantSPoTAsCuratorApi	SearchGroupsAsCurator	GET /api/v1/as-curator/variants/group	Retrieve groups that match a query
VariantSPoTAsCuratorApi	SearchVariantRunsAsCurator	GET /api/v1/as-curator/variants/runs/by/group/{id}	Retrieve run objects related to the given group
VariantSPoTAsUserApi	GetAllVariantsAsUser	GET /api/v1/as-user/variants	Retrieve multiple variant data and metadata objects
VariantSPoTAsUserApi	GetVariantAsUser	GET /api/v1/as-user/variants/{id}	Retrieve a single variant object by ID (itemId)
VariantSPoTAsUserApi	GetVariantByVersionAsUser	GET /api/v1/as-user/variants/{id}/versions/{version}	Retrieve a single variant object by run ID and its version
VariantSPoTAsUserApi	GetVariantGroupAsUser	GET /api/v1/as-user/variants/group/{id}	Retrieve a single variant group by ID (groupId)
VariantSPoTAsUserApi	GetVariantGroupByRunAsUser	GET /api/v1/as-user/variants/group/by/run/{id}	Retrieve a single group object by run ID (runId)
VariantSPoTAsUserApi	GetVariantVersionsAsUser	GET /api/v1/as-user/variants/{id}/versions	Retrieve a list of variant object versions by run ID (runId)
VariantSPoTAsUserApi	SearchVariantGroupsAsUser	GET /api/v1/as-user/variants/group	Retrieve groups that match a query
VariantSPoTAsUserApi	SearchVariantRunsAsUser	GET /api/v1/as-user/variants/runs/by/group/{id}	Retrieve run objects related to the given group
XrefsetQueriesApi	Create	POST /api/v1/xrefsets	Import a new xrefset file
XrefsetQueriesApi	DeleteFile	DELETE /api/v1/xrefsets/{id}	Delete a xrefset with all related data. Only users who uploaded the xrefset are allowed to delete it.
XrefsetQueriesApi	GetDetailsByAccession	GET /api/v1/xrefsets/{id}/metadata	Retrieve xrefset details
XrefsetQueriesApi	SearchEntries	GET /api/v1/xrefsets/entries	Retrieve a list of entries across all xrefsets for given sourceId and targetId
XrefsetQueriesApi	SearchEntriesWithinFile	GET /api/v1/xrefsets/{id}/entries	Retrieve a list of entries for the given xrefset and given sourceId and targetId

Documentation for Models

• AccessionResponse
• AppliedFilter
• AttributeInvalidValue
• AttributeInvalidValueErrorsInner
• AttributeInvalidValueValue
• AttributeValidationSummary
• AttributeValidationSummaryAttributeInvalidValuesInner
• BaseErrorResponse
• BaseErrorResponseError
• BatchOfIds
• CRRequest
• CRResponse
• CellListResponse
• CommitInfo
• CreateGroup201Response
• CreateGroup201ResponseAllOfMeta
• CreateGroupRequest
• CreateGroupRequestMembersInner
• CreateUser201Response
• CreateUserRequest
• CreateUserRequestEmailsInner
• DERequest
• DERequestCaseGroup
• DEResponse
• DEResponsePagination
• DEResponseResultsPerGeneInner
• DataItem
• DataPresentation
• DataPresentationRelationships
• DetachedCollection
• DetachedCollectionDataInner
• DetachedObject
• Email
• ErrorDetail
• ErrorMessage
• ErrorModel
• ExceptionTypeAndMessage
• ExpressionItem
• ExpressionResponse
• FilterGroupsResponse
• FilterOption
• FilterOptionGroup
• FilterUsersResponse
• FindObjectsResponse
• FindObjectsResponseFilterOptionGroupsInner
• FindObjectsResponseFilterOptionGroupsInnerOptionsInner
• FindObjectsResponseObjectsPage
• FindObjectsResponseObjectsPageContentInner
• FindObjectsResponseObjectsPageContentInnerSummaryInner
• FlowCytometryItem
• FlowCytometryResponse
• GSRequest
• GSResponse
• GSResponseResultsPerGeneInner
• GetExpressionAsCurator200Response
• GetExpressionAsCurator200ResponseFeature
• GetExpressionAsCurator200ResponseItemOrigin
• GetFlowCytometryAsCurator200Response
• GetFlowCytometryAsCurator200ResponseFeature
• GetFlowCytometryAsCurator200ResponseValue
• GetVariantAsCurator200Response
• GetVariantAsCurator200ResponseVariant
• Group
• GroupPatch
• GroupPatchOperationsInner
• GroupResponse
• GroupResponseAllOfMembers
• GroupValidationSummary
• GroupValidationSummaryAttributesInner
• IMetadata
• ImportAFileRequest
• ImportCellsRequest
• ImportExpressionSignalRunRequest
• ImportMetadataRequest
• ImportSignalRunRequest
• Info
• JobRuntimeError
• JobRuntimeErrorStackInner
• Link
• ListResponse
• ListResponseMeta
• ListResponseMetaPagination
• LogsPayload
• ManagedObject
• Member
• Meta
• MetaResponse
• MetadataPresentation
• MetadataPresentationMetadata
• MetadataWithId
• MetainfoKeyForSummary
• ObjectsPage
• OmicsResponse
• OmicsResponseDataPresentation
• OmicsResponseDataPresentationDataInner
• OmicsResponseMetadataPresentation
• OmicsResponseMetadataPresentationDataInner
• OmicsResponseMetadataWithId
• Output
• OutputErrorsInner
• PageRequest
• PaginationInfo
• PatchOperation
• RGItem
• Relationships
• ResponseFormat
• RunsResponse
• SCIMErrorResponse
• SearchStudyRequest
• SearchStudyRequestFiltersInner
• SearchStudyRequestPage
• SourceTypePair
• StartImportVariantRequest
• StopPayload
• StopResponse
• StudySearchInfo
• StudyValidationSummary
• StudyValidationSummarySamplesInner
• TaskInfo
• TransformationConfiguration
• TransformationConfigurationFields
• TransformationConfigurationId
• TransformationImage
• TransformationImageReference
• TransformationJob
• TransformationJobCreateFields
• TransformationJobFields
• TransformationJobId
• TransformationJobStopSignal
• TransformationOutputFormat
• TransformationState
• TransformationStateReason
• TransformationStatus
• UploadRGRequest
• User
• UserPatch
• UserResponse
• ValidationError
• VariantItem
• VariantMetadataWithId
• VariantResponse
• XrefSetCreateRequest
• XrefSetCreateResponse
• XrefSetMetadata
• XrefSetSearchResult
• XrefSetSearchResultEntry
• XrefSetSearchResultResultInner

Documentation for Authorization

Authentication schemes defined for the API:

Access-token

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header

Genestack-API-Token

• Type: API key
• API key parameter name: Genestack-API-Token
• Location: HTTP header