scitran/core

View on GitHub
swagger/paths/acquisitions.yaml

Summary

Maintainability
Test Coverage
$template_arguments:
  resource: acquisition
  tag: acquisitions
  parameter: AcquisitionId

/acquisitions:
  $template: templates/container.yaml
  arguments:
    list-output-schema: schemas/output/acquisition-list.json
    create-input-schema: schemas/input/acquisition.json

/acquisitions/{AcquisitionId}:
  $template: templates/container-item.yaml
  arguments:
    update-input-schema: schemas/input/acquisition-update.json
    get-output-schema: schemas/output/acquisition.json
    delete-description: Read-write project permissions are required to delete an acquisition. </br>Admin project permissions are required if the acquisition contains data uploaded by sources other than users and jobs.


/acquisitions/{AcquisitionId}/info:
  $template: templates/container-item-info.yaml

# ===== Tags =====
/acquisitions/{AcquisitionId}/tags:
  $template: templates/tags.yaml
/acquisitions/{AcquisitionId}/tags/{TagValue}:
  $template: templates/tags-tag.yaml

# ===== Files =====
/acquisitions/{AcquisitionId}/files:
  $template: templates/file-list-upload.yaml
/acquisitions/{AcquisitionId}/files/{FileName}:
  $template: templates/file-item.yaml
/acquisitions/{AcquisitionId}/files/{FileName}/info:
  $template: templates/file-item-info.yaml

# ===== Notes =====
/acquisitions/{AcquisitionId}/notes:
  $template: templates/notes.yaml
/acquisitions/{AcquisitionId}/notes/{NoteId}:
  $template: templates/notes-note.yaml

# ===== Analyses =====
/acquisitions/{AcquisitionId}/analyses:
  $template: templates/analyses-list.yaml
  arguments:
    allowCreate: true
/acquisitions/{AcquisitionId}/analyses/{AnalysisId}:
  $template: templates/analysis-item.yaml
  arguments:
    supportsDelete: true
/acquisitions/{AcquisitionId}/analyses/{AnalysisId}/inputs:
  $template: templates/analysis-files.yaml
  arguments:
    filegroup: inputs
/acquisitions/{AcquisitionId}/analyses/{AnalysisId}/inputs/{Filename}:
  $template: templates/analysis-files-create-ticket-filename.yaml
  arguments:
    filegroup: inputs
/acquisitions/{AcquisitionId}/analyses/{AnalysisId}/files:
  $template: templates/analysis-files.yaml
  arguments:
    filegroup: outputs
/acquisitions/{AcquisitionId}/analyses/{AnalysisId}/files/{Filename}:
  $template: templates/analysis-files-create-ticket-filename.yaml
  arguments:
    filegroup: outputs
/acquisitions/{AcquisitionId}/analyses/{AnalysisId}/notes:
  $template: templates/analysis-notes.yaml
/acquisitions/{AcquisitionId}/analyses/{AnalysisId}/notes/{NoteId}:
  $template: templates/analysis-notes-item.yaml