Class: Api::V2::PlateTemplateResource

Inherits:

BaseResource

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

Defined in:

app/resources/api/v2/plate_template_resource.rb

Overview

Note:

This resource is accessed via the /api/v2/plate_templates/ endpoint.

Note:

The below GET examples are current throwing an exception, but are included here for reference.

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.

Examples:

GET request to retrieve all plate templates

GET /api/v2/plate_templates/

GET request to retrieve a specific plate template by ID

GET /api/v2/plate_templates/123/

Instance Attribute Summary

• #uuid ⇒ String readonly

  The UUID of the plate template.

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.

Returns The UUID of the plate template.

Returns:

• (String) —

  The UUID of the plate template.

# File 'app/resources/api/v2/plate_template_resource.rb', line 36

attribute :uuid, readonly: true