swagger: '2.0'
info:
  version: 1.0.0
  title: CMI-PB API
  description: This is a dynamic API generated by PostgREST
host: 'staging.cmi-pb.org:443'
basePath: /db
schemes:
  - https
consumes:
  - application/json
  - application/vnd.pgrst.object+json
  - text/csv
produces:
  - application/json
  - application/vnd.pgrst.object+json
  - text/csv
paths:
  /:
    get:
      tags:
        - Introspection
      summary: OpenAPI description (this document)
      produces:
        - application/openapi+json
        - application/json
      responses:
        '200':
          description: OK
  /ab_titer:
    get:
      tags:
        - ab_titer
      summary: 'Each row represents a sample (sample_id) along with the names and values for measured analytes (isotype, is_antigen_specific, antigen, ab_titer, unit and lower_limit_of_detection) for antibody titer experiment.'
      parameters:
        - $ref: '#/parameters/rowFilter.ab_titer.sample_id'
        - $ref: '#/parameters/rowFilter.ab_titer.isotype'
        - $ref: '#/parameters/rowFilter.ab_titer.is_antigen_specific'
        - $ref: '#/parameters/rowFilter.ab_titer.antigen'
        - $ref: '#/parameters/rowFilter.ab_titer.ab_titer'
        - $ref: '#/parameters/rowFilter.ab_titer.unit'
        - $ref: '#/parameters/rowFilter.ab_titer.lower_limit_of_detection'
        - $ref: '#/parameters/select'
        - $ref: '#/parameters/order'
        - $ref: '#/parameters/range'
        - $ref: '#/parameters/rangeUnit'
        - $ref: '#/parameters/offset'
        - $ref: '#/parameters/limit'
        - $ref: '#/parameters/preferCount'
      responses:
        '200':
          schema:
            items:
              $ref: '#/definitions/ab_titer'
            type: array
          description: OK
        '206':
          description: Partial Content
  /cell_type:
    get:
      tags:
        - cell_type
      summary: Each row represents a cell population name (cell_type_name) along with the gating information (gating_definition and gating_method).
      parameters:
        - $ref: '#/parameters/rowFilter.cell_type.cell_type_name'
        - $ref: '#/parameters/rowFilter.cell_type.gating_definition'
        - $ref: '#/parameters/rowFilter.cell_type.gating_method'
        - $ref: '#/parameters/select'
        - $ref: '#/parameters/order'
        - $ref: '#/parameters/range'
        - $ref: '#/parameters/rangeUnit'
        - $ref: '#/parameters/offset'
        - $ref: '#/parameters/limit'
        - $ref: '#/parameters/preferCount'
      responses:
        '200':
          schema:
            items:
              $ref: '#/definitions/cell_type'
            type: array
          description: OK
        '206':
          description: Partial Content
  /cytof:
    get:
      tags:
        - cytof
      summary: Each row represents a sample (sample_id) along with the names and values for measured analytes (cell_type_name and percent_live_cell) for mass cytometry experiment.
      parameters:
        - $ref: '#/parameters/rowFilter.cytof.sample_id'
        - $ref: '#/parameters/rowFilter.cytof.cell_type_name'
        - $ref: '#/parameters/rowFilter.cytof.percent_live_cell'
        - $ref: '#/parameters/select'
        - $ref: '#/parameters/order'
        - $ref: '#/parameters/range'
        - $ref: '#/parameters/rangeUnit'
        - $ref: '#/parameters/offset'
        - $ref: '#/parameters/limit'
        - $ref: '#/parameters/preferCount'
      responses:
        '200':
          schema:
            items:
              $ref: '#/definitions/cytof'
            type: array
          description: OK
        '206':
          description: Partial Content
  /cytof_file_info:
    get:
      tags:
        - cytof_file_info
      summary: Each row represents a sample (sample_id) along with corresponding flow cytometry experiment datafile name.
      parameters:
        - $ref: '#/parameters/rowFilter.cytof_file_info.sample_id'
        - $ref: '#/parameters/rowFilter.cytof_file_info.ftp_url'
        - $ref: '#/parameters/select'
        - $ref: '#/parameters/order'
        - $ref: '#/parameters/range'
        - $ref: '#/parameters/rangeUnit'
        - $ref: '#/parameters/offset'
        - $ref: '#/parameters/limit'
        - $ref: '#/parameters/preferCount'
      responses:
        '200':
          schema:
            items:
              $ref: '#/definitions/cytof_file_info'
            type: array
          description: OK
        '206':
          description: Partial Content
  /ensembl_gene:
    get:
      tags:
        - ensembl_gene
      summary: Allows transcripts to be related to genes.
      parameters:
        - $ref: '#/parameters/rowFilter.ensembl_gene.versioned_ensembl_gene_id'
        - $ref: '#/parameters/rowFilter.ensembl_gene.biotype'
        - $ref: '#/parameters/rowFilter.ensembl_gene.seq_region_start'
        - $ref: '#/parameters/rowFilter.ensembl_gene.seq_region_end'
        - $ref: '#/parameters/rowFilter.ensembl_gene.seq_region_strand'
        - $ref: '#/parameters/rowFilter.ensembl_gene.description'
        - $ref: '#/parameters/select'
        - $ref: '#/parameters/order'
        - $ref: '#/parameters/range'
        - $ref: '#/parameters/rangeUnit'
        - $ref: '#/parameters/offset'
        - $ref: '#/parameters/limit'
        - $ref: '#/parameters/preferCount'
      responses:
        '200':
          schema:
            items:
              $ref: '#/definitions/ensembl_gene'
            type: array
          description: OK
        '206':
          description: Partial Content
  /ensembl_transcript:
    get:
      tags:
        - ensembl_transcript
      summary: 'Stores information about transcripts. Has seq_region_start, seq_region_end and seq_region_strand for faster retrieval and to allow storage independently of genes and exons. Note that a transcript is usually associated with a translation, but may not be, e.g. in the case of pseudogenes and RNA genes (those that code for RNA molecules).'
      parameters:
        - $ref: '#/parameters/rowFilter.ensembl_transcript.versioned_ensembl_transcript_id'
        - $ref: '#/parameters/rowFilter.ensembl_transcript.versioned_ensembl_gene_id'
        - $ref: '#/parameters/rowFilter.ensembl_transcript.biotype'
        - $ref: '#/parameters/rowFilter.ensembl_transcript.seq_region_start'
        - $ref: '#/parameters/rowFilter.ensembl_transcript.seq_region_end'
        - $ref: '#/parameters/rowFilter.ensembl_transcript.seq_region_strand'
        - $ref: '#/parameters/select'
        - $ref: '#/parameters/order'
        - $ref: '#/parameters/range'
        - $ref: '#/parameters/rangeUnit'
        - $ref: '#/parameters/offset'
        - $ref: '#/parameters/limit'
        - $ref: '#/parameters/preferCount'
      responses:
        '200':
          schema:
            items:
              $ref: '#/definitions/ensembl_transcript'
            type: array
          description: OK
        '206':
          description: Partial Content
  /ensembl_translation:
    get:
      tags:
        - ensembl_translation
      summary: Describes which parts of which exons are used in translation. Transcripts are related to translations by the transcript_id key in this table.
      parameters:
        - $ref: '#/parameters/rowFilter.ensembl_translation.versioned_ensembl_translation_id'
        - $ref: '#/parameters/rowFilter.ensembl_translation.versioned_ensembl_transcript_id'
        - $ref: '#/parameters/rowFilter.ensembl_translation.seq_start'
        - $ref: '#/parameters/rowFilter.ensembl_translation.seq_end'
        - $ref: '#/parameters/select'
        - $ref: '#/parameters/order'
        - $ref: '#/parameters/range'
        - $ref: '#/parameters/rangeUnit'
        - $ref: '#/parameters/offset'
        - $ref: '#/parameters/limit'
        - $ref: '#/parameters/preferCount'
      responses:
        '200':
          schema:
            items:
              $ref: '#/definitions/ensembl_translation'
            type: array
          description: OK
        '206':
          description: Partial Content
  /olink_prot_exp:
    get:
      tags:
        - olink_prot_exp
      summary: 'Each row represents an Olink protein identifer (olink_id) along with sample id (sample_id) and values for measured analytes (npx_protein_expression, npx_limit_of_detection and npx_quality_control).'
      parameters:
        - $ref: '#/parameters/rowFilter.olink_prot_exp.sample_id'
        - $ref: '#/parameters/rowFilter.olink_prot_exp.olink_id'
        - $ref: '#/parameters/rowFilter.olink_prot_exp.npx_protein_expression'
        - $ref: '#/parameters/rowFilter.olink_prot_exp.npx_limit_of_detection'
        - $ref: '#/parameters/rowFilter.olink_prot_exp.npx_quality_control'
        - $ref: '#/parameters/select'
        - $ref: '#/parameters/order'
        - $ref: '#/parameters/range'
        - $ref: '#/parameters/rangeUnit'
        - $ref: '#/parameters/offset'
        - $ref: '#/parameters/limit'
        - $ref: '#/parameters/preferCount'
      responses:
        '200':
          schema:
            items:
              $ref: '#/definitions/olink_prot_exp'
            type: array
          description: OK
        '206':
          description: Partial Content
  /olink_prot_info:
    get:
      tags:
        - olink_prot_info
      summary: A metadata table having information of mapped Olink Proteomics database identifier with the corresponding UniProt database identifier.
      parameters:
        - $ref: '#/parameters/rowFilter.olink_prot_info.uniprot_id'
        - $ref: '#/parameters/rowFilter.olink_prot_info.olink_id'
        - $ref: '#/parameters/select'
        - $ref: '#/parameters/order'
        - $ref: '#/parameters/range'
        - $ref: '#/parameters/rangeUnit'
        - $ref: '#/parameters/offset'
        - $ref: '#/parameters/limit'
        - $ref: '#/parameters/preferCount'
      responses:
        '200':
          schema:
            items:
              $ref: '#/definitions/olink_prot_info'
            type: array
          description: OK
        '206':
          description: Partial Content
  /rnaseq:
    get:
      tags:
        - rnaseq
      summary: Each row represents an ensembl gene identifier (versioned_ensembl_gene_id) along with sample id (sample_id) and values for measured analytes (raw_count and tpm_count).
      parameters:
        - $ref: '#/parameters/rowFilter.rnaseq.versioned_ensembl_gene_id'
        - $ref: '#/parameters/rowFilter.rnaseq.sample_id'
        - $ref: '#/parameters/rowFilter.rnaseq.raw_count'
        - $ref: '#/parameters/rowFilter.rnaseq.tpm'
        - $ref: '#/parameters/select'
        - $ref: '#/parameters/order'
        - $ref: '#/parameters/range'
        - $ref: '#/parameters/rangeUnit'
        - $ref: '#/parameters/offset'
        - $ref: '#/parameters/limit'
        - $ref: '#/parameters/preferCount'
      responses:
        '200':
          schema:
            items:
              $ref: '#/definitions/rnaseq'
            type: array
          description: OK
        '206':
          description: Partial Content
  /sample:
    get:
      tags:
        - sample
      summary: 'Each row represents a clinical sample eg. blood (sample_id) for a subject (subject_id) at the particular visit. Additionally, information about nth visit (visit), sample type eg. blood (sample_type), days count relative to the boost (days_relative_to_boost) are provided.'
      parameters:
        - $ref: '#/parameters/rowFilter.sample.sample_id'
        - $ref: '#/parameters/rowFilter.sample.subject_id'
        - $ref: '#/parameters/rowFilter.sample.days_relative_to_boost'
        - $ref: '#/parameters/rowFilter.sample.sample_type'
        - $ref: '#/parameters/rowFilter.sample.visit'
        - $ref: '#/parameters/select'
        - $ref: '#/parameters/order'
        - $ref: '#/parameters/range'
        - $ref: '#/parameters/rangeUnit'
        - $ref: '#/parameters/offset'
        - $ref: '#/parameters/limit'
        - $ref: '#/parameters/preferCount'
      responses:
        '200':
          schema:
            items:
              $ref: '#/definitions/sample'
            type: array
          description: OK
        '206':
          description: Partial Content
  /subject:
    get:
      tags:
        - subject
      summary: 'Each row in this table is one subject. Subject is described with 8 parameters that include unique identification (subject_id), infancy vaccination status (infancy_vac), TDaP (tetanus, diphtheria, and acellular pertussis) vaccination booster date (date_of_boost), identification for the study (study_name), year of birth, biological sex, ethnicity and race.'
      parameters:
        - $ref: '#/parameters/rowFilter.subject.subject_id'
        - $ref: '#/parameters/rowFilter.subject.infancy_vac'
        - $ref: '#/parameters/rowFilter.subject.biological_sex'
        - $ref: '#/parameters/rowFilter.subject.ethnicity'
        - $ref: '#/parameters/rowFilter.subject.race'
        - $ref: '#/parameters/rowFilter.subject.year_of_birth'
        - $ref: '#/parameters/rowFilter.subject.date_of_boost'
        - $ref: '#/parameters/rowFilter.subject.study_name'
        - $ref: '#/parameters/select'
        - $ref: '#/parameters/order'
        - $ref: '#/parameters/range'
        - $ref: '#/parameters/rangeUnit'
        - $ref: '#/parameters/offset'
        - $ref: '#/parameters/limit'
        - $ref: '#/parameters/preferCount'
      responses:
        '200':
          schema:
            items:
              $ref: '#/definitions/subject'
            type: array
          description: OK
        '206':
          description: Partial Content
