The identity and technical contract details declared by the specification.
ActionEnum
string
download - Download tab - Tab
AddOrRemoveUsers
object
Serializer for adding or removing users from a group.
1 property
1 required
AggregatedExpressionBoxPlot
object
Aggregated expression box plot serializer.
11 properties
11 required
AnnotationField
object
Serializer for AnnotationField objects.
11 properties
6 required
AnnotationFieldDict
object
Serializer for actions that deal with annotation fields.
1 property
1 required
AnnotationPresetSerializerWithPermissions
object
Serializer for AnnotationPreset objects.
5 properties
4 required
AnnotationUpload
object
Serializer for the response when uploading an annotation file.
1 property
1 required
AnnotationUploadDeserializer
object
Deserializer for request data when uploading an annotation file.
2 properties
2 required
AnnotationValue
object
Serializer for AnnotationValue objects.
8 properties
7 required
AnnotationVersionEnum
string
v2 - v2
AnnotationsByPath
object
Serializer that reads annotation field and its value.
2 properties
2 required
ApiLogin
object
Deserializer for login credentials.
2 properties
2 required
AppState
object
Serializer for :class:AppState objects.
3 properties
3 required
AttributeList
object
Attribute serializer.
2 properties
2 required
AttributesDeserializer
object
Serializer for parsing attributes endpoint input.
3 properties
AttributifyDeserializer
object
Serializer for parsing attributify endpoint input.
4 properties
1 required
BackgroundTask
object
Serialize the BackgroundTask model.
6 properties
2 required
BackgroundTaskStatusEnum
string
WT - Waiting PR - Processing OK - Done ER - Error
BaseSpaceSample
object
BaseSpace sample entity serializer.
3 properties
3 required
BaseSpaceSamples
object
BaseSpace samples serializer.
3 properties
BaseSpaceUser
object
BaseSpace user serializer.
2 properties
Basket
object
Serializer for :class:SampleInBasket objects.
6 properties
4 required
BasketAddSamples
object
Basket add samples serializer.
8 properties
8 required
BasketAddSamplesDeserializer
object
Basket add samples deserializer.
4 properties
1 required
BasketBreadcrumb
object
SampleBasketBreadcrumb serializer.
3 properties
1 required
BasketClone
object
Basket clone serializer.
3 properties
3 required
BasketDataTypes
object
Basket data types serializer.
1 property
1 required
BasketExpressions
object
Basket expressions serializer.
2 properties
2 required
BasketMutation
object
Basket update serializer.
2 properties
2 required
BasketOrganism
object
Basket organism list serializer.
1 property
1 required
BasketSampleCount
object
Basket sample count serializer.
1 property
1 required
BasketSource
object
Basket source list serializer.
1 property
1 required
BasketSubset
object
Basket serializer where a subset of samples is selected.
1 property
BillingAccount
object
Billing account serializer.
3 properties
3 required
BillingAccountToCollection
object
Serializer for assigning a collection to a billing account.
1 property
1 required
BillingStatisticsCollection
object
Serializer for the billing statistics by collection.
5 properties
1 required
BillingStatisticsCost
object
Serializer for the billing statistics by billing account. Plus additional billing costs.
6 properties
1 required
CaseControlExpressions
object
CaseControlExpressions serializer.
3 properties
3 required
CaseControlExpressionsDeserializer
object
Serializer for parsing case and control expressions endpoint input.
4 properties
2 required
CollectionSerializerWithPermissions
object
Serializer for Collection objects.
17 properties
9 required
CollectionSpecies
object
Species serializer.
2 properties
2 required
Community
object
Serializer for :class:Community objects.
4 properties
3 required
Configuration
object
Serializer for :class:Configuration objects.
19 properties
2 required
Contributor
object
Serializer for contributor User objects.
4 properties
2 required
CredentialsPoll
object
Serializer for CredentialsPollView.
2 properties
2 required
CurrentUserPermissions
object
Current user permissions serializer.
5 properties
2 required
CurrentUserPermissionsTypeEnum
string
user - user group - group public - public
Data
object
Serializer for Data objects.
30 properties
20 required
DataAccessToken
object
Serializer for DataAccessToken.
7 properties
5 required
DataAccessTokenCreate
object
Serializer for creating DataAccessToken.
8 properties
5 required
DataSerializerWithPermissions
object
Serializer for Data objects.
31 properties
21 required
DataStatus
string
UP - Uploading RE - Resolving WT - Waiting PP - Preparing PR - Processing OK - Done ER - Error DR - Dirty
Delete
object
Bulk delete given objects.
1 property
1 required
DescriptorAttribute
object
Descriptor attribute serializer.
5 properties
3 required
DescriptorSchemaSerializerWithPermissions
object
Serializer for DescriptorSchema objects.
10 properties
5 required
DifferentialExpressionsDeserializer
object
Deserialize ~genesis.models.differentialexpression.models.GeneSetSearch.
4 properties
DifferentialExpressionsSerializerWithPermissions
object
Serialize ~genesis.models.differentialexpression.models.GeneSetSearch.
36 properties
21 required
Duplicate
object
Deserializer for duplicate endpoint.
1 property
1 required
Entity
object
Serializer for Entity with added collection field.
14 properties
7 required
EntitySerializerWithPermissions
object
Serializer for Entity with added collection field.
15 properties
8 required
EstimatedCostPerBillingAccount
object
Serializer for cost per day per billing account.
7 properties
7 required
Expression
object
Expression serializer.
5 properties
5 required
ExpressionBoxPlot
object
ExpressionBoxPlot serializer.
10 properties
10 required
ExpressionBoxPlotDeserializer
object
ExpressionBoxPlot deserializer.
6 properties
1 required
Expressions
object
Expressions serializer.
6 properties
4 required
ExpressionsDeserializer
object
Expressions deserializer.
7 properties
1 required
Feature
object
Serializer for feature.
10 properties
7 required
FeatureTypeEnum
string
gene - Gene transcript - Transcript exon - Exon probe - Probe
File
object
BaseSpace file entity serializer.
2 properties
2 required
Files
object
BaseSpace files serializer.
3 properties
GeneIds
object
Serializer for geneids query parameter. Enforce that if geneids are specified, source and species are also.
3 properties
GeneList
object
Gene list serializer.
3 properties
3 required
GenesetSearchSerializerWithPermissions
object
Serialize ~genesis.models.differentialexpression.models.GeneSetSearch.
38 properties
22 required
Group
object
Serializer for :class:Group objects.
3 properties
3 required
Handle
object
Handle serializer.
1 property
Heatmap
object
Heatmap serializer.
5 properties
5 required
HeatmapDeserializer
object
Heatmap deserializer.
4 properties
1 required
IdGenerator
object
Serializer for IdGeneratorView.
1 property
1 required
Mapping
object
Serializer for mapping.
8 properties
8 required
MoveDataToCollection
object
Deserializer for data move to collection endpoint.
2 properties
2 required
MoveEntityToCollection
object
Serializer for moving entities to a collection.
2 properties
2 required
ObserverSubscribeRequest
object
Serializer for the subscribe endpoint.
2 properties
1 required
ObserverSubscription
object
Serializer for the subscribe response.
1 property
1 required
PaginatedAggregatedExpressionBoxPlotList
object
4 properties
2 required
PaginatedAnnotationFieldList
object
4 properties
2 required
PaginatedAnnotationPresetSerializerWithPermissionsList
object
4 properties
2 required
PaginatedAnnotationValueList
object
4 properties
2 required
PaginatedBackgroundTaskList
object
4 properties
2 required
PaginatedBasketBreadcrumbList
object
4 properties
2 required
PaginatedBasketExpressionsList
object
4 properties
2 required
PaginatedBasketOrganismList
object
4 properties
2 required
PaginatedBasketSourceList
object
4 properties
2 required
PaginatedBillingAccountList
object
4 properties
2 required
PaginatedCollectionSerializerWithPermissionsList
object
4 properties
2 required
PaginatedCollectionSpeciesList
object
4 properties
2 required
PaginatedCommunityList
object
4 properties
2 required
PaginatedConfigurationList
object
4 properties
2 required
PaginatedDataAccessTokenList
object
4 properties
2 required
PaginatedDataList
object
4 properties
2 required
PaginatedDataSerializerWithPermissionsList
object
4 properties
2 required
PaginatedDescriptorSchemaSerializerWithPermissionsList
object
4 properties
2 required
PaginatedDifferentialExpressionsSerializerWithPermissionsList
object
4 properties
2 required
PaginatedEntitySerializerWithPermissionsList
object
4 properties
2 required
PaginatedEstimatedCostPerBillingAccountList
object
4 properties
2 required
PaginatedExpressionBoxPlotList
object
4 properties
2 required
PaginatedExpressionsList
object
4 properties
2 required
PaginatedFeatureList
object
4 properties
2 required
PaginatedGeneListList
object
4 properties
2 required
PaginatedGenesetSearchSerializerWithPermissionsList
object
4 properties
2 required
PaginatedGroupList
object
4 properties
2 required
PaginatedHeatmapList
object
4 properties
2 required
PaginatedMappingList
object
4 properties
2 required
PaginatedParameterPresetList
object
4 properties
2 required
PaginatedPredictionFieldList
object
4 properties
2 required
PaginatedPredictionGroupList
object
4 properties
2 required
PaginatedPredictionPresetSerializerWithPermissionsList
object
4 properties
2 required
PaginatedPredictionValueList
object
4 properties
2 required
PaginatedProcessList
object
4 properties
2 required
PaginatedProcessSerializerWithPermissionsList
object
4 properties
2 required
PaginatedRelationList
object
4 properties
2 required
PaginatedRose2List
object
4 properties
2 required
PaginatedSampleInBasketList
object
4 properties
2 required
PaginatedSampleList
object
4 properties
2 required
PaginatedSearchTableFileColumnList
object
4 properties
2 required
PaginatedUserList
object
4 properties
2 required
PaginatedUserTagList
object
4 properties
2 required
PaginatedVariantAnnotationList
object
4 properties
2 required
PaginatedVariantCallList
object
4 properties
2 required
PaginatedVariantExperimentList
object
4 properties
2 required
PaginatedVariantList
object
4 properties
2 required
ParameterPreset
object
Serializer for :class:ParameterPreset model.
7 properties
6 required
PasswordChange
object
2 properties
2 required
PasswordReset
object
Serializer for requesting a password reset e-mail.
1 property
1 required
PasswordResetConfirm
object
Serializer for confirming a password reset attempt.
4 properties
4 required
PatchedAnnotationPresetSerializerWithPermissions
object
Serializer for AnnotationPreset objects.
5 properties
PatchedAnnotationValue
object
Serializer for AnnotationValue objects.
8 properties
PatchedCollectionSerializerWithPermissions
object
Serializer for Collection objects.
17 properties
PatchedDataAccessToken
object
Serializer for DataAccessToken.
7 properties
PatchedDataSerializerWithPermissions
object
Serializer for Data objects.
31 properties
PatchedEntitySerializerWithPermissions
object
Serializer for Entity with added collection field.
15 properties
PatchedGroup
object
Serializer for :class:Group objects.
3 properties
PatchedParameterPreset
object
Serializer for :class:ParameterPreset model.
7 properties
PatchedPredictionField
object
Serializer for PredictionField objects.
10 properties
PatchedPredictionGroup
object
Serializer for PredictionGroup objects.
4 properties
PatchedPredictionPresetSerializerWithPermissions
object
Serializer for PredictionPreset objects.
5 properties
PatchedPredictionValue
object
Serializer for PredictionValue objects.
7 properties
PatchedRelation
object
Serializer for Relation objects.
13 properties
PatchedUser
object
Serializer for :class:User objects.
15 properties
PatchedUserDetails
object
User model w/o password
5 properties
PatchedUserTag
object
Serializer for :class:UserTag model.
6 properties
PatchedVariant
object
Serializer for Variant objects.
8 properties
PatchedVariantCall
object
Serializer for VariantCall objects.
12 properties
PatchedVariantExperiment
object
Serializer for VariantExperiment objects.
4 properties
Permission
object
Permission serializer. Dictionary keys for users and groups are either ids or usernames (emails) or group names.
3 properties
PermissionsEnum
string
none - none view - view edit - edit share - share owner - owner
PersistenceEnum
string
RAW - Raw CAC - Cached TMP - Temp
PredictionField
object
Serializer for PredictionField objects.
10 properties
7 required
PredictionFieldDict
object
Serializer for actions that deal with prediction fields.
2 properties
1 required
PredictionFieldTypeEnum
string
SCORE - SCORE CLASS - CLASS
PredictionGroup
object
Serializer for PredictionGroup objects.
4 properties
3 required
PredictionPresetSerializerWithPermissions
object
Serializer for PredictionPreset objects.
5 properties
3 required
PredictionValue
object
Serializer for PredictionValue objects.
7 properties
6 required
PredictionsByPath
object
Serializer that reads prediction field and its value.
2 properties
2 required
Process
object
Process serializer.
5 properties
3 required
ProcessSerializerWithPermissions
object
Serializer for Process objects.
22 properties
7 required
Project
object
BaseSpace project entity serializer.
2 properties
2 required
Projects
object
BaseSpace projects serializer.
3 properties
PublicEnum
string
VIEW - VIEW EDIT - EDIT SHARE - SHARE OWNER - OWNER
ReSDKMinimalSupportedVersion
object
Serialize minimal supporter resdk version.
1 property
1 required
Relation
object
Serializer for Relation objects.
13 properties
9 required
RelationAttribute
object
Relation attribute serializer.
4 properties
4 required
RelationPartition
object
Serializer for RelationPartition objects.
4 properties
2 required
RelationTypeEnum
string
crossdb - Crossdb ortholog - Ortholog transcript - Transcript exon - Exon
RelationshipDict
object
Serializer for the DictRelatedField relation.
2 properties
Resources
object
Serialize the platform resource information.
6 properties
RestAuthDetail
object
1 property
1 required
Restart
object
Serializer for restarting a Data object.
1 property
Rose2
object
Rose2 serializer.
5 properties
4 required
Sample
object
Sample serializer.
3 properties
3 required
SampleInBasket
object
SampleInBasket serializer.
4 properties
3 required
SampleTableDeserializer
object
Serializer for parsing sample table endpoint input.
3 properties
2 required
SchedulingClassEnum
string
IN - Interactive BA - Batch
SearchTableFileColumn
object
Serializer for :class:SearchTableFileColumn objects.
7 properties
2 required
SingleUserDataUsage
object
Serializer for data/sample usage of a user.
8 properties
7 required
Statistics
object
Statistics serializer.
4 properties
4 required
Storage
object
Serializer for Storage objects.
8 properties
6 required
SubTypeEnum
string
protein-coding - Protein-coding pseudo - Pseudo rRNA - rRNA ncRNA - ncRNA snRNA - snRNA snoRNA - snoRNA tRNA - tRNA asRNA - asRNA other - Other unknown - Unkno…
UnitEnum
string
s - Second min - Minute hr - Hour d - Day wk - Week
UploadConfig
object
Serializer for upload configuration.
2 properties
2 required
UploadCredentials
object
Serializer for upload credentials.
4 properties
4 required
Url
object
BaseSpace url serializer.
1 property
1 required
User
object
Serializer for :class:User objects.
15 properties
4 required
UserDataUsage
object
Serializer for data/sample usage per user with normalized fields too.
12 properties
11 required
UserDetails
object
User model w/o password
5 properties
3 required
UserTag
object
Serializer for :class:UserTag model.
6 properties
5 required
Variant
object
Serializer for Variant objects.
8 properties
7 required
VariantAnnotation
object
Serializer for VariantAnnotation objects.
8 properties
2 required
VariantAnnotationTypeEnum
string
SNP - SNP INDEL - INDEL MIXED - MIXED MNP - MNP SYMBOLIC - SYMBOLIC
VariantCall
object
Serializer for VariantCall objects.
12 properties
2 required
VariantExperiment
object
Serializer for VariantExperiment objects.
4 properties
4 required
VariantTranscript
object
Serializer for VariantAnnotationTranscript objects.
8 properties
7 required
Versions
object
3 properties
3 required
The full machine-readable OpenAPI contract behind this narrative.