:py:mod:`rhino_health.lib.endpoints.data_schema.data_schema_endpoints`
======================================================================

.. py:module:: rhino_health.lib.endpoints.data_schema.data_schema_endpoints


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

Classes
~~~~~~~

.. autoapisummary::

   rhino_health.lib.endpoints.data_schema.data_schema_endpoints.DataSchemaEndpoints




.. py:class:: DataSchemaEndpoints(session)


   

















   ..
       !! processed by numpydoc !!
   .. py:method:: get_data_schema_by_name(name, version=VersionMode.LATEST, project_uid=None) -> Optional[rhino_health.lib.endpoints.data_schema.data_schema_dataclass.LTSDataSchema]

      
      Returns the latest or a specific DataSchema dataclass

      .. warning:: This feature is under development and the interface may change
      .. warning:: There is no uniqueness constraint on the name for data_schemas so you may not get the correct result
      .. warning:: VersionMode.ALL will return the same as VersionMode.LATEST

      :Parameters:

          **name: str**
              Full name for the DataSchema

          **version: Optional[Union[int, VersionMode]]**
              Version of the DataSchema, latest by default, for an earlier version pass in an integer

          **project_uid: Optional[str]**
              Project UID to search under

      :Returns:

          data_schema: Optional[DataSchema]
              DataSchema with the name or None if not found










      .. rubric:: Examples

      >>> session.data_schema.get_data_schema_by_name("My DataSchema")
      DataSchema("My DataSchema")



      ..
          !! processed by numpydoc !!

   .. py:method:: search_for_data_schemas_by_name(name: str, version: Optional[Union[int, rhino_health.lib.endpoints.endpoint.VersionMode]] = VersionMode.LATEST, project_uid: Optional[str] = None, name_filter_mode: Optional[rhino_health.lib.endpoints.endpoint.NameFilterMode] = NameFilterMode.CONTAINS)

      
      Returns DataSchema dataclasses

      .. warning:: This feature is under development and the interface may change

      :Parameters:

          **name: str**
              Full or partial name for the DataSchema

          **version: Optional[Union[int, VersionMode]]**
              Version of the DataSchema, latest by default

          **project_uid: Optional[str]**
              Project UID to search under

          **name_filter_mode: Optional[NameFilterMode]**
              Only return results with the specified filter mode. By default uses CONTAINS

      :Returns:

          data_schemas: List[DataSchema]
              DataSchema dataclasses that match the name







      .. seealso::

          
          :obj:`rhino_health.lib.endpoints.endpoint.FilterMode`
              Different modes to filter by
          :obj:`rhino_health.lib.endpoints.endpoint.VersionMode`
              Return specific versions
          
          


      .. rubric:: Examples

      >>> session.data_schema.search_for_data_schemas_by_name("My DataSchema")
      [DataSchema(name="My DataSchema")]



      ..
          !! processed by numpydoc !!

   .. py:method:: remove_data_schema(data_schema_uid: str)

      
      Removes a DataSchema with the DATASCHAMA_UID from the system

      .. warning:: This feature is under development and incomplete















      ..
          !! processed by numpydoc !!

   .. py:method:: get_data_schemas(data_schema_uids: Optional[List[str]] = None) -> List[rhino_health.lib.endpoints.data_schema.data_schema_dataclass.LTSDataSchema]

      

      Gets the Data Schemas with the specified DATA_SCHEMA_UIDS

      .. warning:: This feature is under development and the interface may change















      ..
          !! processed by numpydoc !!