openapi: 3.0.3 info: title: Genialis base version: 0.0.0 description: Backend of the Genialis platform. paths: /about/process_resources: get: operationId: about_process_resources_retrieve description: Return the resources of the installed platform. tags: - about security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Resources' description: '' /about/resdk_minimal_supported_version: get: operationId: about_resdk_minimal_supported_version_retrieve description: Return the minimal supported resdk version. tags: - about security: - cookieAuth: [] - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/ReSDKMinimalSupportedVersion' description: '' /about/versions: get: operationId: about_versions_retrieve description: Return the versions of the installed Genialis packages. tags: - about security: - cookieAuth: [] - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/Versions' description: '' /api/_modules/differential_expression/geneset_search: get: operationId: api__modules_differential_expression_geneset_search_list description: |- 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 by list of genes (significant genes for differential expression objects and list of included genes fot geneset objects) * filtering differential expressions by basket ids provided in ``filter_de_by_basket`` parameter * same filtering as Data endpoint (~`resolwe.flow.views.DataViewSet`) * ordering by ``-number_of_genes`` which is the default * same ordering as Data endpoint (~`resolwe.flow.views.DataViewSet`) parameters: - in: query name: basket schema: type: integer - in: query name: build schema: type: string - in: query name: collection schema: type: integer - in: query name: collection__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: collection__isnull schema: type: boolean - in: query name: collection__name schema: type: string - in: query name: collection__name__contains schema: type: string - in: query name: collection__name__icontains schema: type: string - in: query name: collection__name__iexact schema: type: string - in: query name: collection__name__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: collection__name__isnull schema: type: boolean - in: query name: collection__name__istartswith schema: type: string - in: query name: collection__name__startswith schema: type: string - in: query name: collection__slug schema: type: string - in: query name: collection__slug__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: contributor schema: type: integer - in: query name: contributor__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: contributor_name schema: type: string - in: query name: created schema: type: string format: date-time - in: query name: created__date schema: type: string format: date - in: query name: created__gt schema: type: string format: date-time - in: query name: created__gte schema: type: string format: date-time - in: query name: created__isnull schema: type: boolean - in: query name: created__lt schema: type: string format: date-time - in: query name: created__lte schema: type: string format: date-time - in: query name: created__time schema: type: string format: time - in: query name: entity schema: type: integer - in: query name: entity__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: entity__isnull schema: type: boolean - in: query name: entity__name schema: type: string - in: query name: entity__name__contains schema: type: string - in: query name: entity__name__icontains schema: type: string - in: query name: entity__name__iexact schema: type: string - in: query name: entity__name__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: entity__name__isnull schema: type: boolean - in: query name: entity__name__istartswith schema: type: string - in: query name: entity__name__startswith schema: type: string - in: query name: entity__slug schema: type: string - in: query name: entity__slug__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: feature_type schema: type: string - in: query name: filter_de_by_basket schema: type: integer - in: query name: finished schema: type: string format: date-time - in: query name: finished__date schema: type: string format: date - in: query name: finished__gt schema: type: string format: date-time - in: query name: finished__gte schema: type: string format: date-time - in: query name: finished__isnull schema: type: boolean - in: query name: finished__lt schema: type: string format: date-time - in: query name: finished__lte schema: type: string format: date-time - in: query name: finished__time schema: type: string format: time - in: query name: gene_ids schema: type: array items: type: string - in: query name: group schema: type: string - in: query name: id schema: type: integer - in: query name: id__gt schema: type: integer - in: query name: id__gte schema: type: integer - in: query name: id__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: id__isnull schema: type: boolean - in: query name: id__lt schema: type: integer - in: query name: id__lte schema: type: integer - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: modified schema: type: string format: date-time - in: query name: modified__date schema: type: string format: date - in: query name: modified__gt schema: type: string format: date-time - in: query name: modified__gte schema: type: string format: date-time - in: query name: modified__isnull schema: type: boolean - in: query name: modified__lt schema: type: string format: date-time - in: query name: modified__lte schema: type: string format: date-time - in: query name: modified__time schema: type: string format: time - in: query name: name schema: type: string - in: query name: name__contains schema: type: string - in: query name: name__icontains schema: type: string - in: query name: name__iexact schema: type: string - in: query name: name__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: name__isnull schema: type: boolean - in: query name: name__istartswith schema: type: string - in: query name: name__startswith schema: type: string - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: owners schema: type: integer - in: query name: owners_name schema: type: string - in: query name: permission schema: type: string - in: query name: process schema: type: integer - in: query name: process__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: process__isnull schema: type: boolean - in: query name: process__name schema: type: string - in: query name: process__name__contains schema: type: string - in: query name: process__name__icontains schema: type: string - in: query name: process__name__iexact schema: type: string - in: query name: process__name__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: process__name__isnull schema: type: boolean - in: query name: process__name__istartswith schema: type: string - in: query name: process__name__startswith schema: type: string - in: query name: process__slug schema: type: string - in: query name: process__slug__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: relation_id schema: type: number - in: query name: shared_with_me schema: type: boolean - in: query name: slug schema: type: string - in: query name: slug__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: source schema: type: string nullable: true minLength: 1 - in: query name: species schema: type: string nullable: true minLength: 1 - in: query name: started schema: type: string format: date-time - in: query name: started__date schema: type: string format: date - in: query name: started__gt schema: type: string format: date-time - in: query name: started__gte schema: type: string format: date-time - in: query name: started__isnull schema: type: boolean - in: query name: started__lt schema: type: string format: date-time - in: query name: started__lte schema: type: string format: date-time - in: query name: started__time schema: type: string format: time - in: query name: status schema: type: string enum: - DR - ER - OK - PP - PR - RE - UP - WT description: |- * `UP` - Uploading * `RE` - Resolving * `WT` - Waiting * `PP` - Preparing * `PR` - Processing * `OK` - Done * `ER` - Error * `DR` - Dirty - in: query name: status__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: tags schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: type schema: type: string - in: query name: type__exact schema: type: string - in: query name: version schema: type: string - in: query name: version__gt schema: type: string - in: query name: version__gte schema: type: string - in: query name: version__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: version__isnull schema: type: boolean - in: query name: version__lt schema: type: string - in: query name: version__lte schema: type: string tags: - api security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedGenesetSearchSerializerWithPermissionsList' description: '' post: operationId: api__modules_differential_expression_geneset_search_create description: Get list by POST request. tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/GeneIds' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/GeneIds' multipart/form-data: schema: $ref: '#/components/schemas/GeneIds' security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/GenesetSearchSerializerWithPermissions' description: '' /api/_modules/differential_expression/list: get: operationId: api__modules_differential_expression_list_list description: |- 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 that are being calculated on the database side. Those additional fields are: - logfc_threshold - prob_field - prob_threshold - up_regulated - down_regulated Request accepts any standard filter for Data objects, plus: - basket (optional) - source (optional) - species (optional) - filter_de_by_basket (optional) Response: - a list of data objects with additional calculated fields parameters: - in: query name: basket schema: type: string format: uuid - in: query name: build schema: type: string - in: query name: collection schema: type: integer - in: query name: collection__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: collection__isnull schema: type: boolean - in: query name: collection__name schema: type: string - in: query name: collection__name__contains schema: type: string - in: query name: collection__name__icontains schema: type: string - in: query name: collection__name__iexact schema: type: string - in: query name: collection__name__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: collection__name__isnull schema: type: boolean - in: query name: collection__name__istartswith schema: type: string - in: query name: collection__name__startswith schema: type: string - in: query name: collection__slug schema: type: string - in: query name: collection__slug__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: contributor schema: type: integer - in: query name: contributor__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: contributor_name schema: type: string - in: query name: created schema: type: string format: date-time - in: query name: created__date schema: type: string format: date - in: query name: created__gt schema: type: string format: date-time - in: query name: created__gte schema: type: string format: date-time - in: query name: created__isnull schema: type: boolean - in: query name: created__lt schema: type: string format: date-time - in: query name: created__lte schema: type: string format: date-time - in: query name: created__time schema: type: string format: time - in: query name: entity schema: type: integer - in: query name: entity__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: entity__isnull schema: type: boolean - in: query name: entity__name schema: type: string - in: query name: entity__name__contains schema: type: string - in: query name: entity__name__icontains schema: type: string - in: query name: entity__name__iexact schema: type: string - in: query name: entity__name__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: entity__name__isnull schema: type: boolean - in: query name: entity__name__istartswith schema: type: string - in: query name: entity__name__startswith schema: type: string - in: query name: entity__slug schema: type: string - in: query name: entity__slug__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: feature_type schema: type: string - in: query name: filter_de_by_basket schema: type: boolean - in: query name: finished schema: type: string format: date-time - in: query name: finished__date schema: type: string format: date - in: query name: finished__gt schema: type: string format: date-time - in: query name: finished__gte schema: type: string format: date-time - in: query name: finished__isnull schema: type: boolean - in: query name: finished__lt schema: type: string format: date-time - in: query name: finished__lte schema: type: string format: date-time - in: query name: finished__time schema: type: string format: time - in: query name: group schema: type: string - in: query name: id schema: type: integer - in: query name: id__gt schema: type: integer - in: query name: id__gte schema: type: integer - in: query name: id__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: id__isnull schema: type: boolean - in: query name: id__lt schema: type: integer - in: query name: id__lte schema: type: integer - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: modified schema: type: string format: date-time - in: query name: modified__date schema: type: string format: date - in: query name: modified__gt schema: type: string format: date-time - in: query name: modified__gte schema: type: string format: date-time - in: query name: modified__isnull schema: type: boolean - in: query name: modified__lt schema: type: string format: date-time - in: query name: modified__lte schema: type: string format: date-time - in: query name: modified__time schema: type: string format: time - in: query name: name schema: type: string - in: query name: name__contains schema: type: string - in: query name: name__icontains schema: type: string - in: query name: name__iexact schema: type: string - in: query name: name__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: name__isnull schema: type: boolean - in: query name: name__istartswith schema: type: string - in: query name: name__startswith schema: type: string - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: owners schema: type: integer - in: query name: owners_name schema: type: string - in: query name: permission schema: type: string - in: query name: process schema: type: integer - in: query name: process__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: process__isnull schema: type: boolean - in: query name: process__name schema: type: string - in: query name: process__name__contains schema: type: string - in: query name: process__name__icontains schema: type: string - in: query name: process__name__iexact schema: type: string - in: query name: process__name__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: process__name__isnull schema: type: boolean - in: query name: process__name__istartswith schema: type: string - in: query name: process__name__startswith schema: type: string - in: query name: process__slug schema: type: string - in: query name: process__slug__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: relation_id schema: type: number - in: query name: shared_with_me schema: type: boolean - in: query name: slug schema: type: string - in: query name: slug__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: source schema: type: string minLength: 1 - in: query name: species schema: type: string minLength: 1 - in: query name: started schema: type: string format: date-time - in: query name: started__date schema: type: string format: date - in: query name: started__gt schema: type: string format: date-time - in: query name: started__gte schema: type: string format: date-time - in: query name: started__isnull schema: type: boolean - in: query name: started__lt schema: type: string format: date-time - in: query name: started__lte schema: type: string format: date-time - in: query name: started__time schema: type: string format: time - in: query name: status schema: type: string enum: - DR - ER - OK - PP - PR - RE - UP - WT description: |- * `UP` - Uploading * `RE` - Resolving * `WT` - Waiting * `PP` - Preparing * `PR` - Processing * `OK` - Done * `ER` - Error * `DR` - Dirty - in: query name: status__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: tags schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: type schema: type: string - in: query name: type__exact schema: type: string - in: query name: version schema: type: string - in: query name: version__gt schema: type: string - in: query name: version__gte schema: type: string - in: query name: version__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: version__isnull schema: type: boolean - in: query name: version__lt schema: type: string - in: query name: version__lte schema: type: string tags: - api security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedDifferentialExpressionsSerializerWithPermissionsList' description: '' post: operationId: api__modules_differential_expression_list_create description: Get list by POST request. tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/DifferentialExpressionsDeserializer' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/DifferentialExpressionsDeserializer' multipart/form-data: schema: $ref: '#/components/schemas/DifferentialExpressionsDeserializer' security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/DifferentialExpressionsSerializerWithPermissions' description: '' /api/_modules/gene_list/list: get: operationId: api__modules_gene_list_list_list description: Return a response. parameters: - in: query name: data schema: type: integer required: true - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string tags: - api security: - cookieAuth: [] - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedGeneListList' description: '' /api/_modules/gene_list/list_by_ids: get: operationId: api__modules_gene_list_list_by_ids_list description: |- 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 LimitOffset pagination. When 'limit' query parameter is provided, paginated response is returned. parameters: - in: query name: gene_ids schema: type: array items: type: string - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - in: query name: source schema: type: string nullable: true minLength: 1 - in: query name: species schema: type: string nullable: true minLength: 1 tags: - api security: - cookieAuth: [] - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedGeneListList' description: '' post: operationId: api__modules_gene_list_list_by_ids_create description: Return a response. tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/GeneIds' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/GeneIds' multipart/form-data: schema: $ref: '#/components/schemas/GeneIds' security: - cookieAuth: [] - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/GeneList' description: '' /api/_modules/jbrowse/genome: get: operationId: api__modules_jbrowse_genome_list description: Return JBrowse reference sequence. parameters: - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: sample_id schema: type: integer required: true tags: - api security: - cookieAuth: [] - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedDataList' description: '' /api/_modules/process/list: get: operationId: api__modules_process_list_list description: Process viewset which returns reduced number of process fields for faster response time. parameters: - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string tags: - api security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedProcessList' description: '' /api/_modules/sample/table: post: operationId: api__modules_sample_table_create description: Return samples with column values. tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/SampleTableDeserializer' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/SampleTableDeserializer' multipart/form-data: schema: $ref: '#/components/schemas/SampleTableDeserializer' required: true security: - cookieAuth: [] - {} responses: '200': content: application/json: schema: {} description: '' /api/_modules/species/collection: get: operationId: api__modules_species_collection_list description: Return collections' species. parameters: - in: query name: annotation_version schema: enum: - v2 type: string default: v2 minLength: 1 description: '* `v2` - v2' - in: query name: collection_ids schema: type: array items: type: integer required: true - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string tags: - api security: - cookieAuth: [] - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedCollectionSpeciesList' description: '' /api/_modules/visualizations/aggregated_expression_box_plot/get_last: get: operationId: api__modules_visualizations_aggregated_expression_box_plot_get_last_list description: |- Return aggregations appropriate for box plot. Aggregations are retrieved from last `data:aggregator:expression:` data object. If `diff_expr_id` parameter is provided, the first two elements of the response are aggregations from differential expression's case and control data objects. Log transformation operation is log2(x + 1). Request: - feature symbol - source - species - group by - exp type - optional: differential expression - optional: log transform Response: - a list of aggregated expressions for box plot parameters: - in: query name: diff_expr_id schema: type: integer nullable: true - in: query name: exp_type schema: type: string minLength: 1 required: true - in: query name: gene_id schema: type: string minLength: 1 required: true - in: query name: group_by schema: type: string minLength: 1 required: true - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: log_transform schema: type: boolean default: false - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: source schema: type: string minLength: 1 required: true - in: query name: species schema: type: string minLength: 1 required: true tags: - api security: - cookieAuth: [] - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedAggregatedExpressionBoxPlotList' description: '' /api/_modules/visualizations/attributes: post: operationId: api__modules_visualizations_attributes_create description: Attributes endpoint. tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/AttributesDeserializer' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/AttributesDeserializer' multipart/form-data: schema: $ref: '#/components/schemas/AttributesDeserializer' security: - cookieAuth: [] - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/AttributeList' description: '' /api/_modules/visualizations/attributify: get: operationId: api__modules_visualizations_attributify_list description: |- 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 endpoint takes ``sample_ids`` or ``basket`` as a parameter where ``sample_ids`` takes precedence. parameters: - in: query name: annotation_version schema: enum: - v2 type: string default: v2 minLength: 1 description: '* `v2` - v2' - in: query name: attribute schema: {} required: true - in: query name: basket schema: type: string format: uuid - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: sample_ids schema: type: array items: type: integer tags: - api security: - cookieAuth: [] - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedSampleList' description: '' post: operationId: api__modules_visualizations_attributify_create description: Attributify endpoint. tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/AttributifyDeserializer' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/AttributifyDeserializer' multipart/form-data: schema: $ref: '#/components/schemas/AttributifyDeserializer' required: true security: - cookieAuth: [] - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/Sample' description: '' /api/_modules/visualizations/basket_expressions: get: operationId: api__modules_visualizations_basket_expressions_list description: |- Endpoint for retrieving basket expressions. Request: - basket id - tags (optional) Response: - a list of expressions parameters: - in: query name: basket schema: type: string - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: tags schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form tags: - api security: - cookieAuth: [] - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedBasketExpressionsList' description: '' /api/_modules/visualizations/case_control_expressions: post: operationId: api__modules_visualizations_case_control_expressions_create description: Endpoint handler. tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/CaseControlExpressionsDeserializer' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CaseControlExpressionsDeserializer' multipart/form-data: schema: $ref: '#/components/schemas/CaseControlExpressionsDeserializer' required: true security: - cookieAuth: [] - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/CaseControlExpressions' description: '' /api/_modules/visualizations/expression_box_plot: get: operationId: api__modules_visualizations_expression_box_plot_list description: |- 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 gene ids - source - species - optional: attribute the response is grouped by Response: - a list of aggregated statistics suitable for box plot parameters: - in: query name: annotation_version schema: enum: - v2 type: string default: v2 minLength: 1 description: '* `v2` - v2' - in: query name: attribute schema: type: object additionalProperties: {} - in: query name: basket schema: type: string format: uuid required: true - in: query name: gene_ids schema: type: array items: type: string - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: source schema: type: string nullable: true minLength: 1 - in: query name: species schema: type: string nullable: true minLength: 1 tags: - api security: - cookieAuth: [] - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedExpressionBoxPlotList' description: '' post: operationId: api__modules_visualizations_expression_box_plot_create description: Endpoint handler. parameters: - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/ExpressionBoxPlotDeserializer' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/ExpressionBoxPlotDeserializer' multipart/form-data: schema: $ref: '#/components/schemas/ExpressionBoxPlotDeserializer' required: true security: - cookieAuth: [] - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedExpressionBoxPlotList' description: '' /api/_modules/visualizations/expressions: get: operationId: api__modules_visualizations_expressions_list description: |- Endpoint for retrieving expressions for provided genes. Request takes optional parameters: group_by and color_by which are descriptor or relation attributes. Request: - basket id - a list for gene ids - source - species - optional: group_by (serialized ```DescriptorAttribute``` or ```RelationAttribute```) - optional: color_by (same as group_by) Response: - a list of gene/expression/sample values parameters: - in: query name: annotation_version schema: enum: - v2 type: string default: v2 minLength: 1 description: '* `v2` - v2' - in: query name: basket schema: type: string format: uuid required: true - in: query name: color_by schema: type: object additionalProperties: {} nullable: true - in: query name: gene_ids schema: type: array items: type: string - in: query name: group_by schema: type: object additionalProperties: {} nullable: true - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: source schema: type: string nullable: true minLength: 1 - in: query name: species schema: type: string nullable: true minLength: 1 tags: - api security: - cookieAuth: [] - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedExpressionsList' description: '' post: operationId: api__modules_visualizations_expressions_create description: Endpoint handler. parameters: - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/ExpressionsDeserializer' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/ExpressionsDeserializer' multipart/form-data: schema: $ref: '#/components/schemas/ExpressionsDeserializer' required: true security: - cookieAuth: [] - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedExpressionsList' description: '' /api/_modules/visualizations/heatmap: get: operationId: api__modules_visualizations_heatmap_list description: |- Endpoint used for heatmap visualization. Request: - gene_ids - source - species - sample_ids Response: - a list of objects containing heatmap related data: - sample name - gene - expression - expression type parameters: - in: query name: gene_ids schema: type: array items: type: string - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: sample_ids schema: type: array items: type: integer required: true - in: query name: source schema: type: string nullable: true minLength: 1 - in: query name: species schema: type: string nullable: true minLength: 1 tags: - api security: - cookieAuth: [] - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedHeatmapList' description: '' post: operationId: api__modules_visualizations_heatmap_create description: Return a response. parameters: - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/HeatmapDeserializer' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/HeatmapDeserializer' multipart/form-data: schema: $ref: '#/components/schemas/HeatmapDeserializer' required: true security: - cookieAuth: [] - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedHeatmapList' description: '' /api/_modules/visualizations/rose2: get: operationId: api__modules_visualizations_rose2_list description: |- Endpoint returns Rose2 Data objects filtered by basket. Endpoint supports: * :drf:`Limit/Offset Pagination ` * filtering * ordering by `name` and `created` parameters: - in: query name: basket schema: type: string format: uuid required: true - in: query name: build schema: type: string - in: query name: collection schema: type: integer - in: query name: collection__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: collection__isnull schema: type: boolean - in: query name: collection__name schema: type: string - in: query name: collection__name__contains schema: type: string - in: query name: collection__name__icontains schema: type: string - in: query name: collection__name__iexact schema: type: string - in: query name: collection__name__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: collection__name__isnull schema: type: boolean - in: query name: collection__name__istartswith schema: type: string - in: query name: collection__name__startswith schema: type: string - in: query name: collection__slug schema: type: string - in: query name: collection__slug__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: contributor schema: type: integer - in: query name: contributor__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: contributor_name schema: type: string - in: query name: created schema: type: string format: date-time - in: query name: created__date schema: type: string format: date - in: query name: created__gt schema: type: string format: date-time - in: query name: created__gte schema: type: string format: date-time - in: query name: created__isnull schema: type: boolean - in: query name: created__lt schema: type: string format: date-time - in: query name: created__lte schema: type: string format: date-time - in: query name: created__time schema: type: string format: time - in: query name: entity schema: type: integer - in: query name: entity__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: entity__isnull schema: type: boolean - in: query name: entity__name schema: type: string - in: query name: entity__name__contains schema: type: string - in: query name: entity__name__icontains schema: type: string - in: query name: entity__name__iexact schema: type: string - in: query name: entity__name__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: entity__name__isnull schema: type: boolean - in: query name: entity__name__istartswith schema: type: string - in: query name: entity__name__startswith schema: type: string - in: query name: entity__slug schema: type: string - in: query name: entity__slug__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: feature_type schema: type: string - in: query name: finished schema: type: string format: date-time - in: query name: finished__date schema: type: string format: date - in: query name: finished__gt schema: type: string format: date-time - in: query name: finished__gte schema: type: string format: date-time - in: query name: finished__isnull schema: type: boolean - in: query name: finished__lt schema: type: string format: date-time - in: query name: finished__lte schema: type: string format: date-time - in: query name: finished__time schema: type: string format: time - in: query name: group schema: type: string - in: query name: id schema: type: integer - in: query name: id__gt schema: type: integer - in: query name: id__gte schema: type: integer - in: query name: id__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: id__isnull schema: type: boolean - in: query name: id__lt schema: type: integer - in: query name: id__lte schema: type: integer - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: modified schema: type: string format: date-time - in: query name: modified__date schema: type: string format: date - in: query name: modified__gt schema: type: string format: date-time - in: query name: modified__gte schema: type: string format: date-time - in: query name: modified__isnull schema: type: boolean - in: query name: modified__lt schema: type: string format: date-time - in: query name: modified__lte schema: type: string format: date-time - in: query name: modified__time schema: type: string format: time - in: query name: name schema: type: string - in: query name: name__contains schema: type: string - in: query name: name__icontains schema: type: string - in: query name: name__iexact schema: type: string - in: query name: name__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: name__isnull schema: type: boolean - in: query name: name__istartswith schema: type: string - in: query name: name__startswith schema: type: string - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: owners schema: type: integer - in: query name: owners_name schema: type: string - in: query name: permission schema: type: string - in: query name: process schema: type: integer - in: query name: process__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: process__isnull schema: type: boolean - in: query name: process__name schema: type: string - in: query name: process__name__contains schema: type: string - in: query name: process__name__icontains schema: type: string - in: query name: process__name__iexact schema: type: string - in: query name: process__name__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: process__name__isnull schema: type: boolean - in: query name: process__name__istartswith schema: type: string - in: query name: process__name__startswith schema: type: string - in: query name: process__slug schema: type: string - in: query name: process__slug__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: relation_id schema: type: number - in: query name: shared_with_me schema: type: boolean - in: query name: slug schema: type: string - in: query name: slug__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: source schema: type: string - in: query name: species schema: type: string - in: query name: started schema: type: string format: date-time - in: query name: started__date schema: type: string format: date - in: query name: started__gt schema: type: string format: date-time - in: query name: started__gte schema: type: string format: date-time - in: query name: started__isnull schema: type: boolean - in: query name: started__lt schema: type: string format: date-time - in: query name: started__lte schema: type: string format: date-time - in: query name: started__time schema: type: string format: time - in: query name: status schema: type: string enum: - DR - ER - OK - PP - PR - RE - UP - WT description: |- * `UP` - Uploading * `RE` - Resolving * `WT` - Waiting * `PP` - Preparing * `PR` - Processing * `OK` - Done * `ER` - Error * `DR` - Dirty - in: query name: status__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: tags schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: type schema: type: string - in: query name: type__exact schema: type: string - in: query name: version schema: type: string - in: query name: version__gt schema: type: string - in: query name: version__gte schema: type: string - in: query name: version__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: version__isnull schema: type: boolean - in: query name: version__lt schema: type: string - in: query name: version__lte schema: type: string tags: - api security: - cookieAuth: [] - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedRose2List' description: '' /api/accesstoken/data: get: operationId: api_accesstoken_data_list description: API view for :class:`DescriptorSchema` objects. parameters: - in: query name: created schema: type: string format: date-time - in: query name: created__date schema: type: string format: date - in: query name: created__gt schema: type: string format: date-time - in: query name: created__gte schema: type: string format: date-time - in: query name: created__isnull schema: type: boolean - in: query name: created__lt schema: type: string format: date-time - in: query name: created__lte schema: type: string format: date-time - in: query name: created__time schema: type: string format: time - in: query name: description schema: type: string - in: query name: description__contains schema: type: string - in: query name: description__icontains schema: type: string - in: query name: description__iexact schema: type: string - in: query name: description__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: description__isnull schema: type: boolean - in: query name: description__istartswith schema: type: string - in: query name: description__startswith schema: type: string - in: query name: expires schema: type: string format: date-time - in: query name: expires__date schema: type: string format: date - in: query name: expires__gt schema: type: string format: date-time - in: query name: expires__gte schema: type: string format: date-time - in: query name: expires__isnull schema: type: boolean - in: query name: expires__lt schema: type: string format: date-time - in: query name: expires__lte schema: type: string format: date-time - in: query name: expires__time schema: type: string format: time - in: query name: id schema: type: integer - in: query name: id__gt schema: type: integer - in: query name: id__gte schema: type: integer - in: query name: id__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: id__isnull schema: type: boolean - in: query name: id__lt schema: type: integer - in: query name: id__lte schema: type: integer - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: revoked schema: type: string format: date-time - in: query name: revoked__date schema: type: string format: date - in: query name: revoked__gt schema: type: string format: date-time - in: query name: revoked__gte schema: type: string format: date-time - in: query name: revoked__isnull schema: type: boolean - in: query name: revoked__lt schema: type: string format: date-time - in: query name: revoked__lte schema: type: string format: date-time - in: query name: revoked__time schema: type: string format: time tags: - api security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedDataAccessTokenList' description: '' post: operationId: api_accesstoken_data_create description: Set current user, translate permissions and create token. tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/DataAccessTokenCreate' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/DataAccessTokenCreate' multipart/form-data: schema: $ref: '#/components/schemas/DataAccessTokenCreate' required: true security: - cookieAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/DataAccessTokenCreate' description: '' /api/accesstoken/data/{id}: get: operationId: api_accesstoken_data_retrieve description: API view for :class:`DescriptorSchema` objects. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this data access token. required: true tags: - api security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/DataAccessToken' description: '' put: operationId: api_accesstoken_data_update description: API view for :class:`DescriptorSchema` objects. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this data access token. required: true tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/DataAccessToken' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/DataAccessToken' multipart/form-data: schema: $ref: '#/components/schemas/DataAccessToken' required: true security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/DataAccessToken' description: '' patch: operationId: api_accesstoken_data_partial_update description: API view for :class:`DescriptorSchema` objects. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this data access token. required: true tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedDataAccessToken' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedDataAccessToken' multipart/form-data: schema: $ref: '#/components/schemas/PatchedDataAccessToken' security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/DataAccessToken' description: '' delete: operationId: api_accesstoken_data_destroy description: API view for :class:`DescriptorSchema` objects. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this data access token. required: true tags: - api security: - cookieAuth: [] responses: '204': description: No response body /api/annotation: get: operationId: api_annotation_retrieve description: |- Download annotation template. If ``dry_run`` parameter is present, then empty response will be returned. parameters: - in: query name: annotation_type schema: type: string minLength: 1 required: true - in: query name: collection_ids schema: type: array items: type: integer - in: query name: dry_run schema: type: boolean default: false - in: query name: sample_ids schema: type: array items: type: integer tags: - api security: - cookieAuth: [] responses: '200': description: No response body post: operationId: api_annotation_create description: Annotate using uploaded annotation file. tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/AnnotationUploadDeserializer' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/AnnotationUploadDeserializer' multipart/form-data: schema: $ref: '#/components/schemas/AnnotationUploadDeserializer' required: true security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AnnotationUpload' description: '' /api/annotation_field: get: operationId: api_annotation_field_list description: Annotation fields viewset. parameters: - in: query name: collection schema: type: array items: type: integer explode: true style: form - in: query name: collection__name schema: type: string - in: query name: collection__name__contains schema: type: string - in: query name: collection__name__icontains schema: type: string - in: query name: collection__name__iexact schema: type: string - in: query name: collection__name__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: collection__name__isnull schema: type: boolean - in: query name: collection__name__istartswith schema: type: string - in: query name: collection__name__startswith schema: type: string - in: query name: collection__slug schema: type: string - in: query name: collection__slug__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: description schema: type: string - in: query name: description__contains schema: type: string - in: query name: description__icontains schema: type: string - in: query name: description__iexact schema: type: string - in: query name: description__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: description__isnull schema: type: boolean - in: query name: description__istartswith schema: type: string - in: query name: description__startswith schema: type: string - in: query name: entity schema: type: number - in: query name: entity__annotations schema: type: string - in: query name: entity__basket schema: type: string - in: query name: entity__collection schema: type: string - in: query name: entity__collection__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: entity__collection__isnull schema: type: boolean - in: query name: entity__collection__name schema: type: string - in: query name: entity__collection__name__contains schema: type: string - in: query name: entity__collection__name__icontains schema: type: string - in: query name: entity__collection__name__iexact schema: type: string - in: query name: entity__collection__name__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: entity__collection__name__isnull schema: type: boolean - in: query name: entity__collection__name__istartswith schema: type: string - in: query name: entity__collection__name__startswith schema: type: string - in: query name: entity__collection__slug schema: type: string - in: query name: entity__collection__slug__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: entity__contributor schema: type: string - in: query name: entity__contributor__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: entity__contributor_name schema: type: string - in: query name: entity__created schema: type: string format: date-time - in: query name: entity__created__date schema: type: string format: date - in: query name: entity__created__gt schema: type: string format: date-time - in: query name: entity__created__gte schema: type: string format: date-time - in: query name: entity__created__isnull schema: type: boolean - in: query name: entity__created__lt schema: type: string format: date-time - in: query name: entity__created__lte schema: type: string format: date-time - in: query name: entity__created__time schema: type: string format: time - in: query name: entity__description schema: type: string - in: query name: entity__description__contains schema: type: string - in: query name: entity__description__icontains schema: type: string - in: query name: entity__description__iexact schema: type: string - in: query name: entity__description__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: entity__description__isnull schema: type: boolean - in: query name: entity__description__istartswith schema: type: string - in: query name: entity__description__startswith schema: type: string - in: query name: entity__group schema: type: string - in: query name: entity__gt schema: type: number - in: query name: entity__gte schema: type: number - in: query name: entity__in schema: type: array items: type: number description: Multiple values may be separated by commas. explode: false style: form - in: query name: entity__isnull schema: type: boolean - in: query name: entity__lt schema: type: number - in: query name: entity__lte schema: type: number - in: query name: entity__modified schema: type: string format: date-time - in: query name: entity__modified__date schema: type: string format: date - in: query name: entity__modified__gt schema: type: string format: date-time - in: query name: entity__modified__gte schema: type: string format: date-time - in: query name: entity__modified__isnull schema: type: boolean - in: query name: entity__modified__lt schema: type: string format: date-time - in: query name: entity__modified__lte schema: type: string format: date-time - in: query name: entity__modified__time schema: type: string format: time - in: query name: entity__name schema: type: string - in: query name: entity__name__contains schema: type: string - in: query name: entity__name__icontains schema: type: string - in: query name: entity__name__iexact schema: type: string - in: query name: entity__name__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: entity__name__isnull schema: type: boolean - in: query name: entity__name__istartswith schema: type: string - in: query name: entity__name__startswith schema: type: string - in: query name: entity__owners schema: type: integer - in: query name: entity__owners_name schema: type: string - in: query name: entity__permission schema: type: string - in: query name: entity__relation_id schema: type: number - in: query name: entity__shared_with_me schema: type: boolean - in: query name: entity__slug schema: type: string - in: query name: entity__slug__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: entity__status schema: type: string - in: query name: entity__status__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: entity__tags schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: entity__type schema: type: string - in: query name: entity__version schema: type: string - in: query name: entity__version__gt schema: type: string - in: query name: entity__version__gte schema: type: string - in: query name: entity__version__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: entity__version__isnull schema: type: boolean - in: query name: entity__version__lt schema: type: string - in: query name: entity__version__lte schema: type: string - in: query name: group__name schema: type: string - in: query name: group__name__contains schema: type: string - in: query name: group__name__icontains schema: type: string - in: query name: group__name__iexact schema: type: string - in: query name: group__name__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: group__name__isnull schema: type: boolean - in: query name: group__name__istartswith schema: type: string - in: query name: group__name__startswith schema: type: string - in: query name: id schema: type: integer - in: query name: id__gt schema: type: integer - in: query name: id__gte schema: type: integer - in: query name: id__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: id__isnull schema: type: boolean - in: query name: id__lt schema: type: integer - in: query name: id__lte schema: type: integer - in: query name: label schema: type: string - in: query name: label__contains schema: type: string - in: query name: label__icontains schema: type: string - in: query name: label__iexact schema: type: string - in: query name: label__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: label__isnull schema: type: boolean - in: query name: label__istartswith schema: type: string - in: query name: label__startswith schema: type: string - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: name schema: type: string - in: query name: name__contains schema: type: string - in: query name: name__icontains schema: type: string - in: query name: name__iexact schema: type: string - in: query name: name__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: name__isnull schema: type: boolean - in: query name: name__istartswith schema: type: string - in: query name: name__startswith schema: type: string - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: required schema: type: boolean - in: query name: type schema: type: string - in: query name: type__contains schema: type: string - in: query name: type__icontains schema: type: string - in: query name: type__iexact schema: type: string - in: query name: type__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: type__isnull schema: type: boolean - in: query name: type__istartswith schema: type: string - in: query name: type__startswith schema: type: string tags: - api security: - cookieAuth: [] - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedAnnotationFieldList' description: '' /api/annotation_field/{id}: get: operationId: api_annotation_field_retrieve description: Annotation fields viewset. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this annotation field. required: true tags: - api security: - cookieAuth: [] - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/AnnotationField' description: '' /api/annotation_preset: get: operationId: api_annotation_preset_list description: API view for :class:`DescriptorSchema` objects. parameters: - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: name schema: type: string - in: query name: name__contains schema: type: string - in: query name: name__icontains schema: type: string - in: query name: name__iexact schema: type: string - in: query name: name__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: name__isnull schema: type: boolean - in: query name: name__istartswith schema: type: string - in: query name: name__startswith schema: type: string - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string tags: - api security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedAnnotationPresetSerializerWithPermissionsList' description: '' post: operationId: api_annotation_preset_create description: Create a resource. tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/AnnotationPresetSerializerWithPermissions' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/AnnotationPresetSerializerWithPermissions' multipart/form-data: schema: $ref: '#/components/schemas/AnnotationPresetSerializerWithPermissions' required: true security: - cookieAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/AnnotationPresetSerializerWithPermissions' description: '' /api/annotation_preset/{id}: get: operationId: api_annotation_preset_retrieve description: API view for :class:`DescriptorSchema` objects. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this annotation preset. required: true tags: - api security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AnnotationPresetSerializerWithPermissions' description: '' put: operationId: api_annotation_preset_update description: Update a resource. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this annotation preset. required: true tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/AnnotationPresetSerializerWithPermissions' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/AnnotationPresetSerializerWithPermissions' multipart/form-data: schema: $ref: '#/components/schemas/AnnotationPresetSerializerWithPermissions' required: true security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AnnotationPresetSerializerWithPermissions' description: '' patch: operationId: api_annotation_preset_partial_update description: API view for :class:`DescriptorSchema` objects. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this annotation preset. required: true tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedAnnotationPresetSerializerWithPermissions' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedAnnotationPresetSerializerWithPermissions' multipart/form-data: schema: $ref: '#/components/schemas/PatchedAnnotationPresetSerializerWithPermissions' security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AnnotationPresetSerializerWithPermissions' description: '' /api/annotation_preset/{id}/permissions: get: operationId: api_annotation_preset_permissions_retrieve description: Get or set permissions API endpoint. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this annotation preset. required: true tags: - api security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/CurrentUserPermissions' description: '' post: operationId: api_annotation_preset_permissions_create description: Get or set permissions API endpoint. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this annotation preset. required: true tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/Permission' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Permission' multipart/form-data: schema: $ref: '#/components/schemas/Permission' security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/CurrentUserPermissions' description: '' /api/annotation_value: get: operationId: api_annotation_value_list description: Annotation value viewset. parameters: - in: query name: contributor schema: type: integer - in: query name: contributor__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: created schema: type: string format: date-time - in: query name: created__gt schema: type: string format: date-time - in: query name: created__gte schema: type: string format: date-time - in: query name: created__isnull schema: type: boolean - in: query name: created__lt schema: type: string format: date-time - in: query name: created__lte schema: type: string format: date-time - in: query name: entity schema: type: integer - in: query name: entity__annotations schema: type: string - in: query name: entity__basket schema: type: string - in: query name: entity__collection schema: type: integer - in: query name: entity__collection__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: entity__collection__isnull schema: type: boolean - in: query name: entity__collection__name schema: type: string - in: query name: entity__collection__name__contains schema: type: string - in: query name: entity__collection__name__icontains schema: type: string - in: query name: entity__collection__name__iexact schema: type: string - in: query name: entity__collection__name__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: entity__collection__name__isnull schema: type: boolean - in: query name: entity__collection__name__istartswith schema: type: string - in: query name: entity__collection__name__startswith schema: type: string - in: query name: entity__collection__slug schema: type: string - in: query name: entity__collection__slug__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: entity__contributor schema: type: integer - in: query name: entity__contributor__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: entity__contributor_name schema: type: string - in: query name: entity__created schema: type: string format: date-time - in: query name: entity__created__date schema: type: string format: date - in: query name: entity__created__gt schema: type: string format: date-time - in: query name: entity__created__gte schema: type: string format: date-time - in: query name: entity__created__isnull schema: type: boolean - in: query name: entity__created__lt schema: type: string format: date-time - in: query name: entity__created__lte schema: type: string format: date-time - in: query name: entity__created__time schema: type: string format: time - in: query name: entity__description schema: type: string - in: query name: entity__description__contains schema: type: string - in: query name: entity__description__icontains schema: type: string - in: query name: entity__description__iexact schema: type: string - in: query name: entity__description__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: entity__description__isnull schema: type: boolean - in: query name: entity__description__istartswith schema: type: string - in: query name: entity__description__startswith schema: type: string - in: query name: entity__group schema: type: string - in: query name: entity__gt schema: type: integer - in: query name: entity__gte schema: type: integer - in: query name: entity__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: entity__isnull schema: type: boolean - in: query name: entity__lt schema: type: integer - in: query name: entity__lte schema: type: integer - in: query name: entity__modified schema: type: string format: date-time - in: query name: entity__modified__date schema: type: string format: date - in: query name: entity__modified__gt schema: type: string format: date-time - in: query name: entity__modified__gte schema: type: string format: date-time - in: query name: entity__modified__isnull schema: type: boolean - in: query name: entity__modified__lt schema: type: string format: date-time - in: query name: entity__modified__lte schema: type: string format: date-time - in: query name: entity__modified__time schema: type: string format: time - in: query name: entity__name schema: type: string - in: query name: entity__name__contains schema: type: string - in: query name: entity__name__icontains schema: type: string - in: query name: entity__name__iexact schema: type: string - in: query name: entity__name__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: entity__name__isnull schema: type: boolean - in: query name: entity__name__istartswith schema: type: string - in: query name: entity__name__startswith schema: type: string - in: query name: entity__owners schema: type: integer - in: query name: entity__owners_name schema: type: string - in: query name: entity__permission schema: type: string - in: query name: entity__relation_id schema: type: integer - in: query name: entity__shared_with_me schema: type: boolean - in: query name: entity__slug schema: type: string - in: query name: entity__slug__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: entity__status schema: type: string - in: query name: entity__status__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: entity__tags schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: entity__type schema: type: string - in: query name: entity__version schema: type: string - in: query name: entity__version__gt schema: type: string - in: query name: entity__version__gte schema: type: string - in: query name: entity__version__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: entity__version__isnull schema: type: boolean - in: query name: entity__version__lt schema: type: string - in: query name: entity__version__lte schema: type: string - in: query name: field__group__name schema: type: string - in: query name: field__group__name__contains schema: type: string - in: query name: field__group__name__icontains schema: type: string - in: query name: field__group__name__iexact schema: type: string - in: query name: field__group__name__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: field__group__name__isnull schema: type: boolean - in: query name: field__group__name__istartswith schema: type: string - in: query name: field__group__name__startswith schema: type: string - in: query name: field__id schema: type: integer - in: query name: field__id__gt schema: type: integer - in: query name: field__id__gte schema: type: integer - in: query name: field__id__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: field__id__isnull schema: type: boolean - in: query name: field__id__lt schema: type: integer - in: query name: field__id__lte schema: type: integer - in: query name: field__label schema: type: string - in: query name: field__label__contains schema: type: string - in: query name: field__label__icontains schema: type: string - in: query name: field__label__iexact schema: type: string - in: query name: field__label__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: field__label__isnull schema: type: boolean - in: query name: field__label__istartswith schema: type: string - in: query name: field__label__startswith schema: type: string - in: query name: field__name schema: type: string - in: query name: field__name__contains schema: type: string - in: query name: field__name__icontains schema: type: string - in: query name: field__name__iexact schema: type: string - in: query name: field__name__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: field__name__isnull schema: type: boolean - in: query name: field__name__istartswith schema: type: string - in: query name: field__name__startswith schema: type: string - in: query name: id schema: type: integer - in: query name: id__gt schema: type: integer - in: query name: id__gte schema: type: integer - in: query name: id__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: id__isnull schema: type: boolean - in: query name: id__lt schema: type: integer - in: query name: id__lte schema: type: integer - in: query name: label schema: type: string - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string tags: - api security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedAnnotationValueList' description: '' post: operationId: api_annotation_value_create description: Create a resource. tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/AnnotationValue' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/AnnotationValue' multipart/form-data: schema: $ref: '#/components/schemas/AnnotationValue' required: true security: - cookieAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/AnnotationValue' description: '' /api/annotation_value/{id}: get: operationId: api_annotation_value_retrieve description: Annotation value viewset. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this annotation value. required: true tags: - api security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AnnotationValue' description: '' put: operationId: api_annotation_value_update description: |- 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. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this annotation value. required: true tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/AnnotationValue' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/AnnotationValue' multipart/form-data: schema: $ref: '#/components/schemas/AnnotationValue' required: true security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AnnotationValue' description: '' patch: operationId: api_annotation_value_partial_update description: Deny the partial updates of annotation values. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this annotation value. required: true tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedAnnotationValue' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedAnnotationValue' multipart/form-data: schema: $ref: '#/components/schemas/PatchedAnnotationValue' security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AnnotationValue' description: '' delete: operationId: api_annotation_value_destroy description: Annotation value viewset. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this annotation value. required: true tags: - api security: - cookieAuth: [] responses: '204': description: No response body /api/app-state: post: operationId: api_app_state_create description: API view for :class:`AppState` objects. tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/AppState' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/AppState' multipart/form-data: schema: $ref: '#/components/schemas/AppState' required: true security: - cookieAuth: [] - {} responses: '201': content: application/json: schema: $ref: '#/components/schemas/AppState' description: '' /api/app-state/{uuid}: get: operationId: api_app_state_retrieve description: API view for :class:`AppState` objects. parameters: - in: path name: uuid schema: type: string format: uuid description: A UUID string identifying this app state. required: true tags: - api security: - cookieAuth: [] - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/AppState' description: '' /api/base/csrf: get: operationId: api_base_csrf_retrieve description: View that sends the CSRF cookie. tags: - api security: - cookieAuth: [] - {} responses: '200': description: No response body /api/base/data_usage: get: operationId: api_base_data_usage_retrieve description: Get data for the view. parameters: - in: query name: ordering schema: type: array items: enum: - username - full_name - data_size - data_size_normalized - data_count - data_count_normalized - sample_count - sample_count_normalized - collection_count - collection_count_normalized - -username - -full_name - -data_size - -data_size_normalized - -data_count - -data_count_normalized - -sample_count - -sample_count_normalized - -collection_count - -collection_count_normalized type: string description: |- * `username` - username * `full_name` - full_name * `data_size` - data_size * `data_size_normalized` - data_size_normalized * `data_count` - data_count * `data_count_normalized` - data_count_normalized * `sample_count` - sample_count * `sample_count_normalized` - sample_count_normalized * `collection_count` - collection_count * `collection_count_normalized` - collection_count_normalized * `-username` - -username * `-full_name` - -full_name * `-data_size` - -data_size * `-data_size_normalized` - -data_size_normalized * `-data_count` - -data_count * `-data_count_normalized` - -data_count_normalized * `-sample_count` - -sample_count * `-sample_count_normalized` - -sample_count_normalized * `-collection_count` - -collection_count * `-collection_count_normalized` - -collection_count_normalized - in: query name: single schema: type: boolean default: false tags: - api security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/UserDataUsagePolymorphic' description: '' /api/basespace/callback: get: operationId: api_basespace_callback_retrieve description: Get request handler. parameters: - in: query name: code schema: type: string minLength: 1 - in: query name: error schema: type: string minLength: 1 - in: query name: error_description schema: type: string minLength: 1 - in: query name: state schema: type: string minLength: 1 required: true tags: - api security: - cookieAuth: [] - {} responses: '200': content: text/html: schema: type: string description: '' /api/basespace/current_user: get: operationId: api_basespace_current_user_retrieve description: Return currently logged in BaseSpace user. tags: - api security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/BaseSpaceUser' description: '' /api/basespace/files: get: operationId: api_basespace_files_retrieve description: |- 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. Default is 0. - sort_by (optional): The field to use for sorting. Can be 'id', or 'datecreated'. Default is 'id'. - sort_dir (optional): The way to sort the collection. Can be 'asc' or 'desc'. Default is 'asc'. parameters: - in: query name: limit schema: type: integer default: 10 - in: query name: offset schema: type: integer default: 0 - in: query name: sample_id schema: type: string minLength: 1 required: true - in: query name: sort_by schema: type: string default: id minLength: 1 - in: query name: sort_dir schema: type: string default: asc minLength: 1 tags: - api security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Files' description: '' /api/basespace/logout_url: get: operationId: api_basespace_logout_url_retrieve description: Return URL to be used to logout BaseSpace user. tags: - api security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Url' description: '' /api/basespace/oauth_browse_url: get: operationId: api_basespace_oauth_browse_url_retrieve description: Return URL to be used when requesting BaseSpace OAuth browse permissions. tags: - api security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Url' description: '' /api/basespace/oauth_read_projects_url: get: operationId: api_basespace_oauth_read_projects_url_retrieve description: |- Return URL to be used when requesting BaseSpace OAuth read projects permissions. Request parameters: - project_ids: list of project ids parameters: - in: query name: project_ids schema: type: array items: type: string tags: - api security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Url' description: '' /api/basespace/projects: get: operationId: api_basespace_projects_retrieve description: |- 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. Default is 0. - sort_by (optional): The field to use for sotring. Can be 'id', 'name', or 'datecreated'. Default is 'id'. - sort_dir (optional): The way to sort the collection. Can be 'asc' or 'desc'. Default is 'asc'. parameters: - in: query name: limit schema: type: integer default: 10 - in: query name: offset schema: type: integer default: 0 - in: query name: sort_by schema: type: string default: id minLength: 1 - in: query name: sort_dir schema: type: string default: asc minLength: 1 tags: - api security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Projects' description: '' /api/basespace/read_projects_handle: get: operationId: api_basespace_read_projects_handle_retrieve description: |- Return access token secret handle to read BaseSpace projects. Request parameters: - project_ids: list of project ids parameters: - in: query name: project_ids schema: type: array items: type: string tags: - api security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Handle' description: '' /api/basespace/revoke_browse_access: post: operationId: api_basespace_revoke_browse_access_create description: Delete user's BaseSpace browse token. tags: - api security: - cookieAuth: [] responses: '200': description: No response body /api/basespace/samples: get: operationId: api_basespace_samples_retrieve description: |- 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 read. Default is 0. - sort_by (optional): The field to use for sorting. Can be 'Id', 'name', or 'datecreated'. Default is 'id'. - sort_dir (optional): The way to sort the collection. Can be 'asc' or 'desc'. Default is 'asc'. parameters: - in: query name: limit schema: type: integer default: 10 - in: query name: offset schema: type: integer default: 0 - in: query name: project_id schema: type: string minLength: 1 required: true - in: query name: sort_by schema: type: string default: id minLength: 1 - in: query name: sort_dir schema: type: string default: asc minLength: 1 tags: - api security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/BaseSpaceSamples' description: '' /api/basespace/subscribe: post: operationId: api_basespace_subscribe_create description: Register an Observer for a resource. tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/ObserverSubscribeRequest' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/ObserverSubscribeRequest' multipart/form-data: schema: $ref: '#/components/schemas/ObserverSubscribeRequest' required: true security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ObserverSubscription' description: '' /api/basespace/unsubscribe: post: operationId: api_basespace_unsubscribe_create description: Unregister a subscription. tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/ObserverSubscription' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/ObserverSubscription' multipart/form-data: schema: $ref: '#/components/schemas/ObserverSubscription' required: true security: - cookieAuth: [] responses: '200': description: No response body /api/basket: post: operationId: api_basket_create description: API view for all basket operations. tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/Basket' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Basket' multipart/form-data: schema: $ref: '#/components/schemas/Basket' required: true security: - cookieAuth: [] - {} responses: '201': content: application/json: schema: $ref: '#/components/schemas/Basket' description: '' /api/basket/{id}: get: operationId: api_basket_retrieve description: API view for all basket operations. parameters: - in: path name: id schema: type: string format: uuid description: A UUID string identifying this sample basket. required: true tags: - api security: - cookieAuth: [] - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/Basket' description: '' /api/basket/{id}/add_samples: post: operationId: api_basket_add_samples_create description: Add samples to basket. parameters: - in: path name: id schema: type: string format: uuid description: A UUID string identifying this sample basket. required: true tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/BasketAddSamplesDeserializer' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/BasketAddSamplesDeserializer' multipart/form-data: schema: $ref: '#/components/schemas/BasketAddSamplesDeserializer' required: true security: - cookieAuth: [] - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/BasketAddSamples' description: '' /api/basket/{id}/breadcrumbs: get: operationId: api_basket_breadcrumbs_list description: Provide an observable list of breadcrumbs in a basket. parameters: - in: path name: id schema: type: string format: uuid description: A UUID string identifying this sample basket. required: true - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string tags: - api security: - cookieAuth: [] - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedBasketBreadcrumbList' description: '' /api/basket/{id}/clone: post: operationId: api_basket_clone_create description: Clone the basket. parameters: - in: path name: id schema: type: string format: uuid description: A UUID string identifying this sample basket. required: true tags: - api security: - cookieAuth: [] - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/BasketClone' description: '' /api/basket/{id}/data_types: get: operationId: api_basket_data_types_retrieve description: Provide a list of unique data types in a basket. parameters: - in: path name: id schema: type: string format: uuid description: A UUID string identifying this sample basket. required: true - in: query name: tags schema: type: array items: type: string tags: - api security: - cookieAuth: [] - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/BasketDataTypes' description: '' /api/basket/{id}/deselect_samples: post: operationId: api_basket_deselect_samples_create description: Deselect samples. parameters: - in: path name: id schema: type: string format: uuid description: A UUID string identifying this sample basket. required: true tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/BasketSubset' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/BasketSubset' multipart/form-data: schema: $ref: '#/components/schemas/BasketSubset' security: - cookieAuth: [] - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/BasketMutation' description: '' /api/basket/{id}/empty_basket: post: operationId: api_basket_empty_basket_create description: Remove samples from the basket. parameters: - in: path name: id schema: type: string format: uuid description: A UUID string identifying this sample basket. required: true tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/BasketSubset' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/BasketSubset' multipart/form-data: schema: $ref: '#/components/schemas/BasketSubset' security: - cookieAuth: [] - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/BasketMutation' description: '' /api/basket/{id}/make_read_only: post: operationId: api_basket_make_read_only_create description: Make the basket read-only. parameters: - in: path name: id schema: type: string format: uuid description: A UUID string identifying this sample basket. required: true tags: - api security: - cookieAuth: [] - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/BasketMutation' description: '' /api/basket/{id}/organisms: get: operationId: api_basket_organisms_list description: Provide an observable list of organisms in a basket. parameters: - in: query name: annotation_version schema: enum: - v2 type: string default: v2 minLength: 1 description: '* `v2` - v2' - in: path name: id schema: type: string format: uuid description: A UUID string identifying this sample basket. required: true - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string tags: - api security: - cookieAuth: [] - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedBasketOrganismList' description: '' /api/basket/{id}/remove_samples: post: operationId: api_basket_remove_samples_create description: Remove samples. parameters: - in: path name: id schema: type: string format: uuid description: A UUID string identifying this sample basket. required: true tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/BasketSubset' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/BasketSubset' multipart/form-data: schema: $ref: '#/components/schemas/BasketSubset' security: - cookieAuth: [] - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/BasketMutation' description: '' /api/basket/{id}/remove_selected_samples: post: operationId: api_basket_remove_selected_samples_create description: Remove selected samples. parameters: - in: path name: id schema: type: string format: uuid description: A UUID string identifying this sample basket. required: true tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/BasketSubset' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/BasketSubset' multipart/form-data: schema: $ref: '#/components/schemas/BasketSubset' security: - cookieAuth: [] - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/BasketMutation' description: '' /api/basket/{id}/sample_count: get: operationId: api_basket_sample_count_retrieve description: Provide an observable number of samples in a basket. parameters: - in: path name: id schema: type: string format: uuid description: A UUID string identifying this sample basket. required: true tags: - api security: - cookieAuth: [] - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/BasketSampleCount' description: '' /api/basket/{id}/samples: get: operationId: api_basket_samples_list description: Provide an observable list of samples in a basket. parameters: - in: path name: id schema: type: string format: uuid description: A UUID string identifying this sample basket. required: true - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string tags: - api security: - cookieAuth: [] - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedSampleInBasketList' description: '' /api/basket/{id}/select_all_samples: post: operationId: api_basket_select_all_samples_create description: Select all samples. parameters: - in: path name: id schema: type: string format: uuid description: A UUID string identifying this sample basket. required: true tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/BasketSubset' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/BasketSubset' multipart/form-data: schema: $ref: '#/components/schemas/BasketSubset' security: - cookieAuth: [] - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/BasketMutation' description: '' /api/basket/{id}/select_samples: post: operationId: api_basket_select_samples_create description: Select samples. parameters: - in: path name: id schema: type: string format: uuid description: A UUID string identifying this sample basket. required: true tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/BasketSubset' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/BasketSubset' multipart/form-data: schema: $ref: '#/components/schemas/BasketSubset' security: - cookieAuth: [] - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/BasketMutation' description: '' /api/basket/{id}/sources: get: operationId: api_basket_sources_list description: Provide an observable list of sources in a basket. parameters: - in: path name: id schema: type: string format: uuid description: A UUID string identifying this sample basket. required: true - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string tags: - api security: - cookieAuth: [] - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedBasketSourceList' description: '' /api/billingaccount: get: operationId: api_billingaccount_list description: API view for :class:`BillingAccounts` objects. parameters: - in: query name: active schema: type: boolean - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string tags: - api security: - cookieAuth: [] - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedBillingAccountList' description: '' /api/billingaccount/{id}: get: operationId: api_billingaccount_retrieve description: API view for :class:`BillingAccounts` objects. parameters: - in: path name: id schema: type: string pattern: ^[0-9]+$ required: true tags: - api security: - cookieAuth: [] - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/BillingAccount' description: '' /api/billingaccount/{id}/collection: post: operationId: api_billingaccount_collection_create description: |- Assign collection to the billing account. Required arguments: collection_id. The user is only allowed to perform the operation when: - it has 'edit' permission on the collection - it has 'view' permission on the billing account parameters: - in: path name: id schema: type: string pattern: ^[0-9]+$ required: true tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/BillingAccountToCollection' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/BillingAccountToCollection' multipart/form-data: schema: $ref: '#/components/schemas/BillingAccountToCollection' required: true security: - cookieAuth: [] - {} responses: '200': content: application/json: schema: type: string description: '' /api/billingaccount/estimated_usage: get: operationId: api_billingaccount_estimated_usage_list description: API view for :class:`EstimatedCostByBillingAccount` objects. parameters: - in: query name: billing_account_id schema: type: integer - in: query name: billing_account_id__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: cost_type schema: type: string - in: query name: cost_type__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: date_after schema: type: string format: date required: true - in: query name: date_before schema: type: string format: date required: true - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - in: query name: referenced_collection_id schema: type: integer - in: query name: referenced_collection_id__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: referenced_collection_name schema: type: string - in: query name: referenced_collection_name__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: referenced_collection_slug schema: type: string - in: query name: referenced_collection_slug__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form tags: - api security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedEstimatedCostPerBillingAccountList' description: '' /api/billingstatistics/billing_accounts_usage: get: operationId: api_billingstatistics_billing_accounts_usage_list description: |- Get the billing accounts usage. The returned fields are: minimal_usage, maximal_usage, average_usage. The parameters for the request are: - date_from: ISO 8601 date representation, required. - date_to: ISO 8601 date representation, required. - fields: fields of interest, optional. When not specified, all the statistics are returned. parameters: - in: query name: avg_usage schema: type: integer - in: query name: billing_account_id schema: type: integer required: true - in: query name: max_usage schema: type: integer - in: query name: min_usage schema: type: integer tags: - api security: - cookieAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/BillingStatisticsCost' description: '' /api/billingstatistics/collections_usage: get: operationId: api_billingstatistics_collections_usage_list description: |- Get the collection usage. The returned fields are: created_date (could be null), minimal_usage, maximal_usage, average_usage. The parameters for the request are: - collection_ids: the collections that the data should be returned for, required. - date_from: ISO 8601 date representation, required. - date_to: ISO 8601 date representation, required. - fields: fields of interest, optional. When not specified, all the statistics are returned. parameters: - in: query name: collection_ids schema: type: array items: type: integer required: true - in: query name: date_from schema: type: string format: date-time required: true - in: query name: date_to schema: type: string format: date-time required: true - in: query name: fields schema: type: array items: enum: - max_usage - min_usage - avg_usage - created type: string description: |- * `max_usage` - max_usage * `min_usage` - min_usage * `avg_usage` - avg_usage * `created` - created tags: - api security: - cookieAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/BillingStatisticsCollection' description: '' /api/billingstatistics/excel_report: get: operationId: api_billingstatistics_excel_report_retrieve description: |- 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 parameters of the request are first and last month: - date_from: ISO 8601 date representation, required. - date_to: ISO 8601 date representation, required. Currently only year and month are extracted from the parameters. For example if one is interested in statistics in January 2022 the values could be the following. - date_from: 2022-01-01 - date_to: 2022-01-31 Also the dates - date_from: 2022-01-10 - date_to: 2022-01-12 would achieve the same effect. parameters: - in: query name: date_from schema: type: string format: date-time required: true - in: query name: date_to schema: type: string format: date-time required: true tags: - api security: - cookieAuth: [] responses: '200': description: No response body /api/collection: get: operationId: api_collection_list description: |- The extended resolwe Collection viewset. It contains method to set prediction fields. parameters: - in: query name: contributor schema: type: integer - in: query name: contributor__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: contributor_name schema: type: string - in: query name: created schema: type: string format: date-time - in: query name: created__date schema: type: string format: date - in: query name: created__gt schema: type: string format: date-time - in: query name: created__gte schema: type: string format: date-time - in: query name: created__isnull schema: type: boolean - in: query name: created__lt schema: type: string format: date-time - in: query name: created__lte schema: type: string format: date-time - in: query name: created__time schema: type: string format: time - in: query name: description schema: type: string - in: query name: description__contains schema: type: string - in: query name: description__icontains schema: type: string - in: query name: description__iexact schema: type: string - in: query name: description__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: description__isnull schema: type: boolean - in: query name: description__istartswith schema: type: string - in: query name: description__startswith schema: type: string - in: query name: descriptor_schema schema: type: integer - in: query name: entity_count schema: type: number - in: query name: entity_count__gt schema: type: number - in: query name: entity_count__gte schema: type: number - in: query name: entity_count__lt schema: type: number - in: query name: entity_count__lte schema: type: number - in: query name: group schema: type: string - in: query name: id schema: type: integer - in: query name: id__gt schema: type: integer - in: query name: id__gte schema: type: integer - in: query name: id__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: id__isnull schema: type: boolean - in: query name: id__lt schema: type: integer - in: query name: id__lte schema: type: integer - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: modified schema: type: string format: date-time - in: query name: modified__date schema: type: string format: date - in: query name: modified__gt schema: type: string format: date-time - in: query name: modified__gte schema: type: string format: date-time - in: query name: modified__isnull schema: type: boolean - in: query name: modified__lt schema: type: string format: date-time - in: query name: modified__lte schema: type: string format: date-time - in: query name: modified__time schema: type: string format: time - in: query name: name schema: type: string - in: query name: name__contains schema: type: string - in: query name: name__icontains schema: type: string - in: query name: name__iexact schema: type: string - in: query name: name__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: name__isnull schema: type: boolean - in: query name: name__istartswith schema: type: string - in: query name: name__startswith schema: type: string - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: owners schema: type: integer - in: query name: owners_name schema: type: string - in: query name: permission schema: type: string - in: query name: sample schema: type: integer - in: query name: shared_with_me schema: type: boolean - in: query name: slug schema: type: string - in: query name: slug__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: status schema: type: string - in: query name: status__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: tags schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: version schema: type: string - in: query name: version__gt schema: type: string - in: query name: version__gte schema: type: string - in: query name: version__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: version__isnull schema: type: boolean - in: query name: version__lt schema: type: string - in: query name: version__lte schema: type: string tags: - api security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedCollectionSerializerWithPermissionsList' description: '' post: operationId: api_collection_create description: Only authenticated users can create new collections. tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/CollectionSerializerWithPermissions' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CollectionSerializerWithPermissions' multipart/form-data: schema: $ref: '#/components/schemas/CollectionSerializerWithPermissions' required: true security: - cookieAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/CollectionSerializerWithPermissions' description: '' /api/collection/{id}: get: operationId: api_collection_retrieve description: |- The extended resolwe Collection viewset. It contains method to set prediction fields. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this collection. required: true tags: - api security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/CollectionSerializerWithPermissions' description: '' put: operationId: api_collection_update description: Update a resource. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this collection. required: true tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/CollectionSerializerWithPermissions' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CollectionSerializerWithPermissions' multipart/form-data: schema: $ref: '#/components/schemas/CollectionSerializerWithPermissions' required: true security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/CollectionSerializerWithPermissions' description: '' patch: operationId: api_collection_partial_update description: |- The extended resolwe Collection viewset. It contains method to set prediction fields. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this collection. required: true tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedCollectionSerializerWithPermissions' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedCollectionSerializerWithPermissions' multipart/form-data: schema: $ref: '#/components/schemas/PatchedCollectionSerializerWithPermissions' security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/CollectionSerializerWithPermissions' description: '' delete: operationId: api_collection_destroy description: Delete a resource. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this collection. required: true tags: - api security: - cookieAuth: [] responses: '204': description: No response body /api/collection/{id}/permissions: get: operationId: api_collection_permissions_retrieve description: Get or set permissions API endpoint. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this collection. required: true tags: - api security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/CurrentUserPermissions' description: '' post: operationId: api_collection_permissions_create description: Get or set permissions API endpoint. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this collection. required: true tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/Permission' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Permission' multipart/form-data: schema: $ref: '#/components/schemas/Permission' security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/CurrentUserPermissions' description: '' /api/collection/{id}/set_annotation_fields: post: operationId: api_collection_set_annotation_fields_create description: Set AnnotationFields on collection. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this collection. required: true tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/AnnotationFieldDict' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/AnnotationFieldDict' multipart/form-data: schema: $ref: '#/components/schemas/AnnotationFieldDict' required: true security: - cookieAuth: [] responses: '204': description: No response body /api/collection/{id}/set_prediction_fields: post: operationId: api_collection_set_prediction_fields_create description: Set PredictionFields on a collection. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this collection. required: true tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/PredictionFieldDict' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PredictionFieldDict' multipart/form-data: schema: $ref: '#/components/schemas/PredictionFieldDict' required: true security: - cookieAuth: [] responses: '204': description: No response body /api/collection/billing_account/{id}: get: operationId: api_collection_billing_account_retrieve description: Get the Billing account id of the given collection. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this billing account. required: true tags: - api security: - cookieAuth: [] - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/BillingAccount' description: '' /api/collection/bulk_delete: post: operationId: api_collection_bulk_delete_create description: |- Bulk delete objects in the background. The background task is returned. tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/Delete' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Delete' multipart/form-data: schema: $ref: '#/components/schemas/Delete' required: true security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/BackgroundTask' description: '' /api/collection/duplicate: post: operationId: api_collection_duplicate_create description: |- Bulk duplicate objects in the background. The background task is returned. tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/Duplicate' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Duplicate' multipart/form-data: schema: $ref: '#/components/schemas/Duplicate' required: true security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/BackgroundTask' description: '' /api/collection/slug_exists: get: operationId: api_collection_slug_exists_retrieve description: |- Check if given url slug exists. Check if slug given in query parameter ``name`` exists. Return ``True`` if slug already exists and ``False`` otherwise. parameters: - in: query name: name schema: type: string minLength: 1 required: true tags: - api security: - cookieAuth: [] responses: '200': content: application/json: schema: type: boolean description: '' /api/collection/subscribe: post: operationId: api_collection_subscribe_create description: Register an Observer for a resource. tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/ObserverSubscribeRequest' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/ObserverSubscribeRequest' multipart/form-data: schema: $ref: '#/components/schemas/ObserverSubscribeRequest' required: true security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ObserverSubscription' description: '' /api/collection/unsubscribe: post: operationId: api_collection_unsubscribe_create description: Unregister a subscription. tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/ObserverSubscription' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/ObserverSubscription' multipart/form-data: schema: $ref: '#/components/schemas/ObserverSubscription' required: true security: - cookieAuth: [] responses: '200': description: No response body /api/community: get: operationId: api_community_list description: API view for :class:`Community` objects. parameters: - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer tags: - api security: - cookieAuth: [] - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedCommunityList' description: '' /api/configuration: get: operationId: api_configuration_list description: Return configuration list. parameters: - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer tags: - api security: - cookieAuth: [] - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedConfigurationList' description: '' /api/configuration/{community__slug}: get: operationId: api_configuration_retrieve description: API view for :class:`Configuration` objects. parameters: - in: path name: community__slug schema: type: string required: true tags: - api security: - cookieAuth: [] - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/Configuration' description: '' /api/data: get: operationId: api_data_list description: API view for :class:`Data` objects. parameters: - in: query name: build schema: type: string - in: query name: collection schema: type: integer - in: query name: collection__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: collection__isnull schema: type: boolean - in: query name: collection__name schema: type: string - in: query name: collection__name__contains schema: type: string - in: query name: collection__name__icontains schema: type: string - in: query name: collection__name__iexact schema: type: string - in: query name: collection__name__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: collection__name__isnull schema: type: boolean - in: query name: collection__name__istartswith schema: type: string - in: query name: collection__name__startswith schema: type: string - in: query name: collection__slug schema: type: string - in: query name: collection__slug__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: contributor schema: type: integer - in: query name: contributor__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: contributor_name schema: type: string - in: query name: created schema: type: string format: date-time - in: query name: created__date schema: type: string format: date - in: query name: created__gt schema: type: string format: date-time - in: query name: created__gte schema: type: string format: date-time - in: query name: created__isnull schema: type: boolean - in: query name: created__lt schema: type: string format: date-time - in: query name: created__lte schema: type: string format: date-time - in: query name: created__time schema: type: string format: time - in: query name: entity schema: type: integer - in: query name: entity__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: entity__isnull schema: type: boolean - in: query name: entity__name schema: type: string - in: query name: entity__name__contains schema: type: string - in: query name: entity__name__icontains schema: type: string - in: query name: entity__name__iexact schema: type: string - in: query name: entity__name__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: entity__name__isnull schema: type: boolean - in: query name: entity__name__istartswith schema: type: string - in: query name: entity__name__startswith schema: type: string - in: query name: entity__slug schema: type: string - in: query name: entity__slug__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: feature_type schema: type: string - in: query name: finished schema: type: string format: date-time - in: query name: finished__date schema: type: string format: date - in: query name: finished__gt schema: type: string format: date-time - in: query name: finished__gte schema: type: string format: date-time - in: query name: finished__isnull schema: type: boolean - in: query name: finished__lt schema: type: string format: date-time - in: query name: finished__lte schema: type: string format: date-time - in: query name: finished__time schema: type: string format: time - in: query name: group schema: type: string - in: query name: id schema: type: integer - in: query name: id__gt schema: type: integer - in: query name: id__gte schema: type: integer - in: query name: id__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: id__isnull schema: type: boolean - in: query name: id__lt schema: type: integer - in: query name: id__lte schema: type: integer - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: modified schema: type: string format: date-time - in: query name: modified__date schema: type: string format: date - in: query name: modified__gt schema: type: string format: date-time - in: query name: modified__gte schema: type: string format: date-time - in: query name: modified__isnull schema: type: boolean - in: query name: modified__lt schema: type: string format: date-time - in: query name: modified__lte schema: type: string format: date-time - in: query name: modified__time schema: type: string format: time - in: query name: name schema: type: string - in: query name: name__contains schema: type: string - in: query name: name__icontains schema: type: string - in: query name: name__iexact schema: type: string - in: query name: name__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: name__isnull schema: type: boolean - in: query name: name__istartswith schema: type: string - in: query name: name__startswith schema: type: string - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: owners schema: type: integer - in: query name: owners_name schema: type: string - in: query name: permission schema: type: string - in: query name: process schema: type: integer - in: query name: process__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: process__isnull schema: type: boolean - in: query name: process__name schema: type: string - in: query name: process__name__contains schema: type: string - in: query name: process__name__icontains schema: type: string - in: query name: process__name__iexact schema: type: string - in: query name: process__name__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: process__name__isnull schema: type: boolean - in: query name: process__name__istartswith schema: type: string - in: query name: process__name__startswith schema: type: string - in: query name: process__slug schema: type: string - in: query name: process__slug__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: relation_id schema: type: number - in: query name: shared_with_me schema: type: boolean - in: query name: slug schema: type: string - in: query name: slug__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: source schema: type: string - in: query name: species schema: type: string - in: query name: started schema: type: string format: date-time - in: query name: started__date schema: type: string format: date - in: query name: started__gt schema: type: string format: date-time - in: query name: started__gte schema: type: string format: date-time - in: query name: started__isnull schema: type: boolean - in: query name: started__lt schema: type: string format: date-time - in: query name: started__lte schema: type: string format: date-time - in: query name: started__time schema: type: string format: time - in: query name: status schema: type: string enum: - DR - ER - OK - PP - PR - RE - UP - WT description: |- * `UP` - Uploading * `RE` - Resolving * `WT` - Waiting * `PP` - Preparing * `PR` - Processing * `OK` - Done * `ER` - Error * `DR` - Dirty - in: query name: status__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: tags schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: type schema: type: string - in: query name: type__exact schema: type: string - in: query name: version schema: type: string - in: query name: version__gt schema: type: string - in: query name: version__gte schema: type: string - in: query name: version__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: version__isnull schema: type: boolean - in: query name: version__lt schema: type: string - in: query name: version__lte schema: type: string tags: - api security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedDataSerializerWithPermissionsList' description: '' post: operationId: api_data_create description: Create a resource. tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/DataSerializerWithPermissions' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/DataSerializerWithPermissions' multipart/form-data: schema: $ref: '#/components/schemas/DataSerializerWithPermissions' required: true security: - cookieAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/DataSerializerWithPermissions' description: '' /api/data/{id}: get: operationId: api_data_retrieve description: API view for :class:`Data` objects. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this data. required: true tags: - api security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/DataSerializerWithPermissions' description: '' put: operationId: api_data_update description: Update a resource. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this data. required: true tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/DataSerializerWithPermissions' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/DataSerializerWithPermissions' multipart/form-data: schema: $ref: '#/components/schemas/DataSerializerWithPermissions' required: true security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/DataSerializerWithPermissions' description: '' patch: operationId: api_data_partial_update description: API view for :class:`Data` objects. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this data. required: true tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedDataSerializerWithPermissions' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedDataSerializerWithPermissions' multipart/form-data: schema: $ref: '#/components/schemas/PatchedDataSerializerWithPermissions' security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/DataSerializerWithPermissions' description: '' delete: operationId: api_data_destroy description: Delete a resource. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this data. required: true tags: - api security: - cookieAuth: [] responses: '204': description: No response body /api/data/{id}/children: get: operationId: api_data_children_retrieve description: Return children of the current data object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this data. required: true tags: - api security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/DataSerializerWithPermissions' description: '' /api/data/{id}/parents: get: operationId: api_data_parents_list description: Return parents of the current data object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this data. required: true - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer tags: - api security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedDataList' description: '' /api/data/{id}/permissions: get: operationId: api_data_permissions_retrieve description: Get or set permissions API endpoint. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this data. required: true tags: - api security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/CurrentUserPermissions' description: '' post: operationId: api_data_permissions_create description: Get or set permissions API endpoint. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this data. required: true tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/Permission' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Permission' multipart/form-data: schema: $ref: '#/components/schemas/Permission' security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/CurrentUserPermissions' description: '' /api/data/{id}/restart: post: operationId: api_data_restart_create description: Restart the current data object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this data. required: true - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/Restart' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Restart' multipart/form-data: schema: $ref: '#/components/schemas/Restart' security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedDataList' description: '' /api/data/bulk_delete: post: operationId: api_data_bulk_delete_create description: |- Bulk delete objects in the background. The background task is returned. tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/Delete' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Delete' multipart/form-data: schema: $ref: '#/components/schemas/Delete' required: true security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/BackgroundTask' description: '' /api/data/duplicate: post: operationId: api_data_duplicate_create description: |- Bulk duplicate objects in the background. The background task is returned. tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/Duplicate' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Duplicate' multipart/form-data: schema: $ref: '#/components/schemas/Duplicate' required: true security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/BackgroundTask' description: '' /api/data/get_or_create: post: operationId: api_data_get_or_create_create description: Get ``Data`` object if similar already exists, otherwise create it. tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/DataSerializerWithPermissions' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/DataSerializerWithPermissions' multipart/form-data: schema: $ref: '#/components/schemas/DataSerializerWithPermissions' required: true security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/DataSerializerWithPermissions' description: '' /api/data/move_to_collection: post: operationId: api_data_move_to_collection_create description: Move data objects to destination collection. tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/MoveDataToCollection' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/MoveDataToCollection' multipart/form-data: schema: $ref: '#/components/schemas/MoveDataToCollection' required: true security: - cookieAuth: [] responses: '200': description: No response body /api/data/slug_exists: get: operationId: api_data_slug_exists_retrieve description: |- Check if given url slug exists. Check if slug given in query parameter ``name`` exists. Return ``True`` if slug already exists and ``False`` otherwise. parameters: - in: query name: name schema: type: string minLength: 1 required: true tags: - api security: - cookieAuth: [] responses: '200': content: application/json: schema: type: boolean description: '' /api/data/subscribe: post: operationId: api_data_subscribe_create description: Register an Observer for a resource. tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/ObserverSubscribeRequest' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/ObserverSubscribeRequest' multipart/form-data: schema: $ref: '#/components/schemas/ObserverSubscribeRequest' required: true security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ObserverSubscription' description: '' /api/data/unsubscribe: post: operationId: api_data_unsubscribe_create description: Unregister a subscription. tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/ObserverSubscription' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/ObserverSubscription' multipart/form-data: schema: $ref: '#/components/schemas/ObserverSubscription' required: true security: - cookieAuth: [] responses: '200': description: No response body /api/descriptorschema: get: operationId: api_descriptorschema_list description: API view for :class:`DescriptorSchema` objects. parameters: - in: query name: contributor schema: type: integer - in: query name: contributor__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: created schema: type: string format: date-time - in: query name: created__date schema: type: string format: date - in: query name: created__gt schema: type: string format: date-time - in: query name: created__gte schema: type: string format: date-time - in: query name: created__isnull schema: type: boolean - in: query name: created__lt schema: type: string format: date-time - in: query name: created__lte schema: type: string format: date-time - in: query name: created__time schema: type: string format: time - in: query name: id schema: type: integer - in: query name: id__gt schema: type: integer - in: query name: id__gte schema: type: integer - in: query name: id__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: id__isnull schema: type: boolean - in: query name: id__lt schema: type: integer - in: query name: id__lte schema: type: integer - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: modified schema: type: string format: date-time - in: query name: modified__date schema: type: string format: date - in: query name: modified__gt schema: type: string format: date-time - in: query name: modified__gte schema: type: string format: date-time - in: query name: modified__isnull schema: type: boolean - in: query name: modified__lt schema: type: string format: date-time - in: query name: modified__lte schema: type: string format: date-time - in: query name: modified__time schema: type: string format: time - in: query name: name schema: type: string - in: query name: name__contains schema: type: string - in: query name: name__icontains schema: type: string - in: query name: name__iexact schema: type: string - in: query name: name__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: name__isnull schema: type: boolean - in: query name: name__istartswith schema: type: string - in: query name: name__startswith schema: type: string - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: slug schema: type: string - in: query name: slug__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: version schema: type: string - in: query name: version__gt schema: type: string - in: query name: version__gte schema: type: string - in: query name: version__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: version__isnull schema: type: boolean - in: query name: version__lt schema: type: string - in: query name: version__lte schema: type: string tags: - api security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedDescriptorSchemaSerializerWithPermissionsList' description: '' /api/descriptorschema/{id}: get: operationId: api_descriptorschema_retrieve description: API view for :class:`DescriptorSchema` objects. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this descriptor schema. required: true tags: - api security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/DescriptorSchemaSerializerWithPermissions' description: '' /api/descriptorschema/{id}/permissions: get: operationId: api_descriptorschema_permissions_retrieve description: Get or set permissions API endpoint. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this descriptor schema. required: true tags: - api security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/CurrentUserPermissions' description: '' post: operationId: api_descriptorschema_permissions_create description: Get or set permissions API endpoint. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this descriptor schema. required: true tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/Permission' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Permission' multipart/form-data: schema: $ref: '#/components/schemas/Permission' security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/CurrentUserPermissions' description: '' /api/group: get: operationId: api_group_list description: API view for :class:`Group` objects. parameters: - in: query name: id schema: type: integer - in: query name: id__gt schema: type: integer - in: query name: id__gte schema: type: integer - in: query name: id__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: id__isnull schema: type: boolean - in: query name: id__lt schema: type: integer - in: query name: id__lte schema: type: integer - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: name schema: type: string - in: query name: name__contains schema: type: string - in: query name: name__icontains schema: type: string - in: query name: name__iexact schema: type: string - in: query name: name__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: name__isnull schema: type: boolean - in: query name: name__istartswith schema: type: string - in: query name: name__startswith schema: type: string - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string tags: - api security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedGroupList' description: '' post: operationId: api_group_create description: API view for :class:`Group` objects. tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/Group' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Group' multipart/form-data: schema: $ref: '#/components/schemas/Group' required: true security: - cookieAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/Group' description: '' /api/group/{id}: put: operationId: api_group_update description: API view for :class:`Group` objects. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this group. required: true tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/Group' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Group' multipart/form-data: schema: $ref: '#/components/schemas/Group' required: true security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Group' description: '' patch: operationId: api_group_partial_update description: API view for :class:`Group` objects. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this group. required: true tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedGroup' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedGroup' multipart/form-data: schema: $ref: '#/components/schemas/PatchedGroup' security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Group' description: '' /api/group/{id}/add_users: post: operationId: api_group_add_users_create description: Endpoint for adding users to group. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this group. required: true tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/AddOrRemoveUsers' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/AddOrRemoveUsers' multipart/form-data: schema: $ref: '#/components/schemas/AddOrRemoveUsers' required: true security: - cookieAuth: [] responses: '200': description: No response body /api/group/{id}/remove_users: post: operationId: api_group_remove_users_create description: Endpoint for removing users from group. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this group. required: true tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/AddOrRemoveUsers' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/AddOrRemoveUsers' multipart/form-data: schema: $ref: '#/components/schemas/AddOrRemoveUsers' required: true security: - cookieAuth: [] responses: '200': description: No response body /api/kb/feature: get: operationId: api_kb_feature_list description: |- Endpoint used for feature search. Request: - query - source - species - type - feature_id Response: - a list of matching features parameters: - in: query name: feature_id schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: feature_id__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: query schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: source schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: species schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: type schema: type: string enum: - exon - gene - probe - transcript description: |- * `gene` - Gene * `transcript` - Transcript * `exon` - Exon * `probe` - Probe tags: - api security: - cookieAuth: [] - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedFeatureList' description: '' post: operationId: api_kb_feature_create description: Endpoint handler. tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/Feature' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Feature' multipart/form-data: schema: $ref: '#/components/schemas/Feature' required: true security: - cookieAuth: [] - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/Feature' description: '' /api/kb/feature/paste: post: operationId: api_kb_feature_paste_create description: Endpoint used for exactly matching pasted genes. tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/Feature' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Feature' multipart/form-data: schema: $ref: '#/components/schemas/Feature' required: true security: - cookieAuth: [] - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/Feature' description: '' /api/kb/feature/search: get: operationId: api_kb_feature_search_list description: |- Endpoint used for feature search. Request: - query - source - species - type - feature_id Response: - a list of matching features parameters: - in: query name: feature_id schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: feature_id__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: query schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: source schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: species schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: type schema: type: string enum: - exon - gene - probe - transcript description: |- * `gene` - Gene * `transcript` - Transcript * `exon` - Exon * `probe` - Probe tags: - api security: - cookieAuth: [] - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedFeatureList' description: '' post: operationId: api_kb_feature_search_create description: Endpoint handler. tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/Feature' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Feature' multipart/form-data: schema: $ref: '#/components/schemas/Feature' required: true security: - cookieAuth: [] - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/Feature' description: '' /api/kb/feature/search/paste: post: operationId: api_kb_feature_search_paste_create description: Endpoint used for exactly matching pasted genes. tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/Feature' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Feature' multipart/form-data: schema: $ref: '#/components/schemas/Feature' required: true security: - cookieAuth: [] - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/Feature' description: '' /api/kb/mapping/search: get: operationId: api_kb_mapping_search_list description: |- Endpoint used for mapping search. Request: - source_id - source_db - source_species - target_id - target_db - target_species - relation_type Response: - a list of matching mappings parameters: - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: source_db schema: type: string - in: query name: source_db__contains schema: type: string - in: query name: source_db__icontains schema: type: string - in: query name: source_db__iexact schema: type: string - in: query name: source_db__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: source_db__isnull schema: type: boolean - in: query name: source_db__istartswith schema: type: string - in: query name: source_db__startswith schema: type: string - in: query name: source_id schema: type: string - in: query name: source_id__contains schema: type: string - in: query name: source_id__icontains schema: type: string - in: query name: source_id__iexact schema: type: string - in: query name: source_id__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: source_id__isnull schema: type: boolean - in: query name: source_id__istartswith schema: type: string - in: query name: source_id__startswith schema: type: string - in: query name: source_species schema: type: string - in: query name: source_species__contains schema: type: string - in: query name: source_species__icontains schema: type: string - in: query name: source_species__iexact schema: type: string - in: query name: source_species__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: source_species__isnull schema: type: boolean - in: query name: source_species__istartswith schema: type: string - in: query name: source_species__startswith schema: type: string - in: query name: target_db schema: type: string - in: query name: target_db__contains schema: type: string - in: query name: target_db__icontains schema: type: string - in: query name: target_db__iexact schema: type: string - in: query name: target_db__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: target_db__isnull schema: type: boolean - in: query name: target_db__istartswith schema: type: string - in: query name: target_db__startswith schema: type: string - in: query name: target_id schema: type: string - in: query name: target_id__contains schema: type: string - in: query name: target_id__icontains schema: type: string - in: query name: target_id__iexact schema: type: string - in: query name: target_id__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: target_id__isnull schema: type: boolean - in: query name: target_id__istartswith schema: type: string - in: query name: target_id__startswith schema: type: string - in: query name: target_species schema: type: string - in: query name: target_species__contains schema: type: string - in: query name: target_species__icontains schema: type: string - in: query name: target_species__iexact schema: type: string - in: query name: target_species__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: target_species__isnull schema: type: boolean - in: query name: target_species__istartswith schema: type: string - in: query name: target_species__startswith schema: type: string tags: - api security: - cookieAuth: [] - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedMappingList' description: '' post: operationId: api_kb_mapping_search_create description: Endpoint handler. tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/Mapping' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Mapping' multipart/form-data: schema: $ref: '#/components/schemas/Mapping' required: true security: - cookieAuth: [] - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/Mapping' description: '' /api/prediction_field: get: operationId: api_prediction_field_list description: Prediction fields viewset. parameters: - in: query name: collections schema: type: array items: type: integer explode: true style: form - in: query name: collections__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: collections__isnull schema: type: boolean - in: query name: description schema: type: string - in: query name: description__contains schema: type: string - in: query name: description__icontains schema: type: string - in: query name: description__iexact schema: type: string - in: query name: description__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: description__isnull schema: type: boolean - in: query name: description__istartswith schema: type: string - in: query name: description__startswith schema: type: string - in: query name: entity schema: type: integer - in: query name: entity__annotations schema: type: string - in: query name: entity__basket schema: type: string - in: query name: entity__collection schema: type: integer - in: query name: entity__collection__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: entity__collection__isnull schema: type: boolean - in: query name: entity__collection__name schema: type: string - in: query name: entity__collection__name__contains schema: type: string - in: query name: entity__collection__name__icontains schema: type: string - in: query name: entity__collection__name__iexact schema: type: string - in: query name: entity__collection__name__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: entity__collection__name__isnull schema: type: boolean - in: query name: entity__collection__name__istartswith schema: type: string - in: query name: entity__collection__name__startswith schema: type: string - in: query name: entity__collection__slug schema: type: string - in: query name: entity__collection__slug__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: entity__contributor schema: type: integer - in: query name: entity__contributor__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: entity__contributor_name schema: type: string - in: query name: entity__created schema: type: string format: date-time - in: query name: entity__created__date schema: type: string format: date - in: query name: entity__created__gt schema: type: string format: date-time - in: query name: entity__created__gte schema: type: string format: date-time - in: query name: entity__created__isnull schema: type: boolean - in: query name: entity__created__lt schema: type: string format: date-time - in: query name: entity__created__lte schema: type: string format: date-time - in: query name: entity__created__time schema: type: string format: time - in: query name: entity__description schema: type: string - in: query name: entity__description__contains schema: type: string - in: query name: entity__description__icontains schema: type: string - in: query name: entity__description__iexact schema: type: string - in: query name: entity__description__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: entity__description__isnull schema: type: boolean - in: query name: entity__description__istartswith schema: type: string - in: query name: entity__description__startswith schema: type: string - in: query name: entity__group schema: type: string - in: query name: entity__gt schema: type: integer - in: query name: entity__gte schema: type: integer - in: query name: entity__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: entity__isnull schema: type: boolean - in: query name: entity__lt schema: type: integer - in: query name: entity__lte schema: type: integer - in: query name: entity__modified schema: type: string format: date-time - in: query name: entity__modified__date schema: type: string format: date - in: query name: entity__modified__gt schema: type: string format: date-time - in: query name: entity__modified__gte schema: type: string format: date-time - in: query name: entity__modified__isnull schema: type: boolean - in: query name: entity__modified__lt schema: type: string format: date-time - in: query name: entity__modified__lte schema: type: string format: date-time - in: query name: entity__modified__time schema: type: string format: time - in: query name: entity__name schema: type: string - in: query name: entity__name__contains schema: type: string - in: query name: entity__name__icontains schema: type: string - in: query name: entity__name__iexact schema: type: string - in: query name: entity__name__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: entity__name__isnull schema: type: boolean - in: query name: entity__name__istartswith schema: type: string - in: query name: entity__name__startswith schema: type: string - in: query name: entity__owners schema: type: integer - in: query name: entity__owners_name schema: type: string - in: query name: entity__permission schema: type: string - in: query name: entity__relation_id schema: type: integer - in: query name: entity__shared_with_me schema: type: boolean - in: query name: entity__slug schema: type: string - in: query name: entity__slug__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: entity__status schema: type: string - in: query name: entity__status__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: entity__tags schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: entity__type schema: type: string - in: query name: entity__version schema: type: string - in: query name: entity__version__gt schema: type: string - in: query name: entity__version__gte schema: type: string - in: query name: entity__version__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: entity__version__isnull schema: type: boolean - in: query name: entity__version__lt schema: type: string - in: query name: entity__version__lte schema: type: string - in: query name: group__name schema: type: string - in: query name: group__name__contains schema: type: string - in: query name: group__name__icontains schema: type: string - in: query name: group__name__iexact schema: type: string - in: query name: group__name__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: group__name__isnull schema: type: boolean - in: query name: group__name__istartswith schema: type: string - in: query name: group__name__startswith schema: type: string - in: query name: has_dependencies schema: type: boolean - in: query name: id schema: type: integer - in: query name: id__gt schema: type: integer - in: query name: id__gte schema: type: integer - in: query name: id__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: id__isnull schema: type: boolean - in: query name: id__lt schema: type: integer - in: query name: id__lte schema: type: integer - in: query name: label schema: type: string - in: query name: label__contains schema: type: string - in: query name: label__icontains schema: type: string - in: query name: label__iexact schema: type: string - in: query name: label__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: label__isnull schema: type: boolean - in: query name: label__istartswith schema: type: string - in: query name: label__startswith schema: type: string - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: name schema: type: string - in: query name: name__contains schema: type: string - in: query name: name__icontains schema: type: string - in: query name: name__iexact schema: type: string - in: query name: name__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: name__isnull schema: type: boolean - in: query name: name__istartswith schema: type: string - in: query name: name__startswith schema: type: string - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: required schema: type: boolean - in: query name: type schema: type: string enum: - CLASS - SCORE description: |- * `SCORE` - SCORE * `CLASS` - CLASS - in: query name: type__contains schema: type: string - in: query name: type__icontains schema: type: string - in: query name: type__iexact schema: type: string - in: query name: type__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: type__isnull schema: type: boolean - in: query name: type__istartswith schema: type: string - in: query name: type__startswith schema: type: string tags: - api security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedPredictionFieldList' description: '' post: operationId: api_prediction_field_create description: Create a resource. tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/PredictionField' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PredictionField' multipart/form-data: schema: $ref: '#/components/schemas/PredictionField' required: true security: - cookieAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/PredictionField' description: '' /api/prediction_field/{id}: get: operationId: api_prediction_field_retrieve description: Prediction fields viewset. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this prediction field. required: true tags: - api security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PredictionField' description: '' put: operationId: api_prediction_field_update description: Prediction fields viewset. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this prediction field. required: true tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/PredictionField' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PredictionField' multipart/form-data: schema: $ref: '#/components/schemas/PredictionField' required: true security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PredictionField' description: '' patch: operationId: api_prediction_field_partial_update description: Prediction fields viewset. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this prediction field. required: true tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedPredictionField' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedPredictionField' multipart/form-data: schema: $ref: '#/components/schemas/PatchedPredictionField' security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PredictionField' description: '' delete: operationId: api_prediction_field_destroy description: Prediction fields viewset. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this prediction field. required: true tags: - api security: - cookieAuth: [] responses: '204': description: No response body /api/prediction_group: get: operationId: api_prediction_group_list description: Prediction fields viewset. parameters: - in: query name: id schema: type: integer - in: query name: id__gt schema: type: integer - in: query name: id__gte schema: type: integer - in: query name: id__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: id__isnull schema: type: boolean - in: query name: id__lt schema: type: integer - in: query name: id__lte schema: type: integer - in: query name: label schema: type: string - in: query name: label__contains schema: type: string - in: query name: label__icontains schema: type: string - in: query name: label__iexact schema: type: string - in: query name: label__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: label__isnull schema: type: boolean - in: query name: label__istartswith schema: type: string - in: query name: label__startswith schema: type: string - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: name schema: type: string - in: query name: name__contains schema: type: string - in: query name: name__icontains schema: type: string - in: query name: name__iexact schema: type: string - in: query name: name__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: name__isnull schema: type: boolean - in: query name: name__istartswith schema: type: string - in: query name: name__startswith schema: type: string - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: sort_order schema: type: integer - in: query name: sort_order__gt schema: type: integer - in: query name: sort_order__gte schema: type: integer - in: query name: sort_order__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: sort_order__isnull schema: type: boolean - in: query name: sort_order__lt schema: type: integer - in: query name: sort_order__lte schema: type: integer tags: - api security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedPredictionGroupList' description: '' post: operationId: api_prediction_group_create description: Create a resource. tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/PredictionGroup' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PredictionGroup' multipart/form-data: schema: $ref: '#/components/schemas/PredictionGroup' required: true security: - cookieAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/PredictionGroup' description: '' /api/prediction_group/{id}: get: operationId: api_prediction_group_retrieve description: Prediction fields viewset. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this prediction group. required: true tags: - api security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PredictionGroup' description: '' put: operationId: api_prediction_group_update description: Prediction fields viewset. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this prediction group. required: true tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/PredictionGroup' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PredictionGroup' multipart/form-data: schema: $ref: '#/components/schemas/PredictionGroup' required: true security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PredictionGroup' description: '' patch: operationId: api_prediction_group_partial_update description: Prediction fields viewset. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this prediction group. required: true tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedPredictionGroup' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedPredictionGroup' multipart/form-data: schema: $ref: '#/components/schemas/PatchedPredictionGroup' security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PredictionGroup' description: '' delete: operationId: api_prediction_group_destroy description: Prediction fields viewset. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this prediction group. required: true tags: - api security: - cookieAuth: [] responses: '204': description: No response body /api/prediction_preset: get: operationId: api_prediction_preset_list description: API view for :class:`DescriptorSchema` objects. parameters: - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: name schema: type: string - in: query name: name__contains schema: type: string - in: query name: name__icontains schema: type: string - in: query name: name__iexact schema: type: string - in: query name: name__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: name__isnull schema: type: boolean - in: query name: name__istartswith schema: type: string - in: query name: name__startswith schema: type: string - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string tags: - api security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedPredictionPresetSerializerWithPermissionsList' description: '' post: operationId: api_prediction_preset_create description: Create a resource. tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/PredictionPresetSerializerWithPermissions' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PredictionPresetSerializerWithPermissions' multipart/form-data: schema: $ref: '#/components/schemas/PredictionPresetSerializerWithPermissions' required: true security: - cookieAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/PredictionPresetSerializerWithPermissions' description: '' /api/prediction_preset/{id}: get: operationId: api_prediction_preset_retrieve description: API view for :class:`DescriptorSchema` objects. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this prediction preset. required: true tags: - api security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PredictionPresetSerializerWithPermissions' description: '' put: operationId: api_prediction_preset_update description: Update a resource. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this prediction preset. required: true tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/PredictionPresetSerializerWithPermissions' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PredictionPresetSerializerWithPermissions' multipart/form-data: schema: $ref: '#/components/schemas/PredictionPresetSerializerWithPermissions' required: true security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PredictionPresetSerializerWithPermissions' description: '' patch: operationId: api_prediction_preset_partial_update description: API view for :class:`DescriptorSchema` objects. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this prediction preset. required: true tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedPredictionPresetSerializerWithPermissions' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedPredictionPresetSerializerWithPermissions' multipart/form-data: schema: $ref: '#/components/schemas/PatchedPredictionPresetSerializerWithPermissions' security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PredictionPresetSerializerWithPermissions' description: '' delete: operationId: api_prediction_preset_destroy description: API view for :class:`DescriptorSchema` objects. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this prediction preset. required: true tags: - api security: - cookieAuth: [] responses: '204': description: No response body /api/prediction_preset/{id}/permissions: get: operationId: api_prediction_preset_permissions_retrieve description: Get or set permissions API endpoint. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this prediction preset. required: true tags: - api security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/CurrentUserPermissions' description: '' post: operationId: api_prediction_preset_permissions_create description: Get or set permissions API endpoint. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this prediction preset. required: true tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/Permission' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Permission' multipart/form-data: schema: $ref: '#/components/schemas/Permission' security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/CurrentUserPermissions' description: '' /api/prediction_value: get: operationId: api_prediction_value_list description: List objects. parameters: - in: query name: contributor schema: type: integer - in: query name: contributor__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: contributor__isnull schema: type: boolean - in: query name: created schema: type: string format: date-time - in: query name: created__gt schema: type: string format: date-time - in: query name: created__gte schema: type: string format: date-time - in: query name: created__isnull schema: type: boolean - in: query name: created__lt schema: type: string format: date-time - in: query name: created__lte schema: type: string format: date-time - in: query name: entity schema: type: integer - in: query name: entity__annotations schema: type: string - in: query name: entity__basket schema: type: string - in: query name: entity__collection schema: type: integer - in: query name: entity__collection__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: entity__collection__isnull schema: type: boolean - in: query name: entity__collection__name schema: type: string - in: query name: entity__collection__name__contains schema: type: string - in: query name: entity__collection__name__icontains schema: type: string - in: query name: entity__collection__name__iexact schema: type: string - in: query name: entity__collection__name__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: entity__collection__name__isnull schema: type: boolean - in: query name: entity__collection__name__istartswith schema: type: string - in: query name: entity__collection__name__startswith schema: type: string - in: query name: entity__collection__slug schema: type: string - in: query name: entity__collection__slug__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: entity__contributor schema: type: integer - in: query name: entity__contributor__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: entity__contributor_name schema: type: string - in: query name: entity__created schema: type: string format: date-time - in: query name: entity__created__date schema: type: string format: date - in: query name: entity__created__gt schema: type: string format: date-time - in: query name: entity__created__gte schema: type: string format: date-time - in: query name: entity__created__isnull schema: type: boolean - in: query name: entity__created__lt schema: type: string format: date-time - in: query name: entity__created__lte schema: type: string format: date-time - in: query name: entity__created__time schema: type: string format: time - in: query name: entity__description schema: type: string - in: query name: entity__description__contains schema: type: string - in: query name: entity__description__icontains schema: type: string - in: query name: entity__description__iexact schema: type: string - in: query name: entity__description__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: entity__description__isnull schema: type: boolean - in: query name: entity__description__istartswith schema: type: string - in: query name: entity__description__startswith schema: type: string - in: query name: entity__group schema: type: string - in: query name: entity__gt schema: type: integer - in: query name: entity__gte schema: type: integer - in: query name: entity__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: entity__isnull schema: type: boolean - in: query name: entity__lt schema: type: integer - in: query name: entity__lte schema: type: integer - in: query name: entity__modified schema: type: string format: date-time - in: query name: entity__modified__date schema: type: string format: date - in: query name: entity__modified__gt schema: type: string format: date-time - in: query name: entity__modified__gte schema: type: string format: date-time - in: query name: entity__modified__isnull schema: type: boolean - in: query name: entity__modified__lt schema: type: string format: date-time - in: query name: entity__modified__lte schema: type: string format: date-time - in: query name: entity__modified__time schema: type: string format: time - in: query name: entity__name schema: type: string - in: query name: entity__name__contains schema: type: string - in: query name: entity__name__icontains schema: type: string - in: query name: entity__name__iexact schema: type: string - in: query name: entity__name__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: entity__name__isnull schema: type: boolean - in: query name: entity__name__istartswith schema: type: string - in: query name: entity__name__startswith schema: type: string - in: query name: entity__owners schema: type: integer - in: query name: entity__owners_name schema: type: string - in: query name: entity__permission schema: type: string - in: query name: entity__relation_id schema: type: integer - in: query name: entity__shared_with_me schema: type: boolean - in: query name: entity__slug schema: type: string - in: query name: entity__slug__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: entity__status schema: type: string - in: query name: entity__status__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: entity__tags schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: entity__type schema: type: string - in: query name: entity__version schema: type: string - in: query name: entity__version__gt schema: type: string - in: query name: entity__version__gte schema: type: string - in: query name: entity__version__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: entity__version__isnull schema: type: boolean - in: query name: entity__version__lt schema: type: string - in: query name: entity__version__lte schema: type: string - in: query name: field__group__name schema: type: string - in: query name: field__group__name__contains schema: type: string - in: query name: field__group__name__icontains schema: type: string - in: query name: field__group__name__iexact schema: type: string - in: query name: field__group__name__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: field__group__name__isnull schema: type: boolean - in: query name: field__group__name__istartswith schema: type: string - in: query name: field__group__name__startswith schema: type: string - in: query name: field__id schema: type: integer - in: query name: field__id__gt schema: type: integer - in: query name: field__id__gte schema: type: integer - in: query name: field__id__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: field__id__isnull schema: type: boolean - in: query name: field__id__lt schema: type: integer - in: query name: field__id__lte schema: type: integer - in: query name: field__label schema: type: string - in: query name: field__label__contains schema: type: string - in: query name: field__label__icontains schema: type: string - in: query name: field__label__iexact schema: type: string - in: query name: field__label__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: field__label__isnull schema: type: boolean - in: query name: field__label__istartswith schema: type: string - in: query name: field__label__startswith schema: type: string - in: query name: field__name schema: type: string - in: query name: field__name__contains schema: type: string - in: query name: field__name__icontains schema: type: string - in: query name: field__name__iexact schema: type: string - in: query name: field__name__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: field__name__isnull schema: type: boolean - in: query name: field__name__istartswith schema: type: string - in: query name: field__name__startswith schema: type: string - in: query name: id schema: type: integer - in: query name: id__gt schema: type: integer - in: query name: id__gte schema: type: integer - in: query name: id__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: id__isnull schema: type: boolean - in: query name: id__lt schema: type: integer - in: query name: id__lte schema: type: integer - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string tags: - api security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedPredictionValueList' description: '' post: operationId: api_prediction_value_create description: Create a resource. tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/PredictionValue' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PredictionValue' multipart/form-data: schema: $ref: '#/components/schemas/PredictionValue' required: true security: - cookieAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/PredictionValue' description: '' /api/prediction_value/{id}: get: operationId: api_prediction_value_retrieve description: Prediction value viewset. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this prediction value. required: true tags: - api security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PredictionValue' description: '' put: operationId: api_prediction_value_update description: |- 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. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this prediction value. required: true tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/PredictionValue' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PredictionValue' multipart/form-data: schema: $ref: '#/components/schemas/PredictionValue' required: true security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PredictionValue' description: '' patch: operationId: api_prediction_value_partial_update description: Deny the partial updates of prediction values. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this prediction value. required: true tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedPredictionValue' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedPredictionValue' multipart/form-data: schema: $ref: '#/components/schemas/PatchedPredictionValue' security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PredictionValue' description: '' delete: operationId: api_prediction_value_destroy description: Prediction value viewset. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this prediction value. required: true tags: - api security: - cookieAuth: [] responses: '204': description: No response body /api/process: get: operationId: api_process_list description: API view for :class:`Process` objects. parameters: - in: query name: category schema: type: string - in: query name: contributor schema: type: integer - in: query name: contributor__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: created schema: type: string format: date-time - in: query name: created__date schema: type: string format: date - in: query name: created__gt schema: type: string format: date-time - in: query name: created__gte schema: type: string format: date-time - in: query name: created__isnull schema: type: boolean - in: query name: created__lt schema: type: string format: date-time - in: query name: created__lte schema: type: string format: date-time - in: query name: created__time schema: type: string format: time - in: query name: id schema: type: integer - in: query name: id__gt schema: type: integer - in: query name: id__gte schema: type: integer - in: query name: id__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: id__isnull schema: type: boolean - in: query name: id__lt schema: type: integer - in: query name: id__lte schema: type: integer - in: query name: is_active schema: type: boolean - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: modified schema: type: string format: date-time - in: query name: modified__date schema: type: string format: date - in: query name: modified__gt schema: type: string format: date-time - in: query name: modified__gte schema: type: string format: date-time - in: query name: modified__isnull schema: type: boolean - in: query name: modified__lt schema: type: string format: date-time - in: query name: modified__lte schema: type: string format: date-time - in: query name: modified__time schema: type: string format: time - in: query name: name schema: type: string - in: query name: name__contains schema: type: string - in: query name: name__icontains schema: type: string - in: query name: name__iexact schema: type: string - in: query name: name__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: name__isnull schema: type: boolean - in: query name: name__istartswith schema: type: string - in: query name: name__startswith schema: type: string - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: scheduling_class schema: type: string enum: - BA - IN description: |- * `IN` - Interactive * `BA` - Batch - in: query name: slug schema: type: string - in: query name: slug__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: type schema: type: string - in: query name: version schema: type: string - in: query name: version__gt schema: type: string - in: query name: version__gte schema: type: string - in: query name: version__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: version__isnull schema: type: boolean - in: query name: version__lt schema: type: string - in: query name: version__lte schema: type: string tags: - api security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedProcessSerializerWithPermissionsList' description: '' post: operationId: api_process_create description: Only superusers can create new processes. tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/ProcessSerializerWithPermissions' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/ProcessSerializerWithPermissions' multipart/form-data: schema: $ref: '#/components/schemas/ProcessSerializerWithPermissions' required: true security: - cookieAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/ProcessSerializerWithPermissions' description: '' /api/process/{id}: get: operationId: api_process_retrieve description: API view for :class:`Process` objects. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this process. required: true tags: - api security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ProcessSerializerWithPermissions' description: '' /api/process/{id}/permissions: get: operationId: api_process_permissions_retrieve description: Get or set permissions API endpoint. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this process. required: true tags: - api security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/CurrentUserPermissions' description: '' post: operationId: api_process_permissions_create description: Get or set permissions API endpoint. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this process. required: true tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/Permission' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Permission' multipart/form-data: schema: $ref: '#/components/schemas/Permission' security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/CurrentUserPermissions' description: '' /api/process/slug_exists: get: operationId: api_process_slug_exists_retrieve description: |- Check if given url slug exists. Check if slug given in query parameter ``name`` exists. Return ``True`` if slug already exists and ``False`` otherwise. parameters: - in: query name: name schema: type: string minLength: 1 required: true tags: - api security: - cookieAuth: [] responses: '200': content: application/json: schema: type: boolean description: '' /api/relation: get: operationId: api_relation_list description: API view for :class:`Relation` objects. parameters: - in: query name: category schema: type: string - in: query name: collection schema: type: integer - in: query name: contributor schema: type: integer - in: query name: contributor__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: created schema: type: string format: date-time - in: query name: created__date schema: type: string format: date - in: query name: created__gt schema: type: string format: date-time - in: query name: created__gte schema: type: string format: date-time - in: query name: created__isnull schema: type: boolean - in: query name: created__lt schema: type: string format: date-time - in: query name: created__lte schema: type: string format: date-time - in: query name: created__time schema: type: string format: time - in: query name: descriptor_schema schema: type: integer - in: query name: id schema: type: integer - in: query name: id__gt schema: type: integer - in: query name: id__gte schema: type: integer - in: query name: id__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: id__isnull schema: type: boolean - in: query name: id__lt schema: type: integer - in: query name: id__lte schema: type: integer - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: modified schema: type: string format: date-time - in: query name: modified__date schema: type: string format: date - in: query name: modified__gt schema: type: string format: date-time - in: query name: modified__gte schema: type: string format: date-time - in: query name: modified__isnull schema: type: boolean - in: query name: modified__lt schema: type: string format: date-time - in: query name: modified__lte schema: type: string format: date-time - in: query name: modified__time schema: type: string format: time - in: query name: name schema: type: string - in: query name: name__contains schema: type: string - in: query name: name__icontains schema: type: string - in: query name: name__iexact schema: type: string - in: query name: name__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: name__isnull schema: type: boolean - in: query name: name__istartswith schema: type: string - in: query name: name__startswith schema: type: string - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: slug schema: type: string - in: query name: slug__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: tags schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: type schema: type: string - in: query name: version schema: type: string - in: query name: version__gt schema: type: string - in: query name: version__gte schema: type: string - in: query name: version__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: version__isnull schema: type: boolean - in: query name: version__lt schema: type: string - in: query name: version__lte schema: type: string tags: - api security: - cookieAuth: [] - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedRelationList' description: '' post: operationId: api_relation_create description: Create a resource. tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/Relation' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Relation' multipart/form-data: schema: $ref: '#/components/schemas/Relation' required: true security: - cookieAuth: [] - {} responses: '201': content: application/json: schema: $ref: '#/components/schemas/Relation' description: '' /api/relation/{id}: get: operationId: api_relation_retrieve description: API view for :class:`Relation` objects. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this relation. required: true tags: - api security: - cookieAuth: [] - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/Relation' description: '' put: operationId: api_relation_update description: |- Update the ``Relation`` object. Reject the update if user doesn't have ``EDIT`` permission on the collection referenced in the ``Relation``. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this relation. required: true tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/Relation' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Relation' multipart/form-data: schema: $ref: '#/components/schemas/Relation' required: true security: - cookieAuth: [] - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/Relation' description: '' patch: operationId: api_relation_partial_update description: API view for :class:`Relation` objects. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this relation. required: true tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedRelation' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedRelation' multipart/form-data: schema: $ref: '#/components/schemas/PatchedRelation' security: - cookieAuth: [] - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/Relation' description: '' delete: operationId: api_relation_destroy description: |- Delete the ``Relation`` object. Reject the delete if user doesn't have ``EDIT`` permission on the collection referenced in the ``Relation``. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this relation. required: true tags: - api security: - cookieAuth: [] - {} responses: '204': description: No response body /api/resdk_minimal_supported_version: get: operationId: api_resdk_minimal_supported_version_retrieve description: Return the minimal supported resdk version. tags: - api security: - cookieAuth: [] - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/ReSDKMinimalSupportedVersion' description: '' /api/sample: get: operationId: api_sample_list description: |- The extended resolwe Entity viewset. It contains method to set predictios. parameters: - in: query name: annotations schema: type: string - in: query name: basket schema: type: string - in: query name: collection schema: type: integer - in: query name: collection__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: collection__isnull schema: type: boolean - in: query name: collection__name schema: type: string - in: query name: collection__name__contains schema: type: string - in: query name: collection__name__icontains schema: type: string - in: query name: collection__name__iexact schema: type: string - in: query name: collection__name__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: collection__name__isnull schema: type: boolean - in: query name: collection__name__istartswith schema: type: string - in: query name: collection__name__startswith schema: type: string - in: query name: collection__slug schema: type: string - in: query name: collection__slug__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: contributor schema: type: integer - in: query name: contributor__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: contributor_name schema: type: string - in: query name: created schema: type: string format: date-time - in: query name: created__date schema: type: string format: date - in: query name: created__gt schema: type: string format: date-time - in: query name: created__gte schema: type: string format: date-time - in: query name: created__isnull schema: type: boolean - in: query name: created__lt schema: type: string format: date-time - in: query name: created__lte schema: type: string format: date-time - in: query name: created__time schema: type: string format: time - in: query name: description schema: type: string - in: query name: description__contains schema: type: string - in: query name: description__icontains schema: type: string - in: query name: description__iexact schema: type: string - in: query name: description__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: description__isnull schema: type: boolean - in: query name: description__istartswith schema: type: string - in: query name: description__startswith schema: type: string - in: query name: descriptor__disease_information__disease_status__iexact schema: type: string - in: query name: descriptor__disease_information__disease_type__icontains schema: type: string - in: query name: descriptor__general__biosample_source__icontains schema: type: string - in: query name: descriptor__general__biosample_treatment__icontains schema: type: string - in: query name: descriptor__general__description__icontains schema: type: string - in: query name: descriptor__immuno_oncology_treatment_type__io_drug__iexact schema: type: string - in: query name: descriptor__immuno_oncology_treatment_type__io_treatment__iexact schema: type: string - in: query name: descriptor__response_and_survival_analysis__confirmed_bor__iexact schema: type: string - in: query name: descriptor__response_and_survival_analysis__pfs_event__iexact schema: type: string - in: query name: descriptor__subject_information__batch__exact schema: type: string - in: query name: descriptor__subject_information__group__iexact schema: type: string - in: query name: descriptor__subject_information__sample_label__icontains schema: type: string - in: query name: descriptor__subject_information__subject_id__icontains schema: type: string - in: query name: group schema: type: string - in: query name: id schema: type: integer - in: query name: id__gt schema: type: integer - in: query name: id__gte schema: type: integer - in: query name: id__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: id__isnull schema: type: boolean - in: query name: id__lt schema: type: integer - in: query name: id__lte schema: type: integer - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: modified schema: type: string format: date-time - in: query name: modified__date schema: type: string format: date - in: query name: modified__gt schema: type: string format: date-time - in: query name: modified__gte schema: type: string format: date-time - in: query name: modified__isnull schema: type: boolean - in: query name: modified__lt schema: type: string format: date-time - in: query name: modified__lte schema: type: string format: date-time - in: query name: modified__time schema: type: string format: time - in: query name: name schema: type: string - in: query name: name__contains schema: type: string - in: query name: name__icontains schema: type: string - in: query name: name__iexact schema: type: string - in: query name: name__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: name__isnull schema: type: boolean - in: query name: name__istartswith schema: type: string - in: query name: name__startswith schema: type: string - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: owners schema: type: integer - in: query name: owners_name schema: type: string - in: query name: permission schema: type: string - in: query name: relation_id schema: type: integer - in: query name: shared_with_me schema: type: boolean - in: query name: slug schema: type: string - in: query name: slug__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: status schema: type: string - in: query name: status__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: tags schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: type schema: type: string - in: query name: variant_calls__variant schema: type: integer - in: query name: variant_calls__variant__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: variant_calls__variant__isnull schema: type: boolean - in: query name: version schema: type: string - in: query name: version__gt schema: type: string - in: query name: version__gte schema: type: string - in: query name: version__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: version__isnull schema: type: boolean - in: query name: version__lt schema: type: string - in: query name: version__lte schema: type: string tags: - api security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedEntitySerializerWithPermissionsList' description: '' post: operationId: api_sample_create description: Only authenticated users can create new collections. tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/EntitySerializerWithPermissions' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/EntitySerializerWithPermissions' multipart/form-data: schema: $ref: '#/components/schemas/EntitySerializerWithPermissions' required: true security: - cookieAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/EntitySerializerWithPermissions' description: '' /api/sample/{id}: get: operationId: api_sample_retrieve description: |- The extended resolwe Entity viewset. It contains method to set predictios. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this entity. required: true tags: - api security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/EntitySerializerWithPermissions' description: '' put: operationId: api_sample_update description: |- Update an entity. Original queryset produces a temporary database table whose rows cannot be selected for an update. As a workaround, we patch get_queryset function to return only Entity objects without additional data that is not needed for the update. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this entity. required: true tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/EntitySerializerWithPermissions' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/EntitySerializerWithPermissions' multipart/form-data: schema: $ref: '#/components/schemas/EntitySerializerWithPermissions' required: true security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/EntitySerializerWithPermissions' description: '' patch: operationId: api_sample_partial_update description: |- The extended resolwe Entity viewset. It contains method to set predictios. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this entity. required: true tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedEntitySerializerWithPermissions' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedEntitySerializerWithPermissions' multipart/form-data: schema: $ref: '#/components/schemas/PatchedEntitySerializerWithPermissions' security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/EntitySerializerWithPermissions' description: '' delete: operationId: api_sample_destroy description: Delete a resource. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this entity. required: true tags: - api security: - cookieAuth: [] responses: '204': description: No response body /api/sample/{id}/permissions: get: operationId: api_sample_permissions_retrieve description: Get or set permissions API endpoint. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this entity. required: true tags: - api security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/CurrentUserPermissions' description: '' post: operationId: api_sample_permissions_create description: Get or set permissions API endpoint. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this entity. required: true tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/Permission' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Permission' multipart/form-data: schema: $ref: '#/components/schemas/Permission' security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/CurrentUserPermissions' description: '' /api/sample/{id}/set_annotations: post: operationId: api_sample_set_annotations_create description: Add the given list of AnnotationFields to the given entity. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this entity. required: true tags: - api requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/AnnotationsByPath' application/x-www-form-urlencoded: schema: type: array items: $ref: '#/components/schemas/AnnotationsByPath' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/AnnotationsByPath' required: true security: - cookieAuth: [] responses: '200': description: No response body /api/sample/{id}/set_predictions: post: operationId: api_sample_set_predictions_create description: Add the given list of PredictionField to the given entity. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this entity. required: true tags: - api requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/PredictionsByPath' application/x-www-form-urlencoded: schema: type: array items: $ref: '#/components/schemas/PredictionsByPath' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/PredictionsByPath' required: true security: - cookieAuth: [] responses: '200': description: No response body /api/sample/bulk_delete: post: operationId: api_sample_bulk_delete_create description: |- Bulk delete objects in the background. The background task is returned. tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/Delete' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Delete' multipart/form-data: schema: $ref: '#/components/schemas/Delete' required: true security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/BackgroundTask' description: '' /api/sample/duplicate: post: operationId: api_sample_duplicate_create description: |- Bulk duplicate objects in the background. The background task is returned. tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/Duplicate' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Duplicate' multipart/form-data: schema: $ref: '#/components/schemas/Duplicate' required: true security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/BackgroundTask' description: '' /api/sample/move_to_collection: post: operationId: api_sample_move_to_collection_create description: Move samples from source to destination collection. tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/MoveEntityToCollection' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/MoveEntityToCollection' multipart/form-data: schema: $ref: '#/components/schemas/MoveEntityToCollection' required: true security: - cookieAuth: [] responses: '200': description: No response body /api/sample/slug_exists: get: operationId: api_sample_slug_exists_retrieve description: |- Check if given url slug exists. Check if slug given in query parameter ``name`` exists. Return ``True`` if slug already exists and ``False`` otherwise. parameters: - in: query name: name schema: type: string minLength: 1 required: true tags: - api security: - cookieAuth: [] responses: '200': content: application/json: schema: type: boolean description: '' /api/sample/subscribe: post: operationId: api_sample_subscribe_create description: Register an Observer for a resource. tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/ObserverSubscribeRequest' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/ObserverSubscribeRequest' multipart/form-data: schema: $ref: '#/components/schemas/ObserverSubscribeRequest' required: true security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ObserverSubscription' description: '' /api/sample/unsubscribe: post: operationId: api_sample_unsubscribe_create description: Unregister a subscription. tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/ObserverSubscription' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/ObserverSubscription' multipart/form-data: schema: $ref: '#/components/schemas/ObserverSubscription' required: true security: - cookieAuth: [] responses: '200': description: No response body /api/search-table-file-columns: get: operationId: api_search_table_file_columns_list description: API view for :class:`SearchTableFileColumn` objects. parameters: - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer tags: - api security: - cookieAuth: [] - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedSearchTableFileColumnList' description: '' /api/storage/{id}: get: operationId: api_storage_retrieve description: API view for :class:`Storage` objects. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this storage. required: true tags: - api security: - cookieAuth: [] - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/Storage' description: '' /api/task: get: operationId: api_task_list description: |- 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. parameters: - in: query name: id schema: type: integer - in: query name: id__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: status schema: type: string enum: - ER - OK - PR - WT description: |- * `WT` - Waiting * `PR` - Processing * `OK` - Done * `ER` - Error - in: query name: status__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form tags: - api security: - cookieAuth: [] - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedBackgroundTaskList' description: '' /api/task/{id}: get: operationId: api_task_retrieve description: |- 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. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this background task. required: true tags: - api security: - cookieAuth: [] - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/BackgroundTask' description: '' /api/task/subscribe: post: operationId: api_task_subscribe_create description: Register an Observer for a resource. tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/ObserverSubscribeRequest' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/ObserverSubscribeRequest' multipart/form-data: schema: $ref: '#/components/schemas/ObserverSubscribeRequest' required: true security: - cookieAuth: [] - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/ObserverSubscription' description: '' /api/task/unsubscribe: post: operationId: api_task_unsubscribe_create description: Unregister a subscription. tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/ObserverSubscription' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/ObserverSubscription' multipart/form-data: schema: $ref: '#/components/schemas/ObserverSubscription' required: true security: - cookieAuth: [] - {} responses: '200': description: No response body /api/upload/config: get: operationId: api_upload_config_retrieve description: |- 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 support 'LOCAL', and 'S3' connector types. Upload through server is always supported. - credentials: the dictionary representing the set of credentials that are used to upload data. This dictionary is specific to connector type and may be empty. tags: - api security: - cookieAuth: [] - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/UploadConfig' description: '' /api/upload/credentials: get: operationId: api_upload_credentials_retrieve description: Return the upload credentials. tags: - api security: - cookieAuth: [] - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/UploadCredentials' description: '' /api/upload_config: get: operationId: api_upload_config_retrieve_2 description: |- 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 support 'LOCAL', and 'S3' connector types. Upload through server is always supported. - credentials: the dictionary representing the set of credentials that are used to upload data. This dictionary is specific to connector type and may be empty. tags: - api security: - cookieAuth: [] - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/UploadConfig' description: '' /api/user: get: operationId: api_user_list description: API view for :class:`User` objects. parameters: - in: query name: company schema: type: string - in: query name: department schema: type: string - in: query name: email schema: type: string - in: query name: email__contains schema: type: string - in: query name: email__icontains schema: type: string - in: query name: email__iexact schema: type: string - in: query name: email__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: email__isnull schema: type: boolean - in: query name: email__istartswith schema: type: string - in: query name: email__startswith schema: type: string - in: query name: first_name schema: type: string - in: query name: first_name__contains schema: type: string - in: query name: first_name__icontains schema: type: string - in: query name: first_name__iexact schema: type: string - in: query name: first_name__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: first_name__isnull schema: type: boolean - in: query name: first_name__istartswith schema: type: string - in: query name: first_name__startswith schema: type: string - in: query name: groups schema: type: integer - in: query name: id schema: type: integer - in: query name: id__gt schema: type: integer - in: query name: id__gte schema: type: integer - in: query name: id__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: id__isnull schema: type: boolean - in: query name: id__lt schema: type: integer - in: query name: id__lte schema: type: integer - in: query name: job_title schema: type: string - in: query name: lab schema: type: string - in: query name: last_name schema: type: string - in: query name: last_name__contains schema: type: string - in: query name: last_name__icontains schema: type: string - in: query name: last_name__iexact schema: type: string - in: query name: last_name__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: last_name__isnull schema: type: boolean - in: query name: last_name__istartswith schema: type: string - in: query name: last_name__startswith schema: type: string - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: location schema: type: string - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: username schema: type: string - in: query name: username__contains schema: type: string - in: query name: username__icontains schema: type: string - in: query name: username__iexact schema: type: string - in: query name: username__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: username__isnull schema: type: boolean - in: query name: username__istartswith schema: type: string - in: query name: username__startswith schema: type: string tags: - api security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedUserList' description: '' post: operationId: api_user_create description: API view for :class:`User` objects. tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/User' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/User' multipart/form-data: schema: $ref: '#/components/schemas/User' required: true security: - cookieAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/User' description: '' /api/user-settings/parameter-preset: get: operationId: api_user_settings_parameter_preset_list description: API view for :class:`ParameterPreset` objects. parameters: - in: query name: contributor schema: type: integer - in: query name: contributor__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: created schema: type: string format: date-time - in: query name: created__date schema: type: string format: date - in: query name: created__gt schema: type: string format: date-time - in: query name: created__gte schema: type: string format: date-time - in: query name: created__isnull schema: type: boolean - in: query name: created__lt schema: type: string format: date-time - in: query name: created__lte schema: type: string format: date-time - in: query name: created__time schema: type: string format: time - in: query name: id schema: type: integer - in: query name: id__gt schema: type: integer - in: query name: id__gte schema: type: integer - in: query name: id__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: id__isnull schema: type: boolean - in: query name: id__lt schema: type: integer - in: query name: id__lte schema: type: integer - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: modified schema: type: string format: date-time - in: query name: modified__date schema: type: string format: date - in: query name: modified__gt schema: type: string format: date-time - in: query name: modified__gte schema: type: string format: date-time - in: query name: modified__isnull schema: type: boolean - in: query name: modified__lt schema: type: string format: date-time - in: query name: modified__lte schema: type: string format: date-time - in: query name: modified__time schema: type: string format: time - in: query name: name schema: type: string - in: query name: name__contains schema: type: string - in: query name: name__icontains schema: type: string - in: query name: name__iexact schema: type: string - in: query name: name__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: name__isnull schema: type: boolean - in: query name: name__istartswith schema: type: string - in: query name: name__startswith schema: type: string - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: process schema: type: integer - in: query name: process__slug schema: type: string - in: query name: slug schema: type: string - in: query name: slug__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: version schema: type: string - in: query name: version__gt schema: type: string - in: query name: version__gte schema: type: string - in: query name: version__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: version__isnull schema: type: boolean - in: query name: version__lt schema: type: string - in: query name: version__lte schema: type: string tags: - api security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedParameterPresetList' description: '' post: operationId: api_user_settings_parameter_preset_create description: Create a resource. tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/ParameterPreset' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/ParameterPreset' multipart/form-data: schema: $ref: '#/components/schemas/ParameterPreset' required: true security: - cookieAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/ParameterPreset' description: '' /api/user-settings/parameter-preset/{id}: get: operationId: api_user_settings_parameter_preset_retrieve description: API view for :class:`ParameterPreset` objects. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this parameter preset. required: true tags: - api security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ParameterPreset' description: '' put: operationId: api_user_settings_parameter_preset_update description: API view for :class:`ParameterPreset` objects. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this parameter preset. required: true tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/ParameterPreset' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/ParameterPreset' multipart/form-data: schema: $ref: '#/components/schemas/ParameterPreset' required: true security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ParameterPreset' description: '' patch: operationId: api_user_settings_parameter_preset_partial_update description: API view for :class:`ParameterPreset` objects. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this parameter preset. required: true tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedParameterPreset' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedParameterPreset' multipart/form-data: schema: $ref: '#/components/schemas/PatchedParameterPreset' security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ParameterPreset' description: '' delete: operationId: api_user_settings_parameter_preset_destroy description: API view for :class:`ParameterPreset` objects. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this parameter preset. required: true tags: - api security: - cookieAuth: [] responses: '204': description: No response body /api/user/{id}: put: operationId: api_user_update description: API view for :class:`User` objects. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this user. required: true tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/User' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/User' multipart/form-data: schema: $ref: '#/components/schemas/User' required: true security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/User' description: '' patch: operationId: api_user_partial_update description: API view for :class:`User` objects. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this user. required: true tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedUser' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedUser' multipart/form-data: schema: $ref: '#/components/schemas/PatchedUser' security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/User' description: '' /api/usertag: get: operationId: api_usertag_list description: API view for :class:`UserTag` objects. parameters: - in: query name: contributor schema: type: string - in: query name: created schema: type: string format: date-time - in: query name: created__date schema: type: string format: date - in: query name: created__gt schema: type: string format: date-time - in: query name: created__gte schema: type: string format: date-time - in: query name: created__isnull schema: type: boolean - in: query name: created__lt schema: type: string format: date-time - in: query name: created__lte schema: type: string format: date-time - in: query name: created__time schema: type: string format: time - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: start schema: type: string format: date - in: query name: start__gt schema: type: string format: date - in: query name: start__gte schema: type: string format: date - in: query name: start__isnull schema: type: boolean - in: query name: start__lt schema: type: string format: date - in: query name: start__lte schema: type: string format: date - in: query name: tag_word schema: type: string - in: query name: user schema: type: string tags: - api security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedUserTagList' description: '' post: operationId: api_usertag_create description: Make currently logged in user the contributor. tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/UserTag' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/UserTag' multipart/form-data: schema: $ref: '#/components/schemas/UserTag' required: true security: - cookieAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/UserTag' description: '' /api/usertag/{id}: get: operationId: api_usertag_retrieve description: API view for :class:`UserTag` objects. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this user tag. required: true tags: - api security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/UserTag' description: '' put: operationId: api_usertag_update description: API view for :class:`UserTag` objects. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this user tag. required: true tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/UserTag' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/UserTag' multipart/form-data: schema: $ref: '#/components/schemas/UserTag' required: true security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/UserTag' description: '' patch: operationId: api_usertag_partial_update description: API view for :class:`UserTag` objects. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this user tag. required: true tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedUserTag' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedUserTag' multipart/form-data: schema: $ref: '#/components/schemas/PatchedUserTag' security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/UserTag' description: '' delete: operationId: api_usertag_destroy description: API view for :class:`UserTag` objects. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this user tag. required: true tags: - api security: - cookieAuth: [] responses: '204': description: No response body /api/variant: get: operationId: api_variant_list description: Variant endpoint. parameters: - in: query name: alternative schema: type: string - in: query name: alternative__contains schema: type: string - in: query name: alternative__icontains schema: type: string - in: query name: alternative__iexact schema: type: string - in: query name: alternative__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: alternative__isnull schema: type: boolean - in: query name: alternative__istartswith schema: type: string - in: query name: alternative__startswith schema: type: string - in: query name: annotation__clinical_diagnosis schema: type: string - in: query name: annotation__clinical_diagnosis__contains schema: type: string - in: query name: annotation__clinical_diagnosis__icontains schema: type: string - in: query name: annotation__clinical_diagnosis__iexact schema: type: string - in: query name: annotation__clinical_diagnosis__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: annotation__clinical_diagnosis__isnull schema: type: boolean - in: query name: annotation__clinical_diagnosis__istartswith schema: type: string - in: query name: annotation__clinical_diagnosis__startswith schema: type: string - in: query name: annotation__clinical_significance schema: type: string - in: query name: annotation__clinical_significance__contains schema: type: string - in: query name: annotation__clinical_significance__icontains schema: type: string - in: query name: annotation__clinical_significance__iexact schema: type: string - in: query name: annotation__clinical_significance__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: annotation__clinical_significance__isnull schema: type: boolean - in: query name: annotation__clinical_significance__istartswith schema: type: string - in: query name: annotation__clinical_significance__startswith schema: type: string - in: query name: annotation__clinvar_id schema: type: string - in: query name: annotation__clinvar_id__contains schema: type: string - in: query name: annotation__clinvar_id__icontains schema: type: string - in: query name: annotation__clinvar_id__iexact schema: type: string - in: query name: annotation__clinvar_id__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: annotation__clinvar_id__isnull schema: type: boolean - in: query name: annotation__clinvar_id__istartswith schema: type: string - in: query name: annotation__clinvar_id__startswith schema: type: string - in: query name: annotation__dbsnp_id schema: type: string - in: query name: annotation__dbsnp_id__contains schema: type: string - in: query name: annotation__dbsnp_id__icontains schema: type: string - in: query name: annotation__dbsnp_id__iexact schema: type: string - in: query name: annotation__dbsnp_id__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: annotation__dbsnp_id__isnull schema: type: boolean - in: query name: annotation__dbsnp_id__istartswith schema: type: string - in: query name: annotation__dbsnp_id__startswith schema: type: string - in: query name: annotation__transcripts schema: type: array items: type: integer explode: true style: form - in: query name: annotation__transcripts__annotation schema: type: string - in: query name: annotation__transcripts__annotation__contains schema: type: string - in: query name: annotation__transcripts__annotation__icontains schema: type: string - in: query name: annotation__transcripts__annotation__iexact schema: type: string - in: query name: annotation__transcripts__annotation__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: annotation__transcripts__annotation__isnull schema: type: boolean - in: query name: annotation__transcripts__annotation__istartswith schema: type: string - in: query name: annotation__transcripts__annotation__startswith schema: type: string - in: query name: annotation__transcripts__annotation_impact schema: type: string - in: query name: annotation__transcripts__annotation_impact__contains schema: type: string - in: query name: annotation__transcripts__annotation_impact__icontains schema: type: string - in: query name: annotation__transcripts__annotation_impact__iexact schema: type: string - in: query name: annotation__transcripts__annotation_impact__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: annotation__transcripts__annotation_impact__isnull schema: type: boolean - in: query name: annotation__transcripts__annotation_impact__istartswith schema: type: string - in: query name: annotation__transcripts__annotation_impact__startswith schema: type: string - in: query name: annotation__transcripts__canonical schema: type: boolean - in: query name: annotation__transcripts__gene schema: type: string - in: query name: annotation__transcripts__gene__contains schema: type: string - in: query name: annotation__transcripts__gene__icontains schema: type: string - in: query name: annotation__transcripts__gene__iexact schema: type: string - in: query name: annotation__transcripts__gene__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: annotation__transcripts__gene__isnull schema: type: boolean - in: query name: annotation__transcripts__gene__istartswith schema: type: string - in: query name: annotation__transcripts__gene__startswith schema: type: string - in: query name: annotation__transcripts__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: annotation__transcripts__isnull schema: type: boolean - in: query name: annotation__transcripts__protein_impact schema: type: string - in: query name: annotation__transcripts__protein_impact__contains schema: type: string - in: query name: annotation__transcripts__protein_impact__icontains schema: type: string - in: query name: annotation__transcripts__protein_impact__iexact schema: type: string - in: query name: annotation__transcripts__protein_impact__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: annotation__transcripts__protein_impact__isnull schema: type: boolean - in: query name: annotation__transcripts__protein_impact__istartswith schema: type: string - in: query name: annotation__transcripts__protein_impact__startswith schema: type: string - in: query name: annotation__type schema: type: string nullable: true enum: - INDEL - MIXED - MNP - SNP - SYMBOLIC description: |- * `SNP` - SNP * `INDEL` - INDEL * `MIXED` - MIXED * `MNP` - MNP * `SYMBOLIC` - SYMBOLIC - in: query name: annotation__type__contains schema: type: string - in: query name: annotation__type__icontains schema: type: string - in: query name: annotation__type__iexact schema: type: string - in: query name: annotation__type__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: annotation__type__isnull schema: type: boolean - in: query name: annotation__type__istartswith schema: type: string - in: query name: annotation__type__startswith schema: type: string - in: query name: chromosome schema: type: string - in: query name: chromosome__contains schema: type: string - in: query name: chromosome__icontains schema: type: string - in: query name: chromosome__iexact schema: type: string - in: query name: chromosome__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: chromosome__isnull schema: type: boolean - in: query name: chromosome__istartswith schema: type: string - in: query name: chromosome__startswith schema: type: string - in: query name: genome_assembly schema: type: string - in: query name: genome_assembly__contains schema: type: string - in: query name: genome_assembly__icontains schema: type: string - in: query name: genome_assembly__iexact schema: type: string - in: query name: genome_assembly__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: genome_assembly__isnull schema: type: boolean - in: query name: genome_assembly__istartswith schema: type: string - in: query name: genome_assembly__startswith schema: type: string - in: query name: id schema: type: integer - in: query name: id__gt schema: type: integer - in: query name: id__gte schema: type: integer - in: query name: id__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: id__isnull schema: type: boolean - in: query name: id__lt schema: type: integer - in: query name: id__lte schema: type: integer - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: position schema: type: integer - in: query name: position__gt schema: type: integer - in: query name: position__gte schema: type: integer - in: query name: position__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: position__isnull schema: type: boolean - in: query name: position__lt schema: type: integer - in: query name: position__lte schema: type: integer - in: query name: reference schema: type: string - in: query name: reference__contains schema: type: string - in: query name: reference__icontains schema: type: string - in: query name: reference__iexact schema: type: string - in: query name: reference__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: reference__isnull schema: type: boolean - in: query name: reference__istartswith schema: type: string - in: query name: reference__startswith schema: type: string - in: query name: species schema: type: string - in: query name: species__contains schema: type: string - in: query name: species__icontains schema: type: string - in: query name: species__iexact schema: type: string - in: query name: species__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: species__isnull schema: type: boolean - in: query name: species__istartswith schema: type: string - in: query name: species__startswith schema: type: string - in: query name: variant_calls schema: type: integer - in: query name: variant_calls__alternative_allele_depth schema: type: integer - in: query name: variant_calls__alternative_allele_depth__gt schema: type: integer - in: query name: variant_calls__alternative_allele_depth__gte schema: type: integer - in: query name: variant_calls__alternative_allele_depth__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: variant_calls__alternative_allele_depth__isnull schema: type: boolean - in: query name: variant_calls__alternative_allele_depth__lt schema: type: integer - in: query name: variant_calls__alternative_allele_depth__lte schema: type: integer - in: query name: variant_calls__data schema: type: integer - in: query name: variant_calls__data__build schema: type: string - in: query name: variant_calls__data__collection schema: type: integer - in: query name: variant_calls__data__collection__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: variant_calls__data__collection__isnull schema: type: boolean - in: query name: variant_calls__data__collection__name schema: type: string - in: query name: variant_calls__data__collection__name__contains schema: type: string - in: query name: variant_calls__data__collection__name__icontains schema: type: string - in: query name: variant_calls__data__collection__name__iexact schema: type: string - in: query name: variant_calls__data__collection__name__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: variant_calls__data__collection__name__isnull schema: type: boolean - in: query name: variant_calls__data__collection__name__istartswith schema: type: string - in: query name: variant_calls__data__collection__name__startswith schema: type: string - in: query name: variant_calls__data__collection__slug schema: type: string - in: query name: variant_calls__data__collection__slug__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: variant_calls__data__contributor schema: type: integer - in: query name: variant_calls__data__contributor__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: variant_calls__data__contributor_name schema: type: string - in: query name: variant_calls__data__created schema: type: string format: date-time - in: query name: variant_calls__data__created__date schema: type: string format: date - in: query name: variant_calls__data__created__gt schema: type: string format: date-time - in: query name: variant_calls__data__created__gte schema: type: string format: date-time - in: query name: variant_calls__data__created__isnull schema: type: boolean - in: query name: variant_calls__data__created__lt schema: type: string format: date-time - in: query name: variant_calls__data__created__lte schema: type: string format: date-time - in: query name: variant_calls__data__created__time schema: type: string format: time - in: query name: variant_calls__data__entity schema: type: integer - in: query name: variant_calls__data__entity__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: variant_calls__data__entity__isnull schema: type: boolean - in: query name: variant_calls__data__entity__name schema: type: string - in: query name: variant_calls__data__entity__name__contains schema: type: string - in: query name: variant_calls__data__entity__name__icontains schema: type: string - in: query name: variant_calls__data__entity__name__iexact schema: type: string - in: query name: variant_calls__data__entity__name__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: variant_calls__data__entity__name__isnull schema: type: boolean - in: query name: variant_calls__data__entity__name__istartswith schema: type: string - in: query name: variant_calls__data__entity__name__startswith schema: type: string - in: query name: variant_calls__data__entity__slug schema: type: string - in: query name: variant_calls__data__entity__slug__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: variant_calls__data__feature_type schema: type: string - in: query name: variant_calls__data__finished schema: type: string format: date-time - in: query name: variant_calls__data__finished__date schema: type: string format: date - in: query name: variant_calls__data__finished__gt schema: type: string format: date-time - in: query name: variant_calls__data__finished__gte schema: type: string format: date-time - in: query name: variant_calls__data__finished__isnull schema: type: boolean - in: query name: variant_calls__data__finished__lt schema: type: string format: date-time - in: query name: variant_calls__data__finished__lte schema: type: string format: date-time - in: query name: variant_calls__data__finished__time schema: type: string format: time - in: query name: variant_calls__data__group schema: type: string - in: query name: variant_calls__data__gt schema: type: integer - in: query name: variant_calls__data__gte schema: type: integer - in: query name: variant_calls__data__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: variant_calls__data__isnull schema: type: boolean - in: query name: variant_calls__data__lt schema: type: integer - in: query name: variant_calls__data__lte schema: type: integer - in: query name: variant_calls__data__modified schema: type: string format: date-time - in: query name: variant_calls__data__modified__date schema: type: string format: date - in: query name: variant_calls__data__modified__gt schema: type: string format: date-time - in: query name: variant_calls__data__modified__gte schema: type: string format: date-time - in: query name: variant_calls__data__modified__isnull schema: type: boolean - in: query name: variant_calls__data__modified__lt schema: type: string format: date-time - in: query name: variant_calls__data__modified__lte schema: type: string format: date-time - in: query name: variant_calls__data__modified__time schema: type: string format: time - in: query name: variant_calls__data__name schema: type: string - in: query name: variant_calls__data__name__contains schema: type: string - in: query name: variant_calls__data__name__icontains schema: type: string - in: query name: variant_calls__data__name__iexact schema: type: string - in: query name: variant_calls__data__name__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: variant_calls__data__name__isnull schema: type: boolean - in: query name: variant_calls__data__name__istartswith schema: type: string - in: query name: variant_calls__data__name__startswith schema: type: string - in: query name: variant_calls__data__owners schema: type: integer - in: query name: variant_calls__data__owners_name schema: type: string - in: query name: variant_calls__data__permission schema: type: string - in: query name: variant_calls__data__process schema: type: integer - in: query name: variant_calls__data__process__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: variant_calls__data__process__isnull schema: type: boolean - in: query name: variant_calls__data__process__name schema: type: string - in: query name: variant_calls__data__process__name__contains schema: type: string - in: query name: variant_calls__data__process__name__icontains schema: type: string - in: query name: variant_calls__data__process__name__iexact schema: type: string - in: query name: variant_calls__data__process__name__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: variant_calls__data__process__name__isnull schema: type: boolean - in: query name: variant_calls__data__process__name__istartswith schema: type: string - in: query name: variant_calls__data__process__name__startswith schema: type: string - in: query name: variant_calls__data__process__slug schema: type: string - in: query name: variant_calls__data__process__slug__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: variant_calls__data__relation_id schema: type: number - in: query name: variant_calls__data__shared_with_me schema: type: boolean - in: query name: variant_calls__data__slug schema: type: string - in: query name: variant_calls__data__slug__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: variant_calls__data__source schema: type: string - in: query name: variant_calls__data__species schema: type: string - in: query name: variant_calls__data__started schema: type: string format: date-time - in: query name: variant_calls__data__started__date schema: type: string format: date - in: query name: variant_calls__data__started__gt schema: type: string format: date-time - in: query name: variant_calls__data__started__gte schema: type: string format: date-time - in: query name: variant_calls__data__started__isnull schema: type: boolean - in: query name: variant_calls__data__started__lt schema: type: string format: date-time - in: query name: variant_calls__data__started__lte schema: type: string format: date-time - in: query name: variant_calls__data__started__time schema: type: string format: time - in: query name: variant_calls__data__status schema: type: string enum: - DR - ER - OK - PP - PR - RE - UP - WT description: |- * `UP` - Uploading * `RE` - Resolving * `WT` - Waiting * `PP` - Preparing * `PR` - Processing * `OK` - Done * `ER` - Error * `DR` - Dirty - in: query name: variant_calls__data__status__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: variant_calls__data__tags schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: variant_calls__data__type schema: type: string - in: query name: variant_calls__data__type__exact schema: type: string - in: query name: variant_calls__data__version schema: type: string - in: query name: variant_calls__data__version__gt schema: type: string - in: query name: variant_calls__data__version__gte schema: type: string - in: query name: variant_calls__data__version__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: variant_calls__data__version__isnull schema: type: boolean - in: query name: variant_calls__data__version__lt schema: type: string - in: query name: variant_calls__data__version__lte schema: type: string - in: query name: variant_calls__depth schema: type: integer - in: query name: variant_calls__depth__gt schema: type: integer - in: query name: variant_calls__depth__gte schema: type: integer - in: query name: variant_calls__depth__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: variant_calls__depth__isnull schema: type: boolean - in: query name: variant_calls__depth__lt schema: type: integer - in: query name: variant_calls__depth__lte schema: type: integer - in: query name: variant_calls__depth_norm_quality schema: type: number format: float - in: query name: variant_calls__depth_norm_quality__gt schema: type: number format: float - in: query name: variant_calls__depth_norm_quality__gte schema: type: number format: float - in: query name: variant_calls__depth_norm_quality__in schema: type: array items: type: number format: float description: Multiple values may be separated by commas. explode: false style: form - in: query name: variant_calls__depth_norm_quality__isnull schema: type: boolean - in: query name: variant_calls__depth_norm_quality__lt schema: type: number format: float - in: query name: variant_calls__depth_norm_quality__lte schema: type: number format: float - in: query name: variant_calls__experiment schema: type: integer - in: query name: variant_calls__experiment__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: variant_calls__experiment__isnull schema: type: boolean - in: query name: variant_calls__filter schema: type: string - in: query name: variant_calls__filter__contains schema: type: string - in: query name: variant_calls__filter__icontains schema: type: string - in: query name: variant_calls__filter__iexact schema: type: string - in: query name: variant_calls__filter__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: variant_calls__filter__isnull schema: type: boolean - in: query name: variant_calls__filter__istartswith schema: type: string - in: query name: variant_calls__filter__startswith schema: type: string - in: query name: variant_calls__genotype schema: type: string - in: query name: variant_calls__genotype__contains schema: type: string - in: query name: variant_calls__genotype__icontains schema: type: string - in: query name: variant_calls__genotype__iexact schema: type: string - in: query name: variant_calls__genotype__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: variant_calls__genotype__isnull schema: type: boolean - in: query name: variant_calls__genotype__istartswith schema: type: string - in: query name: variant_calls__genotype__startswith schema: type: string - in: query name: variant_calls__genotype_quality schema: type: integer - in: query name: variant_calls__genotype_quality__gt schema: type: integer - in: query name: variant_calls__genotype_quality__gte schema: type: integer - in: query name: variant_calls__genotype_quality__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: variant_calls__genotype_quality__isnull schema: type: boolean - in: query name: variant_calls__genotype_quality__lt schema: type: integer - in: query name: variant_calls__genotype_quality__lte schema: type: integer - in: query name: variant_calls__gt schema: type: integer - in: query name: variant_calls__gte schema: type: integer - in: query name: variant_calls__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: variant_calls__isnull schema: type: boolean - in: query name: variant_calls__lt schema: type: integer - in: query name: variant_calls__lte schema: type: integer - in: query name: variant_calls__quality schema: type: number format: float - in: query name: variant_calls__quality__gt schema: type: number format: float - in: query name: variant_calls__quality__gte schema: type: number format: float - in: query name: variant_calls__quality__in schema: type: array items: type: number format: float description: Multiple values may be separated by commas. explode: false style: form - in: query name: variant_calls__quality__isnull schema: type: boolean - in: query name: variant_calls__quality__lt schema: type: number format: float - in: query name: variant_calls__quality__lte schema: type: number format: float - in: query name: variant_calls__sample schema: type: integer - in: query name: variant_calls__sample__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: variant_calls__sample__isnull schema: type: boolean - in: query name: variant_calls__sample__slug schema: type: string - in: query name: variant_calls__sample__slug__contains schema: type: string - in: query name: variant_calls__sample__slug__icontains schema: type: string - in: query name: variant_calls__sample__slug__iexact schema: type: string - in: query name: variant_calls__sample__slug__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: variant_calls__sample__slug__isnull schema: type: boolean - in: query name: variant_calls__sample__slug__istartswith schema: type: string - in: query name: variant_calls__sample__slug__startswith schema: type: string - in: query name: variant_calls__variant schema: type: integer - in: query name: variant_calls__variant__alternative schema: type: string - in: query name: variant_calls__variant__alternative__contains schema: type: string - in: query name: variant_calls__variant__alternative__icontains schema: type: string - in: query name: variant_calls__variant__alternative__iexact schema: type: string - in: query name: variant_calls__variant__alternative__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: variant_calls__variant__alternative__isnull schema: type: boolean - in: query name: variant_calls__variant__alternative__istartswith schema: type: string - in: query name: variant_calls__variant__alternative__startswith schema: type: string - in: query name: variant_calls__variant__chromosome schema: type: string - in: query name: variant_calls__variant__chromosome__contains schema: type: string - in: query name: variant_calls__variant__chromosome__icontains schema: type: string - in: query name: variant_calls__variant__chromosome__iexact schema: type: string - in: query name: variant_calls__variant__chromosome__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: variant_calls__variant__chromosome__isnull schema: type: boolean - in: query name: variant_calls__variant__chromosome__istartswith schema: type: string - in: query name: variant_calls__variant__chromosome__startswith schema: type: string - in: query name: variant_calls__variant__genome_assembly schema: type: string - in: query name: variant_calls__variant__genome_assembly__contains schema: type: string - in: query name: variant_calls__variant__genome_assembly__icontains schema: type: string - in: query name: variant_calls__variant__genome_assembly__iexact schema: type: string - in: query name: variant_calls__variant__genome_assembly__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: variant_calls__variant__genome_assembly__isnull schema: type: boolean - in: query name: variant_calls__variant__genome_assembly__istartswith schema: type: string - in: query name: variant_calls__variant__genome_assembly__startswith schema: type: string - in: query name: variant_calls__variant__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: variant_calls__variant__isnull schema: type: boolean - in: query name: variant_calls__variant__position schema: type: integer - in: query name: variant_calls__variant__position__gt schema: type: integer - in: query name: variant_calls__variant__position__gte schema: type: integer - in: query name: variant_calls__variant__position__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: variant_calls__variant__position__isnull schema: type: boolean - in: query name: variant_calls__variant__position__lt schema: type: integer - in: query name: variant_calls__variant__position__lte schema: type: integer - in: query name: variant_calls__variant__reference schema: type: string - in: query name: variant_calls__variant__reference__contains schema: type: string - in: query name: variant_calls__variant__reference__icontains schema: type: string - in: query name: variant_calls__variant__reference__iexact schema: type: string - in: query name: variant_calls__variant__reference__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: variant_calls__variant__reference__isnull schema: type: boolean - in: query name: variant_calls__variant__reference__istartswith schema: type: string - in: query name: variant_calls__variant__reference__startswith schema: type: string - in: query name: variant_calls__variant__species schema: type: string - in: query name: variant_calls__variant__species__contains schema: type: string - in: query name: variant_calls__variant__species__icontains schema: type: string - in: query name: variant_calls__variant__species__iexact schema: type: string - in: query name: variant_calls__variant__species__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: variant_calls__variant__species__isnull schema: type: boolean - in: query name: variant_calls__variant__species__istartswith schema: type: string - in: query name: variant_calls__variant__species__startswith schema: type: string tags: - api security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedVariantList' description: '' post: operationId: api_variant_create description: Create a resource. tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/Variant' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Variant' multipart/form-data: schema: $ref: '#/components/schemas/Variant' required: true security: - cookieAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/Variant' description: '' /api/variant/{id}: put: operationId: api_variant_update description: Variant endpoint. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this variant. required: true tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/Variant' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Variant' multipart/form-data: schema: $ref: '#/components/schemas/Variant' required: true security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Variant' description: '' patch: operationId: api_variant_partial_update description: Variant endpoint. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this variant. required: true tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedVariant' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedVariant' multipart/form-data: schema: $ref: '#/components/schemas/PatchedVariant' security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Variant' description: '' delete: operationId: api_variant_destroy description: Variant endpoint. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this variant. required: true tags: - api security: - cookieAuth: [] responses: '204': description: No response body /api/variant_annotations: get: operationId: api_variant_annotations_list description: VariantAnnotation endpoint. parameters: - in: query name: clinical_diagnosis schema: type: string - in: query name: clinical_diagnosis__contains schema: type: string - in: query name: clinical_diagnosis__icontains schema: type: string - in: query name: clinical_diagnosis__iexact schema: type: string - in: query name: clinical_diagnosis__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: clinical_diagnosis__isnull schema: type: boolean - in: query name: clinical_diagnosis__istartswith schema: type: string - in: query name: clinical_diagnosis__startswith schema: type: string - in: query name: clinical_significance schema: type: string - in: query name: clinical_significance__contains schema: type: string - in: query name: clinical_significance__icontains schema: type: string - in: query name: clinical_significance__iexact schema: type: string - in: query name: clinical_significance__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: clinical_significance__isnull schema: type: boolean - in: query name: clinical_significance__istartswith schema: type: string - in: query name: clinical_significance__startswith schema: type: string - in: query name: clinvar_id schema: type: string - in: query name: clinvar_id__contains schema: type: string - in: query name: clinvar_id__icontains schema: type: string - in: query name: clinvar_id__iexact schema: type: string - in: query name: clinvar_id__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: clinvar_id__isnull schema: type: boolean - in: query name: clinvar_id__istartswith schema: type: string - in: query name: clinvar_id__startswith schema: type: string - in: query name: dbsnp_id schema: type: string - in: query name: dbsnp_id__contains schema: type: string - in: query name: dbsnp_id__icontains schema: type: string - in: query name: dbsnp_id__iexact schema: type: string - in: query name: dbsnp_id__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: dbsnp_id__isnull schema: type: boolean - in: query name: dbsnp_id__istartswith schema: type: string - in: query name: dbsnp_id__startswith schema: type: string - in: query name: id schema: type: integer - in: query name: id__gt schema: type: integer - in: query name: id__gte schema: type: integer - in: query name: id__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: id__isnull schema: type: boolean - in: query name: id__lt schema: type: integer - in: query name: id__lte schema: type: integer - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: transcripts__annotation schema: type: string - in: query name: transcripts__annotation__contains schema: type: string - in: query name: transcripts__annotation__icontains schema: type: string - in: query name: transcripts__annotation__iexact schema: type: string - in: query name: transcripts__annotation__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: transcripts__annotation__isnull schema: type: boolean - in: query name: transcripts__annotation__istartswith schema: type: string - in: query name: transcripts__annotation__startswith schema: type: string - in: query name: transcripts__annotation_impact schema: type: string - in: query name: transcripts__annotation_impact__contains schema: type: string - in: query name: transcripts__annotation_impact__icontains schema: type: string - in: query name: transcripts__annotation_impact__iexact schema: type: string - in: query name: transcripts__annotation_impact__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: transcripts__annotation_impact__isnull schema: type: boolean - in: query name: transcripts__annotation_impact__istartswith schema: type: string - in: query name: transcripts__annotation_impact__startswith schema: type: string - in: query name: transcripts__gene schema: type: string - in: query name: transcripts__gene__contains schema: type: string - in: query name: transcripts__gene__icontains schema: type: string - in: query name: transcripts__gene__iexact schema: type: string - in: query name: transcripts__gene__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: transcripts__gene__isnull schema: type: boolean - in: query name: transcripts__gene__istartswith schema: type: string - in: query name: transcripts__gene__startswith schema: type: string - in: query name: transcripts__protein_impact schema: type: string - in: query name: transcripts__protein_impact__contains schema: type: string - in: query name: transcripts__protein_impact__icontains schema: type: string - in: query name: transcripts__protein_impact__iexact schema: type: string - in: query name: transcripts__protein_impact__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: transcripts__protein_impact__isnull schema: type: boolean - in: query name: transcripts__protein_impact__istartswith schema: type: string - in: query name: transcripts__protein_impact__startswith schema: type: string - in: query name: type schema: type: string nullable: true enum: - INDEL - MIXED - MNP - SNP - SYMBOLIC description: |- * `SNP` - SNP * `INDEL` - INDEL * `MIXED` - MIXED * `MNP` - MNP * `SYMBOLIC` - SYMBOLIC - in: query name: type__contains schema: type: string - in: query name: type__icontains schema: type: string - in: query name: type__iexact schema: type: string - in: query name: type__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: type__isnull schema: type: boolean - in: query name: type__istartswith schema: type: string - in: query name: type__startswith schema: type: string - in: query name: variant schema: type: integer - in: query name: variant__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: variant__isnull schema: type: boolean tags: - api security: - cookieAuth: [] - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedVariantAnnotationList' description: '' /api/variant_calls: get: operationId: api_variant_calls_list description: |- VariantCall endpoint. The default filter backends are used so permissions are respected. parameters: - in: query name: alternative_allele_depth schema: type: integer - in: query name: alternative_allele_depth__gt schema: type: integer - in: query name: alternative_allele_depth__gte schema: type: integer - in: query name: alternative_allele_depth__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: alternative_allele_depth__isnull schema: type: boolean - in: query name: alternative_allele_depth__lt schema: type: integer - in: query name: alternative_allele_depth__lte schema: type: integer - in: query name: data schema: type: integer - in: query name: data__build schema: type: string - in: query name: data__collection schema: type: integer - in: query name: data__collection__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: data__collection__isnull schema: type: boolean - in: query name: data__collection__name schema: type: string - in: query name: data__collection__name__contains schema: type: string - in: query name: data__collection__name__icontains schema: type: string - in: query name: data__collection__name__iexact schema: type: string - in: query name: data__collection__name__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: data__collection__name__isnull schema: type: boolean - in: query name: data__collection__name__istartswith schema: type: string - in: query name: data__collection__name__startswith schema: type: string - in: query name: data__collection__slug schema: type: string - in: query name: data__collection__slug__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: data__contributor schema: type: integer - in: query name: data__contributor__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: data__contributor_name schema: type: string - in: query name: data__created schema: type: string format: date-time - in: query name: data__created__date schema: type: string format: date - in: query name: data__created__gt schema: type: string format: date-time - in: query name: data__created__gte schema: type: string format: date-time - in: query name: data__created__isnull schema: type: boolean - in: query name: data__created__lt schema: type: string format: date-time - in: query name: data__created__lte schema: type: string format: date-time - in: query name: data__created__time schema: type: string format: time - in: query name: data__entity schema: type: integer - in: query name: data__entity__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: data__entity__isnull schema: type: boolean - in: query name: data__entity__name schema: type: string - in: query name: data__entity__name__contains schema: type: string - in: query name: data__entity__name__icontains schema: type: string - in: query name: data__entity__name__iexact schema: type: string - in: query name: data__entity__name__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: data__entity__name__isnull schema: type: boolean - in: query name: data__entity__name__istartswith schema: type: string - in: query name: data__entity__name__startswith schema: type: string - in: query name: data__entity__slug schema: type: string - in: query name: data__entity__slug__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: data__feature_type schema: type: string - in: query name: data__finished schema: type: string format: date-time - in: query name: data__finished__date schema: type: string format: date - in: query name: data__finished__gt schema: type: string format: date-time - in: query name: data__finished__gte schema: type: string format: date-time - in: query name: data__finished__isnull schema: type: boolean - in: query name: data__finished__lt schema: type: string format: date-time - in: query name: data__finished__lte schema: type: string format: date-time - in: query name: data__finished__time schema: type: string format: time - in: query name: data__group schema: type: string - in: query name: data__gt schema: type: integer - in: query name: data__gte schema: type: integer - in: query name: data__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: data__isnull schema: type: boolean - in: query name: data__lt schema: type: integer - in: query name: data__lte schema: type: integer - in: query name: data__modified schema: type: string format: date-time - in: query name: data__modified__date schema: type: string format: date - in: query name: data__modified__gt schema: type: string format: date-time - in: query name: data__modified__gte schema: type: string format: date-time - in: query name: data__modified__isnull schema: type: boolean - in: query name: data__modified__lt schema: type: string format: date-time - in: query name: data__modified__lte schema: type: string format: date-time - in: query name: data__modified__time schema: type: string format: time - in: query name: data__name schema: type: string - in: query name: data__name__contains schema: type: string - in: query name: data__name__icontains schema: type: string - in: query name: data__name__iexact schema: type: string - in: query name: data__name__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: data__name__isnull schema: type: boolean - in: query name: data__name__istartswith schema: type: string - in: query name: data__name__startswith schema: type: string - in: query name: data__owners schema: type: integer - in: query name: data__owners_name schema: type: string - in: query name: data__permission schema: type: string - in: query name: data__process schema: type: integer - in: query name: data__process__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: data__process__isnull schema: type: boolean - in: query name: data__process__name schema: type: string - in: query name: data__process__name__contains schema: type: string - in: query name: data__process__name__icontains schema: type: string - in: query name: data__process__name__iexact schema: type: string - in: query name: data__process__name__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: data__process__name__isnull schema: type: boolean - in: query name: data__process__name__istartswith schema: type: string - in: query name: data__process__name__startswith schema: type: string - in: query name: data__process__slug schema: type: string - in: query name: data__process__slug__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: data__relation_id schema: type: number - in: query name: data__shared_with_me schema: type: boolean - in: query name: data__slug schema: type: string - in: query name: data__slug__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: data__source schema: type: string - in: query name: data__species schema: type: string - in: query name: data__started schema: type: string format: date-time - in: query name: data__started__date schema: type: string format: date - in: query name: data__started__gt schema: type: string format: date-time - in: query name: data__started__gte schema: type: string format: date-time - in: query name: data__started__isnull schema: type: boolean - in: query name: data__started__lt schema: type: string format: date-time - in: query name: data__started__lte schema: type: string format: date-time - in: query name: data__started__time schema: type: string format: time - in: query name: data__status schema: type: string enum: - DR - ER - OK - PP - PR - RE - UP - WT description: |- * `UP` - Uploading * `RE` - Resolving * `WT` - Waiting * `PP` - Preparing * `PR` - Processing * `OK` - Done * `ER` - Error * `DR` - Dirty - in: query name: data__status__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: data__tags schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: data__type schema: type: string - in: query name: data__type__exact schema: type: string - in: query name: data__version schema: type: string - in: query name: data__version__gt schema: type: string - in: query name: data__version__gte schema: type: string - in: query name: data__version__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: data__version__isnull schema: type: boolean - in: query name: data__version__lt schema: type: string - in: query name: data__version__lte schema: type: string - in: query name: depth schema: type: integer - in: query name: depth__gt schema: type: integer - in: query name: depth__gte schema: type: integer - in: query name: depth__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: depth__isnull schema: type: boolean - in: query name: depth__lt schema: type: integer - in: query name: depth__lte schema: type: integer - in: query name: depth_norm_quality schema: type: number format: float - in: query name: depth_norm_quality__gt schema: type: number format: float - in: query name: depth_norm_quality__gte schema: type: number format: float - in: query name: depth_norm_quality__in schema: type: array items: type: number format: float description: Multiple values may be separated by commas. explode: false style: form - in: query name: depth_norm_quality__isnull schema: type: boolean - in: query name: depth_norm_quality__lt schema: type: number format: float - in: query name: depth_norm_quality__lte schema: type: number format: float - in: query name: experiment schema: type: integer - in: query name: experiment__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: experiment__isnull schema: type: boolean - in: query name: filter schema: type: string - in: query name: filter__contains schema: type: string - in: query name: filter__icontains schema: type: string - in: query name: filter__iexact schema: type: string - in: query name: filter__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: filter__isnull schema: type: boolean - in: query name: filter__istartswith schema: type: string - in: query name: filter__startswith schema: type: string - in: query name: genotype schema: type: string - in: query name: genotype__contains schema: type: string - in: query name: genotype__icontains schema: type: string - in: query name: genotype__iexact schema: type: string - in: query name: genotype__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: genotype__isnull schema: type: boolean - in: query name: genotype__istartswith schema: type: string - in: query name: genotype__startswith schema: type: string - in: query name: genotype_quality schema: type: integer - in: query name: genotype_quality__gt schema: type: integer - in: query name: genotype_quality__gte schema: type: integer - in: query name: genotype_quality__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: genotype_quality__isnull schema: type: boolean - in: query name: genotype_quality__lt schema: type: integer - in: query name: genotype_quality__lte schema: type: integer - in: query name: id schema: type: integer - in: query name: id__gt schema: type: integer - in: query name: id__gte schema: type: integer - in: query name: id__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: id__isnull schema: type: boolean - in: query name: id__lt schema: type: integer - in: query name: id__lte schema: type: integer - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: quality schema: type: number format: float - in: query name: quality__gt schema: type: number format: float - in: query name: quality__gte schema: type: number format: float - in: query name: quality__in schema: type: array items: type: number format: float description: Multiple values may be separated by commas. explode: false style: form - in: query name: quality__isnull schema: type: boolean - in: query name: quality__lt schema: type: number format: float - in: query name: quality__lte schema: type: number format: float - in: query name: sample schema: type: integer - in: query name: sample__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: sample__isnull schema: type: boolean - in: query name: sample__slug schema: type: string - in: query name: sample__slug__contains schema: type: string - in: query name: sample__slug__icontains schema: type: string - in: query name: sample__slug__iexact schema: type: string - in: query name: sample__slug__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: sample__slug__isnull schema: type: boolean - in: query name: sample__slug__istartswith schema: type: string - in: query name: sample__slug__startswith schema: type: string - in: query name: variant schema: type: integer - in: query name: variant__alternative schema: type: string - in: query name: variant__alternative__contains schema: type: string - in: query name: variant__alternative__icontains schema: type: string - in: query name: variant__alternative__iexact schema: type: string - in: query name: variant__alternative__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: variant__alternative__isnull schema: type: boolean - in: query name: variant__alternative__istartswith schema: type: string - in: query name: variant__alternative__startswith schema: type: string - in: query name: variant__chromosome schema: type: string - in: query name: variant__chromosome__contains schema: type: string - in: query name: variant__chromosome__icontains schema: type: string - in: query name: variant__chromosome__iexact schema: type: string - in: query name: variant__chromosome__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: variant__chromosome__isnull schema: type: boolean - in: query name: variant__chromosome__istartswith schema: type: string - in: query name: variant__chromosome__startswith schema: type: string - in: query name: variant__genome_assembly schema: type: string - in: query name: variant__genome_assembly__contains schema: type: string - in: query name: variant__genome_assembly__icontains schema: type: string - in: query name: variant__genome_assembly__iexact schema: type: string - in: query name: variant__genome_assembly__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: variant__genome_assembly__isnull schema: type: boolean - in: query name: variant__genome_assembly__istartswith schema: type: string - in: query name: variant__genome_assembly__startswith schema: type: string - in: query name: variant__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: variant__isnull schema: type: boolean - in: query name: variant__position schema: type: integer - in: query name: variant__position__gt schema: type: integer - in: query name: variant__position__gte schema: type: integer - in: query name: variant__position__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: variant__position__isnull schema: type: boolean - in: query name: variant__position__lt schema: type: integer - in: query name: variant__position__lte schema: type: integer - in: query name: variant__reference schema: type: string - in: query name: variant__reference__contains schema: type: string - in: query name: variant__reference__icontains schema: type: string - in: query name: variant__reference__iexact schema: type: string - in: query name: variant__reference__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: variant__reference__isnull schema: type: boolean - in: query name: variant__reference__istartswith schema: type: string - in: query name: variant__reference__startswith schema: type: string - in: query name: variant__species schema: type: string - in: query name: variant__species__contains schema: type: string - in: query name: variant__species__icontains schema: type: string - in: query name: variant__species__iexact schema: type: string - in: query name: variant__species__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: variant__species__isnull schema: type: boolean - in: query name: variant__species__istartswith schema: type: string - in: query name: variant__species__startswith schema: type: string tags: - api security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedVariantCallList' description: '' post: operationId: api_variant_calls_create description: Create a resource. tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/VariantCall' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/VariantCall' multipart/form-data: schema: $ref: '#/components/schemas/VariantCall' required: true security: - cookieAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/VariantCall' description: '' /api/variant_calls/{id}: put: operationId: api_variant_calls_update description: |- VariantCall endpoint. The default filter backends are used so permissions are respected. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this variant call. required: true tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/VariantCall' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/VariantCall' multipart/form-data: schema: $ref: '#/components/schemas/VariantCall' required: true security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VariantCall' description: '' patch: operationId: api_variant_calls_partial_update description: |- VariantCall endpoint. The default filter backends are used so permissions are respected. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this variant call. required: true tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedVariantCall' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedVariantCall' multipart/form-data: schema: $ref: '#/components/schemas/PatchedVariantCall' security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VariantCall' description: '' delete: operationId: api_variant_calls_destroy description: |- VariantCall endpoint. The default filter backends are used so permissions are respected. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this variant call. required: true tags: - api security: - cookieAuth: [] responses: '204': description: No response body /api/variant_experiment: get: operationId: api_variant_experiment_list description: VariantExperiment endpoint. parameters: - in: query name: contributor__email schema: type: string - in: query name: contributor__email__contains schema: type: string - in: query name: contributor__email__icontains schema: type: string - in: query name: contributor__email__iexact schema: type: string - in: query name: contributor__email__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: contributor__email__isnull schema: type: boolean - in: query name: contributor__email__istartswith schema: type: string - in: query name: contributor__email__startswith schema: type: string - in: query name: contributor__id schema: type: integer - in: query name: contributor__id__gt schema: type: integer - in: query name: contributor__id__gte schema: type: integer - in: query name: contributor__id__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: contributor__id__isnull schema: type: boolean - in: query name: contributor__id__lt schema: type: integer - in: query name: contributor__id__lte schema: type: integer - in: query name: contributor__username schema: type: string - in: query name: contributor__username__contains schema: type: string - in: query name: contributor__username__icontains schema: type: string - in: query name: contributor__username__iexact schema: type: string - in: query name: contributor__username__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: contributor__username__isnull schema: type: boolean - in: query name: contributor__username__istartswith schema: type: string - in: query name: contributor__username__startswith schema: type: string - in: query name: id schema: type: integer - in: query name: id__gt schema: type: integer - in: query name: id__gte schema: type: integer - in: query name: id__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: id__isnull schema: type: boolean - in: query name: id__lt schema: type: integer - in: query name: id__lte schema: type: integer - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: timestamp schema: type: string format: date-time - in: query name: timestamp__date schema: type: string format: date - in: query name: timestamp__gt schema: type: string format: date-time - in: query name: timestamp__gte schema: type: string format: date-time - in: query name: timestamp__isnull schema: type: boolean - in: query name: timestamp__lt schema: type: string format: date-time - in: query name: timestamp__lte schema: type: string format: date-time - in: query name: timestamp__time schema: type: string format: time - in: query name: variant_calls schema: type: integer - in: query name: variant_calls__alternative_allele_depth schema: type: integer - in: query name: variant_calls__alternative_allele_depth__gt schema: type: integer - in: query name: variant_calls__alternative_allele_depth__gte schema: type: integer - in: query name: variant_calls__alternative_allele_depth__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: variant_calls__alternative_allele_depth__isnull schema: type: boolean - in: query name: variant_calls__alternative_allele_depth__lt schema: type: integer - in: query name: variant_calls__alternative_allele_depth__lte schema: type: integer - in: query name: variant_calls__data schema: type: integer - in: query name: variant_calls__data__build schema: type: string - in: query name: variant_calls__data__collection schema: type: integer - in: query name: variant_calls__data__collection__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: variant_calls__data__collection__isnull schema: type: boolean - in: query name: variant_calls__data__collection__name schema: type: string - in: query name: variant_calls__data__collection__name__contains schema: type: string - in: query name: variant_calls__data__collection__name__icontains schema: type: string - in: query name: variant_calls__data__collection__name__iexact schema: type: string - in: query name: variant_calls__data__collection__name__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: variant_calls__data__collection__name__isnull schema: type: boolean - in: query name: variant_calls__data__collection__name__istartswith schema: type: string - in: query name: variant_calls__data__collection__name__startswith schema: type: string - in: query name: variant_calls__data__collection__slug schema: type: string - in: query name: variant_calls__data__collection__slug__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: variant_calls__data__contributor schema: type: integer - in: query name: variant_calls__data__contributor__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: variant_calls__data__contributor_name schema: type: string - in: query name: variant_calls__data__created schema: type: string format: date-time - in: query name: variant_calls__data__created__date schema: type: string format: date - in: query name: variant_calls__data__created__gt schema: type: string format: date-time - in: query name: variant_calls__data__created__gte schema: type: string format: date-time - in: query name: variant_calls__data__created__isnull schema: type: boolean - in: query name: variant_calls__data__created__lt schema: type: string format: date-time - in: query name: variant_calls__data__created__lte schema: type: string format: date-time - in: query name: variant_calls__data__created__time schema: type: string format: time - in: query name: variant_calls__data__entity schema: type: integer - in: query name: variant_calls__data__entity__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: variant_calls__data__entity__isnull schema: type: boolean - in: query name: variant_calls__data__entity__name schema: type: string - in: query name: variant_calls__data__entity__name__contains schema: type: string - in: query name: variant_calls__data__entity__name__icontains schema: type: string - in: query name: variant_calls__data__entity__name__iexact schema: type: string - in: query name: variant_calls__data__entity__name__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: variant_calls__data__entity__name__isnull schema: type: boolean - in: query name: variant_calls__data__entity__name__istartswith schema: type: string - in: query name: variant_calls__data__entity__name__startswith schema: type: string - in: query name: variant_calls__data__entity__slug schema: type: string - in: query name: variant_calls__data__entity__slug__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: variant_calls__data__feature_type schema: type: string - in: query name: variant_calls__data__finished schema: type: string format: date-time - in: query name: variant_calls__data__finished__date schema: type: string format: date - in: query name: variant_calls__data__finished__gt schema: type: string format: date-time - in: query name: variant_calls__data__finished__gte schema: type: string format: date-time - in: query name: variant_calls__data__finished__isnull schema: type: boolean - in: query name: variant_calls__data__finished__lt schema: type: string format: date-time - in: query name: variant_calls__data__finished__lte schema: type: string format: date-time - in: query name: variant_calls__data__finished__time schema: type: string format: time - in: query name: variant_calls__data__group schema: type: string - in: query name: variant_calls__data__gt schema: type: integer - in: query name: variant_calls__data__gte schema: type: integer - in: query name: variant_calls__data__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: variant_calls__data__isnull schema: type: boolean - in: query name: variant_calls__data__lt schema: type: integer - in: query name: variant_calls__data__lte schema: type: integer - in: query name: variant_calls__data__modified schema: type: string format: date-time - in: query name: variant_calls__data__modified__date schema: type: string format: date - in: query name: variant_calls__data__modified__gt schema: type: string format: date-time - in: query name: variant_calls__data__modified__gte schema: type: string format: date-time - in: query name: variant_calls__data__modified__isnull schema: type: boolean - in: query name: variant_calls__data__modified__lt schema: type: string format: date-time - in: query name: variant_calls__data__modified__lte schema: type: string format: date-time - in: query name: variant_calls__data__modified__time schema: type: string format: time - in: query name: variant_calls__data__name schema: type: string - in: query name: variant_calls__data__name__contains schema: type: string - in: query name: variant_calls__data__name__icontains schema: type: string - in: query name: variant_calls__data__name__iexact schema: type: string - in: query name: variant_calls__data__name__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: variant_calls__data__name__isnull schema: type: boolean - in: query name: variant_calls__data__name__istartswith schema: type: string - in: query name: variant_calls__data__name__startswith schema: type: string - in: query name: variant_calls__data__owners schema: type: integer - in: query name: variant_calls__data__owners_name schema: type: string - in: query name: variant_calls__data__permission schema: type: string - in: query name: variant_calls__data__process schema: type: integer - in: query name: variant_calls__data__process__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: variant_calls__data__process__isnull schema: type: boolean - in: query name: variant_calls__data__process__name schema: type: string - in: query name: variant_calls__data__process__name__contains schema: type: string - in: query name: variant_calls__data__process__name__icontains schema: type: string - in: query name: variant_calls__data__process__name__iexact schema: type: string - in: query name: variant_calls__data__process__name__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: variant_calls__data__process__name__isnull schema: type: boolean - in: query name: variant_calls__data__process__name__istartswith schema: type: string - in: query name: variant_calls__data__process__name__startswith schema: type: string - in: query name: variant_calls__data__process__slug schema: type: string - in: query name: variant_calls__data__process__slug__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: variant_calls__data__relation_id schema: type: number - in: query name: variant_calls__data__shared_with_me schema: type: boolean - in: query name: variant_calls__data__slug schema: type: string - in: query name: variant_calls__data__slug__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: variant_calls__data__source schema: type: string - in: query name: variant_calls__data__species schema: type: string - in: query name: variant_calls__data__started schema: type: string format: date-time - in: query name: variant_calls__data__started__date schema: type: string format: date - in: query name: variant_calls__data__started__gt schema: type: string format: date-time - in: query name: variant_calls__data__started__gte schema: type: string format: date-time - in: query name: variant_calls__data__started__isnull schema: type: boolean - in: query name: variant_calls__data__started__lt schema: type: string format: date-time - in: query name: variant_calls__data__started__lte schema: type: string format: date-time - in: query name: variant_calls__data__started__time schema: type: string format: time - in: query name: variant_calls__data__status schema: type: string enum: - DR - ER - OK - PP - PR - RE - UP - WT description: |- * `UP` - Uploading * `RE` - Resolving * `WT` - Waiting * `PP` - Preparing * `PR` - Processing * `OK` - Done * `ER` - Error * `DR` - Dirty - in: query name: variant_calls__data__status__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: variant_calls__data__tags schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: variant_calls__data__type schema: type: string - in: query name: variant_calls__data__type__exact schema: type: string - in: query name: variant_calls__data__version schema: type: string - in: query name: variant_calls__data__version__gt schema: type: string - in: query name: variant_calls__data__version__gte schema: type: string - in: query name: variant_calls__data__version__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: variant_calls__data__version__isnull schema: type: boolean - in: query name: variant_calls__data__version__lt schema: type: string - in: query name: variant_calls__data__version__lte schema: type: string - in: query name: variant_calls__depth schema: type: integer - in: query name: variant_calls__depth__gt schema: type: integer - in: query name: variant_calls__depth__gte schema: type: integer - in: query name: variant_calls__depth__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: variant_calls__depth__isnull schema: type: boolean - in: query name: variant_calls__depth__lt schema: type: integer - in: query name: variant_calls__depth__lte schema: type: integer - in: query name: variant_calls__depth_norm_quality schema: type: number format: float - in: query name: variant_calls__depth_norm_quality__gt schema: type: number format: float - in: query name: variant_calls__depth_norm_quality__gte schema: type: number format: float - in: query name: variant_calls__depth_norm_quality__in schema: type: array items: type: number format: float description: Multiple values may be separated by commas. explode: false style: form - in: query name: variant_calls__depth_norm_quality__isnull schema: type: boolean - in: query name: variant_calls__depth_norm_quality__lt schema: type: number format: float - in: query name: variant_calls__depth_norm_quality__lte schema: type: number format: float - in: query name: variant_calls__experiment schema: type: integer - in: query name: variant_calls__experiment__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: variant_calls__experiment__isnull schema: type: boolean - in: query name: variant_calls__filter schema: type: string - in: query name: variant_calls__filter__contains schema: type: string - in: query name: variant_calls__filter__icontains schema: type: string - in: query name: variant_calls__filter__iexact schema: type: string - in: query name: variant_calls__filter__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: variant_calls__filter__isnull schema: type: boolean - in: query name: variant_calls__filter__istartswith schema: type: string - in: query name: variant_calls__filter__startswith schema: type: string - in: query name: variant_calls__genotype schema: type: string - in: query name: variant_calls__genotype__contains schema: type: string - in: query name: variant_calls__genotype__icontains schema: type: string - in: query name: variant_calls__genotype__iexact schema: type: string - in: query name: variant_calls__genotype__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: variant_calls__genotype__isnull schema: type: boolean - in: query name: variant_calls__genotype__istartswith schema: type: string - in: query name: variant_calls__genotype__startswith schema: type: string - in: query name: variant_calls__genotype_quality schema: type: integer - in: query name: variant_calls__genotype_quality__gt schema: type: integer - in: query name: variant_calls__genotype_quality__gte schema: type: integer - in: query name: variant_calls__genotype_quality__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: variant_calls__genotype_quality__isnull schema: type: boolean - in: query name: variant_calls__genotype_quality__lt schema: type: integer - in: query name: variant_calls__genotype_quality__lte schema: type: integer - in: query name: variant_calls__gt schema: type: integer - in: query name: variant_calls__gte schema: type: integer - in: query name: variant_calls__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: variant_calls__isnull schema: type: boolean - in: query name: variant_calls__lt schema: type: integer - in: query name: variant_calls__lte schema: type: integer - in: query name: variant_calls__quality schema: type: number format: float - in: query name: variant_calls__quality__gt schema: type: number format: float - in: query name: variant_calls__quality__gte schema: type: number format: float - in: query name: variant_calls__quality__in schema: type: array items: type: number format: float description: Multiple values may be separated by commas. explode: false style: form - in: query name: variant_calls__quality__isnull schema: type: boolean - in: query name: variant_calls__quality__lt schema: type: number format: float - in: query name: variant_calls__quality__lte schema: type: number format: float - in: query name: variant_calls__sample schema: type: integer - in: query name: variant_calls__sample__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: variant_calls__sample__isnull schema: type: boolean - in: query name: variant_calls__sample__slug schema: type: string - in: query name: variant_calls__sample__slug__contains schema: type: string - in: query name: variant_calls__sample__slug__icontains schema: type: string - in: query name: variant_calls__sample__slug__iexact schema: type: string - in: query name: variant_calls__sample__slug__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: variant_calls__sample__slug__isnull schema: type: boolean - in: query name: variant_calls__sample__slug__istartswith schema: type: string - in: query name: variant_calls__sample__slug__startswith schema: type: string - in: query name: variant_calls__variant schema: type: integer - in: query name: variant_calls__variant__alternative schema: type: string - in: query name: variant_calls__variant__alternative__contains schema: type: string - in: query name: variant_calls__variant__alternative__icontains schema: type: string - in: query name: variant_calls__variant__alternative__iexact schema: type: string - in: query name: variant_calls__variant__alternative__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: variant_calls__variant__alternative__isnull schema: type: boolean - in: query name: variant_calls__variant__alternative__istartswith schema: type: string - in: query name: variant_calls__variant__alternative__startswith schema: type: string - in: query name: variant_calls__variant__chromosome schema: type: string - in: query name: variant_calls__variant__chromosome__contains schema: type: string - in: query name: variant_calls__variant__chromosome__icontains schema: type: string - in: query name: variant_calls__variant__chromosome__iexact schema: type: string - in: query name: variant_calls__variant__chromosome__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: variant_calls__variant__chromosome__isnull schema: type: boolean - in: query name: variant_calls__variant__chromosome__istartswith schema: type: string - in: query name: variant_calls__variant__chromosome__startswith schema: type: string - in: query name: variant_calls__variant__genome_assembly schema: type: string - in: query name: variant_calls__variant__genome_assembly__contains schema: type: string - in: query name: variant_calls__variant__genome_assembly__icontains schema: type: string - in: query name: variant_calls__variant__genome_assembly__iexact schema: type: string - in: query name: variant_calls__variant__genome_assembly__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: variant_calls__variant__genome_assembly__isnull schema: type: boolean - in: query name: variant_calls__variant__genome_assembly__istartswith schema: type: string - in: query name: variant_calls__variant__genome_assembly__startswith schema: type: string - in: query name: variant_calls__variant__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: variant_calls__variant__isnull schema: type: boolean - in: query name: variant_calls__variant__position schema: type: integer - in: query name: variant_calls__variant__position__gt schema: type: integer - in: query name: variant_calls__variant__position__gte schema: type: integer - in: query name: variant_calls__variant__position__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: variant_calls__variant__position__isnull schema: type: boolean - in: query name: variant_calls__variant__position__lt schema: type: integer - in: query name: variant_calls__variant__position__lte schema: type: integer - in: query name: variant_calls__variant__reference schema: type: string - in: query name: variant_calls__variant__reference__contains schema: type: string - in: query name: variant_calls__variant__reference__icontains schema: type: string - in: query name: variant_calls__variant__reference__iexact schema: type: string - in: query name: variant_calls__variant__reference__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: variant_calls__variant__reference__isnull schema: type: boolean - in: query name: variant_calls__variant__reference__istartswith schema: type: string - in: query name: variant_calls__variant__reference__startswith schema: type: string - in: query name: variant_calls__variant__species schema: type: string - in: query name: variant_calls__variant__species__contains schema: type: string - in: query name: variant_calls__variant__species__icontains schema: type: string - in: query name: variant_calls__variant__species__iexact schema: type: string - in: query name: variant_calls__variant__species__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: variant_calls__variant__species__isnull schema: type: boolean - in: query name: variant_calls__variant__species__istartswith schema: type: string - in: query name: variant_calls__variant__species__startswith schema: type: string - in: query name: variant_data_source schema: type: string - in: query name: variant_data_source__contains schema: type: string - in: query name: variant_data_source__icontains schema: type: string - in: query name: variant_data_source__iexact schema: type: string - in: query name: variant_data_source__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: variant_data_source__isnull schema: type: boolean - in: query name: variant_data_source__istartswith schema: type: string - in: query name: variant_data_source__startswith schema: type: string tags: - api security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedVariantExperimentList' description: '' post: operationId: api_variant_experiment_create description: Create a resource. tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/VariantExperiment' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/VariantExperiment' multipart/form-data: schema: $ref: '#/components/schemas/VariantExperiment' required: true security: - cookieAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/VariantExperiment' description: '' /api/variant_experiment/{id}: put: operationId: api_variant_experiment_update description: VariantExperiment endpoint. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this variant experiment. required: true tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/VariantExperiment' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/VariantExperiment' multipart/form-data: schema: $ref: '#/components/schemas/VariantExperiment' required: true security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VariantExperiment' description: '' patch: operationId: api_variant_experiment_partial_update description: VariantExperiment endpoint. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this variant experiment. required: true tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedVariantExperiment' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedVariantExperiment' multipart/form-data: schema: $ref: '#/components/schemas/PatchedVariantExperiment' security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VariantExperiment' description: '' delete: operationId: api_variant_experiment_destroy description: VariantExperiment endpoint. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this variant experiment. required: true tags: - api security: - cookieAuth: [] responses: '204': description: No response body /api/versions: get: operationId: api_versions_retrieve description: Return the versions of the installed Genialis packages. tags: - api security: - cookieAuth: [] - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/Versions' description: '' /health_check: get: operationId: health_check_retrieve description: Perform database and redis health check. tags: - health_check security: - cookieAuth: [] - {} responses: '200': description: No response body /rest-auth/login/: post: operationId: rest_auth_login_create description: Attempt to perform automatic login. tags: - rest-auth requestBody: content: application/json: schema: $ref: '#/components/schemas/ApiLogin' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/ApiLogin' multipart/form-data: schema: $ref: '#/components/schemas/ApiLogin' required: true security: - cookieAuth: [] - {} responses: '204': description: No response body /rest-auth/logout/: post: operationId: rest_auth_logout_create description: |- Calls Django logout method and delete the Token object assigned to the current User object. Accepts/Returns nothing. tags: - rest-auth security: - cookieAuth: [] - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/RestAuthDetail' description: '' /rest-auth/password/change/: post: operationId: rest_auth_password_change_create description: |- Calls Django Auth SetPasswordForm save method. Accepts the following POST parameters: new_password1, new_password2 Returns the success/fail message. tags: - rest-auth requestBody: content: application/json: schema: $ref: '#/components/schemas/PasswordChange' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PasswordChange' multipart/form-data: schema: $ref: '#/components/schemas/PasswordChange' required: true security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RestAuthDetail' description: '' /rest-auth/password/reset/: post: operationId: rest_auth_password_reset_create description: |- Calls Django Auth PasswordResetForm save method. Accepts the following POST parameters: email Returns the success/fail message. tags: - rest-auth requestBody: content: application/json: schema: $ref: '#/components/schemas/PasswordReset' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PasswordReset' multipart/form-data: schema: $ref: '#/components/schemas/PasswordReset' required: true security: - cookieAuth: [] - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/RestAuthDetail' description: '' /rest-auth/password/reset/confirm/: post: operationId: rest_auth_password_reset_confirm_create description: |- Password reset e-mail link is confirmed, therefore this resets the user's password. Accepts the following POST parameters: token, uid, new_password1, new_password2 Returns the success/fail message. tags: - rest-auth requestBody: content: application/json: schema: $ref: '#/components/schemas/PasswordResetConfirm' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PasswordResetConfirm' multipart/form-data: schema: $ref: '#/components/schemas/PasswordResetConfirm' required: true security: - cookieAuth: [] - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/RestAuthDetail' description: '' /rest-auth/user/: get: operationId: rest_auth_user_retrieve description: |- Reads and updates UserModel fields Accepts GET, PUT, PATCH methods. Default accepted fields: username, first_name, last_name Default display fields: pk, username, email, first_name, last_name Read-only fields: pk, email Returns UserModel fields. tags: - rest-auth security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/UserDetails' description: '' put: operationId: rest_auth_user_update description: |- Reads and updates UserModel fields Accepts GET, PUT, PATCH methods. Default accepted fields: username, first_name, last_name Default display fields: pk, username, email, first_name, last_name Read-only fields: pk, email Returns UserModel fields. tags: - rest-auth requestBody: content: application/json: schema: $ref: '#/components/schemas/UserDetails' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/UserDetails' multipart/form-data: schema: $ref: '#/components/schemas/UserDetails' required: true security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/UserDetails' description: '' patch: operationId: rest_auth_user_partial_update description: |- Reads and updates UserModel fields Accepts GET, PUT, PATCH methods. Default accepted fields: username, first_name, last_name Default display fields: pk, username, email, first_name, last_name Read-only fields: pk, email Returns UserModel fields. tags: - rest-auth requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedUserDetails' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedUserDetails' multipart/form-data: schema: $ref: '#/components/schemas/PatchedUserDetails' security: - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/UserDetails' description: '' /saml-auth/api-login/: post: operationId: saml_auth_api_login_create description: Attempt to perform automatic login. tags: - saml-auth requestBody: content: application/json: schema: $ref: '#/components/schemas/ApiLogin' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/ApiLogin' multipart/form-data: schema: $ref: '#/components/schemas/ApiLogin' required: true security: - cookieAuth: [] - {} responses: '204': description: No response body /saml-auth/remote-login/auth-id/: get: operationId: saml_auth_remote_login_auth_id_retrieve description: Generate a cryptographically secure auth_id token. tags: - saml-auth security: - cookieAuth: [] - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/IdGenerator' description: '' /saml-auth/remote-login/poll/: get: operationId: saml_auth_remote_login_poll_retrieve description: Poll the redis server for authentication data. parameters: - in: cookie name: auth_id schema: type: string required: true tags: - saml-auth security: - cookieAuth: [] - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/CredentialsPoll' description: '' '204': description: No response body components: schemas: ActionEnum: enum: - download - tab type: string description: |- * `download` - Download * `tab` - Tab AddOrRemoveUsers: type: object description: Serializer for adding or removing users from a group. properties: user_ids: type: array items: type: integer required: - user_ids AggregatedExpressionBoxPlot: type: object description: Aggregated expression box plot serializer. properties: attribute: type: string gene: type: string exp_types: type: array items: {} min: type: number format: double max: type: number format: double median: type: number format: double q1: type: number format: double q3: type: number format: double lowerwhisker: type: number format: double upperwhisker: type: number format: double data_count: type: integer required: - attribute - data_count - exp_types - gene - lowerwhisker - max - median - min - q1 - q3 - upperwhisker AnnotationField: type: object description: Serializer for AnnotationField objects. properties: id: type: integer readOnly: true description: type: string maxLength: 256 group: $ref: '#/components/schemas/RelationshipDict' label: type: string maxLength: 128 name: type: string sort_order: type: integer maximum: 32767 minimum: 0 type: type: string maxLength: 16 validator_regex: type: string nullable: true maxLength: 128 vocabulary: nullable: true required: type: boolean version: type: string default: 0.0.0 required: - description - group - id - label - sort_order - type AnnotationFieldDict: type: object description: Serializer for actions that deal with annotation fields. properties: annotation_fields: type: array items: type: integer required: - annotation_fields AnnotationPresetSerializerWithPermissions: type: object description: Serializer for AnnotationPreset objects. properties: id: type: integer readOnly: true name: type: string fields: type: array items: type: integer contributor: $ref: '#/components/schemas/Contributor' current_user_permissions: type: array items: $ref: '#/components/schemas/CurrentUserPermissions' readOnly: true required: - contributor - current_user_permissions - fields - id AnnotationUpload: type: object description: Serializer for the response when uploading an annotation file. properties: annotated_samples: type: array items: type: integer required: - annotated_samples AnnotationUploadDeserializer: type: object description: Deserializer for request data when uploading an annotation file. properties: annotation_type: type: string annotation_file: type: string format: uri required: - annotation_file - annotation_type AnnotationValue: type: object description: Serializer for AnnotationValue objects. properties: label: description: Return the cached label. readOnly: true created: type: string format: date-time readOnly: true id: type: integer readOnly: true entity: type: integer field: type: integer contributor: $ref: '#/components/schemas/Contributor' value: oneOf: - type: string - type: integer - type: number format: double - type: string format: date description: Get the actual value or None if object is delete marker. readOnly: true _value: writeOnly: true nullable: true title: ' value' required: - contributor - created - entity - field - id - label - value AnnotationVersionEnum: enum: - v2 type: string description: '* `v2` - v2' AnnotationsByPath: type: object description: Serializer that reads annotation field and its value. properties: field_path: type: string maxLength: 257 value: nullable: true required: - field_path - value ApiLogin: type: object description: Deserializer for login credentials. properties: email: type: string format: email password: type: string required: - email - password AppState: type: object description: Serializer for :class:`AppState` objects. properties: uuid: type: string format: uuid state: {} contributor: type: integer required: - contributor - state - uuid AttributeList: type: object description: Attribute serializer. properties: descriptor_attributes: type: array items: $ref: '#/components/schemas/DescriptorAttribute' relation_attributes: type: array items: $ref: '#/components/schemas/RelationAttribute' required: - descriptor_attributes - relation_attributes AttributesDeserializer: type: object description: Serializer for parsing attributes endpoint input. properties: annotation_version: allOf: - $ref: '#/components/schemas/AnnotationVersionEnum' default: v2 sample_ids: type: array items: type: integer basket: type: string format: uuid AttributifyDeserializer: type: object description: Serializer for parsing attributify endpoint input. properties: attribute: {} annotation_version: allOf: - $ref: '#/components/schemas/AnnotationVersionEnum' default: v2 sample_ids: type: array items: type: integer basket: type: string format: uuid required: - attribute BackgroundTask: type: object description: Serialize the BackgroundTask model. properties: id: type: integer readOnly: true started: type: string format: date-time nullable: true finished: type: string format: date-time nullable: true status: $ref: '#/components/schemas/BackgroundTaskStatusEnum' description: type: string maxLength: 256 output: {} required: - description - id BackgroundTaskStatusEnum: enum: - WT - PR - OK - ER type: string description: |- * `WT` - Waiting * `PR` - Processing * `OK` - Done * `ER` - Error BaseSpaceSample: type: object description: BaseSpace sample entity serializer. properties: id: type: string name: type: string is_paired_end: type: boolean required: - id - is_paired_end - name BaseSpaceSamples: type: object description: BaseSpace samples serializer. properties: displayed_count: type: integer default: 0 total_count: type: integer default: 0 items: type: array items: $ref: '#/components/schemas/BaseSpaceSample' BaseSpaceUser: type: object description: BaseSpace user serializer. properties: email: type: string name: type: string Basket: type: object description: Serializer for :class:`SampleInBasket` objects. properties: name: type: string read_only: type: boolean contributor: $ref: '#/components/schemas/Contributor' id: type: string format: uuid readOnly: true created: type: string format: date-time readOnly: true modified: type: string format: date-time readOnly: true required: - contributor - created - id - modified BasketAddSamples: type: object description: Basket add samples serializer. properties: id: type: string modified: type: string format: date-time ignored: type: array items: type: integer duplicated: type: array items: type: integer permitted_organisms: type: array items: type: string permitted_sources: type: array items: type: string conflict_organisms: type: array items: type: string conflict_sources: type: array items: type: string required: - conflict_organisms - conflict_sources - duplicated - id - ignored - modified - permitted_organisms - permitted_sources BasketAddSamplesDeserializer: type: object description: Basket add samples deserializer. properties: annotation_version: allOf: - $ref: '#/components/schemas/AnnotationVersionEnum' default: v2 only_existing_organism: type: boolean default: false breadcrumb: {} samples: type: array items: type: integer required: - samples BasketBreadcrumb: type: object description: SampleBasketBreadcrumb serializer. properties: id: type: integer readOnly: true data: {} created: type: string format: date-time required: - id BasketClone: type: object description: Basket clone serializer. properties: id: type: string modified: type: string format: date-time removed_samples: type: boolean required: - id - modified - removed_samples BasketDataTypes: type: object description: Basket data types serializer. properties: data_types: type: array items: type: string required: - data_types BasketExpressions: type: object description: Basket expressions serializer. properties: id: type: integer exp_type: type: string description: Return expression type. readOnly: true required: - exp_type - id BasketMutation: type: object description: Basket update serializer. properties: id: type: string modified: type: string format: date-time required: - id - modified BasketOrganism: type: object description: Basket organism list serializer. properties: organism: type: string required: - organism BasketSampleCount: type: object description: Basket sample count serializer. properties: sampleCount: type: integer required: - sampleCount BasketSource: type: object description: Basket source list serializer. properties: source: type: string required: - source BasketSubset: type: object description: Basket serializer where a subset of samples is selected. properties: samples: type: array items: type: integer default: [] BillingAccount: type: object description: Billing account serializer. properties: active: type: boolean readOnly: true name: type: string readOnly: true id: type: integer readOnly: true required: - active - id - name BillingAccountToCollection: type: object description: Serializer for assigning a collection to a billing account. properties: collection_id: type: integer required: - collection_id BillingStatisticsCollection: type: object description: Serializer for the billing statistics by collection. properties: max_usage: type: integer min_usage: type: integer avg_usage: type: integer collection_id: type: integer created: type: string format: date-time required: - collection_id BillingStatisticsCost: type: object description: |- Serializer for the billing statistics by billing account. Plus additional billing costs. properties: max_usage: type: integer min_usage: type: integer avg_usage: type: integer billing_account_id: type: integer storage: type: number format: double default: 0.0 compute: type: number format: double default: 0.0 required: - billing_account_id BlankEnum: enum: - '' CaseControlExpressions: type: object description: CaseControlExpressions serializer. properties: expressions: type: array items: $ref: '#/components/schemas/Expression' stats: type: array items: $ref: '#/components/schemas/Statistics' exceptions: type: array items: {} required: - exceptions - expressions - stats CaseControlExpressionsDeserializer: type: object description: Serializer for parsing case and control expressions endpoint input. properties: diff_expr_id: type: integer selected_genes: type: array items: type: string highlighted_genes: type: array items: type: string log2: type: boolean default: false required: - diff_expr_id - selected_genes CollectionSerializerWithPermissions: type: object description: Serializer for Collection objects. properties: created: type: string format: date-time readOnly: true duplicated: type: string format: date-time readOnly: true nullable: true id: type: integer readOnly: true modified: type: string format: date-time readOnly: true data_count: type: integer description: Return number of data objects on the collection. readOnly: true status: type: string readOnly: true contributor: $ref: '#/components/schemas/Contributor' description: type: string name: type: string settings: {} slug: type: string nullable: true tags: type: array items: type: string maxLength: 255 entity_count: type: integer description: Return number of entities on the collection. readOnly: true descriptor: {} descriptor_schema: allOf: - $ref: '#/components/schemas/RelationshipDict' nullable: true descriptor_dirty: type: boolean current_user_permissions: type: array items: $ref: '#/components/schemas/CurrentUserPermissions' readOnly: true required: - contributor - created - current_user_permissions - data_count - duplicated - entity_count - id - modified - status CollectionSpecies: type: object description: Species serializer. properties: collection_id: type: integer species: type: array items: type: string description: Return a list of species. readOnly: true required: - collection_id - species Community: type: object description: Serializer for :class:`Community` objects. properties: id: type: integer readOnly: true name: type: string maxLength: 100 slug: type: string maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ default: type: boolean required: - id - name - slug Configuration: type: object description: Serializer for :class:`Configuration` objects. properties: id: type: integer readOnly: true community: type: string readOnly: true gene_info_filtering_organisms: type: array items: type: string gene_info_filtering_sources: type: array items: type: string import_visible: type: boolean krasid_help_text: type: string nullable: true krasid_visible: type: boolean landing_page_content: type: string require_login_visible: type: boolean search_archiver_process: type: string search_filter_by_community: type: boolean search_process_group_stubs: {} search_table_columns: type: array items: $ref: '#/components/schemas/SearchTableFileColumn' search_visible: type: boolean visualizations_de_color_palette: type: array items: type: string maxLength: 7 title: Visualizations comparison table color palette maxItems: 9 visualizations_de_creation_processes: type: array items: type: string title: Visualizations differential expression creation processes visualizations_gene_view_visible: type: boolean visualizations_genome_browser_visible: type: boolean visualizations_visible: type: boolean required: - community - id Contributor: type: object description: Serializer for contributor User objects. properties: first_name: type: string maxLength: 150 id: type: integer readOnly: true last_name: type: string maxLength: 150 username: type: string description: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. pattern: ^[\w.@+-]+$ maxLength: 150 required: - id - username CredentialsPoll: type: object description: Serializer for CredentialsPollView. properties: sessionid: type: string csrftoken: type: string required: - csrftoken - sessionid CurrentUserPermissions: type: object description: Current user permissions serializer. properties: id: type: integer type: $ref: '#/components/schemas/CurrentUserPermissionsTypeEnum' name: type: string maxLength: 100 username: type: string maxLength: 150 permissions: type: array items: $ref: '#/components/schemas/PermissionsEnum' required: - permissions - type CurrentUserPermissionsTypeEnum: enum: - user - group - public type: string description: |- * `user` - user * `group` - group * `public` - public Data: type: object description: Serializer for Data objects. properties: checksum: type: string readOnly: true created: type: string format: date-time readOnly: true descriptor_dirty: type: boolean readOnly: true duplicated: type: string format: date-time readOnly: true nullable: true finished: type: string format: date-time readOnly: true nullable: true id: type: integer readOnly: true modified: type: string format: date-time readOnly: true process_cores: type: integer readOnly: true process_error: type: array items: type: string maxLength: 255 readOnly: true process_info: type: array items: type: string maxLength: 255 readOnly: true process_memory: type: integer readOnly: true process_progress: type: integer readOnly: true process_rc: type: integer readOnly: true nullable: true process_warning: type: array items: type: string maxLength: 255 readOnly: true output: {} scheduled: type: string format: date-time readOnly: true nullable: true size: type: integer readOnly: true started: type: string format: date-time readOnly: true nullable: true status: allOf: - $ref: '#/components/schemas/DataStatus' readOnly: true contributor: $ref: '#/components/schemas/Contributor' input: {} process: $ref: '#/components/schemas/RelationshipDict' collection: allOf: - $ref: '#/components/schemas/RelationshipDict' nullable: true descriptor: {} descriptor_schema: allOf: - $ref: '#/components/schemas/RelationshipDict' nullable: true entity: allOf: - $ref: '#/components/schemas/RelationshipDict' nullable: true name: type: string slug: type: string nullable: true tags: type: array items: type: string maxLength: 255 process_resources: {} required: - checksum - contributor - created - descriptor_dirty - duplicated - finished - id - modified - process - process_cores - process_error - process_info - process_memory - process_progress - process_rc - process_warning - scheduled - size - started - status DataAccessToken: type: object description: Serializer for ``DataAccessToken``. properties: description: type: string user: $ref: '#/components/schemas/Contributor' data: type: array items: type: integer permissions: type: string expires: type: string format: date-time created: type: string format: date-time readOnly: true revoked: type: string format: date-time readOnly: true required: - created - data - permissions - revoked - user DataAccessTokenCreate: type: object description: Serializer for creating ``DataAccessToken``. properties: description: type: string user: $ref: '#/components/schemas/Contributor' data: type: array items: type: integer permissions: type: string expires: type: string format: date-time created: type: string format: date-time readOnly: true revoked: type: string format: date-time readOnly: true token: type: string required: - created - data - permissions - revoked - user DataSerializerWithPermissions: type: object description: Serializer for Data objects. properties: checksum: type: string readOnly: true created: type: string format: date-time readOnly: true descriptor_dirty: type: boolean readOnly: true duplicated: type: string format: date-time readOnly: true nullable: true finished: type: string format: date-time readOnly: true nullable: true id: type: integer readOnly: true modified: type: string format: date-time readOnly: true process_cores: type: integer readOnly: true process_error: type: array items: type: string maxLength: 255 readOnly: true process_info: type: array items: type: string maxLength: 255 readOnly: true process_memory: type: integer readOnly: true process_progress: type: integer readOnly: true process_rc: type: integer readOnly: true nullable: true process_warning: type: array items: type: string maxLength: 255 readOnly: true output: {} scheduled: type: string format: date-time readOnly: true nullable: true size: type: integer readOnly: true started: type: string format: date-time readOnly: true nullable: true status: allOf: - $ref: '#/components/schemas/DataStatus' readOnly: true contributor: $ref: '#/components/schemas/Contributor' input: {} process: $ref: '#/components/schemas/RelationshipDict' collection: allOf: - $ref: '#/components/schemas/RelationshipDict' nullable: true descriptor: {} descriptor_schema: allOf: - $ref: '#/components/schemas/RelationshipDict' nullable: true entity: allOf: - $ref: '#/components/schemas/RelationshipDict' nullable: true name: type: string slug: type: string nullable: true tags: type: array items: type: string maxLength: 255 process_resources: {} current_user_permissions: type: array items: $ref: '#/components/schemas/CurrentUserPermissions' readOnly: true required: - checksum - contributor - created - current_user_permissions - descriptor_dirty - duplicated - finished - id - modified - process - process_cores - process_error - process_info - process_memory - process_progress - process_rc - process_warning - scheduled - size - started - status DataStatus: enum: - UP - RE - WT - PP - PR - OK - ER - DR type: string description: |- * `UP` - Uploading * `RE` - Resolving * `WT` - Waiting * `PP` - Preparing * `PR` - Processing * `OK` - Done * `ER` - Error * `DR` - Dirty Delete: type: object description: Bulk delete given objects. properties: ids: type: array items: type: integer required: - ids DescriptorAttribute: type: object description: Descriptor attribute serializer. properties: attribute_type: type: string label: type: string field_path: type: string group_label: type: string default: '' field_type: type: string default: '' required: - attribute_type - field_path - label DescriptorSchemaSerializerWithPermissions: type: object description: Serializer for DescriptorSchema objects. properties: created: type: string format: date-time readOnly: true id: type: integer readOnly: true modified: type: string format: date-time readOnly: true contributor: $ref: '#/components/schemas/Contributor' version: type: string default: 0.0.0 description: type: string name: type: string schema: {} slug: type: string nullable: true current_user_permissions: type: array items: $ref: '#/components/schemas/CurrentUserPermissions' readOnly: true required: - contributor - created - current_user_permissions - id - modified DifferentialExpressionsDeserializer: type: object description: Deserialize ~`genesis.models.differential_expression.models.GeneSetSearch`. properties: basket: type: string format: uuid source: type: string species: type: string filter_de_by_basket: type: boolean DifferentialExpressionsSerializerWithPermissions: type: object description: Serialize ~`genesis.models.differential_expression.models.GeneSetSearch`. properties: checksum: type: string readOnly: true created: type: string format: date-time readOnly: true descriptor_dirty: type: boolean readOnly: true duplicated: type: string format: date-time readOnly: true nullable: true finished: type: string format: date-time readOnly: true nullable: true id: type: integer readOnly: true modified: type: string format: date-time readOnly: true process_cores: type: integer readOnly: true process_error: type: array items: type: string maxLength: 255 readOnly: true process_info: type: array items: type: string maxLength: 255 readOnly: true process_memory: type: integer readOnly: true process_progress: type: integer readOnly: true process_rc: type: integer readOnly: true nullable: true process_warning: type: array items: type: string maxLength: 255 readOnly: true output: {} scheduled: type: string format: date-time readOnly: true nullable: true size: type: integer readOnly: true started: type: string format: date-time readOnly: true nullable: true status: allOf: - $ref: '#/components/schemas/DataStatus' readOnly: true contributor: $ref: '#/components/schemas/Contributor' input: {} process: $ref: '#/components/schemas/RelationshipDict' collection: allOf: - $ref: '#/components/schemas/RelationshipDict' nullable: true descriptor: {} descriptor_schema: allOf: - $ref: '#/components/schemas/RelationshipDict' nullable: true entity: allOf: - $ref: '#/components/schemas/RelationshipDict' nullable: true name: type: string slug: type: string nullable: true tags: type: array items: type: string maxLength: 255 process_resources: {} logfc_threshold: type: number format: double default: 0.0 prob_field: type: string default: '0' prob_threshold: type: number format: double default: 0.0 up_regulated: type: integer default: 0 down_regulated: type: integer default: 0 current_user_permissions: type: array items: $ref: '#/components/schemas/CurrentUserPermissions' readOnly: true required: - checksum - contributor - created - current_user_permissions - descriptor_dirty - duplicated - finished - id - modified - process - process_cores - process_error - process_info - process_memory - process_progress - process_rc - process_warning - scheduled - size - started - status Duplicate: type: object description: Deserializer for duplicate endpoint. properties: ids: type: array items: type: integer required: - ids Entity: type: object description: Serializer for Entity with added collection field. properties: created: type: string format: date-time readOnly: true duplicated: type: string format: date-time readOnly: true nullable: true id: type: integer readOnly: true modified: type: string format: date-time readOnly: true data_count: type: integer description: Return number of data objects on the collection. readOnly: true status: type: string readOnly: true contributor: $ref: '#/components/schemas/Contributor' description: type: string name: type: string settings: {} slug: type: string nullable: true tags: type: array items: type: string maxLength: 255 collection: allOf: - $ref: '#/components/schemas/RelationshipDict' nullable: true type: type: string nullable: true maxLength: 100 required: - contributor - created - data_count - duplicated - id - modified - status EntitySerializerWithPermissions: type: object description: Serializer for Entity with added collection field. properties: created: type: string format: date-time readOnly: true duplicated: type: string format: date-time readOnly: true nullable: true id: type: integer readOnly: true modified: type: string format: date-time readOnly: true data_count: type: integer description: Return number of data objects on the collection. readOnly: true status: type: string readOnly: true contributor: $ref: '#/components/schemas/Contributor' description: type: string name: type: string settings: {} slug: type: string nullable: true tags: type: array items: type: string maxLength: 255 collection: allOf: - $ref: '#/components/schemas/RelationshipDict' nullable: true type: type: string nullable: true maxLength: 100 current_user_permissions: type: array items: $ref: '#/components/schemas/CurrentUserPermissions' readOnly: true required: - contributor - created - current_user_permissions - data_count - duplicated - id - modified - status EstimatedCostPerBillingAccount: type: object description: Serializer for cost per day per billing account. properties: cost_type: type: string readOnly: true date: type: string format: date readOnly: true aggregated_cost: type: number format: double billing_account_id: type: integer readOnly: true referenced_collection_id: type: integer readOnly: true nullable: true referenced_collection_name: type: string readOnly: true nullable: true referenced_collection_slug: type: string readOnly: true nullable: true required: - aggregated_cost - billing_account_id - cost_type - date - referenced_collection_id - referenced_collection_name - referenced_collection_slug Expression: type: object description: Expression serializer. properties: sample: type: string expression: type: number format: double gene: type: string type: type: string exp_type: type: string required: - exp_type - expression - gene - sample - type ExpressionBoxPlot: type: object description: ExpressionBoxPlot serializer. properties: attribute: type: string gene: type: string exp_types: type: array items: {} min: type: number format: double max: type: number format: double median: type: number format: double q1: type: number format: double q3: type: number format: double lowerwhisker: type: number format: double upperwhisker: type: number format: double required: - attribute - exp_types - gene - lowerwhisker - max - median - min - q1 - q3 - upperwhisker ExpressionBoxPlotDeserializer: type: object description: ExpressionBoxPlot deserializer. properties: gene_ids: type: array items: type: string source: type: string nullable: true species: type: string nullable: true annotation_version: allOf: - $ref: '#/components/schemas/AnnotationVersionEnum' default: v2 attribute: type: object additionalProperties: {} basket: type: string format: uuid required: - basket Expressions: type: object description: Expressions serializer. properties: gene: type: string expression: type: number format: double exp_type: type: string sample: type: string group_by: type: string color_by: type: string required: - exp_type - expression - gene - sample ExpressionsDeserializer: type: object description: Expressions deserializer. properties: gene_ids: type: array items: type: string source: type: string nullable: true species: type: string nullable: true annotation_version: allOf: - $ref: '#/components/schemas/AnnotationVersionEnum' default: v2 basket: type: string format: uuid group_by: type: object additionalProperties: {} nullable: true color_by: type: object additionalProperties: {} nullable: true required: - basket Feature: type: object description: Serializer for feature. properties: aliases: type: array items: type: string maxLength: 256 description: type: string feature_id: type: string maxLength: 50 full_name: type: string maxLength: 350 id: type: integer readOnly: true name: type: string maxLength: 1024 source: type: string maxLength: 20 species: type: string maxLength: 50 sub_type: $ref: '#/components/schemas/SubTypeEnum' type: $ref: '#/components/schemas/FeatureTypeEnum' required: - feature_id - id - name - source - species - sub_type - type FeatureTypeEnum: enum: - gene - transcript - exon - probe type: string description: |- * `gene` - Gene * `transcript` - Transcript * `exon` - Exon * `probe` - Probe File: type: object description: BaseSpace file entity serializer. properties: id: type: string name: type: string required: - id - name Files: type: object description: BaseSpace files serializer. properties: displayed_count: type: integer default: 0 total_count: type: integer default: 0 items: type: array items: $ref: '#/components/schemas/File' GeneIds: type: object description: |- Serializer for gene_ids query parameter. Enforce that if gene_ids are specified, source and species are also. properties: gene_ids: type: array items: type: string source: type: string nullable: true species: type: string nullable: true GeneList: type: object description: Gene list serializer. properties: feature_id: type: string name: type: string full_name: type: string required: - feature_id - full_name - name GenesetSearchSerializerWithPermissions: type: object description: Serialize ~`genesis.models.differential_expression.models.GeneSetSearch`. properties: checksum: type: string readOnly: true created: type: string format: date-time readOnly: true descriptor_dirty: type: boolean readOnly: true duplicated: type: string format: date-time readOnly: true nullable: true finished: type: string format: date-time readOnly: true nullable: true id: type: integer readOnly: true modified: type: string format: date-time readOnly: true process_cores: type: integer readOnly: true process_error: type: array items: type: string maxLength: 255 readOnly: true process_info: type: array items: type: string maxLength: 255 readOnly: true process_memory: type: integer readOnly: true process_progress: type: integer readOnly: true process_rc: type: integer readOnly: true nullable: true process_warning: type: array items: type: string maxLength: 255 readOnly: true output: {} scheduled: type: string format: date-time readOnly: true nullable: true size: type: integer readOnly: true started: type: string format: date-time readOnly: true nullable: true status: allOf: - $ref: '#/components/schemas/DataStatus' readOnly: true contributor: $ref: '#/components/schemas/Contributor' input: {} process: $ref: '#/components/schemas/RelationshipDict' collection: allOf: - $ref: '#/components/schemas/RelationshipDict' nullable: true descriptor: {} descriptor_schema: allOf: - $ref: '#/components/schemas/RelationshipDict' nullable: true entity: allOf: - $ref: '#/components/schemas/RelationshipDict' nullable: true name: type: string slug: type: string nullable: true tags: type: array items: type: string maxLength: 255 process_resources: {} logfc_threshold: type: number format: double default: 0.0 prob_field: type: string default: '0' prob_threshold: type: number format: double default: 0.0 up_regulated: type: integer default: 0 down_regulated: type: integer default: 0 number_of_genes: type: integer default: 0 source: type: string current_user_permissions: type: array items: $ref: '#/components/schemas/CurrentUserPermissions' readOnly: true required: - checksum - contributor - created - current_user_permissions - descriptor_dirty - duplicated - finished - id - modified - process - process_cores - process_error - process_info - process_memory - process_progress - process_rc - process_warning - scheduled - size - source - started - status Group: type: object description: Serializer for :class:`Group` objects. properties: id: type: integer readOnly: true name: type: string maxLength: 150 users: type: array items: type: integer readOnly: true required: - id - name - users Handle: type: object description: Handle serializer. properties: handle: type: string format: uuid Heatmap: type: object description: Heatmap serializer. properties: sample_id: type: integer description: Return sample id. readOnly: true sample_name: type: string description: Return sample name. readOnly: true gene: type: string expression: type: number format: double expression_type: type: string nullable: true description: Return expression type. readOnly: true required: - expression - expression_type - gene - sample_id - sample_name HeatmapDeserializer: type: object description: Heatmap deserializer. properties: gene_ids: type: array items: type: string source: type: string nullable: true species: type: string nullable: true sample_ids: type: array items: type: integer required: - sample_ids IdGenerator: type: object description: Serializer for IdGeneratorView. properties: auth_id: type: string readOnly: true required: - auth_id Mapping: type: object description: Serializer for mapping. properties: id: type: integer readOnly: true relation_type: $ref: '#/components/schemas/RelationTypeEnum' source_db: type: string maxLength: 20 source_id: type: string maxLength: 50 source_species: type: string maxLength: 50 target_db: type: string maxLength: 20 target_id: type: string maxLength: 50 target_species: type: string maxLength: 50 required: - id - relation_type - source_db - source_id - source_species - target_db - target_id - target_species MoveDataToCollection: type: object description: Deserializer for data move to collection endpoint. properties: ids: type: array items: type: integer destination_collection: type: integer required: - destination_collection - ids MoveEntityToCollection: type: object description: Serializer for moving entities to a collection. properties: ids: type: array items: type: integer destination_collection: type: integer required: - destination_collection - ids NullEnum: enum: - null ObserverSubscribeRequest: type: object description: Serializer for the subscribe endpoint. properties: ids: type: array items: type: integer nullable: true session_id: type: string required: - session_id ObserverSubscription: type: object description: Serializer for the subscribe response. properties: subscription_id: type: string format: uuid required: - subscription_id PaginatedAggregatedExpressionBoxPlotList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/AggregatedExpressionBoxPlot' PaginatedAnnotationFieldList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/AnnotationField' PaginatedAnnotationPresetSerializerWithPermissionsList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/AnnotationPresetSerializerWithPermissions' PaginatedAnnotationValueList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/AnnotationValue' PaginatedBackgroundTaskList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/BackgroundTask' PaginatedBasketBreadcrumbList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/BasketBreadcrumb' PaginatedBasketExpressionsList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/BasketExpressions' PaginatedBasketOrganismList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/BasketOrganism' PaginatedBasketSourceList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/BasketSource' PaginatedBillingAccountList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/BillingAccount' PaginatedCollectionSerializerWithPermissionsList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/CollectionSerializerWithPermissions' PaginatedCollectionSpeciesList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/CollectionSpecies' PaginatedCommunityList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/Community' PaginatedConfigurationList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/Configuration' PaginatedDataAccessTokenList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/DataAccessToken' PaginatedDataList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/Data' PaginatedDataSerializerWithPermissionsList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/DataSerializerWithPermissions' PaginatedDescriptorSchemaSerializerWithPermissionsList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/DescriptorSchemaSerializerWithPermissions' PaginatedDifferentialExpressionsSerializerWithPermissionsList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/DifferentialExpressionsSerializerWithPermissions' PaginatedEntitySerializerWithPermissionsList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/EntitySerializerWithPermissions' PaginatedEstimatedCostPerBillingAccountList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/EstimatedCostPerBillingAccount' PaginatedExpressionBoxPlotList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/ExpressionBoxPlot' PaginatedExpressionsList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/Expressions' PaginatedFeatureList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/Feature' PaginatedGeneListList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/GeneList' PaginatedGenesetSearchSerializerWithPermissionsList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/GenesetSearchSerializerWithPermissions' PaginatedGroupList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/Group' PaginatedHeatmapList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/Heatmap' PaginatedMappingList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/Mapping' PaginatedParameterPresetList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/ParameterPreset' PaginatedPredictionFieldList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/PredictionField' PaginatedPredictionGroupList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/PredictionGroup' PaginatedPredictionPresetSerializerWithPermissionsList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/PredictionPresetSerializerWithPermissions' PaginatedPredictionValueList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/PredictionValue' PaginatedProcessList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/Process' PaginatedProcessSerializerWithPermissionsList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/ProcessSerializerWithPermissions' PaginatedRelationList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/Relation' PaginatedRose2List: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/Rose2' PaginatedSampleInBasketList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/SampleInBasket' PaginatedSampleList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/Sample' PaginatedSearchTableFileColumnList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/SearchTableFileColumn' PaginatedUserList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/User' PaginatedUserTagList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/UserTag' PaginatedVariantAnnotationList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/VariantAnnotation' PaginatedVariantCallList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/VariantCall' PaginatedVariantExperimentList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/VariantExperiment' PaginatedVariantList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/Variant' ParameterPreset: type: object description: Serializer for :class:`ParameterPreset` model. properties: id: type: integer readOnly: true name: type: string maxLength: 100 created: type: string format: date-time readOnly: true modified: type: string format: date-time readOnly: true contributor: type: integer process: type: integer input_preset: {} required: - contributor - created - id - modified - name - process PasswordChange: type: object properties: new_password1: type: string maxLength: 128 new_password2: type: string maxLength: 128 required: - new_password1 - new_password2 PasswordReset: type: object description: Serializer for requesting a password reset e-mail. properties: email: type: string format: email required: - email PasswordResetConfirm: type: object description: Serializer for confirming a password reset attempt. properties: new_password1: type: string maxLength: 128 new_password2: type: string maxLength: 128 uid: type: string token: type: string required: - new_password1 - new_password2 - token - uid PatchedAnnotationPresetSerializerWithPermissions: type: object description: Serializer for AnnotationPreset objects. properties: id: type: integer readOnly: true name: type: string fields: type: array items: type: integer contributor: $ref: '#/components/schemas/Contributor' current_user_permissions: type: array items: $ref: '#/components/schemas/CurrentUserPermissions' readOnly: true PatchedAnnotationValue: type: object description: Serializer for AnnotationValue objects. properties: label: description: Return the cached label. readOnly: true created: type: string format: date-time readOnly: true id: type: integer readOnly: true entity: type: integer field: type: integer contributor: $ref: '#/components/schemas/Contributor' value: oneOf: - type: string - type: integer - type: number format: double - type: string format: date description: Get the actual value or None if object is delete marker. readOnly: true _value: writeOnly: true nullable: true title: ' value' PatchedCollectionSerializerWithPermissions: type: object description: Serializer for Collection objects. properties: created: type: string format: date-time readOnly: true duplicated: type: string format: date-time readOnly: true nullable: true id: type: integer readOnly: true modified: type: string format: date-time readOnly: true data_count: type: integer description: Return number of data objects on the collection. readOnly: true status: type: string readOnly: true contributor: $ref: '#/components/schemas/Contributor' description: type: string name: type: string settings: {} slug: type: string nullable: true tags: type: array items: type: string maxLength: 255 entity_count: type: integer description: Return number of entities on the collection. readOnly: true descriptor: {} descriptor_schema: allOf: - $ref: '#/components/schemas/RelationshipDict' nullable: true descriptor_dirty: type: boolean current_user_permissions: type: array items: $ref: '#/components/schemas/CurrentUserPermissions' readOnly: true PatchedDataAccessToken: type: object description: Serializer for ``DataAccessToken``. properties: description: type: string user: $ref: '#/components/schemas/Contributor' data: type: array items: type: integer permissions: type: string expires: type: string format: date-time created: type: string format: date-time readOnly: true revoked: type: string format: date-time readOnly: true PatchedDataSerializerWithPermissions: type: object description: Serializer for Data objects. properties: checksum: type: string readOnly: true created: type: string format: date-time readOnly: true descriptor_dirty: type: boolean readOnly: true duplicated: type: string format: date-time readOnly: true nullable: true finished: type: string format: date-time readOnly: true nullable: true id: type: integer readOnly: true modified: type: string format: date-time readOnly: true process_cores: type: integer readOnly: true process_error: type: array items: type: string maxLength: 255 readOnly: true process_info: type: array items: type: string maxLength: 255 readOnly: true process_memory: type: integer readOnly: true process_progress: type: integer readOnly: true process_rc: type: integer readOnly: true nullable: true process_warning: type: array items: type: string maxLength: 255 readOnly: true output: {} scheduled: type: string format: date-time readOnly: true nullable: true size: type: integer readOnly: true started: type: string format: date-time readOnly: true nullable: true status: allOf: - $ref: '#/components/schemas/DataStatus' readOnly: true contributor: $ref: '#/components/schemas/Contributor' input: {} process: $ref: '#/components/schemas/RelationshipDict' collection: allOf: - $ref: '#/components/schemas/RelationshipDict' nullable: true descriptor: {} descriptor_schema: allOf: - $ref: '#/components/schemas/RelationshipDict' nullable: true entity: allOf: - $ref: '#/components/schemas/RelationshipDict' nullable: true name: type: string slug: type: string nullable: true tags: type: array items: type: string maxLength: 255 process_resources: {} current_user_permissions: type: array items: $ref: '#/components/schemas/CurrentUserPermissions' readOnly: true PatchedEntitySerializerWithPermissions: type: object description: Serializer for Entity with added collection field. properties: created: type: string format: date-time readOnly: true duplicated: type: string format: date-time readOnly: true nullable: true id: type: integer readOnly: true modified: type: string format: date-time readOnly: true data_count: type: integer description: Return number of data objects on the collection. readOnly: true status: type: string readOnly: true contributor: $ref: '#/components/schemas/Contributor' description: type: string name: type: string settings: {} slug: type: string nullable: true tags: type: array items: type: string maxLength: 255 collection: allOf: - $ref: '#/components/schemas/RelationshipDict' nullable: true type: type: string nullable: true maxLength: 100 current_user_permissions: type: array items: $ref: '#/components/schemas/CurrentUserPermissions' readOnly: true PatchedGroup: type: object description: Serializer for :class:`Group` objects. properties: id: type: integer readOnly: true name: type: string maxLength: 150 users: type: array items: type: integer readOnly: true PatchedParameterPreset: type: object description: Serializer for :class:`ParameterPreset` model. properties: id: type: integer readOnly: true name: type: string maxLength: 100 created: type: string format: date-time readOnly: true modified: type: string format: date-time readOnly: true contributor: type: integer process: type: integer input_preset: {} PatchedPredictionField: type: object description: Serializer for PredictionField objects. properties: id: type: integer readOnly: true group: $ref: '#/components/schemas/RelationshipDict' name: type: string type: $ref: '#/components/schemas/PredictionFieldTypeEnum' version: type: string default: 0.0.0 description: type: string maxLength: 256 inputs: type: array items: $ref: '#/components/schemas/RelationshipDict' label: type: string maxLength: 128 required: type: boolean sort_order: type: integer maximum: 32767 minimum: 0 PatchedPredictionGroup: type: object description: Serializer for PredictionGroup objects. properties: id: type: integer readOnly: true name: type: string label: type: string maxLength: 128 sort_order: type: integer maximum: 32767 minimum: 0 PatchedPredictionPresetSerializerWithPermissions: type: object description: Serializer for PredictionPreset objects. properties: id: type: integer readOnly: true contributor: $ref: '#/components/schemas/Contributor' name: type: string fields: type: array items: type: integer current_user_permissions: type: array items: $ref: '#/components/schemas/CurrentUserPermissions' readOnly: true PatchedPredictionValue: type: object description: Serializer for PredictionValue objects. properties: created: type: string format: date-time readOnly: true id: type: integer readOnly: true entity: type: integer field: type: integer contributor: $ref: '#/components/schemas/Contributor' value: oneOf: - type: object properties: class_: type: string probability: type: number format: double required: - class_ - probability - type: object properties: score: type: number format: double required: - score description: Get the actual value. readOnly: true _value: writeOnly: true nullable: true title: ' value' PatchedRelation: type: object description: Serializer for Relation objects. properties: created: type: string format: date-time readOnly: true id: type: integer readOnly: true modified: type: string format: date-time readOnly: true descriptor_dirty: type: boolean readOnly: true contributor: $ref: '#/components/schemas/Contributor' type: type: string collection: $ref: '#/components/schemas/RelationshipDict' category: type: string maxLength: 100 partitions: type: array items: $ref: '#/components/schemas/RelationPartition' slug: type: string nullable: true unit: nullable: true oneOf: - $ref: '#/components/schemas/UnitEnum' - $ref: '#/components/schemas/BlankEnum' - $ref: '#/components/schemas/NullEnum' descriptor: {} descriptor_schema: allOf: - $ref: '#/components/schemas/RelationshipDict' nullable: true PatchedUser: type: object description: Serializer for :class:`User` objects. properties: id: type: integer readOnly: true first_name: type: string maxLength: 150 last_name: type: string maxLength: 150 job_title: type: string company: type: string department: type: string location: type: string lab: type: string phone_number: type: string maxLength: 128 username: type: string description: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. pattern: ^[\w.@+-]+$ maxLength: 150 password: type: string writeOnly: true maxLength: 128 email: type: string format: email maxLength: 254 community: type: string writeOnly: true date_joined: type: string format: date-time last_login: type: string format: date-time nullable: true PatchedUserDetails: type: object description: User model w/o password properties: pk: type: integer readOnly: true title: ID username: type: string description: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. pattern: ^[\w.@+-]+$ maxLength: 150 email: type: string format: email readOnly: true first_name: type: string maxLength: 150 last_name: type: string maxLength: 150 PatchedUserTag: type: object description: Serializer for :class:`UserTag` model. properties: id: type: integer readOnly: true user: type: string description: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. tag_word: type: string start: type: string format: date contributor: type: string description: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. created: type: string format: date-time readOnly: true nullable: true PatchedVariant: type: object description: Serializer for Variant objects. properties: id: type: integer readOnly: true species: type: string maxLength: 50 genome_assembly: type: string maxLength: 20 chromosome: type: string maxLength: 20 position: type: integer maximum: 9223372036854775807 minimum: 0 format: int64 reference: type: string alternative: type: string annotation: allOf: - $ref: '#/components/schemas/VariantAnnotation' nullable: true PatchedVariantCall: type: object description: Serializer for VariantCall objects. properties: id: type: integer readOnly: true sample: type: integer variant: type: integer nullable: true experiment: type: integer nullable: true data: type: integer nullable: true quality: type: number format: double nullable: true genotype_quality: type: integer maximum: 2147483647 minimum: 0 nullable: true depth: type: integer maximum: 2147483647 minimum: 0 nullable: true depth_norm_quality: type: number format: double nullable: true alternative_allele_depth: type: integer maximum: 2147483647 minimum: 0 nullable: true filter: type: string nullable: true maxLength: 20 genotype: type: string nullable: true maxLength: 3 PatchedVariantExperiment: type: object description: Serializer for VariantExperiment objects. properties: id: type: integer readOnly: true timestamp: type: string format: date-time readOnly: true contributor: $ref: '#/components/schemas/Contributor' variant_data_source: type: string maxLength: 100 Permission: type: object description: |- Permission serializer. Dictionary keys for users and groups are either ids or usernames (emails) or group names. properties: users: type: object additionalProperties: enum: - VIEW - EDIT - SHARE - OWNER type: string description: |- * `VIEW` - VIEW * `EDIT` - EDIT * `SHARE` - SHARE * `OWNER` - OWNER groups: type: object additionalProperties: enum: - VIEW - EDIT - SHARE - OWNER type: string description: |- * `VIEW` - VIEW * `EDIT` - EDIT * `SHARE` - SHARE * `OWNER` - OWNER public: $ref: '#/components/schemas/PublicEnum' PermissionsEnum: enum: - none - view - edit - share - owner type: string description: |- * `none` - none * `view` - view * `edit` - edit * `share` - share * `owner` - owner PersistenceEnum: enum: - RAW - CAC - TMP type: string description: |- * `RAW` - Raw * `CAC` - Cached * `TMP` - Temp PredictionField: type: object description: Serializer for PredictionField objects. properties: id: type: integer readOnly: true group: $ref: '#/components/schemas/RelationshipDict' name: type: string type: $ref: '#/components/schemas/PredictionFieldTypeEnum' version: type: string default: 0.0.0 description: type: string maxLength: 256 inputs: type: array items: $ref: '#/components/schemas/RelationshipDict' label: type: string maxLength: 128 required: type: boolean sort_order: type: integer maximum: 32767 minimum: 0 required: - description - group - id - inputs - label - sort_order - type PredictionFieldDict: type: object description: Serializer for actions that deal with prediction fields. properties: prediction_fields: type: array items: type: integer confirm_action: type: boolean default: false required: - prediction_fields PredictionFieldTypeEnum: enum: - SCORE - CLASS type: string description: |- * `SCORE` - SCORE * `CLASS` - CLASS PredictionGroup: type: object description: Serializer for PredictionGroup objects. properties: id: type: integer readOnly: true name: type: string label: type: string maxLength: 128 sort_order: type: integer maximum: 32767 minimum: 0 required: - id - label - sort_order PredictionPresetSerializerWithPermissions: type: object description: Serializer for PredictionPreset objects. properties: id: type: integer readOnly: true contributor: $ref: '#/components/schemas/Contributor' name: type: string fields: type: array items: type: integer current_user_permissions: type: array items: $ref: '#/components/schemas/CurrentUserPermissions' readOnly: true required: - contributor - current_user_permissions - id PredictionValue: type: object description: Serializer for PredictionValue objects. properties: created: type: string format: date-time readOnly: true id: type: integer readOnly: true entity: type: integer field: type: integer contributor: $ref: '#/components/schemas/Contributor' value: oneOf: - type: object properties: class_: type: string probability: type: number format: double required: - class_ - probability - type: object properties: score: type: number format: double required: - score description: Get the actual value. readOnly: true _value: writeOnly: true nullable: true title: ' value' required: - contributor - created - entity - field - id - value PredictionsByPath: type: object description: Serializer that reads prediction field and its value. properties: field_path: type: string maxLength: 257 value: nullable: true required: - field_path - value Process: type: object description: Process serializer. properties: id: type: integer readOnly: true slug: type: string maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ name: type: string maxLength: 100 description: type: string category: type: string pattern: ^([a-zA-Z0-9]+[:\-])*[a-zA-Z0-9]+:$ maxLength: 200 required: - id - name - slug ProcessSerializerWithPermissions: type: object description: Serializer for Process objects. properties: created: type: string format: date-time readOnly: true id: type: integer readOnly: true modified: type: string format: date-time readOnly: true is_active: type: boolean readOnly: true title: Active category: type: string pattern: ^([a-zA-Z0-9]+[:\-])*[a-zA-Z0-9]+:$ maxLength: 200 contributor: $ref: '#/components/schemas/Contributor' data_name: type: string nullable: true maxLength: 200 description: type: string entity_always_create: type: boolean entity_input: type: string nullable: true maxLength: 100 entity_type: type: string nullable: true maxLength: 100 input_schema: {} name: type: string output_schema: {} persistence: $ref: '#/components/schemas/PersistenceEnum' requirements: {} run: {} scheduling_class: $ref: '#/components/schemas/SchedulingClassEnum' slug: type: string nullable: true type: type: string pattern: ^data:[a-z0-9:]+:$ maxLength: 100 version: type: string default: 0.0.0 current_user_permissions: type: array items: $ref: '#/components/schemas/CurrentUserPermissions' readOnly: true required: - contributor - created - current_user_permissions - id - is_active - modified - type Project: type: object description: BaseSpace project entity serializer. properties: id: type: string name: type: string required: - id - name Projects: type: object description: BaseSpace projects serializer. properties: displayed_count: type: integer default: 0 total_count: type: integer default: 0 items: type: array items: $ref: '#/components/schemas/Project' PublicEnum: enum: - VIEW - EDIT - SHARE - OWNER type: string description: |- * `VIEW` - VIEW * `EDIT` - EDIT * `SHARE` - SHARE * `OWNER` - OWNER ReSDKMinimalSupportedVersion: type: object description: Serialize minimal supporter resdk version. properties: minimal_supported_version: type: string readOnly: true required: - minimal_supported_version Relation: type: object description: Serializer for Relation objects. properties: created: type: string format: date-time readOnly: true id: type: integer readOnly: true modified: type: string format: date-time readOnly: true descriptor_dirty: type: boolean readOnly: true contributor: $ref: '#/components/schemas/Contributor' type: type: string collection: $ref: '#/components/schemas/RelationshipDict' category: type: string maxLength: 100 partitions: type: array items: $ref: '#/components/schemas/RelationPartition' slug: type: string nullable: true unit: nullable: true oneOf: - $ref: '#/components/schemas/UnitEnum' - $ref: '#/components/schemas/BlankEnum' - $ref: '#/components/schemas/NullEnum' descriptor: {} descriptor_schema: allOf: - $ref: '#/components/schemas/RelationshipDict' nullable: true required: - category - collection - contributor - created - descriptor_dirty - id - modified - partitions - type RelationAttribute: type: object description: Relation attribute serializer. properties: attribute_type: type: string label: type: string relation_type: type: string relation_category: type: string required: - attribute_type - label - relation_category - relation_type RelationPartition: type: object description: Serializer for RelationPartition objects. properties: id: type: integer readOnly: true entity: type: integer position: type: integer maximum: 32767 minimum: 0 nullable: true label: type: string nullable: true maxLength: 30 required: - entity - id RelationTypeEnum: enum: - crossdb - ortholog - transcript - exon type: string description: |- * `crossdb` - Crossdb * `ortholog` - Ortholog * `transcript` - Transcript * `exon` - Exon RelationshipDict: type: object description: Serializer for the DictRelatedField relation. properties: id: type: integer slug: type: string nullable: true Resources: type: object description: Serialize the platform resource information. properties: max_memory: type: integer max_cores: type: integer max_storage: type: integer min_memory: type: integer min_cores: type: integer min_storage: type: integer RestAuthDetail: type: object properties: detail: type: string readOnly: true required: - detail Restart: type: object description: Serializer for restarting a Data object. properties: resource_overrides: {} Rose2: type: object description: Rose2 serializer. properties: id: type: integer readOnly: true slug: type: string maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ name: type: string maxLength: 100 created: type: string format: date-time readOnly: true output: {} required: - created - id - name - slug Sample: type: object description: Sample serializer. properties: sample_id: type: integer sample_name: type: string attribute: type: string required: - attribute - sample_id - sample_name SampleInBasket: type: object description: SampleInBasket serializer. properties: id: type: integer readOnly: true selected: type: boolean sample: $ref: '#/components/schemas/Entity' breadcrumb: $ref: '#/components/schemas/BasketBreadcrumb' required: - breadcrumb - id - sample SampleTableDeserializer: type: object description: Serializer for parsing sample table endpoint input. properties: annotation_version: allOf: - $ref: '#/components/schemas/AnnotationVersionEnum' default: v2 sample_ids: type: array items: type: integer table_column_ids: type: array items: type: integer required: - sample_ids - table_column_ids SchedulingClassEnum: enum: - IN - BA type: string description: |- * `IN` - Interactive * `BA` - Batch SearchTableFileColumn: type: object description: Serializer for :class:`SearchTableFileColumn` objects. properties: id: type: integer readOnly: true type: type: string label: type: string file_path: type: string action: $ref: '#/components/schemas/ActionEnum' column_name: type: string exclude_builds: type: array items: type: string required: - id - label SingleUserDataUsage: type: object description: Serializer for data/sample usage of a user. properties: user_id: type: integer username: type: string full_name: type: string data_size: type: number format: double data_count: type: integer sample_count: type: integer collection_count: type: integer single: type: boolean writeOnly: true default: true required: - collection_count - data_count - data_size - full_name - sample_count - user_id - username Statistics: type: object description: Statistics serializer. properties: name: type: string expression: type: number format: double sterr: type: number format: double type: type: string required: - expression - name - sterr - type Storage: type: object description: Serializer for Storage objects. properties: created: type: string format: date-time readOnly: true id: type: integer readOnly: true modified: type: string format: date-time readOnly: true contributor: $ref: '#/components/schemas/Contributor' data: type: array items: type: integer json: {} name: type: string slug: type: string nullable: true required: - contributor - created - data - id - json - modified SubTypeEnum: enum: - protein-coding - pseudo - rRNA - ncRNA - snRNA - snoRNA - tRNA - asRNA - other - unknown type: string description: |- * `protein-coding` - Protein-coding * `pseudo` - Pseudo * `rRNA` - rRNA * `ncRNA` - ncRNA * `snRNA` - snRNA * `snoRNA` - snoRNA * `tRNA` - tRNA * `asRNA` - asRNA * `other` - Other * `unknown` - Unknown UnitEnum: enum: - s - min - hr - d - wk type: string description: |- * `s` - Second * `min` - Minute * `hr` - Hour * `d` - Day * `wk` - Week UploadConfig: type: object description: Serializer for upload configuration. properties: type: type: string config: type: object additionalProperties: {} required: - config - type UploadCredentials: type: object description: Serializer for upload credentials. properties: AccessKeyId: type: string SecretAccessKey: type: string Token: type: string Expiration: type: string format: date-time required: - AccessKeyId - Expiration - SecretAccessKey - Token Url: type: object description: BaseSpace url serializer. properties: url: type: string format: uri required: - url User: type: object description: Serializer for :class:`User` objects. properties: id: type: integer readOnly: true first_name: type: string maxLength: 150 last_name: type: string maxLength: 150 job_title: type: string company: type: string department: type: string location: type: string lab: type: string phone_number: type: string maxLength: 128 username: type: string description: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. pattern: ^[\w.@+-]+$ maxLength: 150 password: type: string writeOnly: true maxLength: 128 email: type: string format: email maxLength: 254 community: type: string writeOnly: true date_joined: type: string format: date-time last_login: type: string format: date-time nullable: true required: - email - id - password - username UserDataUsage: type: object description: Serializer for data/sample usage per user with normalized fields too. properties: user_id: type: integer username: type: string full_name: type: string data_size: type: number format: double data_count: type: integer sample_count: type: integer collection_count: type: integer single: type: boolean writeOnly: true default: false data_size_normalized: type: number format: double data_count_normalized: type: number format: double sample_count_normalized: type: number format: double collection_count_normalized: type: number format: double required: - collection_count - collection_count_normalized - data_count - data_count_normalized - data_size - data_size_normalized - full_name - sample_count - sample_count_normalized - user_id - username UserDataUsagePolymorphic: oneOf: - $ref: '#/components/schemas/SingleUserDataUsage' - $ref: '#/components/schemas/UserDataUsage' discriminator: propertyName: single mapping: false: '#/components/schemas/UserDataUsage' UserDetails: type: object description: User model w/o password properties: pk: type: integer readOnly: true title: ID username: type: string description: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. pattern: ^[\w.@+-]+$ maxLength: 150 email: type: string format: email readOnly: true first_name: type: string maxLength: 150 last_name: type: string maxLength: 150 required: - email - pk - username UserTag: type: object description: Serializer for :class:`UserTag` model. properties: id: type: integer readOnly: true user: type: string description: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. tag_word: type: string start: type: string format: date contributor: type: string description: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. created: type: string format: date-time readOnly: true nullable: true required: - contributor - created - id - tag_word - user Variant: type: object description: Serializer for Variant objects. properties: id: type: integer readOnly: true species: type: string maxLength: 50 genome_assembly: type: string maxLength: 20 chromosome: type: string maxLength: 20 position: type: integer maximum: 9223372036854775807 minimum: 0 format: int64 reference: type: string alternative: type: string annotation: allOf: - $ref: '#/components/schemas/VariantAnnotation' nullable: true required: - alternative - chromosome - genome_assembly - id - position - reference - species VariantAnnotation: type: object description: Serializer for VariantAnnotation objects. properties: id: type: integer readOnly: true variant_id: type: integer readOnly: true type: nullable: true oneOf: - $ref: '#/components/schemas/VariantAnnotationTypeEnum' - $ref: '#/components/schemas/BlankEnum' - $ref: '#/components/schemas/NullEnum' clinical_diagnosis: type: string nullable: true clinical_significance: type: string nullable: true maxLength: 100 dbsnp_id: type: string nullable: true maxLength: 150 clinvar_id: type: string nullable: true maxLength: 150 transcripts: type: array items: $ref: '#/components/schemas/VariantTranscript' required: - id - variant_id VariantAnnotationTypeEnum: enum: - SNP - INDEL - MIXED - MNP - SYMBOLIC type: string description: |- * `SNP` - SNP * `INDEL` - INDEL * `MIXED` - MIXED * `MNP` - MNP * `SYMBOLIC` - SYMBOLIC VariantCall: type: object description: Serializer for VariantCall objects. properties: id: type: integer readOnly: true sample: type: integer variant: type: integer nullable: true experiment: type: integer nullable: true data: type: integer nullable: true quality: type: number format: double nullable: true genotype_quality: type: integer maximum: 2147483647 minimum: 0 nullable: true depth: type: integer maximum: 2147483647 minimum: 0 nullable: true depth_norm_quality: type: number format: double nullable: true alternative_allele_depth: type: integer maximum: 2147483647 minimum: 0 nullable: true filter: type: string nullable: true maxLength: 20 genotype: type: string nullable: true maxLength: 3 required: - id - sample VariantExperiment: type: object description: Serializer for VariantExperiment objects. properties: id: type: integer readOnly: true timestamp: type: string format: date-time readOnly: true contributor: $ref: '#/components/schemas/Contributor' variant_data_source: type: string maxLength: 100 required: - contributor - id - timestamp - variant_data_source VariantTranscript: type: object description: Serializer for VariantAnnotationTranscript objects. properties: id: type: integer readOnly: true variant_annotation_id: type: integer readOnly: true annotation: type: string annotation_impact: type: string maxLength: 20 gene: type: string maxLength: 100 protein_impact: type: string maxLength: 100 transcript_id: type: string maxLength: 200 canonical: type: boolean required: - annotation - annotation_impact - gene - id - protein_impact - transcript_id - variant_annotation_id Versions: type: object properties: resolwe: type: string readOnly: true resolwe-bio: type: string readOnly: true genialis-bio: type: string readOnly: true required: - genialis-bio - resolwe - resolwe-bio securitySchemes: cookieAuth: type: apiKey in: cookie name: sessionid