definitions:
  ab_titer:
    description: 'Each row represents a sample (sample_id) along with the names and values for measured analytes (isotype, is_antigen_specific, antigen, ab_titer, unit and lower_limit_of_detection) for antibody titer experiment.'
    properties:
      sample_id:
        format: integer
        type: integer
        description: |-
          Primary key, internal identifier. Also, Foreign key to the ensembl_gene table.

          Note:
          This is a Primary Key.<pk/>
      isotype:
        format: character varying
        type: string
        description: |-
          Name of immunoglobulin isotype.

          Note:
          This is a Primary Key.<pk/>
      is_antigen_specific:
        format: boolean
        type: boolean
        description: Boolean value for whether antibody titer is specific to an antigen or it is total antibody titer.
      antigen:
        format: character varying
        type: string
        description: |-
          Name of antigen.

          Note:
          This is a Primary Key.<pk/>
      ab_titer:
        format: double precision
        type: number
        description: Ab titer score/value.
      unit:
        format: character varying
        type: string
        description: |-
          Unit of antibody titer. Eg. IU/ML

          Note:
          This is a Primary Key.<pk/>
      lower_limit_of_detection:
        format: double precision
        type: number
        description: The lower limit of detection for determining antibody titer (ab_titer) value.
    type: object
  cell_type:
    description: Each row represents a cell population name (cell_type_name) along with the gating information (gating_definition and gating_method).
    properties:
      cell_type_name:
        format: character varying
        type: string
        description: |-
          Primary key, internal identifier.

          Note:
          This is a Primary Key.<pk/>
      gating_definition:
        format: character varying
        type: string
        description: Gating definition.
      gating_method:
        format: character varying
        type: string
        description: Whether automatic or manual gating method is used.
    type: object
  cytof:
    description: Each row represents a sample (sample_id) along with the names and values for measured analytes (cell_type_name and percent_live_cell) for mass cytometry experiment.
    properties:
      sample_id:
        format: integer
        type: integer
        description: |-
          Primary key, internal identifier. Also, Foreign key to the sample table.

          Note:
          This is a Primary Key.<pk/>
      cell_type_name:
        format: character varying
        type: string
        description: |-
          Primary key, internal identifier. The name of characterised cell populations. Foreign key to the cell_type table.

          Note:
          This is a Primary Key.<pk/>
      percent_live_cell:
        format: double precision
        type: number
        description: The percentage score/value of each cell type.
    type: object
  cytof_file_info:
    description: Each row represents a sample (sample_id) along with corresponding flow cytometry experiment datafile name.
    properties:
      sample_id:
        format: integer
        type: integer
        description: |-
          Primary key. Also, Foreign key references to the sample table.

          Note:
          This is a Primary Key.<pk/>
      ftp_url:
        format: character varying
        type: string
        description: Corresponding FCS data file name.
    type: object
  ensembl_gene:
    description: Allows transcripts to be related to genes.
    properties:
      versioned_ensembl_gene_id:
        format: character varying
        type: string
        description: |-
          Release-independent stable identifier along with stable identifier version number.

          Note:
          This is a Primary Key.<pk/>
      biotype:
        format: character varying
        type: string
        description: 'Biotype, e.g. protein_coding.'
      seq_region_start:
        format: integer
        type: integer
        description: Sequence start position.
      seq_region_end:
        format: integer
        type: integer
        description: Sequence end position.
      seq_region_strand:
        format: integer
        type: integer
        description: 'Sequence region strand: 1 - forward; -1 - reverse.'
      description:
        format: character varying
        type: string
        description: Gene description.
    type: object
  ensembl_transcript:
    description: 'Stores information about transcripts. Has seq_region_start, seq_region_end and seq_region_strand for faster retrieval and to allow storage independently of genes and exons. Note that a transcript is usually associated with a translation, but may not be, e.g. in the case of pseudogenes and RNA genes (those that code for RNA molecules).'
    properties:
      versioned_ensembl_transcript_id:
        format: character varying
        type: string
        description: |-
          Primary key, internal identifier. Release-independent stable identifier from ensebml database with stable identifier version number

          Note:
          This is a Primary Key.<pk/>
      versioned_ensembl_gene_id:
        format: character varying
        type: string
        description: |-
          Primary key, internal identifier. Release-independent stable identifier from ensebml database with stable identifier version number.

          Note:
          This is a Primary Key.<pk/>
      biotype:
        format: character varying
        type: string
        description: 'Biotype, e.g. protein_coding.'
      seq_region_start:
        format: integer
        type: integer
        description: Sequence start position.
      seq_region_end:
        format: integer
        type: integer
        description: Sequence end position.
      seq_region_strand:
        format: integer
        type: integer
        description: 'Sequence region strand: 1 - forward; -1 - reverse.'
    type: object
  ensembl_translation:
    description: Describes which parts of which exons are used in translation. Transcripts are related to translations by the transcript_id key in this table.
    properties:
      versioned_ensembl_translation_id:
        format: character varying
        type: string
        description: |-
          Primary key, internal identifier. Release-independent ensebml stable identifier with stable identifier version number.

          Note:
          This is a Primary Key.<pk/>
      versioned_ensembl_transcript_id:
        format: character varying
        type: string
        description: Foreign key references to the ensembl_transcript table.
      seq_start:
        format: integer
        type: integer
        description: 1-based offset into the relative coordinate system.
      seq_end:
        format: integer
        type: integer
        description: 1-based offset into the relative coordinate system.
    type: object
  olink_prot_exp:
    description: 'Each row represents an Olink protein identifer (olink_id) along with sample id (sample_id) and values for measured analytes (npx_protein_expression, npx_limit_of_detection and npx_quality_control).'
    properties:
      sample_id:
        format: integer
        type: integer
        description: |-
          Primary key. Also, Foreign key references to the sample table.

          Note:
          This is a Primary Key.<pk/>
      olink_id:
        format: character varying
        type: string
        description: |-
          Foreign key references to the olink_prot_info table.

          Note:
          This is a Primary Key.<pk/>
      npx_protein_expression:
        format: double precision
        type: number
        description: 'NPX, Normalized Protein eXpression, is Olink’s arbitrary unit which is in Log2 scale.'
      npx_limit_of_detection:
        format: double precision
        type: number
        description: Limit of detection value provided by Olink Proteomics.
      npx_quality_control:
        format: character varying
        type: string
        description: Quality Control analysis result provided by Olink Proteomics.
    type: object
  olink_prot_info:
    description: A metadata table having information of mapped Olink Proteomics database identifier with the corresponding UniProt database identifier.
    properties:
      uniprot_id:
        format: character varying
        type: string
        description: |-
          Primary key, internal identifier. UniProt database identifier.

          Note:
          This is a Primary Key.<pk/>
      olink_id:
        format: character varying
        type: string
        description: |-
          Primary key, internal identifier. Olink Proteomics database identifier.

          Note:
          This is a Primary Key.<pk/>
    type: object
  rnaseq:
    description: Each row represents an ensembl gene identifier (versioned_ensembl_gene_id) along with sample id (sample_id) and values for measured analytes (raw_count and tpm_count).
    properties:
      versioned_ensembl_gene_id:
        format: character varying
        type: string
        description: |-
          Primary key, internal identifier. Also, Foreign key to the ensembl_gene table.

          Note:
          This is a Primary Key.<pk/>
      sample_id:
        format: integer
        type: integer
        description: |-
          Foreign key references to the sample table.

          Note:
          This is a Primary Key.<pk/>
      raw_count:
        format: integer
        type: integer
        description: Raw counts are simply the number of reads overlapping a given feature such as a gene. They are a proxy for the expression level of genes.
      tpm:
        format: double precision
        type: number
        description: 'Full form: Transcripts Per Kilobase Million. It is a unit of transcript expression and it should be read as - for every 1,000,000 RNA molecules in the RNA-seq sample, x came from this gene/transcript.'
    type: object
  sample:
    description: 'Each row represents a clinical sample eg. blood (sample_id) for a subject (subject_id) at the particular visit. Additionally, information about nth visit (visit), sample type eg. blood (sample_type), days count relative to the boost (days_relative_to_boost) are provided.'
    properties:
      sample_id:
        format: integer
        type: integer
        description: |-
          Primary key, internal identifier.

          Note:
          This is a Primary Key.<pk/>
      subject_id:
        format: integer
        type: integer
        description: Foreign key references to the subject table.
      days_relative_to_boost:
        format: integer
        type: integer
        description: Days-count between the date of TDaP vaccination booster mentioned in the subject table (date_of_boost) and the sample collection date.
      sample_type:
        format: character varying
        type: string
        description: Type of sample eg. blood.
      visit:
        format: integer
        type: integer
        description: nth visit of subject for sample submission.
    type: object
  subject:
    description: 'Each row in this table is one subject. Subject is described with 8 parameters that include unique identification (subject_id), infancy vaccination status (infancy_vac), TDaP (tetanus, diphtheria, and acellular pertussis) vaccination booster date (date_of_boost), identification for the study (study_name), year of birth, biological sex, ethnicity and race.'
    properties:
      subject_id:
        format: integer
        type: integer
        description: |-
          Primary key, internal identifier.

          Note:
          This is a Primary Key.<pk/>
      infancy_vac:
        maxLength: 2
        format: character varying
        type: string
        description: 'Infancy Pertussis vaccination information i.e., the whole-cell vaccine (wP) or the acellular vaccine (aP).'
      biological_sex:
        maxLength: 15
        format: character varying
        type: string
        description: Biological sex information.
      ethnicity:
        maxLength: 50
        format: character varying
        type: string
        description: Ethnicity information.
      race:
        maxLength: 50
        format: character varying
        type: string
        description: Race information.
      year_of_birth:
        format: date
        type: string
        description: Birth year information.
      date_of_boost:
        format: date
        type: string
        description: 'TDaP (Tetanus, Diphtheria, and acellular Pertussis) vaccination booster date.'
      study_name:
        maxLength: 50
        format: character varying
        type: string
        description: Identification for the study.
    type: object
