Class: Api::V2::PolyMetadatumResource

Inherits:
BaseResource
  • Object
show all
Defined in:
app/resources/api/v2/poly_metadatum_resource.rb

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from BaseResource

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

Instance Attribute Details

#created_at ⇒ DateTime (readonly)

The timestamp indicating when this metadata entry was created.

Returns:

  • (DateTime) —

    The creation time of the metadata record.


71
 
# File 'app/resources/api/v2/poly_metadatum_resource.rb', line 71

attribute :created_at, readonly: true

#key ⇒ String

Note:

This is a required attribute and must be unqiue for each metadatable object.

The key or name of the metadata.

Returns:

  • (String) —

    The metadata key.


60
 
# File 'app/resources/api/v2/poly_metadatum_resource.rb', line 60

attribute :key

#metadatable ⇒ ApplicationRecord

Note:

This is a required relationship.

Note:

The given metadata must exist

The resource that this metadata belongs to. This is a polymorphic association, it can be associated with multiple different models (e.g., Well, Sample).

Returns:


89
 
# File 'app/resources/api/v2/poly_metadatum_resource.rb', line 89

has_one :metadatable, polymorphic: true

#updated_at ⇒ DateTime (readonly)

The timestamp indicating when this metadata entry was last updated.

Returns:

  • (DateTime) —

    The last modification time of the metadata record.


76
 
# File 'app/resources/api/v2/poly_metadatum_resource.rb', line 76

attribute :updated_at, readonly: true

#value ⇒ String

Note:

This is a required attribute

The value stored under the metadata key.

Returns:

  • (String) —

    The metadata value.


66
 
# File 'app/resources/api/v2/poly_metadatum_resource.rb', line 66

attribute :value

Instance Method Details

#filter_by_key ⇒ Object

Filters metadata records based on their key.

Examples:

GET request to retrieve metadata with a specific key

GET /api/v2/poly_metadata?filter[key]=sample_type
[View source]

99
 
# File 'app/resources/api/v2/poly_metadatum_resource.rb', line 99

filter :key

#filter_by_metadatable_id ⇒ Object

Filters metadata records based on the associated resource's ID.

Examples:

GET request to retrieve metadata associated with a specific resource

GET /api/v2/poly_metadata?filter[metadatable_id]=123
[View source]

105
 
# File 'app/resources/api/v2/poly_metadatum_resource.rb', line 105

filter :metadatable_id