data_access_api.routers.schema
==============================

.. py:module:: data_access_api.routers.schema


Classes
-------

.. autoapisummary::

   data_access_api.routers.schema.CohortQueryInput
   data_access_api.routers.schema.DataframeQuery
   data_access_api.routers.schema.StatisticsResponse
   data_access_api.routers.schema.AccessionIdsResponse


Module Contents
---------------

.. py:class:: CohortQueryInput

   Bases: :py:obj:`pydantic.BaseModel`


   Represents the input for a cohort query.


   .. py:attribute:: encrypted_project_id
      :type:  str


   .. py:attribute:: query_id
      :type:  str


   .. py:attribute:: query_name
      :type:  str


   .. py:attribute:: query
      :type:  str


   .. py:attribute:: trust_id
      :type:  str


.. py:class:: DataframeQuery

   Bases: :py:obj:`pydantic.BaseModel`


   Represents the input for a dataframe query.


   .. py:attribute:: encrypted_project_id
      :type:  str


   .. py:attribute:: query
      :type:  str


.. py:class:: StatisticsResponse

   Bases: :py:obj:`pydantic.BaseModel`


   Represents the response for a statistics query.


   .. py:attribute:: query_id
      :type:  str


   .. py:attribute:: trust_id
      :type:  str


   .. py:attribute:: record_count
      :type:  int


   .. py:attribute:: created
      :type:  str


   .. py:attribute:: data
      :type:  list[dict[str, Any]]


   .. py:attribute:: suppressed
      :type:  bool
      :value: False



.. py:class:: AccessionIdsResponse

   Bases: :py:obj:`pydantic.BaseModel`


   Represents the response for an accession-ids query.


   .. py:attribute:: accession_ids
      :type:  list[str]