How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Genialis API

The api API from Genialis — 156 operation(s) for api.

Genialis API is one of 5 APIs that Genialis publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 239 operations across 156 paths, and defines 195 schemas. It is described by OpenAPI 3.2.0, at version 0.0.0.

Requests are made against a single base URL, https://app.genialis.com.

239 operations 156 paths 195 schemas 15 DELETE107 GET18 PATCH81 POST18 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
0.0.0
Base URL
https://app.genialis.com
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Genialis API declares 1 security scheme for authenticating requests. An API key is passed in the cookie as sessionid (cookieAuth).

Paths & Operations 239

Across 156 paths, the API surfaces 239 operations — 15 DELETE, 107 GET, 18 PATCH, 81 POST, 18 PUT. Each is listed below with its method, path, parameters, and response codes.

api 239
GET
/api/_modules/differential_expression/geneset_search
View for geneset search endpoint. This endpoint returns combined list of Data objects of type data:differentialexpression: and data:geneset:. Endpoint supports: :drf:Limit/Offset Pagination filtering…
api__modules_differential_expression_geneset_search_list 119 params → 200
POST
/api/_modules/differential_expression/geneset_search
Get list by POST request.
api__modules_differential_expression_geneset_search_create body → 200
GET
/api/_modules/differential_expression/list
Endpoint used for differential expression data. Endpoint used for retrieving differential expression data objects that derive from samples in the basket. Data objects contain some additional fields t…
api__modules_differential_expression_list_list 118 params → 200
POST
/api/_modules/differential_expression/list
Get list by POST request.
api__modules_differential_expression_list_create body → 200
GET
/api/_modules/gene_list/list
Return a response.
api__modules_gene_list_list_list 4 params → 200
GET
/api/_modules/gene_list/list_by_ids
View for gene list by ids endpoint. This endpoint expects gene source and a list of gene ids and returns a list of features with additional metadata from the knowledge base. Endpoint supports LimitOf…
api__modules_gene_list_list_by_ids_list 5 params → 200
POST
/api/_modules/gene_list/list_by_ids
Return a response.
api__modules_gene_list_list_by_ids_create body → 200
GET
/api/_modules/jbrowse/genome
Return JBrowse reference sequence.
api__modules_jbrowse_genome_list 4 params → 200
GET
/api/_modules/process/list
Process viewset which returns reduced number of process fields for faster response time.
api__modules_process_list_list 3 params → 200
POST
/api/_modules/sample/table
Return samples with column values.
api__modules_sample_table_create body → 200
GET
/api/_modules/species/collection
Return collections' species.
api__modules_species_collection_list 5 params → 200
GET
/api/_modules/visualizations/aggregated_expression_box_plot/get_last
Return aggregations appropriate for box plot. Aggregations are retrieved from last data:aggregator:expression: data object. If diffexprid parameter is provided, the first two elements of the response…
api__modules_visualizations_aggregated_expression_box_plot_get_last_list 10 params → 200
POST
/api/_modules/visualizations/attributes
Attributes endpoint.
api__modules_visualizations_attributes_create body → 200
GET
/api/_modules/visualizations/attributify
Attributify endpoint. Returns a minimal set of sample fields and an resolved attribute field specified in the request. This can be used for visualizations to group samples by an attribute. The endpoi…
api__modules_visualizations_attributify_list 7 params → 200
POST
/api/_modules/visualizations/attributify
Attributify endpoint.
api__modules_visualizations_attributify_create body → 200
GET
/api/_modules/visualizations/basket_expressions
Endpoint for retrieving basket expressions. Request: - basket id - tags (optional) Response: - a list of expressions
api__modules_visualizations_basket_expressions_list 5 params → 200
POST
/api/_modules/visualizations/case_control_expressions
Endpoint handler.
api__modules_visualizations_case_control_expressions_create body → 200
GET
/api/_modules/visualizations/expression_box_plot
Endpoint for box plot. Statistics can be grouped by provided attribute or for each given gene if no attribute provided. Log transformation operation is log2(x + 1). Request: - basket id - a list of g…
api__modules_visualizations_expression_box_plot_list 9 params → 200
POST
/api/_modules/visualizations/expression_box_plot
Endpoint handler.
api__modules_visualizations_expression_box_plot_create 3 params body → 200
GET
/api/_modules/visualizations/expressions
Endpoint for retrieving expressions for provided genes. Request takes optional parameters: groupby and colorby which are descriptor or relation attributes. Request: - basket id - a list for gene ids…
api__modules_visualizations_expressions_list 10 params → 200
POST
/api/_modules/visualizations/expressions
Endpoint handler.
api__modules_visualizations_expressions_create 3 params body → 200
GET
/api/_modules/visualizations/heatmap
Endpoint used for heatmap visualization. Request: - geneids - source - species - sampleids Response: - a list of objects containing heatmap related data: - sample name - gene - expression - expressio…
api__modules_visualizations_heatmap_list 7 params → 200
POST
/api/_modules/visualizations/heatmap
Return a response.
api__modules_visualizations_heatmap_create 3 params body → 200
GET
/api/_modules/visualizations/rose2
Endpoint returns Rose2 Data objects filtered by basket. Endpoint supports: :drf:Limit/Offset Pagination filtering ordering by name and created
api__modules_visualizations_rose2_list 117 params → 200
GET
/api/accesstoken/data
API view for :class:DescriptorSchema objects.
api_accesstoken_data_list 42 params → 200
POST
/api/accesstoken/data
Set current user, translate permissions and create token.
api_accesstoken_data_create body → 201
GET
/api/accesstoken/data/{id}
API view for :class:DescriptorSchema objects.
api_accesstoken_data_retrieve 1 param → 200
PUT
/api/accesstoken/data/{id}
API view for :class:DescriptorSchema objects.
api_accesstoken_data_update 1 param body → 200
PATCH
/api/accesstoken/data/{id}
API view for :class:DescriptorSchema objects.
api_accesstoken_data_partial_update 1 param body → 200
DELETE
/api/accesstoken/data/{id}
API view for :class:DescriptorSchema objects.
api_accesstoken_data_destroy 1 param → 204
GET
/api/annotation
Download annotation template. If dryrun parameter is present, then empty response will be returned.
api_annotation_retrieve 4 params → 200
POST
/api/annotation
Annotate using uploaded annotation file.
api_annotation_create body → 200
GET
/api/annotation_field
Annotation fields viewset.
api_annotation_field_list 138 params → 200
GET
/api/annotation_field/{id}
Annotation fields viewset.
api_annotation_field_retrieve 1 param → 200
GET
/api/annotation_preset
API view for :class:DescriptorSchema objects.
api_annotation_preset_list 11 params → 200
POST
/api/annotation_preset
Create a resource.
api_annotation_preset_create body → 201
GET
/api/annotation_preset/{id}
API view for :class:DescriptorSchema objects.
api_annotation_preset_retrieve 1 param → 200
PUT
/api/annotation_preset/{id}
Update a resource.
api_annotation_preset_update 1 param body → 200
PATCH
/api/annotation_preset/{id}
API view for :class:DescriptorSchema objects.
api_annotation_preset_partial_update 1 param body → 200
GET
/api/annotation_preset/{id}/permissions
Get or set permissions API endpoint.
api_annotation_preset_permissions_retrieve 1 param → 200
POST
/api/annotation_preset/{id}/permissions
Get or set permissions API endpoint.
api_annotation_preset_permissions_create 1 param body → 200
GET
/api/annotation_value
Annotation value viewset.
api_annotation_value_list 126 params → 200
POST
/api/annotation_value
Create a resource.
api_annotation_value_create body → 201
GET
/api/annotation_value/{id}
Annotation value viewset.
api_annotation_value_retrieve 1 param → 200
PUT
/api/annotation_value/{id}
Update annotation value(s). When posting multiple values, the request is treated as a bulk update. The bulk update can create or delete values. Values are deleted when the value is set to None.
api_annotation_value_update 1 param body → 200
PATCH
/api/annotation_value/{id}
Deny the partial updates of annotation values.
api_annotation_value_partial_update 1 param body → 200
DELETE
/api/annotation_value/{id}
Annotation value viewset.
api_annotation_value_destroy 1 param → 204
POST
/api/app-state
API view for :class:AppState objects.
api_app_state_create body → 201
GET
/api/app-state/{uuid}
API view for :class:AppState objects.
api_app_state_retrieve 1 param → 200
GET
/api/base/csrf
View that sends the CSRF cookie.
api_base_csrf_retrieve → 200
GET
/api/base/data_usage
Get data for the view.
api_base_data_usage_retrieve 2 params → 200
GET
/api/basespace/callback
Get request handler.
api_basespace_callback_retrieve 4 params → 200
GET
/api/basespace/current_user
Return currently logged in BaseSpace user.
api_basespace_current_user_retrieve → 200
GET
/api/basespace/files
Return samples's files. Request parameters: - limit (optional): the maximum number of items to return. Range: 0-1000. Default is 10. - offset (optional): The starting point of the collection to read.…
api_basespace_files_retrieve 5 params → 200
GET
/api/basespace/logout_url
Return URL to be used to logout BaseSpace user.
api_basespace_logout_url_retrieve → 200
GET
/api/basespace/oauth_browse_url
Return URL to be used when requesting BaseSpace OAuth browse permissions.
api_basespace_oauth_browse_url_retrieve → 200
GET
/api/basespace/oauth_read_projects_url
Return URL to be used when requesting BaseSpace OAuth read projects permissions. Request parameters: - projectids: list of project ids
api_basespace_oauth_read_projects_url_retrieve 1 param → 200
GET
/api/basespace/projects
Return user's projects. Request parameters: - limit (optional): the maximum number of items to return. Range: 0-1024. Default is 10. - offset (optional): The starting point of the collection to read.…
api_basespace_projects_retrieve 4 params → 200
GET
/api/basespace/read_projects_handle
Return access token secret handle to read BaseSpace projects. Request parameters: - projectids: list of project ids
api_basespace_read_projects_handle_retrieve 1 param → 200
POST
/api/basespace/revoke_browse_access
Delete user's BaseSpace browse token.
api_basespace_revoke_browse_access_create → 200
GET
/api/basespace/samples
Return projects's samples. Request parameters: - limit (optional): the maximum number of items to return. Range: 0-1024. Default is 10. - offset (optional): The starting point of the collection to re…
api_basespace_samples_retrieve 5 params → 200
POST
/api/basespace/subscribe
Register an Observer for a resource.
api_basespace_subscribe_create body → 200
POST
/api/basespace/unsubscribe
Unregister a subscription.
api_basespace_unsubscribe_create body → 200
POST
/api/basket
API view for all basket operations.
api_basket_create body → 201
GET
/api/basket/{id}
API view for all basket operations.
api_basket_retrieve 1 param → 200
POST
/api/basket/{id}/add_samples
Add samples to basket.
api_basket_add_samples_create 1 param body → 200
GET
/api/basket/{id}/breadcrumbs
Provide an observable list of breadcrumbs in a basket.
api_basket_breadcrumbs_list 4 params → 200
POST
/api/basket/{id}/clone
Clone the basket.
api_basket_clone_create 1 param → 200
GET
/api/basket/{id}/data_types
Provide a list of unique data types in a basket.
api_basket_data_types_retrieve 2 params → 200
POST
/api/basket/{id}/deselect_samples
Deselect samples.
api_basket_deselect_samples_create 1 param body → 200
POST
/api/basket/{id}/empty_basket
Remove samples from the basket.
api_basket_empty_basket_create 1 param body → 200
POST
/api/basket/{id}/make_read_only
Make the basket read-only.
api_basket_make_read_only_create 1 param → 200
GET
/api/basket/{id}/organisms
Provide an observable list of organisms in a basket.
api_basket_organisms_list 5 params → 200
POST
/api/basket/{id}/remove_samples
Remove samples.
api_basket_remove_samples_create 1 param body → 200
POST
/api/basket/{id}/remove_selected_samples
Remove selected samples.
api_basket_remove_selected_samples_create 1 param body → 200
GET
/api/basket/{id}/sample_count
Provide an observable number of samples in a basket.
api_basket_sample_count_retrieve 1 param → 200
GET
/api/basket/{id}/samples
Provide an observable list of samples in a basket.
api_basket_samples_list 4 params → 200
POST
/api/basket/{id}/select_all_samples
Select all samples.
api_basket_select_all_samples_create 1 param body → 200
POST
/api/basket/{id}/select_samples
Select samples.
api_basket_select_samples_create 1 param body → 200
GET
/api/basket/{id}/sources
Provide an observable list of sources in a basket.
api_basket_sources_list 4 params → 200
GET
/api/billingaccount
API view for :class:BillingAccounts objects.
api_billingaccount_list 4 params → 200
GET
/api/billingaccount/{id}
API view for :class:BillingAccounts objects.
api_billingaccount_retrieve 1 param → 200
POST
/api/billingaccount/{id}/collection
Assign collection to the billing account. Required arguments: collectionid. The user is only allowed to perform the operation when: - it has 'edit' permission on the collection - it has 'view' permis…
api_billingaccount_collection_create 1 param body → 200
GET
/api/billingaccount/estimated_usage
API view for :class:EstimatedCostByBillingAccount objects.
api_billingaccount_estimated_usage_list 14 params → 200
GET
/api/billingstatistics/billing_accounts_usage
Get the billing accounts usage. The returned fields are: minimalusage, maximalusage, averageusage. The parameters for the request are: - datefrom: ISO 8601 date representation, required. - dateto: IS…
api_billingstatistics_billing_accounts_usage_list 4 params → 200
GET
/api/billingstatistics/collections_usage
Get the collection usage. The returned fields are: createddate (could be null), minimalusage, maximalusage, averageusage. The parameters for the request are: - collectionids: the collections that the…
api_billingstatistics_collections_usage_list 4 params → 200
GET
/api/billingstatistics/excel_report
Get storage statistics. The granularity is one month. One specifies the first (F) and the last (L) month and the statistics is generated for all months M satisfying the condition S <= M <= L. The par…
api_billingstatistics_excel_report_retrieve 2 params → 200
GET
/api/collection
The extended resolwe Collection viewset. It contains method to set prediction fields.
api_collection_list 69 params → 200
POST
/api/collection
Only authenticated users can create new collections.
api_collection_create body → 201
GET
/api/collection/{id}
The extended resolwe Collection viewset. It contains method to set prediction fields.
api_collection_retrieve 1 param → 200
PUT
/api/collection/{id}
Update a resource.
api_collection_update 1 param body → 200
PATCH
/api/collection/{id}
The extended resolwe Collection viewset. It contains method to set prediction fields.
api_collection_partial_update 1 param body → 200
DELETE
/api/collection/{id}
Delete a resource.
api_collection_destroy 1 param → 204
GET
/api/collection/{id}/permissions
Get or set permissions API endpoint.
api_collection_permissions_retrieve 1 param → 200
POST
/api/collection/{id}/permissions
Get or set permissions API endpoint.
api_collection_permissions_create 1 param body → 200
POST
/api/collection/{id}/set_annotation_fields
Set AnnotationFields on collection.
api_collection_set_annotation_fields_create 1 param body → 204
POST
/api/collection/{id}/set_prediction_fields
Set PredictionFields on a collection.
api_collection_set_prediction_fields_create 1 param body → 204
GET
/api/collection/billing_account/{id}
Get the Billing account id of the given collection.
api_collection_billing_account_retrieve 1 param → 200
POST
/api/collection/bulk_delete
Bulk delete objects in the background. The background task is returned.
api_collection_bulk_delete_create body → 200
POST
/api/collection/duplicate
Bulk duplicate objects in the background. The background task is returned.
api_collection_duplicate_create body → 200
GET
/api/collection/slug_exists
Check if given url slug exists. Check if slug given in query parameter name exists. Return True if slug already exists and False otherwise.
api_collection_slug_exists_retrieve 1 param → 200
POST
/api/collection/subscribe
Register an Observer for a resource.
api_collection_subscribe_create body → 200
POST
/api/collection/unsubscribe
Unregister a subscription.
api_collection_unsubscribe_create body → 200
GET
/api/community
API view for :class:Community objects.
api_community_list 2 params → 200
GET
/api/configuration
Return configuration list.
api_configuration_list 2 params → 200
GET
/api/configuration/{community__slug}
API view for :class:Configuration objects.
api_configuration_retrieve 1 param → 200
GET
/api/data
API view for :class:Data objects.
api_data_list 116 params → 200
POST
/api/data
Create a resource.
api_data_create body → 201
GET
/api/data/{id}
API view for :class:Data objects.
api_data_retrieve 1 param → 200
PUT
/api/data/{id}
Update a resource.
api_data_update 1 param body → 200
PATCH
/api/data/{id}
API view for :class:Data objects.
api_data_partial_update 1 param body → 200
DELETE
/api/data/{id}
Delete a resource.
api_data_destroy 1 param → 204
GET
/api/data/{id}/children
Return children of the current data object.
api_data_children_retrieve 1 param → 200
GET
/api/data/{id}/parents
Return parents of the current data object.
api_data_parents_list 3 params → 200
GET
/api/data/{id}/permissions
Get or set permissions API endpoint.
api_data_permissions_retrieve 1 param → 200
POST
/api/data/{id}/permissions
Get or set permissions API endpoint.
api_data_permissions_create 1 param body → 200
POST
/api/data/{id}/restart
Restart the current data object.
api_data_restart_create 3 params body → 200
POST
/api/data/bulk_delete
Bulk delete objects in the background. The background task is returned.
api_data_bulk_delete_create body → 200
POST
/api/data/duplicate
Bulk duplicate objects in the background. The background task is returned.
api_data_duplicate_create body → 200
POST
/api/data/get_or_create
Get Data object if similar already exists, otherwise create it.
api_data_get_or_create_create body → 200
POST
/api/data/move_to_collection
Move data objects to destination collection.
api_data_move_to_collection_create body → 200
GET
/api/data/slug_exists
Check if given url slug exists. Check if slug given in query parameter name exists. Return True if slug already exists and False otherwise.
api_data_slug_exists_retrieve 1 param → 200
POST
/api/data/subscribe
Register an Observer for a resource.
api_data_subscribe_create body → 200
POST
/api/data/unsubscribe
Unregister a subscription.
api_data_unsubscribe_create body → 200
GET
/api/descriptorschema
API view for :class:DescriptorSchema objects.
api_descriptorschema_list 45 params → 200
GET
/api/descriptorschema/{id}
API view for :class:DescriptorSchema objects.
api_descriptorschema_retrieve 1 param → 200
GET
/api/descriptorschema/{id}/permissions
Get or set permissions API endpoint.
api_descriptorschema_permissions_retrieve 1 param → 200
POST
/api/descriptorschema/{id}/permissions
Get or set permissions API endpoint.
api_descriptorschema_permissions_create 1 param body → 200
GET
/api/group
API view for :class:Group objects.
api_group_list 18 params → 200
POST
/api/group
API view for :class:Group objects.
api_group_create body → 201
PUT
/api/group/{id}
API view for :class:Group objects.
api_group_update 1 param body → 200
PATCH
/api/group/{id}
API view for :class:Group objects.
api_group_partial_update 1 param body → 200
POST
/api/group/{id}/add_users
Endpoint for adding users to group.
api_group_add_users_create 1 param body → 200
POST
/api/group/{id}/remove_users
Endpoint for removing users from group.
api_group_remove_users_create 1 param body → 200
GET
/api/kb/feature
Endpoint used for feature search. Request: - query - source - species - type - featureid Response: - a list of matching features
api_kb_feature_list 9 params → 200
POST
/api/kb/feature
Endpoint handler.
api_kb_feature_create body → 200
POST
/api/kb/feature/paste
Endpoint used for exactly matching pasted genes.
api_kb_feature_paste_create body → 200
GET
/api/kb/feature/search
Endpoint used for feature search. Request: - query - source - species - type - featureid Response: - a list of matching features
api_kb_feature_search_list 9 params → 200
POST
/api/kb/feature/search
Endpoint handler.
api_kb_feature_search_create body → 200
POST
/api/kb/feature/search/paste
Endpoint used for exactly matching pasted genes.
api_kb_feature_search_paste_create body → 200
GET
/api/kb/mapping/search
Endpoint used for mapping search. Request: - sourceid - sourcedb - sourcespecies - targetid - targetdb - targetspecies - relationtype Response: - a list of matching mappings
api_kb_mapping_search_list 51 params → 200
POST
/api/kb/mapping/search
Endpoint handler.
api_kb_mapping_search_create body → 200
GET
/api/prediction_field
Prediction fields viewset.
api_prediction_field_list 131 params → 200
POST
/api/prediction_field
Create a resource.
api_prediction_field_create body → 201
GET
/api/prediction_field/{id}
Prediction fields viewset.
api_prediction_field_retrieve 1 param → 200
PUT
/api/prediction_field/{id}
Prediction fields viewset.
api_prediction_field_update 1 param body → 200
PATCH
/api/prediction_field/{id}
Prediction fields viewset.
api_prediction_field_partial_update 1 param body → 200
DELETE
/api/prediction_field/{id}
Prediction fields viewset.
api_prediction_field_destroy 1 param → 204
GET
/api/prediction_group
Prediction fields viewset.
api_prediction_group_list 33 params → 200
POST
/api/prediction_group
Create a resource.
api_prediction_group_create body → 201
GET
/api/prediction_group/{id}
Prediction fields viewset.
api_prediction_group_retrieve 1 param → 200
PUT
/api/prediction_group/{id}
Prediction fields viewset.
api_prediction_group_update 1 param body → 200
PATCH
/api/prediction_group/{id}
Prediction fields viewset.
api_prediction_group_partial_update 1 param body → 200
DELETE
/api/prediction_group/{id}
Prediction fields viewset.
api_prediction_group_destroy 1 param → 204
GET
/api/prediction_preset
API view for :class:DescriptorSchema objects.
api_prediction_preset_list 11 params → 200
POST
/api/prediction_preset
Create a resource.
api_prediction_preset_create body → 201
GET
/api/prediction_preset/{id}
API view for :class:DescriptorSchema objects.
api_prediction_preset_retrieve 1 param → 200
PUT
/api/prediction_preset/{id}
Update a resource.
api_prediction_preset_update 1 param body → 200
PATCH
/api/prediction_preset/{id}
API view for :class:DescriptorSchema objects.
api_prediction_preset_partial_update 1 param body → 200
DELETE
/api/prediction_preset/{id}
API view for :class:DescriptorSchema objects.
api_prediction_preset_destroy 1 param → 204
GET
/api/prediction_preset/{id}/permissions
Get or set permissions API endpoint.
api_prediction_preset_permissions_retrieve 1 param → 200
POST
/api/prediction_preset/{id}/permissions
Get or set permissions API endpoint.
api_prediction_preset_permissions_create 1 param body → 200
GET
/api/prediction_value
List objects.
api_prediction_value_list 126 params → 200
POST
/api/prediction_value
Create a resource.
api_prediction_value_create body → 201
GET
/api/prediction_value/{id}
Prediction value viewset.
api_prediction_value_retrieve 1 param → 200
PUT
/api/prediction_value/{id}
Update prediction value(s). When posting multiple values, the request is treated as a bulk update. The bulk update can create or delete values. Values are deleted when the value is set to None.
api_prediction_value_update 1 param body → 200
PATCH
/api/prediction_value/{id}
Deny the partial updates of prediction values.
api_prediction_value_partial_update 1 param body → 200
DELETE
/api/prediction_value/{id}
Prediction value viewset.
api_prediction_value_destroy 1 param → 204
GET
/api/process
API view for :class:Process objects.
api_process_list 49 params → 200
POST
/api/process
Only superusers can create new processes.
api_process_create body → 201
GET
/api/process/{id}
API view for :class:Process objects.
api_process_retrieve 1 param → 200
GET
/api/process/{id}/permissions
Get or set permissions API endpoint.
api_process_permissions_retrieve 1 param → 200
POST
/api/process/{id}/permissions
Get or set permissions API endpoint.
api_process_permissions_create 1 param body → 200
GET
/api/process/slug_exists
Check if given url slug exists. Check if slug given in query parameter name exists. Return True if slug already exists and False otherwise.
api_process_slug_exists_retrieve 1 param → 200
GET
/api/relation
API view for :class:Relation objects.
api_relation_list 50 params → 200
POST
/api/relation
Create a resource.
api_relation_create body → 201
GET
/api/relation/{id}
API view for :class:Relation objects.
api_relation_retrieve 1 param → 200
PUT
/api/relation/{id}
Update the Relation object. Reject the update if user doesn't have EDIT permission on the collection referenced in the Relation.
api_relation_update 1 param body → 200
PATCH
/api/relation/{id}
API view for :class:Relation objects.
api_relation_partial_update 1 param body → 200
DELETE
/api/relation/{id}
Delete the Relation object. Reject the delete if user doesn't have EDIT permission on the collection referenced in the Relation.
api_relation_destroy 1 param → 204
GET
/api/resdk_minimal_supported_version
Return the minimal supported resdk version.
api_resdk_minimal_supported_version_retrieve → 200
GET
/api/sample
The extended resolwe Entity viewset. It contains method to set predictios.
api_sample_list 95 params → 200
POST
/api/sample
Only authenticated users can create new collections.
api_sample_create body → 201
GET
/api/sample/{id}
The extended resolwe Entity viewset. It contains method to set predictios.
api_sample_retrieve 1 param → 200
PUT
/api/sample/{id}
Update an entity. Original queryset produces a temporary database table whose rows cannot be selected for an update. As a workaround, we patch getqueryset function to return only Entity objects witho…
api_sample_update 1 param body → 200
PATCH
/api/sample/{id}
The extended resolwe Entity viewset. It contains method to set predictios.
api_sample_partial_update 1 param body → 200
DELETE
/api/sample/{id}
Delete a resource.
api_sample_destroy 1 param → 204
GET
/api/sample/{id}/permissions
Get or set permissions API endpoint.
api_sample_permissions_retrieve 1 param → 200
POST
/api/sample/{id}/permissions
Get or set permissions API endpoint.
api_sample_permissions_create 1 param body → 200
POST
/api/sample/{id}/set_annotations
Add the given list of AnnotationFields to the given entity.
api_sample_set_annotations_create 1 param body → 200
POST
/api/sample/{id}/set_predictions
Add the given list of PredictionField to the given entity.
api_sample_set_predictions_create 1 param body → 200
POST
/api/sample/bulk_delete
Bulk delete objects in the background. The background task is returned.
api_sample_bulk_delete_create body → 200
POST
/api/sample/duplicate
Bulk duplicate objects in the background. The background task is returned.
api_sample_duplicate_create body → 200
POST
/api/sample/move_to_collection
Move samples from source to destination collection.
api_sample_move_to_collection_create body → 200
GET
/api/sample/slug_exists
Check if given url slug exists. Check if slug given in query parameter name exists. Return True if slug already exists and False otherwise.
api_sample_slug_exists_retrieve 1 param → 200
POST
/api/sample/subscribe
Register an Observer for a resource.
api_sample_subscribe_create body → 200
POST
/api/sample/unsubscribe
Unregister a subscription.
api_sample_unsubscribe_create body → 200
GET
/api/search-table-file-columns
API view for :class:SearchTableFileColumn objects.
api_search_table_file_columns_list 2 params → 200
GET
/api/storage/{id}
API view for :class:Storage objects.
api_storage_retrieve 1 param → 200
GET
/api/task
Observable task viewset. It exposes standard observable endpoints so user can subscribe to it plus it lists all the background tasks for a current user.
api_task_list 7 params → 200
GET
/api/task/{id}
Observable task viewset. It exposes standard observable endpoints so user can subscribe to it plus it lists all the background tasks for a current user.
api_task_retrieve 1 param → 200
POST
/api/task/subscribe
Register an Observer for a resource.
api_task_subscribe_create body → 200
POST
/api/task/unsubscribe
Unregister a subscription.
api_task_unsubscribe_create body → 200
GET
/api/upload/config
Return the JSON representing the upload configuration. The returning object is JSON representation of the dictionary with the following fields: - type: the type of upload connector. Currently we supp…
api_upload_config_retrieve → 200
GET
/api/upload/credentials
Return the upload credentials.
api_upload_credentials_retrieve → 200
GET
/api/upload_config
Return the JSON representing the upload configuration. The returning object is JSON representation of the dictionary with the following fields: - type: the type of upload connector. Currently we supp…
api_upload_config_retrieve_2 → 200
GET
/api/user
API view for :class:User objects.
api_user_list 48 params → 200
POST
/api/user
API view for :class:User objects.
api_user_create body → 201
GET
/api/user-settings/parameter-preset
API view for :class:ParameterPreset objects.
api_user_settings_parameter_preset_list 47 params → 200
POST
/api/user-settings/parameter-preset
Create a resource.
api_user_settings_parameter_preset_create body → 201
GET
/api/user-settings/parameter-preset/{id}
API view for :class:ParameterPreset objects.
api_user_settings_parameter_preset_retrieve 1 param → 200
PUT
/api/user-settings/parameter-preset/{id}
API view for :class:ParameterPreset objects.
api_user_settings_parameter_preset_update 1 param body → 200
PATCH
/api/user-settings/parameter-preset/{id}
API view for :class:ParameterPreset objects.
api_user_settings_parameter_preset_partial_update 1 param body → 200
DELETE
/api/user-settings/parameter-preset/{id}
API view for :class:ParameterPreset objects.
api_user_settings_parameter_preset_destroy 1 param → 204
PUT
/api/user/{id}
API view for :class:User objects.
api_user_update 1 param body → 200
PATCH
/api/user/{id}
API view for :class:User objects.
api_user_partial_update 1 param body → 200
GET
/api/usertag
API view for :class:UserTag objects.
api_usertag_list 20 params → 200
POST
/api/usertag
Make currently logged in user the contributor.
api_usertag_create body → 201
GET
/api/usertag/{id}
API view for :class:UserTag objects.
api_usertag_retrieve 1 param → 200
PUT
/api/usertag/{id}
API view for :class:UserTag objects.
api_usertag_update 1 param body → 200
PATCH
/api/usertag/{id}
API view for :class:UserTag objects.
api_usertag_partial_update 1 param body → 200
DELETE
/api/usertag/{id}
API view for :class:UserTag objects.
api_usertag_destroy 1 param → 204
GET
/api/variant
Variant endpoint.
api_variant_list 368 params → 200
POST
/api/variant
Create a resource.
api_variant_create body → 201
PUT
/api/variant/{id}
Variant endpoint.
api_variant_update 1 param body → 200
PATCH
/api/variant/{id}
Variant endpoint.
api_variant_partial_update 1 param body → 200
DELETE
/api/variant/{id}
Variant endpoint.
api_variant_destroy 1 param → 204
GET
/api/variant_annotations
VariantAnnotation endpoint.
api_variant_annotations_list 85 params → 200
GET
/api/variant_calls
VariantCall endpoint. The default filter backends are used so permissions are respected.
api_variant_calls_list 238 params → 200
POST
/api/variant_calls
Create a resource.
api_variant_calls_create body → 201
PUT
/api/variant_calls/{id}
VariantCall endpoint. The default filter backends are used so permissions are respected.
api_variant_calls_update 1 param body → 200
PATCH
/api/variant_calls/{id}
VariantCall endpoint. The default filter backends are used so permissions are respected.
api_variant_calls_partial_update 1 param body → 200
DELETE
/api/variant_calls/{id}
VariantCall endpoint. The default filter backends are used so permissions are respected.
api_variant_calls_destroy 1 param → 204
GET
/api/variant_experiment
VariantExperiment endpoint.
api_variant_experiment_list 284 params → 200
POST
/api/variant_experiment
Create a resource.
api_variant_experiment_create body → 201
PUT
/api/variant_experiment/{id}
VariantExperiment endpoint.
api_variant_experiment_update 1 param body → 200
PATCH
/api/variant_experiment/{id}
VariantExperiment endpoint.
api_variant_experiment_partial_update 1 param body → 200
DELETE
/api/variant_experiment/{id}
VariantExperiment endpoint.
api_variant_experiment_destroy 1 param → 204
GET
/api/versions
Return the versions of the installed Genialis packages.
api_versions_retrieve → 200

Schemas 195

The contract defines 195 schemas that model the data the API accepts and returns. The most detailed are GenesetSearchSerializerWithPermissions (38 properties), DifferentialExpressionsSerializerWithPermissions (36 properties), DataSerializerWithPermissions (31 properties), PatchedDataSerializerWithPermissions (31 properties). Each schema is shown below with its type and property counts.

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

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

genialis-api-api-openapi.yml Raw ↑

Other APIs Genialis publishes across the network.

Genialis About API
Genialis Health Check API
Genialis Rest Auth API
Genialis Saml Auth API
Where this information came from

This is an independent, third-party profile of Genialis API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.