parameters:
  preferParams:
    name: Prefer
    description: Preference
    required: false
    in: header
    type: string
    enum:
      - params=single-object
  preferReturn:
    name: Prefer
    description: Preference
    required: false
    in: header
    type: string
    enum:
      - return=representation
      - return=minimal
      - return=none
  preferCount:
    name: Prefer
    description: Preference
    required: false
    in: header
    type: string
    enum:
      - count=none
  select:
    name: select
    description: Filtering Columns
    required: false
    in: query
    type: string
  on_conflict:
    name: on_conflict
    description: On Conflict
    required: false
    in: query
    type: string
  order:
    name: order
    description: Ordering
    required: false
    in: query
    type: string
  range:
    name: Range
    description: Limiting and Pagination
    required: false
    in: header
    type: string
  rangeUnit:
    name: Range-Unit
    description: Limiting and Pagination
    required: false
    default: items
    in: header
    type: string
  offset:
    name: offset
    description: Limiting and Pagination
    required: false
    in: query
    type: string
  limit:
    name: limit
    description: Limiting and Pagination
    required: false
    in: query
    type: string
  body.ab_titer:
    name: ab_titer
    description: ab_titer
    required: false
    schema:
      $ref: '#/definitions/ab_titer'
    in: body
  rowFilter.ab_titer.sample_id:
    name: sample_id
    description: 'Primary key, internal identifier. Also, Foreign key to the ensembl_gene table.'
    required: false
    format: integer
    in: query
    type: string
  rowFilter.ab_titer.isotype:
    name: isotype
    description: Name of immunoglobulin isotype.
    required: false
    format: character varying
    in: query
    type: string
  rowFilter.ab_titer.is_antigen_specific:
    name: is_antigen_specific
    description: Boolean value for whether antibody titer is specific to an antigen or it is total antibody titer.
    required: false
    format: boolean
    in: query
    type: string
  rowFilter.ab_titer.antigen:
    name: antigen
    description: Name of antigen.
    required: false
    format: character varying
    in: query
    type: string
  rowFilter.ab_titer.ab_titer:
    name: ab_titer
    description: Ab titer score/value.
    required: false
    format: double precision
    in: query
    type: string
  rowFilter.ab_titer.unit:
    name: unit
    description: Unit of antibody titer. Eg. IU/ML
    required: false
    format: character varying
    in: query
    type: string
  rowFilter.ab_titer.lower_limit_of_detection:
    name: lower_limit_of_detection
    description: The lower limit of detection for determining antibody titer (ab_titer) value.
    required: false
    format: double precision
    in: query
    type: string
  body.cell_type:
    name: cell_type
    description: cell_type
    required: false
    schema:
      $ref: '#/definitions/cell_type'
    in: body
  rowFilter.cell_type.cell_type_name:
    name: cell_type_name
    description: 'Primary key, internal identifier.'
    required: false
    format: character varying
    in: query
    type: string
  rowFilter.cell_type.gating_definition:
    name: gating_definition
    description: Gating definition.
    required: false
    format: character varying
    in: query
    type: string
  rowFilter.cell_type.gating_method:
    name: gating_method
    description: Whether automatic or manual gating method is used.
    required: false
    format: character varying
    in: query
    type: string
  body.cytof:
    name: cytof
    description: cytof
    required: false
    schema:
      $ref: '#/definitions/cytof'
    in: body
  rowFilter.cytof.sample_id:
    name: sample_id
    description: 'Primary key, internal identifier. Also, Foreign key to the sample table.'
    required: false
    format: integer
    in: query
    type: string
  rowFilter.cytof.cell_type_name:
    name: cell_type_name
    description: 'Primary key, internal identifier. The name of characterised cell populations. Foreign key to the cell_type table.'
    required: false
    format: character varying
    in: query
    type: string
  rowFilter.cytof.percent_live_cell:
    name: percent_live_cell
    description: The percentage score/value of each cell type.
    required: false
    format: double precision
    in: query
    type: string
  body.cytof_file_info:
    name: cytof_file_info
    description: cytof_file_info
    required: false
    schema:
      $ref: '#/definitions/cytof_file_info'
    in: body
  rowFilter.cytof_file_info.sample_id:
    name: sample_id
    description: 'Primary key. Also, Foreign key references to the sample table.'
    required: false
    format: integer
    in: query
    type: string
  rowFilter.cytof_file_info.ftp_url:
    name: ftp_url
    description: Corresponding FCS data file name.
    required: false
    format: character varying
    in: query
    type: string
  body.ensembl_gene:
    name: ensembl_gene
    description: ensembl_gene
    required: false
    schema:
      $ref: '#/definitions/ensembl_gene'
    in: body
  rowFilter.ensembl_gene.versioned_ensembl_gene_id:
    name: versioned_ensembl_gene_id
    description: Release-independent stable identifier along with stable identifier version number.
    required: false
    format: character varying
    in: query
    type: string
  rowFilter.ensembl_gene.biotype:
    name: biotype
    description: 'Biotype, e.g. protein_coding.'
    required: false
    format: character varying
    in: query
    type: string
  rowFilter.ensembl_gene.seq_region_start:
    name: seq_region_start
    description: Sequence start position.
    required: false
    format: integer
    in: query
    type: string
  rowFilter.ensembl_gene.seq_region_end:
    name: seq_region_end
    description: Sequence end position.
    required: false
    format: integer
    in: query
    type: string
  rowFilter.ensembl_gene.seq_region_strand:
    name: seq_region_strand
    description: 'Sequence region strand: 1 - forward; -1 - reverse.'
    required: false
    format: integer
    in: query
    type: string
  rowFilter.ensembl_gene.description:
    name: description
    description: Gene description.
    required: false
    format: character varying
    in: query
    type: string
  body.ensembl_transcript:
    name: ensembl_transcript
    description: ensembl_transcript
    required: false
    schema:
      $ref: '#/definitions/ensembl_transcript'
    in: body
  rowFilter.ensembl_transcript.versioned_ensembl_transcript_id:
    name: versioned_ensembl_transcript_id
    description: 'Primary key, internal identifier. Release-independent stable identifier from ensebml database with stable identifier version number'
    required: false
    format: character varying
    in: query
    type: string
  rowFilter.ensembl_transcript.versioned_ensembl_gene_id:
    name: versioned_ensembl_gene_id
    description: 'Primary key, internal identifier. Release-independent stable identifier from ensebml database with stable identifier version number.'
    required: false
    format: character varying
    in: query
    type: string
  rowFilter.ensembl_transcript.biotype:
    name: biotype
    description: 'Biotype, e.g. protein_coding.'
    required: false
    format: character varying
    in: query
    type: string
  rowFilter.ensembl_transcript.seq_region_start:
    name: seq_region_start
    description: Sequence start position.
    required: false
    format: integer
    in: query
    type: string
  rowFilter.ensembl_transcript.seq_region_end:
    name: seq_region_end
    description: Sequence end position.
    required: false
    format: integer
    in: query
    type: string
  rowFilter.ensembl_transcript.seq_region_strand:
    name: seq_region_strand
    description: 'Sequence region strand: 1 - forward; -1 - reverse.'
    required: false
    format: integer
    in: query
    type: string
  body.ensembl_translation:
    name: ensembl_translation
    description: ensembl_translation
    required: false
    schema:
      $ref: '#/definitions/ensembl_translation'
    in: body
  rowFilter.ensembl_translation.versioned_ensembl_translation_id:
    name: versioned_ensembl_translation_id
    description: 'Primary key, internal identifier. Release-independent ensebml stable identifier with stable identifier version number.'
    required: false
    format: character varying
    in: query
    type: string
  rowFilter.ensembl_translation.versioned_ensembl_transcript_id:
    name: versioned_ensembl_transcript_id
    description: Foreign key references to the ensembl_transcript table.
    required: false
    format: character varying
    in: query
    type: string
  rowFilter.ensembl_translation.seq_start:
    name: seq_start
    description: 1-based offset into the relative coordinate system.
    required: false
    format: integer
    in: query
    type: string
  rowFilter.ensembl_translation.seq_end:
    name: seq_end
    description: 1-based offset into the relative coordinate system.
    required: false
    format: integer
    in: query
    type: string
  body.olink_prot_exp:
    name: olink_prot_exp
    description: olink_prot_exp
    required: false
    schema:
      $ref: '#/definitions/olink_prot_exp'
    in: body
  rowFilter.olink_prot_exp.sample_id:
    name: sample_id
    description: 'Primary key. Also, Foreign key references to the sample table.'
    required: false
    format: integer
    in: query
    type: string
  rowFilter.olink_prot_exp.olink_id:
    name: olink_id
    description: Foreign key references to the olink_prot_info table.
    required: false
    format: character varying
    in: query
    type: string
  rowFilter.olink_prot_exp.npx_protein_expression:
    name: npx_protein_expression
    description: 'NPX, Normalized Protein eXpression, is Olink’s arbitrary unit which is in Log2 scale.'
    required: false
    format: double precision
    in: query
    type: string
  rowFilter.olink_prot_exp.npx_limit_of_detection:
    name: npx_limit_of_detection
    description: Limit of detection value provided by Olink Proteomics.
    required: false
    format: double precision
    in: query
    type: string
  rowFilter.olink_prot_exp.npx_quality_control:
    name: npx_quality_control
    description: Quality Control analysis result provided by Olink Proteomics.
    required: false
    format: character varying
    in: query
    type: string
  body.olink_prot_info:
    name: olink_prot_info
    description: olink_prot_info
    required: false
    schema:
      $ref: '#/definitions/olink_prot_info'
    in: body
  rowFilter.olink_prot_info.uniprot_id:
    name: uniprot_id
    description: 'Primary key, internal identifier. UniProt database identifier.'
    required: false
    format: character varying
    in: query
    type: string
  rowFilter.olink_prot_info.olink_id:
    name: olink_id
    description: 'Primary key, internal identifier. Olink Proteomics database identifier.'
    required: false
    format: character varying
    in: query
    type: string
  body.rnaseq:
    name: rnaseq
    description: rnaseq
    required: false
    schema:
      $ref: '#/definitions/rnaseq'
    in: body
  rowFilter.rnaseq.versioned_ensembl_gene_id:
    name: versioned_ensembl_gene_id
    description: 'Primary key, internal identifier. Also, Foreign key to the ensembl_gene table.'
    required: false
    format: character varying
    in: query
    type: string
  rowFilter.rnaseq.sample_id:
    name: sample_id
    description: Foreign key references to the sample table.
    required: false
    format: integer
    in: query
    type: string
  rowFilter.rnaseq.raw_count:
    name: raw_count
    description: Raw counts are simply the number of reads overlapping a given feature such as a gene. They are a proxy for the expression level of genes.
    required: false
    format: integer
    in: query
    type: string
  rowFilter.rnaseq.tpm:
    name: tpm
    description: 'Full form: Transcripts Per Kilobase Million. It is a unit of transcript expression and it should be read as - for every 1,000,000 RNA molecules in the RNA-seq sample, x came from this gene/transcript.'
    required: false
    format: double precision
    in: query
    type: string
  body.sample:
    name: sample
    description: sample
    required: false
    schema:
      $ref: '#/definitions/sample'
    in: body
  rowFilter.sample.sample_id:
    name: sample_id
    description: 'Primary key, internal identifier.'
    required: false
    format: integer
    in: query
    type: string
  rowFilter.sample.subject_id:
    name: subject_id
    description: Foreign key references to the subject table.
    required: false
    format: integer
    in: query
    type: string
  rowFilter.sample.days_relative_to_boost:
    name: days_relative_to_boost
    description: Days-count between the date of TDaP vaccination booster mentioned in the subject table (date_of_boost) and the sample collection date.
    required: false
    format: integer
    in: query
    type: string
  rowFilter.sample.sample_type:
    name: sample_type
    description: Type of sample eg. blood.
    required: false
    format: character varying
    in: query
    type: string
  rowFilter.sample.visit:
    name: visit
    description: nth visit of subject for sample submission.
    required: false
    format: integer
    in: query
    type: string
  body.subject:
    name: subject
    description: subject
    required: false
    schema:
      $ref: '#/definitions/subject'
    in: body
  rowFilter.subject.subject_id:
    name: subject_id
    description: 'Primary key, internal identifier.'
    required: false
    format: integer
    in: query
    type: string
  rowFilter.subject.infancy_vac:
    name: infancy_vac
    description: 'Infancy Pertussis vaccination information i.e., the whole-cell vaccine (wP) or the acellular vaccine (aP).'
    required: false
    format: character varying
    in: query
    type: string
  rowFilter.subject.biological_sex:
    name: biological_sex
    description: Biological sex information.
    required: false
    format: character varying
    in: query
    type: string
  rowFilter.subject.ethnicity:
    name: ethnicity
    description: Ethnicity information.
    required: false
    format: character varying
    in: query
    type: string
  rowFilter.subject.race:
    name: race
    description: Race information.
    required: false
    format: character varying
    in: query
    type: string
  rowFilter.subject.year_of_birth:
    name: year_of_birth
    description: Birth year information.
    required: false
    format: date
    in: query
    type: string
  rowFilter.subject.date_of_boost:
    name: date_of_boost
    description: 'TDaP (Tetanus, Diphtheria, and acellular Pertussis) vaccination booster date.'
    required: false
    format: date
    in: query
    type: string
  rowFilter.subject.study_name:
    name: study_name
    description: Identification for the study.
    required: false
    format: character varying
    in: query
    type: string
externalDocs:
  url: 'https://postgrest.org/en/v7.0/api.html'
  description: PostgREST Documentation
