Class: Api::V2::TransferTemplateResource

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

Overview

Note:

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

Note:

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

Provides a JSON:API representation of TransferTemplate.

A template is effectively a partially constructed Transfer instance, containing only the transfers that should be made and the final Transfer class that should be constructed.

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 TransferTemplate resources

GET /api/v2/transfer_templates/

GET request for a TransferTemplate with ID 123

GET /api/v2/transfer_templates/123/

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

#name ⇒ String (readonly)

The name of the transfer template.

Returns:

  • (String) —

    the name of the transfer template.



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

attribute :name

#uuid ⇒ String (readonly)

Note:

This attribute is read-only and cannot be modified.

The UUID of the transfer template.

Returns:

  • (String) —

    the UUID of the transfer template.



41
 
# File 'app/resources/api/v2/transfer_template_resource.rb', line 41

attribute :uuid, readonly: true

Instance Method Details

#filter_uuid ⇒ ActiveRecord::Relation

Filter the transfer templates by UUID.

Examples:

GET request with UUID filter

GET /api/v2/transfer_templates?filter[uuid]=12345678-1234-1234-1234-123456789012

Returns:

  • (ActiveRecord::Relation) —

    The filtered transfer templates.



52
 
# File 'app/resources/api/v2/transfer_template_resource.rb', line 52

filter :uuid, apply: ->(records, value, _options) { records.with_uuid(value) }