Skip to main content
Skip table of contents

Experiment Quarantine API

This feature is deprecated and support may be removed from future versions of XNAT

Contents


In a project where the Quarantine setting is disabled, these API will have no effect.


Check The Quarantine Status Of An Experiment

CODE
GET - /data/projects/{project-id}/subjects/{subject-label | subject-id}/experiments/{experiment-label | experiment-id}/status

Response

Returns a simple string:

  • "active"
  • "quarantined"


Set An Experiment's Quarantine Status to "Active"

CODE
PUT - /data/projects/{project-id}/subjects/{subject-label | subject-id}/experiments/{experiment-label | experiment-id}?activate=true

Response

Returns the accession ID of the affected experiment


Set An Experiment's Quarantine Status to "Quarantined"

CODE
PUT - /data/projects/{project-id}/subjects/{subject-label | subject-id}/experiments/{experiment-label | experiment-id}?quarantine=true

Response

Returns the accession ID of the affected experiment

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.