Class: Api::V2::SampleMetadataResource

Inherits:

BaseResource

• Object
• JSONAPI::Resource
• BaseResource
• Api::V2::SampleMetadataResource

Defined in:

app/resources/api/v2/sample_metadata_resource.rb

Overview

TODO:

This documentation does not yet include a detailed description of what this resource represents.

TODO:

This documentation does not yet include detailed descriptions for relationships, attributes and filters.

TODO:

This documentation does not yet include any example usage of the API via cURL or similar.

Note:

This resource is immutable: its endpoint will not accept POST, PATCH, or DELETE requests.

Note:

Access this resource via the /api/v2/sample_metadata/ endpoint.

Provides a JSON:API representation of Sample::Metadata.

For more information about JSON:API see the JSON:API Specifications or look at the JSONAPI::Resources package for Sequencescape’s implementation of the JSON:API standard.

Instance Attribute Summary

• #cohort ⇒ String

  The sample cohort.

• #collected_by ⇒ String

  The name of the body collecting the sample.

• #concentration ⇒ String

  The sample concentration.

• #donor_id ⇒ String

  The ID of the sample donor.

• #gender ⇒ String

  The gender of the organism providing the sample.

• #sample_common_name ⇒ String

  The common name for the sample.

• #sample_description ⇒ String

  A description of the sample.

• #supplier_name ⇒ String

  The supplier name for the sample.

• #volume ⇒ String

  The volume of the sample.

Method Summary

Methods inherited from BaseResource

apply_includes, creatable_fields, default_includes, #fetchable_fields, inclusions, resolve_relationship_names_to_relations, updatable_fields

Instance Attribute Details

#cohort ⇒ String

Returns the sample cohort.

Returns:

• (String) —

  the sample cohort.

# File 'app/resources/api/v2/sample_metadata_resource.rb', line 31

attribute :cohort

#collected_by ⇒ String

Returns the name of the body collecting the sample.

Returns:

• (String) —

  the name of the body collecting the sample.

# File 'app/resources/api/v2/sample_metadata_resource.rb', line 35

attribute :collected_by

#concentration ⇒ String

Returns the sample concentration.

Returns:

• (String) —

  the sample concentration.

# File 'app/resources/api/v2/sample_metadata_resource.rb', line 39

attribute :concentration

#donor_id ⇒ String

Returns the ID of the sample donor.

Returns:

• (String) —

  the ID of the sample donor.

# File 'app/resources/api/v2/sample_metadata_resource.rb', line 43

attribute :donor_id

#gender ⇒ String

Returns the gender of the organism providing the sample.

Returns:

• (String) —

  the gender of the organism providing the sample.

# File 'app/resources/api/v2/sample_metadata_resource.rb', line 47

attribute :gender

#sample_common_name ⇒ String

Returns the common name for the sample.

Returns:

• (String) —

  the common name for the sample.

# File 'app/resources/api/v2/sample_metadata_resource.rb', line 51

attribute :sample_common_name

#sample_description ⇒ String

Returns a description of the sample.

Returns:

• (String) —

  a description of the sample.

# File 'app/resources/api/v2/sample_metadata_resource.rb', line 55

attribute :sample_description

#supplier_name ⇒ String

Returns the supplier name for the sample.

Returns:

• (String) —

  the supplier name for the sample.

# File 'app/resources/api/v2/sample_metadata_resource.rb', line 59

attribute :supplier_name

#volume ⇒ String

Returns the volume of the sample.

Returns:

• (String) —

  the volume of the sample.

# File 'app/resources/api/v2/sample_metadata_resource.rb', line 63

attribute :volume