Class: Api::V2::TransferTemplateResource

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

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.

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

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)

Returns the name of the transfer template.

Returns:

  • (String) —

    the name of the transfer template.



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

attribute :name

#uuid ⇒ String (readonly)

Returns the UUID of the transfer template.

Returns:

  • (String) —

    the UUID of the transfer template.



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

attribute :uuid, readonly: true

Instance Method Details

#filter_uuid ⇒ Object

Filter the transfer templates by UUID.

Examples:

GET request with UUID filter

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


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

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