Class: Api::V2::TubeRackStatusResource

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

Overview

Note:

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

Note:

This resource is read-only; it can be accessed via GET requests, but creation or modification is not allowed.

Provides a JSON:API representation of TubeRackStatus.

A TubeRackStatus stores the status of the creation process of tube racks

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.

Examples:

GET request for all TubeRackStatus resources

GET /api/v2/tube_rack_statuses/

GET request for a TubeRackStatus with ID 123

GET /api/v2/tube_rack_statuses/123/

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

#uuid ⇒ String (readonly)

Note:

This identifier is automatically assigned upon creation and cannot be modified.

Note:

This attribute is required for identifying the tube rack status.

Returns The UUID of the tube rack status resource.

Returns:

  • (String) —

    The UUID of the tube rack status resource.



34
 
# File 'app/resources/api/v2/tube_rack_status_resource.rb', line 34

attribute :uuid, readonly: true