Module: Panoptes::Client::Subjects

Included in:
Panoptes::Client
Defined in:
lib/panoptes/client/subjects.rb

Instance Method Summary collapse

Instance Method Details

#retire_subject(workflow_id, subject_id) ⇒ Object

TODO:

Add this endpoint to the Apiary docs and add a see-reference here.

Retire a subject for a workflow

Parameters:

  • workflow_id (Integer) —

    the ID of a workflow

  • subject_id (Integer) —

    the ID of a subject associated with that workflow (through one of the assigned subject_sets)

Returns:

  • nothing



10
11
12
13
14
15
 
# File 'lib/panoptes/client/subjects.rb', line 10

def retire_subject(workflow_id, subject_id)
  post("/workflows/#{workflow_id}/retired_subjects", {
    admin: true,
    subject_id: subject_id
  })
end