Class: Api::V2::CustomMetadatumCollectionResource

Inherits:
BaseResource
  • Object
show all
Defined in:
app/resources/api/v2/custom_metadatum_collection_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:

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

Provides a JSON:API representation of CustomMetadatumCollection.

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 collapse

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

#asset_id ⇒ Int

Returns The ID of the labware the metadata corresponds to. Can only and must be set on creation.

Returns:

  • (Int) —

    The ID of the labware the metadata corresponds to. Can only and must be set on creation.



33
 
# File 'app/resources/api/v2/custom_metadatum_collection_resource.rb', line 33

attribute :asset_id, write_once: true

#metadata ⇒ Hash

Returns All metadata in this collection.

Returns:

  • (Hash) —

    All metadata in this collection.



37
 
# File 'app/resources/api/v2/custom_metadatum_collection_resource.rb', line 37

attribute :metadata

#user_id ⇒ Int

Returns The ID of the user who created this collection. Can only and must be set on creation.

Returns:

  • (Int) —

    The ID of the user who created this collection. Can only and must be set on creation.



29
 
# File 'app/resources/api/v2/custom_metadatum_collection_resource.rb', line 29

attribute :user_id, write_once: true

#uuid ⇒ String (readonly)

Returns The UUID of the collection.

Returns:

  • (String) —

    The UUID of the collection.



25
 
# File 'app/resources/api/v2/custom_metadatum_collection_resource.rb', line 25

attribute :uuid, readonly: true