Class: Api::V2::StateChangeResource

Inherits:
BaseResource
  • Object
show all
Defined in:
app/resources/api/v2/state_change_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 cannot be modified after creation: its endpoint will not accept PATCH requests.

Note:

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

Provides a JSON:API representation of StateChange.

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

#contents ⇒ Array

Returns Array of “contents” to fail, deciphered by the target.

Returns:

  • (Array) —

    Array of “contents” to fail, deciphered by the target.



24
 
# File 'app/resources/api/v2/state_change_resource.rb', line 24

attribute :contents

#customer_accepts_responsibility=(value) ⇒ Void (writeonly)

Parameters:

  • value (Boolean) —

    Sets whether the customer proceeded against advice and will still be charged in the event of a failure.

Returns:

  • (Void) 


30
 
# File 'app/resources/api/v2/state_change_resource.rb', line 30

attribute :customer_accepts_responsibility, writeonly: true

#previous_state ⇒ String (readonly)

Returns The previous state of the target before this state change.

Returns:

  • (String) —

    The previous state of the target before this state change.



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

attribute :previous_state, readonly: true

#reason ⇒ String

Returns The previous state of the target before this state change.

Returns:

  • (String) —

    The previous state of the target before this state change.



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

attribute :reason

#target ⇒ LabwareResource

Note:

This relationship is required.

Setting this relationship alongside the target_uuid attribute will override the attribute value.

Returns:



89
 
# File 'app/resources/api/v2/state_change_resource.rb', line 89

has_one :target, class_name: 'Labware'

#target_state ⇒ String

Note:

This attribute is required.

Returns The state of the target after this state change.

Returns:

  • (String) —

    The state of the target after this state change.



43
 
# File 'app/resources/api/v2/state_change_resource.rb', line 43

attribute :target_state

#target_uuid=(value) ⇒ Void (writeonly)

Deprecated.

Use the target relationship instead.

This is declared for convenience where the target is not available to set as a relationship. Setting this attribute alongside the target relationship will prefer the relationship value.

Parameters:

  • value (String) —

    The UUID of the target labware this state change applies to.

Returns:

  • (Void)

See Also:



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

attribute :target_uuid, writeonly: true

#user ⇒ UserResource

Note:

This relationship is required.

Setting this relationship alongside the user_uuid attribute will override the attribute value.

Returns:

  • (UserResource) —

    The user who initiated this state change.



83
 
# File 'app/resources/api/v2/state_change_resource.rb', line 83

has_one :user

#user_uuid=(value) ⇒ Void (writeonly)

Deprecated.

Use the user relationship instead.

This is declared for convenience where the user is not available to set as a relationship. Setting this attribute alongside the user relationship will prefer the relationship value.

Parameters:

  • value (String) —

    The UUID of the user who initiated this state change.

Returns:

  • (Void)

See Also:



65
 
# File 'app/resources/api/v2/state_change_resource.rb', line 65

attribute :user_uuid, writeonly: true

#uuid ⇒ String (readonly)

Returns The UUID of the state change.

Returns:

  • (String) —

    The UUID of the state change.



73
 
# File 'app/resources/api/v2/state_change_resource.rb', line 73

attribute :uuid, readonly: true