flywheel package¶

FileSpec Class¶

Wrapper for specifying input file data.

class FileSpec(pathOrName, data, contentType)¶

name¶

The name of the file.

Returns: The name of the file.
Return type: char

path¶

The path to the file on disk.

Returns: The path of the file on disk.
Return type: char

data¶

The file data (as binary or string).

Returns: The file data.
Return type: char

contentType¶

The optional content type to set for the file.

Returns: The content type.
Return type: char

Flywheel Class¶

Global namespace for API calls.

class Flywheel¶

addAcquisition()¶

Create a new acquisition

Parameters: body (flywheel.model.AcquisitionInput) – (required)
Returns: [InsertedId, resp]

addAcquisitionAnalysis()¶

Create an analysis and upload files.

When query param “job” is “true”, send JSON to create an analysis and job. Otherwise, multipart/form-data to upload files and create an analysis.

Parameters

cid (char) – (required)
body (flywheel.model.Object) – (required)
job (logical) – (optional) returns job_id instead of analysis.id

Returns

[InsertedId, resp]

addAcquisitionAnalysisNote()¶

Add a note to acquisition analysis.

Parameters

containerId (char) – (required) 24-char hex id
analysisId (char) – (required) 24-char hex analysis id
body (flywheel.model.Object) – (required)

Returns

[Note, resp]

addAcquisitionNote()¶

Add a note to acquisition.

Parameters

containerId (char) – (required)
body (flywheel.model.NoteInput) – (required)

Returns

[Note, resp]

addAcquisitionTag()¶

Add a tag to acquisition.

Propagates changes to projects, sessions and acquisitions

Parameters

cid (char) – (required)
body (flywheel.model.Tag) – (required)

Returns

[ModifiedResult, resp]

deleteAcquisition()¶

Delete a acquisition

Read-write project permissions are required to delete an acquisition. Admin project permissions are required if the acquisition contains data uploaded by sources other than users and jobs.

Parameters

acquisitionId (char) – (required)
deleteReason (Object) – (optional) Provide a reason for the deletion

Returns

[DeletedResult, resp]

deleteAcquisitionAnalysis()¶

Delete an anaylsis

Delete an analysis for a container.

Parameters

cid (char) – (required)
analysisId (char) – (required)
deleteReason (Object) – (optional) Provide a reason for the deletion

Returns

[DeletedResult, resp]

deleteAcquisitionAnalysisNote()¶

Remove a note from acquisition analysis.

Parameters

cid (char) – (required) 24-char hex id
analysisId (char) – (required) 24-char hex analysis id
noteId (char) – (required) 24-char hex note id

Returns

[DeletedResult, resp]

deleteAcquisitionFile()¶

Delete a file

A user with read-write or higher permissions on the container may delete files that were uploaded by users or were the output of jobs. (Specifically, files whose origin.type is either job or user.) A user with admin permissions on the container may delete any file.

Parameters

cid (char) – (required)
filename (char) – (required)
deleteReason (Object) – (optional) A reason for deletion when change-logging is enabled
force (logical) – (optional) Force deletion of the file even if some checks fail

Returns

[DeletedResult, resp]

deleteAcquisitionNote()¶

Remove a note from acquisition

Parameters

cid (char) – (required)
noteId (char) – (required)

Returns

[DeletedResult, resp]

deleteAcquisitionTag()¶

Delete a tag

Parameters

cid (char) – (required)
value (char) – (required) The tag to interact with

Returns

[DeletedResult, resp]

downloadAcquisitionAnalysisInputs()¶

Download analysis inputs.

If “ticket” query param is included and not empty, download inputs. If “ticket” query param is included and empty, create a ticket for all inputs in the anlaysis If no “ticket” query param is included, server error 500

Parameters

acquisitionId (char) – (required)
analysisId (char) – (required)
ticket (char) – (optional) ticket id of the inputs to download

Returns

[AnalysisFilesCreateTicketOutput, resp]

downloadAcquisitionAnalysisOutputs()¶

Download analysis outputs.

If “ticket” query param is included and not empty, download outputs. If “ticket” query param is included and empty, create a ticket for all outputs in the anlaysis If no “ticket” query param is included, server error 500

Parameters

acquisitionId (char) – (required)
analysisId (char) – (required)
ticket (char) – (optional) ticket id of the outputs to download

Returns

[AnalysisFilesCreateTicketOutput, resp]

downloadFileFromAcquisition()¶

Download a file.

Files can be downloaded directly from this endpoint with a valid “Authorization” header or via a ticket id. To generate a ticket: - Make a request with an empty “ticket” parameter and a valid “Authorization” header. The server will respond with a generated ticket id. - Make another request with the received ticket id in the “ticket” parameter. A valid “Authorization” header is no longer required. When “view” is true, [RFC7233](https://tools.ietf.org/html/rfc7233) range request headers are supported. When virus_scan feature is enabled the quarantined files only can be downloaded using signed urls otherwise it will return with a HTTP 400 response.

Parameters

acquisitionId (char) – (required)
fileName (char) – (required)
view (logical) – (optional) If true, the proper “Content-Type” header based on the file’s mimetype is set on response If false, the “Content-Type” header is set to “application/octet-stream”
info (logical) – (optional) If the file is a zipfile, return a json response of zipfile member information
member (char) – (optional) The filename of a zipfile member to download rather than the entire file
signature (char) – (optional) Url’s signature (signed download url)
expires (char) – (optional) Signed url expiration time (epoch time)

Returns

[DownloadTicket, resp]

getAcquisitionFileZipInfo()¶

Download a file.

Files can be downloaded directly from this endpoint with a valid “Authorization” header or via a ticket id. To generate a ticket: - Make a request with an empty “ticket” parameter and a valid “Authorization” header. The server will respond with a generated ticket id. - Make another request with the received ticket id in the “ticket” parameter. A valid “Authorization” header is no longer required. When “view” is true, [RFC7233](https://tools.ietf.org/html/rfc7233) range request headers are supported. When virus_scan feature is enabled the quarantined files only can be downloaded using signed urls otherwise it will return with a HTTP 400 response.

Parameters

acquisitionId (char) – (required)
fileName (char) – (required)
ticket (char) – (optional) The generated ticket id for the download, or present but empty to generate a ticket id
view (logical) – (optional) If true, the proper “Content-Type” header based on the file’s mimetype is set on response If false, the “Content-Type” header is set to “application/octet-stream”
info (logical) – (optional) If the file is a zipfile, return a json response of zipfile member information
member (char) – (optional) The filename of a zipfile member to download rather than the entire file
signature (char) – (optional) Url’s signature (signed download url)
expires (char) – (optional) Signed url expiration time (epoch time)

Returns

[FileZipInfo, resp]

getAcquisitionDownloadTicket()¶

Download a file.

Files can be downloaded directly from this endpoint with a valid “Authorization” header or via a ticket id. To generate a ticket: - Make a request with an empty “ticket” parameter and a valid “Authorization” header. The server will respond with a generated ticket id. - Make another request with the received ticket id in the “ticket” parameter. A valid “Authorization” header is no longer required. When “view” is true, [RFC7233](https://tools.ietf.org/html/rfc7233) range request headers are supported. When virus_scan feature is enabled the quarantined files only can be downloaded using signed urls otherwise it will return with a HTTP 400 response.

Parameters

acquisitionId (char) – (required)
fileName (char) – (required)
ticket (char) – (optional) The generated ticket id for the download, or present but empty to generate a ticket id
view (logical) – (optional) If true, the proper “Content-Type” header based on the file’s mimetype is set on response If false, the “Content-Type” header is set to “application/octet-stream”
info (logical) – (optional) If the file is a zipfile, return a json response of zipfile member information
member (char) – (optional) The filename of a zipfile member to download rather than the entire file
signature (char) – (optional) Url’s signature (signed download url)
expires (char) – (optional) Signed url expiration time (epoch time)

Returns

[DownloadTicket, resp]

downloadInputFromAcquisitionAnalysis()¶

Download analysis inputs with filter.

If “ticket” query param is included and not empty, download inputs. If “ticket” query param is included and empty, create a ticket for matching inputs in the analysis. If no “ticket” query param is included, inputs will be downloaded directly.

Parameters

acquisitionId (char) – (required)
analysisId (char) – (required)
filename (char) – (required) filename to download (get tar of all if empty)
info (logical) – (optional) If the file is a zipfile, return a json response of zipfile member information
member (char) – (optional) The filename of a zipfile member to download rather than the entire file

Returns

[AnalysisFilesCreateTicketOutput, resp]

getAcquisitionAnalysisInputZipInfo()¶

Download analysis inputs with filter.

If “ticket” query param is included and not empty, download inputs. If “ticket” query param is included and empty, create a ticket for matching inputs in the analysis. If no “ticket” query param is included, inputs will be downloaded directly.

Parameters

acquisitionId (char) – (required)
analysisId (char) – (required)
filename (char) – (required) filename to download (get tar of all if empty)
ticket (char) – (optional) ticket id of the inputs to download
info (logical) – (optional) If the file is a zipfile, return a json response of zipfile member information
member (char) – (optional) The filename of a zipfile member to download rather than the entire file

Returns

[FileZipInfo, resp]

getAcquisitionAnalysisInputDownloadTicket()¶

Download analysis inputs with filter.

If “ticket” query param is included and not empty, download inputs. If “ticket” query param is included and empty, create a ticket for matching inputs in the analysis. If no “ticket” query param is included, inputs will be downloaded directly.

Parameters

acquisitionId (char) – (required)
analysisId (char) – (required)
filename (char) – (required) filename to download (get tar of all if empty)
ticket (char) – (optional) ticket id of the inputs to download
info (logical) – (optional) If the file is a zipfile, return a json response of zipfile member information
member (char) – (optional) The filename of a zipfile member to download rather than the entire file

Returns

[AnalysisFilesCreateTicketOutput, resp]

downloadOutputFromAcquisitionAnalysis()¶

Download analysis outputs with filter.

If “ticket” query param is included and not empty, download outputs. If “ticket” query param is included and empty, create a ticket for matching outputs in the analysis. If no “ticket” query param is included, outputs will be downloaded directly.

Parameters

acquisitionId (char) – (required)
analysisId (char) – (required)
filename (char) – (required) filename to download (get tar of all if empty)
info (logical) – (optional) If the file is a zipfile, return a json response of zipfile member information
member (char) – (optional) The filename of a zipfile member to download rather than the entire file

Returns

[AnalysisFilesCreateTicketOutput, resp]

getAcquisitionAnalysisOutputZipInfo()¶

Download analysis outputs with filter.

If “ticket” query param is included and not empty, download outputs. If “ticket” query param is included and empty, create a ticket for matching outputs in the analysis. If no “ticket” query param is included, outputs will be downloaded directly.

Parameters

acquisitionId (char) – (required)
analysisId (char) – (required)
filename (char) – (required) filename to download (get tar of all if empty)
ticket (char) – (optional) ticket id of the outputs to download
info (logical) – (optional) If the file is a zipfile, return a json response of zipfile member information
member (char) – (optional) The filename of a zipfile member to download rather than the entire file

Returns

[FileZipInfo, resp]

getAcquisitionAnalysisOutputDownloadTicket()¶

Download analysis outputs with filter.

If “ticket” query param is included and not empty, download outputs. If “ticket” query param is included and empty, create a ticket for matching outputs in the analysis. If no “ticket” query param is included, outputs will be downloaded directly.

Parameters

acquisitionId (char) – (required)
analysisId (char) – (required)
filename (char) – (required) filename to download (get tar of all if empty)
ticket (char) – (optional) ticket id of the outputs to download
info (logical) – (optional) If the file is a zipfile, return a json response of zipfile member information
member (char) – (optional) The filename of a zipfile member to download rather than the entire file

Returns

[AnalysisFilesCreateTicketOutput, resp]

getAcquisition()¶

Get a single acquisition

Parameters

acquisitionId (char) – (required)
join (JoinType) – (optional)
joinAvatars (logical) – (optional) add name and avatar to notes
xAcceptFeature (vector[Object]) – (optional)

Returns

[AcquisitionOutput, resp]

getAcquisitionAnalyses()¶

Get analyses for acquisition.

Returns analyses that directly belong to this resource.

Parameters

cid (char) – (required)
filter (char) – (optional) The filter to apply. (e.g. label=my-label,created>2018-09-22)
sort (char) – (optional) The sort fields and order. (e.g. label:asc,created:desc)
limit (integer) – (optional) The maximum number of entries to return.
skip (integer) – (optional) The number of entries to skip.
page (integer) – (optional) The page number (i.e. skip limit*page entries)
afterId (char) – (optional) Paginate after the given id. (Cannot be used with sort, page or skip)
inflateJob (logical) – (optional)
joinAvatars (logical) – (optional)
join (JoinType) – (optional)
xAcceptFeature (vector[char]) – (optional)

Returns

[none, resp]

getAcquisitionAnalysis()¶

Get an analysis.

partial(func, *args, **keywords) - new function with partial application of the given arguments and keywords.

Parameters

cid (char) – (required)
analysisId (char) – (required)
inflateJob (logical) – (optional) Return job as an object instead of an id
joinAvatars (logical) – (optional)
join (JoinType) – (optional)

Returns

[none, resp]

getAcquisitionFileInfo()¶

Get info for a particular file.

Parameters

cid (char) – (required)
filename (char) – (required)

Returns

[FileOutput, resp]

getAcquisitionNote()¶

Get a note on acquisition.

Get a note on acquisition

Parameters

cid (char) – (required)
noteId (char) – (required)

Returns

[Note, resp]

getAcquisitionTag()¶

Get the value of a tag, by name.

Get the value of a tag, by name

Parameters

cid (char) – (required)
value (char) – (required) The tag to interact with

Returns

[char, resp]

getAllAcquisitions()¶

Get a list of acquisitions

Get a list of acquisitions.

Parameters

exhaustive (logical) – (optional) Set to return a complete list regardless of permissions
join (JoinType) – (optional)
joinAvatars (logical) – (optional) add name and avatar to notes
collectionId (char) – (optional)
filter (char) – (optional) The filter to apply. (e.g. label=my-label,created>2018-09-22)
sort (char) – (optional) The sort fields and order. (e.g. label:asc,created:desc)
limit (integer) – (optional) The maximum number of entries to return.
skip (integer) – (optional) The number of entries to skip.
page (integer) – (optional) The page number (i.e. skip limit*page entries)
afterId (char) – (optional) Paginate after the given id. (Cannot be used with sort, page or skip)
xAcceptFeature (vector[Object]) – (optional)

Returns

[none, resp]

modifyAcquisition()¶

Update an acquisition

Parameters

acquisitionId (char) – (required)
body (flywheel.model.AcquisitionModifyInput) – (required)

Returns

[ModifiedResult, resp]

modifyAcquisitionAnalysis()¶

Modify an analysis.

Parameters

cid (char) – (required)
analysisId (char) – (required)
body (flywheel.model.AnalysisModifyInput) – (required)

Returns

[ModifiedResult, resp]

modifyAcquisitionFile()¶

Modify a file’s attributes

Note: If modifying a file’s modality, the current classification will be cleared (except for items in the “Custom” list)

Parameters

cid (char) – (required)
filename (char) – (required)
body (flywheel.model.FileModifyInput) – (required)

Returns

[ModifiedResult, resp]

modifyAcquisitionFileClassification()¶

Update classification for a particular file.

If replacing a file’s classification, the modality can optionally be modified as well.

Parameters

cid (char) – (required)
filename (char) – (required)
body (flywheel.model.FileClassificationDelta) – (required)

Returns

[ModifiedResult, resp]

modifyAcquisitionFileInfo()¶

Update info for a particular file.

Parameters

acquisitionId (char) – (required)
fileName (char) – (required)
body (flywheel.model.InfoUpdateInput) – (required)

Returns

[InlineResponse200, resp]

modifyAcquisitionInfo()¶

Update or replace info for a acquisition.

Parameters

acquisitionId (char) – (required)
body (flywheel.model.InfoUpdateInput) – (required)

Returns

[none, resp]

modifyAcquisitionNote()¶

Update a note on acquisition.

Update a note on acquisition

Parameters

cid (char) – (required)
noteId (char) – (required)
body (flywheel.model.NoteInput) – (required)

Returns

[integer, resp]

renameAcquisitionTag()¶

Rename a tag.

Rename a tag

Parameters

cid (char) – (required)
value (char) – (required) The tag to interact with
body (flywheel.model.Tag) – (required)

Returns

[char, resp]

replaceAcquisitionFile()¶

Replace a file

Parameters

acquisitionId (char) – (required)
fileName (char) – (required)

Returns

[none, resp]

uploadFileToAcquisition()¶

Upload a file to acquisition.

Parameters

cid (char) – (required)
file (vector) – (required) The file to upload
preserveMetadata (logical) – (optional)
ticket (char) – (optional)
metadata (char) – (optional) File metadata
xAcceptFeature (vector[char]) – (optional) redirect header

Returns

[none, resp]

uploadOutputToAcquisitionAnalysis()¶

Upload an output file to analysis.

Parameters

acquisitionId (char) – (required)
analysisId (char) – (required)
file (vector) – (required) The file to upload

Returns

[none, resp]

addAnalysisNote()¶

Add a note to analysis.

Parameters

containerId (char) – (required) Container id
body (flywheel.model.Object) – (required)

Returns

[Note, resp]

addAnalysisTag()¶

Add a tag to analysis.

Propagates changes to projects, sessions and acquisitions

Parameters

containerId (char) – (required)
body (flywheel.model.Tag) – (required)

Returns

[ModifiedResult, resp]

deleteAnalysis()¶

Delete an analysis

Delete an analysis by its id Args: analysis_id: The id of the analysis auth_session: The auth session delete_reason: The reason for deletion (required when change-logging is enabled)

Parameters

analysisId (char) – (required) 24-char hex analysis id
deleteReason (ContainerDeleteReason) – (optional)

Returns

[DeletedResult, resp]

deleteAnalysisNote()¶

Remove a note from analysis

Parameters

containerId (char) – (required) Container id
noteId (char) – (required) 24-char hex note id

Returns

[none, resp]

deleteAnalysisTag()¶

Delete a tag

Parameters

containerId (char) – (required)
value (char) – (required) The tag to interact with

Returns

[none, resp]

downloadAnalysisInputs()¶

Download analysis inputs.

If “ticket” query param is included and not empty, download inputs. If “ticket” query param is included and empty, create a ticket for all inputs in the anlaysis If no “ticket” query param is included, server error 500

Parameters

analysisId (char) – (required)
ticket (char) – (optional) ticket id of the inputs to download

Returns

[AnalysisFilesCreateTicketOutput, resp]

downloadAnalysisOutputs()¶

Download analysis outputs.

If “ticket” query param is included and not empty, download outputs. If “ticket” query param is included and empty, create a ticket for all outputs in the anlaysis If no “ticket” query param is included, server error 500

Parameters

analysisId (char) – (required)
ticket (char) – (optional) ticket id of the outputs to download

Returns

[AnalysisFilesCreateTicketOutput, resp]

downloadInputFromAnalysis()¶

Download analysis inputs with filter.

If “ticket” query param is included and not empty, download inputs. If “ticket” query param is included and empty, create a ticket for matching inputs in the analysis. If no “ticket” query param is included, inputs will be downloaded directly.

Parameters

analysisId (char) – (required)
filename (char) – (required) filename to download (get tar of all if empty)
info (logical) – (optional) If the file is a zipfile, return a json response of zipfile member information
member (char) – (optional) The filename of a zipfile member to download rather than the entire file

Returns

[AnalysisFilesCreateTicketOutput, resp]

getAnalysisInputZipInfo()¶

Download analysis inputs with filter.

If “ticket” query param is included and not empty, download inputs. If “ticket” query param is included and empty, create a ticket for matching inputs in the analysis. If no “ticket” query param is included, inputs will be downloaded directly.

Parameters

analysisId (char) – (required)
filename (char) – (required) filename to download (get tar of all if empty)
ticket (char) – (optional) ticket id of the inputs to download
info (logical) – (optional) If the file is a zipfile, return a json response of zipfile member information
member (char) – (optional) The filename of a zipfile member to download rather than the entire file

Returns

[FileZipInfo, resp]

getAnalysisInputDownloadTicket()¶

Download analysis inputs with filter.

If “ticket” query param is included and not empty, download inputs. If “ticket” query param is included and empty, create a ticket for matching inputs in the analysis. If no “ticket” query param is included, inputs will be downloaded directly.

Parameters

analysisId (char) – (required)
filename (char) – (required) filename to download (get tar of all if empty)
ticket (char) – (optional) ticket id of the inputs to download
info (logical) – (optional) If the file is a zipfile, return a json response of zipfile member information
member (char) – (optional) The filename of a zipfile member to download rather than the entire file

Returns

[AnalysisFilesCreateTicketOutput, resp]

downloadOutputFromAnalysis()¶

Download analysis outputs with filter.

If “ticket” query param is included and not empty, download outputs. If “ticket” query param is included and empty, create a ticket for matching outputs in the analysis. If no “ticket” query param is included, outputs will be downloaded directly.

Parameters

analysisId (char) – (required)
filename (char) – (required) filename to download (get tar of all if empty)
info (logical) – (optional) If the file is a zipfile, return a json response of zipfile member information
member (char) – (optional) The filename of a zipfile member to download rather than the entire file

Returns

[AnalysisFilesCreateTicketOutput, resp]

getAnalysisOutputZipInfo()¶

Download analysis outputs with filter.

If “ticket” query param is included and not empty, download outputs. If “ticket” query param is included and empty, create a ticket for matching outputs in the analysis. If no “ticket” query param is included, outputs will be downloaded directly.

Parameters

analysisId (char) – (required)
filename (char) – (required) filename to download (get tar of all if empty)
ticket (char) – (optional) ticket id of the outputs to download
info (logical) – (optional) If the file is a zipfile, return a json response of zipfile member information
member (char) – (optional) The filename of a zipfile member to download rather than the entire file

Returns

[FileZipInfo, resp]

getAnalysisOutputDownloadTicket()¶

Download analysis outputs with filter.

If “ticket” query param is included and not empty, download outputs. If “ticket” query param is included and empty, create a ticket for matching outputs in the analysis. If no “ticket” query param is included, outputs will be downloaded directly.

Parameters

analysisId (char) – (required)
filename (char) – (required) filename to download (get tar of all if empty)
ticket (char) – (optional) ticket id of the outputs to download
info (logical) – (optional) If the file is a zipfile, return a json response of zipfile member information
member (char) – (optional) The filename of a zipfile member to download rather than the entire file

Returns

[AnalysisFilesCreateTicketOutput, resp]

getAnalyses()¶

Get nested analyses for a container

Returns analyses that belong to containers of the specified type that belong to ContainerId. Ex: projects/{ProjectId}/acquisitions/analyses will return any analyses that have an acquisition that is under that project as a parent. The all keyword is also supported, for example: projects/{ProjectId}/all/analyses will return any analyses that have any session or acquisition or the project itself as a parent.

Parameters

containerName (char) – (required) The parent container type
containerId (char) – (required) The parent container id
subcontainerName (char) – (required) The sub container type

Returns

[vector[AnalysisListOutput], resp]

getAnalysis()¶

Get an analysis.

Get an analysis by its id

Parameters

analysisId (char) – (required) 24-char hex analysis id
inflateJob (logical) – (optional) expand job info
joinAvatars (logical) – (optional) add name and avatar to notes
join (JoinType) – (optional)

Returns

[none, resp]

getAnalysisFileInfo()¶

Get info for a particular file.

Parameters

containerId (char) – (required) Container id
filename (char) – (required) The name of the file

Returns

[FileOutput, resp]

getAnalysisNote()¶

Get a note on analysis.

Get a note on analysis

Parameters

containerId (char) – (required) Container id
noteId (char) – (required) 24-char hex note id

Returns

[Note, resp]

getAnalysisTag()¶

Get the value of a tag, by name.

Get the value of a tag, by name

Parameters

containerId (char) – (required)
value (char) – (required) The tag to interact with

Returns

[char, resp]

modifyAnalysis()¶

Modify an analysis.

Modify an analysis by its id Args: analysis_id: The id of the analysis analysis_modify: The modifications to make auth_session: The auth session

Parameters

analysisId (char) – (required) 24-char hex analysis id
body (flywheel.model.Object) – (required)

Returns

[ModifiedResult, resp]

modifyAnalysisInfo()¶

Update or replace info for a analysis.

Parameters

analysisId (char) – (required)
body (flywheel.model.InfoUpdateInput) – (required)

Returns

[none, resp]

modifyAnalysisNote()¶

Update a note on analysis.

Update a note on analysis

Parameters

containerId (char) – (required) Container id
noteId (char) – (required) 24-char hex note id
body (flywheel.model.Object) – (required)

Returns

[integer, resp]

renameAnalysisTag()¶

Rename a tag.

Rename a tag

Parameters

containerId (char) – (required)
value (char) – (required) The tag to interact with
body (flywheel.model.Tag) – (required)

Returns

[char, resp]

uploadOutputToAnalysis()¶

Upload an output file to analysis.

Parameters

analysisId (char) – (required)
file (vector) – (required) The file to upload

Returns

[none, resp]

cancelBatch()¶

Cancel a Job

Cancels jobs that are still pending, returns number of jobs cancelled. Moves a ‘running’ batch job to ‘cancelled’.

Parameters: batchId (char) – (required)
Returns: [BatchCancelOutput, resp]

createBatchJobFromJobs()¶

Create a batch job proposal from preconstructed jobs and insert it as ‘pending’.

Parameters: body (flywheel.model.BatchJobsProposalInput) – (required) Set of jobs to be run as a batch
Returns: [BatchProposal, resp]

getAllBatches()¶

Get a list of batch jobs the user has created.

Requires login.

Returns: [vector[Batch], resp]

getBatch()¶

Get batch job details.

Parameters

batchId (char) – (required)
jobs (logical) – (optional) If true, return job objects instead of job ids

Returns

[Batch, resp]

proposeBatch()¶

Create a batch job proposal and insert it as ‘pending’.

Parameters: body (flywheel.model.BatchProposalInput) – (required) The batch proposal
Returns: [BatchProposal, resp]

startBatch()¶

Launch a job.

Creates jobs from proposed inputs, returns jobs enqueued. Moves ‘pending’ batch job to ‘running’.

Parameters: batchId (char) – (required)
Returns: [vector[JobOutput], resp]

bulkCopy()¶

Perform a bulk copy operation

Parameters: body (flywheel.model.BulkMoveSessions) – (required)
Returns: [Map, resp]

bulkDelete()¶

Perform a bulk delete operation

Parameters: body (flywheel.model.BulkMoveSessions) – (required)
Returns: [Map, resp]

bulkMoveSessions()¶

Perform a bulk move of sessions to either a subject or project

Parameters: body (flywheel.model.BulkMoveSessions) – (required)
Returns: [Map, resp]

callbackVirusScan()¶

Callback url to send the virus scan result of a file.

This endpoint accepts the result from the anti-virus service. NOTE: this endpoint only can be used via a signed url.

Parameters

containerType (char) – (required)
containerId (char) – (required)
fileName (char) – (required)
body (flywheel.model.CallbacksVirusScanInput) – (required)
signature (char) – (optional) Url’s signature (signed callback url)
expires (char) – (optional) Signed url expiration time (epoch time)

Returns

[none, resp]

addCollection()¶

Create a collection

Parameters: body (flywheel.model.CollectionInput) – (required)
Returns: [InsertedId, resp]

addCollectionAnalysis()¶

Create an analysis and upload files.

When query param “job” is “true”, send JSON to create an analysis and job. Otherwise, multipart/form-data to upload files and create an analysis.

Parameters

cid (char) – (required)
body (flywheel.model.Object) – (required)
job (logical) – (optional) returns job_id instead of analysis.id

Returns

[InsertedId, resp]

addCollectionAnalysisNote()¶

Add a note to collection analysis.

Parameters

containerId (char) – (required) 24-char hex id
analysisId (char) – (required) 24-char hex analysis id
body (flywheel.model.Object) – (required)

Returns

[Note, resp]

addCollectionNote()¶

Add a note to collection.

Parameters

containerId (char) – (required)
body (flywheel.model.NoteInput) – (required)

Returns

[Note, resp]

addCollectionPermission()¶

Add a permission

Parameters

collectionId (char) – (required)
body (flywheel.model.PermissionAccessPermission) – (required)

Returns

[InlineResponse200, resp]

addCollectionTag()¶

Add a tag to collection.

Propagates changes to projects, sessions and acquisitions

Parameters

cid (char) – (required)
body (flywheel.model.Tag) – (required)

Returns

[ModifiedResult, resp]

deleteCollection()¶

Delete a collection

Delete Collections.

Parameters: collectionId (char) – (required)
Returns: [DeletedResult, resp]

deleteCollectionAnalysis()¶

Delete an anaylsis

Delete an analysis for a container.

Parameters

cid (char) – (required)
analysisId (char) – (required)
deleteReason (Object) – (optional) Provide a reason for the deletion

Returns

[DeletedResult, resp]

deleteCollectionAnalysisNote()¶

Remove a note from collection analysis.

Parameters

cid (char) – (required) 24-char hex id
analysisId (char) – (required) 24-char hex analysis id
noteId (char) – (required) 24-char hex note id

Returns

[DeletedResult, resp]

deleteCollectionFile()¶

Delete a file

A user with read-write or higher permissions on the container may delete files that were uploaded by users or were the output of jobs. (Specifically, files whose origin.type is either job or user.) A user with admin permissions on the container may delete any file.

Parameters

cid (char) – (required)
filename (char) – (required)
deleteReason (Object) – (optional) A reason for deletion when change-logging is enabled
force (logical) – (optional) Force deletion of the file even if some checks fail

Returns

[DeletedResult, resp]

deleteCollectionNote()¶

Remove a note from collection

Parameters

cid (char) – (required)
noteId (char) – (required)

Returns

[DeletedResult, resp]

deleteCollectionTag()¶

Delete a tag

Parameters

cid (char) – (required)
value (char) – (required) The tag to interact with

Returns

[DeletedResult, resp]

deleteCollectionUserPermission()¶

Delete a permission

Parameters

collectionId (char) – (required)
userId (char) – (required)

Returns

[InlineResponse200, resp]

downloadCollectionAnalysisInputs()¶

Download analysis inputs.

If “ticket” query param is included and not empty, download inputs. If “ticket” query param is included and empty, create a ticket for all inputs in the anlaysis If no “ticket” query param is included, server error 500

Parameters

collectionId (char) – (required)
analysisId (char) – (required)
ticket (char) – (optional) ticket id of the inputs to download

Returns

[AnalysisFilesCreateTicketOutput, resp]

downloadCollectionAnalysisOutputs()¶

Download analysis outputs.

If “ticket” query param is included and not empty, download outputs. If “ticket” query param is included and empty, create a ticket for all outputs in the anlaysis If no “ticket” query param is included, server error 500

Parameters

collectionId (char) – (required)
analysisId (char) – (required)
ticket (char) – (optional) ticket id of the outputs to download

Returns

[AnalysisFilesCreateTicketOutput, resp]

downloadFileFromCollection()¶

Download a file.

Files can be downloaded directly from this endpoint with a valid “Authorization” header or via a ticket id. To generate a ticket: - Make a request with an empty “ticket” parameter and a valid “Authorization” header. The server will respond with a generated ticket id. - Make another request with the received ticket id in the “ticket” parameter. A valid “Authorization” header is no longer required. When “view” is true, [RFC7233](https://tools.ietf.org/html/rfc7233) range request headers are supported. When virus_scan feature is enabled the quarantined files only can be downloaded using signed urls otherwise it will return with a HTTP 400 response.

Parameters

collectionId (char) – (required)
fileName (char) – (required)
view (logical) – (optional) If true, the proper “Content-Type” header based on the file’s mimetype is set on response If false, the “Content-Type” header is set to “application/octet-stream”
info (logical) – (optional) If the file is a zipfile, return a json response of zipfile member information
member (char) – (optional) The filename of a zipfile member to download rather than the entire file
signature (char) – (optional) Url’s signature (signed download url)
expires (char) – (optional) Signed url expiration time (epoch time)

Returns

[DownloadTicket, resp]

getCollectionFileZipInfo()¶

Download a file.

Files can be downloaded directly from this endpoint with a valid “Authorization” header or via a ticket id. To generate a ticket: - Make a request with an empty “ticket” parameter and a valid “Authorization” header. The server will respond with a generated ticket id. - Make another request with the received ticket id in the “ticket” parameter. A valid “Authorization” header is no longer required. When “view” is true, [RFC7233](https://tools.ietf.org/html/rfc7233) range request headers are supported. When virus_scan feature is enabled the quarantined files only can be downloaded using signed urls otherwise it will return with a HTTP 400 response.

Parameters

collectionId (char) – (required)
fileName (char) – (required)
ticket (char) – (optional) The generated ticket id for the download, or present but empty to generate a ticket id
view (logical) – (optional) If true, the proper “Content-Type” header based on the file’s mimetype is set on response If false, the “Content-Type” header is set to “application/octet-stream”
info (logical) – (optional) If the file is a zipfile, return a json response of zipfile member information
member (char) – (optional) The filename of a zipfile member to download rather than the entire file
signature (char) – (optional) Url’s signature (signed download url)
expires (char) – (optional) Signed url expiration time (epoch time)

Returns

[FileZipInfo, resp]

getCollectionDownloadTicket()¶

Download a file.

Files can be downloaded directly from this endpoint with a valid “Authorization” header or via a ticket id. To generate a ticket: - Make a request with an empty “ticket” parameter and a valid “Authorization” header. The server will respond with a generated ticket id. - Make another request with the received ticket id in the “ticket” parameter. A valid “Authorization” header is no longer required. When “view” is true, [RFC7233](https://tools.ietf.org/html/rfc7233) range request headers are supported. When virus_scan feature is enabled the quarantined files only can be downloaded using signed urls otherwise it will return with a HTTP 400 response.

Parameters

collectionId (char) – (required)
fileName (char) – (required)
ticket (char) – (optional) The generated ticket id for the download, or present but empty to generate a ticket id
view (logical) – (optional) If true, the proper “Content-Type” header based on the file’s mimetype is set on response If false, the “Content-Type” header is set to “application/octet-stream”
info (logical) – (optional) If the file is a zipfile, return a json response of zipfile member information
member (char) – (optional) The filename of a zipfile member to download rather than the entire file
signature (char) – (optional) Url’s signature (signed download url)
expires (char) – (optional) Signed url expiration time (epoch time)

Returns

[DownloadTicket, resp]

downloadInputFromCollectionAnalysis()¶

Download analysis inputs with filter.

If “ticket” query param is included and not empty, download inputs. If “ticket” query param is included and empty, create a ticket for matching inputs in the analysis. If no “ticket” query param is included, inputs will be downloaded directly.

Parameters

collectionId (char) – (required)
analysisId (char) – (required)
filename (char) – (required) filename to download (get tar of all if empty)
info (logical) – (optional) If the file is a zipfile, return a json response of zipfile member information
member (char) – (optional) The filename of a zipfile member to download rather than the entire file

Returns

[AnalysisFilesCreateTicketOutput, resp]

getCollectionAnalysisInputZipInfo()¶

Download analysis inputs with filter.

If “ticket” query param is included and not empty, download inputs. If “ticket” query param is included and empty, create a ticket for matching inputs in the analysis. If no “ticket” query param is included, inputs will be downloaded directly.

Parameters

collectionId (char) – (required)
analysisId (char) – (required)
filename (char) – (required) filename to download (get tar of all if empty)
ticket (char) – (optional) ticket id of the inputs to download
info (logical) – (optional) If the file is a zipfile, return a json response of zipfile member information
member (char) – (optional) The filename of a zipfile member to download rather than the entire file

Returns

[FileZipInfo, resp]

getCollectionAnalysisInputDownloadTicket()¶

Download analysis inputs with filter.

If “ticket” query param is included and not empty, download inputs. If “ticket” query param is included and empty, create a ticket for matching inputs in the analysis. If no “ticket” query param is included, inputs will be downloaded directly.

Parameters

collectionId (char) – (required)
analysisId (char) – (required)
filename (char) – (required) filename to download (get tar of all if empty)
ticket (char) – (optional) ticket id of the inputs to download
info (logical) – (optional) If the file is a zipfile, return a json response of zipfile member information
member (char) – (optional) The filename of a zipfile member to download rather than the entire file

Returns

[AnalysisFilesCreateTicketOutput, resp]

downloadOutputFromCollectionAnalysis()¶

Download analysis outputs with filter.

If “ticket” query param is included and not empty, download outputs. If “ticket” query param is included and empty, create a ticket for matching outputs in the analysis. If no “ticket” query param is included, outputs will be downloaded directly.

Parameters

collectionId (char) – (required)
analysisId (char) – (required)
filename (char) – (required) filename to download (get tar of all if empty)
info (logical) – (optional) If the file is a zipfile, return a json response of zipfile member information
member (char) – (optional) The filename of a zipfile member to download rather than the entire file

Returns

[AnalysisFilesCreateTicketOutput, resp]

getCollectionAnalysisOutputZipInfo()¶

Download analysis outputs with filter.

If “ticket” query param is included and not empty, download outputs. If “ticket” query param is included and empty, create a ticket for matching outputs in the analysis. If no “ticket” query param is included, outputs will be downloaded directly.

Parameters

collectionId (char) – (required)
analysisId (char) – (required)
filename (char) – (required) filename to download (get tar of all if empty)
ticket (char) – (optional) ticket id of the outputs to download
info (logical) – (optional) If the file is a zipfile, return a json response of zipfile member information
member (char) – (optional) The filename of a zipfile member to download rather than the entire file

Returns

[FileZipInfo, resp]

getCollectionAnalysisOutputDownloadTicket()¶

Download analysis outputs with filter.

If “ticket” query param is included and not empty, download outputs. If “ticket” query param is included and empty, create a ticket for matching outputs in the analysis. If no “ticket” query param is included, outputs will be downloaded directly.

Parameters

collectionId (char) – (required)
analysisId (char) – (required)
filename (char) – (required) filename to download (get tar of all if empty)
ticket (char) – (optional) ticket id of the outputs to download
info (logical) – (optional) If the file is a zipfile, return a json response of zipfile member information
member (char) – (optional) The filename of a zipfile member to download rather than the entire file

Returns

[AnalysisFilesCreateTicketOutput, resp]

getAllCollections()¶

List all collections.

Parameters

exhaustive (logical) – (optional)
joinAvatars (logical) – (optional) add name and avatar to notes
joinFiles (logical) – (optional)
join (JoinType) – (optional)
stats (logical) – (optional)
userId (char) – (optional)
filter (char) – (optional) The filter to apply. (e.g. label=my-label,created>2018-09-22)
sort (char) – (optional) The sort fields and order. (e.g. label:asc,created:desc)
limit (integer) – (optional) The maximum number of entries to return.
skip (integer) – (optional) The number of entries to skip.
page (integer) – (optional) The page number (i.e. skip limit*page entries)
afterId (char) – (optional) Paginate after the given id. (Cannot be used with sort, page or skip)
xAcceptFeature (vector[Object]) – (optional)

Returns

[none, resp]

getAllCollectionsCurators()¶

List all curators of collections

Returns: [Map], resp]

getCollection()¶

Retrieve a single collection

Parameters

collectionId (char) – (required)
joinAvatars (logical) – (optional) add name and avatar to notes
join (JoinType) – (optional)
xAcceptFeature (vector[Object]) – (optional)

Returns

[CollectionOutput, resp]

getCollectionAcquisitions()¶

List acquisitions in a collection

Parameters

collectionId (char) – (required)
session (char) – (optional) The id of a session, to which the acquisitions returned will be restricted
filter (char) – (optional) The filter to apply. (e.g. label=my-label,created>2018-09-22)
sort (char) – (optional) The sort fields and order. (e.g. label:asc,created:desc)
limit (integer) – (optional) The maximum number of entries to return.
skip (integer) – (optional) The number of entries to skip.
page (integer) – (optional) The page number (i.e. skip limit*page entries)
afterId (char) – (optional) Paginate after the given id. (Cannot be used with sort, page or skip)
xAcceptFeature (vector[char]) – (optional)

Returns

[none, resp]

getCollectionAnalyses()¶

Get analyses for collection.

Returns analyses that directly belong to this resource.

Parameters

cid (char) – (required)
filter (char) – (optional) The filter to apply. (e.g. label=my-label,created>2018-09-22)
sort (char) – (optional) The sort fields and order. (e.g. label:asc,created:desc)
limit (integer) – (optional) The maximum number of entries to return.
skip (integer) – (optional) The number of entries to skip.
page (integer) – (optional) The page number (i.e. skip limit*page entries)
afterId (char) – (optional) Paginate after the given id. (Cannot be used with sort, page or skip)
inflateJob (logical) – (optional)
joinAvatars (logical) – (optional)
join (JoinType) – (optional)
xAcceptFeature (vector[char]) – (optional)

Returns

[none, resp]

getCollectionAnalysis()¶

Get an analysis.

partial(func, *args, **keywords) - new function with partial application of the given arguments and keywords.

Parameters

cid (char) – (required)
analysisId (char) – (required)
inflateJob (logical) – (optional) Return job as an object instead of an id
joinAvatars (logical) – (optional)
join (JoinType) – (optional)

Returns

[none, resp]

getCollectionFileInfo()¶

Get info for a particular file.

Parameters

cid (char) – (required)
filename (char) – (required)

Returns

[FileOutput, resp]

getCollectionNote()¶

Get a note on collection.

Get a note on collection

Parameters

cid (char) – (required)
noteId (char) – (required)

Returns

[Note, resp]

getCollectionSessions()¶

List sessions in a collection

List sessions in a collection.

Parameters

collectionId (char) – (required)
filter (char) – (optional) The filter to apply. (e.g. label=my-label,created>2018-09-22)
sort (char) – (optional) The sort fields and order. (e.g. label:asc,created:desc)
limit (integer) – (optional) The maximum number of entries to return.
skip (integer) – (optional) The number of entries to skip.
page (integer) – (optional) The page number (i.e. skip limit*page entries)
afterId (char) – (optional) Paginate after the given id. (Cannot be used with sort, page or skip)
xAcceptFeature (vector[char]) – (optional)

Returns

[none, resp]

getCollectionTag()¶

Get the value of a tag, by name.

Get the value of a tag, by name

Parameters

cid (char) – (required)
value (char) – (required) The tag to interact with

Returns

[char, resp]

getCollectionUserPermission()¶

List a user’s permissions for this group.

Parameters

collectionId (char) – (required)
userId (char) – (required)

Returns

[PermissionAccessPermission, resp]

modifyCollection()¶

Update a collection and its contents

Parameters

collectionId (char) – (required)
body (flywheel.model.CollectionInputWithContents) – (required)

Returns

[ModifiedResult, resp]

modifyCollectionAnalysis()¶

Modify an analysis.

Parameters

cid (char) – (required)
analysisId (char) – (required)
body (flywheel.model.AnalysisModifyInput) – (required)

Returns

[ModifiedResult, resp]

modifyCollectionFile()¶

Modify a file’s attributes

Note: If modifying a file’s modality, the current classification will be cleared (except for items in the “Custom” list)

Parameters

cid (char) – (required)
filename (char) – (required)
body (flywheel.model.FileModifyInput) – (required)

Returns

[ModifiedResult, resp]

modifyCollectionFileClassification()¶

Update classification for a particular file.

If replacing a file’s classification, the modality can optionally be modified as well.

Parameters

cid (char) – (required)
filename (char) – (required)
body (flywheel.model.FileClassificationDelta) – (required)

Returns

[ModifiedResult, resp]

modifyCollectionFileInfo()¶

Update info for a particular file.

Parameters

collectionId (char) – (required)
fileName (char) – (required)
body (flywheel.model.InfoUpdateInput) – (required)

Returns

[InlineResponse200, resp]

modifyCollectionInfo()¶

Update or replace info for a collection.

Parameters

collectionId (char) – (required)
body (flywheel.model.InfoUpdateInput) – (required)

Returns

[none, resp]

modifyCollectionNote()¶

Update a note on collection.

Update a note on collection

Parameters

cid (char) – (required)
noteId (char) – (required)
body (flywheel.model.NoteInput) – (required)

Returns

[integer, resp]

modifyCollectionUserPermission()¶

Update a user’s permission for this group.

Parameters

collectionId (char) – (required)
userId (char) – (required)
body (flywheel.model.PermissionAccessPermission) – (required)

Returns

[InlineResponse200, resp]

renameCollectionTag()¶

Rename a tag.

Rename a tag

Parameters

cid (char) – (required)
value (char) – (required) The tag to interact with
body (flywheel.model.Tag) – (required)

Returns

[char, resp]

replaceCollectionFile()¶

Replace a file

Parameters

collectionId (char) – (required)
fileName (char) – (required)

Returns

[none, resp]

uploadFileToCollection()¶

Upload a file to collection.

Parameters

cid (char) – (required)
file (vector) – (required) The file to upload
preserveMetadata (logical) – (optional)
ticket (char) – (optional)
metadata (char) – (optional) File metadata
xAcceptFeature (vector[char]) – (optional) redirect header

Returns

[none, resp]

uploadOutputToCollectionAnalysis()¶

Upload an output file to analysis.

Parameters

collectionId (char) – (required)
analysisId (char) – (required)
file (vector) – (required) The file to upload

Returns

[none, resp]

getConfig()¶

Get public configuration

return config dict

Returns: [ConfigOut, resp]

addContainerAnalysis()¶

Create an analysis and upload files.

When query param “job” is “true”, send JSON to create an analysis and job. Otherwise, multipart/form-data to upload files and create an analysis.

Parameters

cid (char) – (required)
body (flywheel.model.Object) – (required)
job (logical) – (optional) returns job_id instead of analysis.id

Returns

[InsertedId, resp]

addContainerAnalysisNote()¶

Add a note to container analysis.

Parameters

containerId (char) – (required) 24-char hex id
analysisId (char) – (required) 24-char hex analysis id
body (flywheel.model.Object) – (required)

Returns

[Note, resp]

addContainerNote()¶

Add a note to container.

Parameters

containerId (char) – (required)
body (flywheel.model.NoteInput) – (required)

Returns

[Note, resp]

addContainerTag()¶

Add a tag to container.

Propagates changes to projects, sessions and acquisitions

Parameters

cid (char) – (required)
body (flywheel.model.Tag) – (required)

Returns

[ModifiedResult, resp]

addView()¶

Add a new data view

Create container view

Parameters

containerId (char) – (required)
body (flywheel.model.ContainerIdViewInput) – (required)

Returns

[ViewIdOutput, resp]

checkUidsExist()¶

Check for existence of UIDs system-wide

Parameters: body (flywheel.model.ContainerUidcheck) – (required)
Returns: [ContainerUidcheck, resp]

deleteContainer()¶

Delete a container

Delete Container

Parameters

containerId (char) – (required)
deleteReason (ContainerDeleteReason) – (optional)

Returns

[DeletedResult, resp]

deleteContainerAnalysis()¶

Delete an anaylsis

Delete an analysis for a container.

Parameters

cid (char) – (required)
analysisId (char) – (required)
deleteReason (Object) – (optional) Provide a reason for the deletion

Returns

[DeletedResult, resp]

deleteContainerAnalysisNote()¶

Remove a note from container analysis.

Parameters

cid (char) – (required) 24-char hex id
analysisId (char) – (required) 24-char hex analysis id
noteId (char) – (required) 24-char hex note id

Returns

[DeletedResult, resp]

deleteContainerFile()¶

Delete a file

A user with read-write or higher permissions on the container may delete files that were uploaded by users or were the output of jobs. (Specifically, files whose origin.type is either job or user.) A user with admin permissions on the container may delete any file.

Parameters

cid (char) – (required)
filename (char) – (required)
deleteReason (Object) – (optional) A reason for deletion when change-logging is enabled
force (logical) – (optional) Force deletion of the file even if some checks fail

Returns

[DeletedResult, resp]

deleteContainerNote()¶

Remove a note from container

Parameters

cid (char) – (required)
noteId (char) – (required)

Returns

[DeletedResult, resp]

deleteContainerTag()¶

Delete a tag

Parameters

cid (char) – (required)
value (char) – (required) The tag to interact with

Returns

[DeletedResult, resp]

downloadContainerAnalysisInputs()¶

Download analysis inputs.

If “ticket” query param is included and not empty, download inputs. If “ticket” query param is included and empty, create a ticket for all inputs in the anlaysis If no “ticket” query param is included, server error 500

Parameters

containerId (char) – (required)
analysisId (char) – (required)
ticket (char) – (optional) ticket id of the inputs to download

Returns

[AnalysisFilesCreateTicketOutput, resp]

downloadContainerAnalysisOutputs()¶

Download analysis outputs.

If “ticket” query param is included and not empty, download outputs. If “ticket” query param is included and empty, create a ticket for all outputs in the anlaysis If no “ticket” query param is included, server error 500

Parameters

containerId (char) – (required)
analysisId (char) – (required)
ticket (char) – (optional) ticket id of the outputs to download

Returns

[AnalysisFilesCreateTicketOutput, resp]

downloadFileFromContainer()¶

Download a file.

Files can be downloaded directly from this endpoint with a valid “Authorization” header or via a ticket id. To generate a ticket: - Make a request with an empty “ticket” parameter and a valid “Authorization” header. The server will respond with a generated ticket id. - Make another request with the received ticket id in the “ticket” parameter. A valid “Authorization” header is no longer required. When “view” is true, [RFC7233](https://tools.ietf.org/html/rfc7233) range request headers are supported. When virus_scan feature is enabled the quarantined files only can be downloaded using signed urls otherwise it will return with a HTTP 400 response.

Parameters

containerId (char) – (required)
fileName (char) – (required)
view (logical) – (optional) If true, the proper “Content-Type” header based on the file’s mimetype is set on response If false, the “Content-Type” header is set to “application/octet-stream”
info (logical) – (optional) If the file is a zipfile, return a json response of zipfile member information
member (char) – (optional) The filename of a zipfile member to download rather than the entire file
signature (char) – (optional) Url’s signature (signed download url)
expires (char) – (optional) Signed url expiration time (epoch time)

Returns

[DownloadTicket, resp]

getContainerFileZipInfo()¶

Download a file.

Files can be downloaded directly from this endpoint with a valid “Authorization” header or via a ticket id. To generate a ticket: - Make a request with an empty “ticket” parameter and a valid “Authorization” header. The server will respond with a generated ticket id. - Make another request with the received ticket id in the “ticket” parameter. A valid “Authorization” header is no longer required. When “view” is true, [RFC7233](https://tools.ietf.org/html/rfc7233) range request headers are supported. When virus_scan feature is enabled the quarantined files only can be downloaded using signed urls otherwise it will return with a HTTP 400 response.

Parameters

containerId (char) – (required)
fileName (char) – (required)
ticket (char) – (optional) The generated ticket id for the download, or present but empty to generate a ticket id
view (logical) – (optional) If true, the proper “Content-Type” header based on the file’s mimetype is set on response If false, the “Content-Type” header is set to “application/octet-stream”
info (logical) – (optional) If the file is a zipfile, return a json response of zipfile member information
member (char) – (optional) The filename of a zipfile member to download rather than the entire file
signature (char) – (optional) Url’s signature (signed download url)
expires (char) – (optional) Signed url expiration time (epoch time)

Returns

[FileZipInfo, resp]

getContainerDownloadTicket()¶

Download a file.

Files can be downloaded directly from this endpoint with a valid “Authorization” header or via a ticket id. To generate a ticket: - Make a request with an empty “ticket” parameter and a valid “Authorization” header. The server will respond with a generated ticket id. - Make another request with the received ticket id in the “ticket” parameter. A valid “Authorization” header is no longer required. When “view” is true, [RFC7233](https://tools.ietf.org/html/rfc7233) range request headers are supported. When virus_scan feature is enabled the quarantined files only can be downloaded using signed urls otherwise it will return with a HTTP 400 response.

Parameters

containerId (char) – (required)
fileName (char) – (required)
ticket (char) – (optional) The generated ticket id for the download, or present but empty to generate a ticket id
view (logical) – (optional) If true, the proper “Content-Type” header based on the file’s mimetype is set on response If false, the “Content-Type” header is set to “application/octet-stream”
info (logical) – (optional) If the file is a zipfile, return a json response of zipfile member information
member (char) – (optional) The filename of a zipfile member to download rather than the entire file
signature (char) – (optional) Url’s signature (signed download url)
expires (char) – (optional) Signed url expiration time (epoch time)

Returns

[DownloadTicket, resp]

downloadInputFromContainerAnalysis()¶

Download analysis inputs with filter.

If “ticket” query param is included and not empty, download inputs. If “ticket” query param is included and empty, create a ticket for matching inputs in the analysis. If no “ticket” query param is included, inputs will be downloaded directly.

Parameters

containerId (char) – (required)
analysisId (char) – (required)
filename (char) – (required) filename to download (get tar of all if empty)
info (logical) – (optional) If the file is a zipfile, return a json response of zipfile member information
member (char) – (optional) The filename of a zipfile member to download rather than the entire file

Returns

[AnalysisFilesCreateTicketOutput, resp]

getContainerAnalysisInputZipInfo()¶

Download analysis inputs with filter.

If “ticket” query param is included and not empty, download inputs. If “ticket” query param is included and empty, create a ticket for matching inputs in the analysis. If no “ticket” query param is included, inputs will be downloaded directly.

Parameters

containerId (char) – (required)
analysisId (char) – (required)
filename (char) – (required) filename to download (get tar of all if empty)
ticket (char) – (optional) ticket id of the inputs to download
info (logical) – (optional) If the file is a zipfile, return a json response of zipfile member information
member (char) – (optional) The filename of a zipfile member to download rather than the entire file

Returns

[FileZipInfo, resp]

getContainerAnalysisInputDownloadTicket()¶

Download analysis inputs with filter.

If “ticket” query param is included and not empty, download inputs. If “ticket” query param is included and empty, create a ticket for matching inputs in the analysis. If no “ticket” query param is included, inputs will be downloaded directly.

Parameters

containerId (char) – (required)
analysisId (char) – (required)
filename (char) – (required) filename to download (get tar of all if empty)
ticket (char) – (optional) ticket id of the inputs to download
info (logical) – (optional) If the file is a zipfile, return a json response of zipfile member information
member (char) – (optional) The filename of a zipfile member to download rather than the entire file

Returns

[AnalysisFilesCreateTicketOutput, resp]

downloadOutputFromContainerAnalysis()¶

Download analysis outputs with filter.

If “ticket” query param is included and not empty, download outputs. If “ticket” query param is included and empty, create a ticket for matching outputs in the analysis. If no “ticket” query param is included, outputs will be downloaded directly.

Parameters

containerId (char) – (required)
analysisId (char) – (required)
filename (char) – (required) filename to download (get tar of all if empty)
info (logical) – (optional) If the file is a zipfile, return a json response of zipfile member information
member (char) – (optional) The filename of a zipfile member to download rather than the entire file

Returns

[AnalysisFilesCreateTicketOutput, resp]

getContainerAnalysisOutputZipInfo()¶

Download analysis outputs with filter.

If “ticket” query param is included and not empty, download outputs. If “ticket” query param is included and empty, create a ticket for matching outputs in the analysis. If no “ticket” query param is included, outputs will be downloaded directly.

Parameters

containerId (char) – (required)
analysisId (char) – (required)
filename (char) – (required) filename to download (get tar of all if empty)
ticket (char) – (optional) ticket id of the outputs to download
info (logical) – (optional) If the file is a zipfile, return a json response of zipfile member information
member (char) – (optional) The filename of a zipfile member to download rather than the entire file

Returns

[FileZipInfo, resp]

getContainerAnalysisOutputDownloadTicket()¶

Download analysis outputs with filter.

If “ticket” query param is included and not empty, download outputs. If “ticket” query param is included and empty, create a ticket for matching outputs in the analysis. If no “ticket” query param is included, outputs will be downloaded directly.

Parameters

containerId (char) – (required)
analysisId (char) – (required)
filename (char) – (required) filename to download (get tar of all if empty)
ticket (char) – (optional) ticket id of the outputs to download
info (logical) – (optional) If the file is a zipfile, return a json response of zipfile member information
member (char) – (optional) The filename of a zipfile member to download rather than the entire file

Returns

[AnalysisFilesCreateTicketOutput, resp]

getContainer()¶

Retrieve a single container

Parameters: containerId (char) – (required)
Returns: [ContainerOutput, resp]

getContainerAnalyses()¶

Get analyses for container.

Returns analyses that directly belong to this resource.

Parameters

cid (char) – (required)
filter (char) – (optional) The filter to apply. (e.g. label=my-label,created>2018-09-22)
sort (char) – (optional) The sort fields and order. (e.g. label:asc,created:desc)
limit (integer) – (optional) The maximum number of entries to return.
skip (integer) – (optional) The number of entries to skip.
page (integer) – (optional) The page number (i.e. skip limit*page entries)
afterId (char) – (optional) Paginate after the given id. (Cannot be used with sort, page or skip)
inflateJob (logical) – (optional)
joinAvatars (logical) – (optional)
join (JoinType) – (optional)
xAcceptFeature (vector[char]) – (optional)

Returns

[none, resp]

getContainerAnalysis()¶

Get an analysis.

partial(func, *args, **keywords) - new function with partial application of the given arguments and keywords.

Parameters

cid (char) – (required)
analysisId (char) – (required)
inflateJob (logical) – (optional) Return job as an object instead of an id
joinAvatars (logical) – (optional)
join (JoinType) – (optional)

Returns

[none, resp]

getContainerFileInfo()¶

Get info for a particular file.

Parameters

containerId (char) – (required)
fileName (char) – (required)

Returns

[FileEntry, resp]

getContainerNote()¶

Get a note on container.

Get a note on container

Parameters

cid (char) – (required)
noteId (char) – (required)

Returns

[Note, resp]

getContainerTag()¶

Get the value of a tag, by name.

Get the value of a tag, by name

Parameters

cid (char) – (required)
value (char) – (required) The tag to interact with

Returns

[char, resp]

modifyContainer()¶

Update a container and its contents

Parameters

containerId (char) – (required)
body (flywheel.model.ContainerUpdate) – (required)

Returns

[none, resp]

modifyContainerAnalysis()¶

Modify an analysis.

Parameters

cid (char) – (required)
analysisId (char) – (required)
body (flywheel.model.AnalysisModifyInput) – (required)

Returns

[ModifiedResult, resp]

modifyContainerFile()¶

Modify a file’s attributes

Note: If modifying a file’s modality, the current classification will be cleared (except for items in the “Custom” list)

Parameters

cid (char) – (required)
filename (char) – (required)
body (flywheel.model.FileModifyInput) – (required)

Returns

[ModifiedResult, resp]

modifyContainerFileClassification()¶

Update classification for a particular file.

If replacing a file’s classification, the modality can optionally be modified as well.

Parameters

cid (char) – (required)
filename (char) – (required)
body (flywheel.model.FileClassificationDelta) – (required)

Returns

[ModifiedResult, resp]

modifyContainerFileInfo()¶

Update info for a particular file.

Parameters

containerId (char) – (required)
fileName (char) – (required)
body (flywheel.model.InfoUpdateInput) – (required)

Returns

[InlineResponse200, resp]

modifyContainerInfo()¶

Update or replace info for a container.

Parameters

containerId (char) – (required)
body (flywheel.model.InfoUpdateInput) – (required)

Returns

[none, resp]

modifyContainerNote()¶

Update a note on container.

Update a note on container

Parameters

cid (char) – (required)
noteId (char) – (required)
body (flywheel.model.NoteInput) – (required)

Returns

[integer, resp]

renameContainerTag()¶

Rename a tag.

Rename a tag

Parameters

cid (char) – (required)
value (char) – (required) The tag to interact with
body (flywheel.model.Tag) – (required)

Returns

[char, resp]

replaceContainerFile()¶

Replace a file

Parameters

containerId (char) – (required)
fileName (char) – (required)

Returns

[none, resp]

uploadFileToContainer()¶

Upload a file to container.

Parameters

cid (char) – (required)
file (vector) – (required) The file to upload
preserveMetadata (logical) – (optional)
ticket (char) – (optional)
metadata (char) – (optional) File metadata
xAcceptFeature (vector[char]) – (optional) redirect header

Returns

[none, resp]

uploadOutputToContainerAnalysis()¶

Upload an output file to analysis.

Parameters

containerId (char) – (required)
analysisId (char) – (required)
file (vector) – (required) The file to upload

Returns

[none, resp]

deleteViewExecution()¶

Delete a data_view_execution

Parameters: dataViewExecutionId (char) – (required)
Returns: [DeletedResult, resp]

getAllDataViewExecutions()¶

Get a list of data_view_executions

Parameters

exhaustive (logical) – (optional) Set to return a complete list regardless of permissions
filter (char) – (optional) The filter to apply. (e.g. label=my-label,created>2018-09-22)
sort (char) – (optional) The sort fields and order. (e.g. label:asc,created:desc)
limit (integer) – (optional) The maximum number of entries to return.
skip (integer) – (optional) The number of entries to skip.
page (integer) – (optional) The page number (i.e. skip limit*page entries)
afterId (char) – (optional) Paginate after the given id. (Cannot be used with sort, page or skip)
xAcceptFeature (vector[char]) – (optional)

Returns

[vector[DataViewExecution], resp]

getDataViewExecution()¶

Get a single data_view_execution

Parameters: dataViewExecutionId (char) – (required)
Returns: [DataViewExecution, resp]

getDataViewExecutionData()¶

Get the data from a data_view_execution

Parameters

dataViewExecutionId (char) – (required)
ticket (char) – (optional) download ticket id
fileFormat (char) – (optional)
fileName (char) – (optional) download ticket filename

Returns

[none, resp]

saveDataViewExecution()¶

Save a data_view_execution to a project

Parameters

dataViewExecutionId (char) – (required)
fileFormat (char) – (optional)

Returns

[FileEntry, resp]

getSearchQuerySuggestions()¶

Get suggestions for a structured search query

Send the search query from the start of the string, and get a set of suggested replacements back. When utilizing a suggestion, the caller should replace the contents from the “from” field to the end of the string with the provided “value”.

Parameters: body (flywheel.model.SearchStructuredSearchQuery) – (required)
Returns: [SearchQuerySuggestions, resp]

getSearchStatus()¶

Get the status of search (Mongo Connector)

Returns: [SearchStatus, resp]

parseSearchQuery()¶

Parse a structured search query

Validates a search query, returning any parse errors that were encountered. In the future, this endpoint may return the abstract syntax tree or evaluated query.

Parameters: body (flywheel.model.SearchStructuredSearchQuery) – (required)
Returns: [SearchParseSearchQueryResult, resp]

search()¶

Perform a search query

Parameters

body (flywheel.model.SearchQuery) – (required)
simple (logical) – (optional) Unwrap result documents into a list.
size (integer) – (optional) The maximum number of results to return.
facets (logical) – (optional) Include additional statistics about the search results. Internal use only.
csv (logical) – (optional) Format the response as a CSV file

Returns

[none, resp]

cleanPackfiles()¶

Clean up expired upload tokens and invalid token directories.

Returns: [Map, resp]

engineUpload()¶

Upload a list of file fields.

### Default behavior: > Uploads a list of file fields sent as file1, file2, etc to an existing container and updates fields of the files, the container and it’s parents as specified in the metadata fileformfield using the engine placer class > A non-file form field called “metadata” is also required, which must be a string containing JSON. > See api/schemas/input/enginemetadata.json for the format of this metadata. ### When level is analysis: > Uploads a list of files to an existing analysis object, marking all files as output=true using the job-based analyses placer class. > A non-file form field called “metadata” is also required, which must be a string containing JSON. > See api/schemas/input/analysis.json for the format of this metadata. ### Signed URL upload with upload_ticket > Upload a single file directly to the storage backend. The workflow is the following: - Send a request with an empty ?upload_ticket= query parameter to get an upload ticket and URL - Upload the file using a PUT request to the upload URL - Once done, send a POST request to this endpoint with the upload ticket to finalize the upload. The file will be placed into the DB via this POST request.

Parameters

level (char) – (required) Which level to store files in
id (char) – (required) The ID of the container to place files in
job (char) – (required) Required if level is analysis
uploadTicket (char) – (optional) Use empty value to get a ticket, and provide the ticket id to finalize the upload
body (char) – (optional) Object encoded as a JSON string. It is required and used only when the upload_ticket parameter is used. See schemas/input/signedurlmetadata.json for the format of the json payload.
formData (char) – (optional)

Returns

[Map, resp]

fetchTree()¶

Query a portion of the flywheel hierarchy, returning only the requested fields.

This is a build-your-own request endpoint that can fetch from anywhere in the hierarchy, returning just the fields that you care about. # Fields Each fetch-level described must include a list of fields to return. These fields can be anything on the container (except info), and will be included in the response if they are present in the container. # Joins Children or parents can be joined as part of this request, by specifying an additional subdocument of the given name. Check /tree/graph for a list of containers and their connections. # Filter Joined documents can be further filtered (with the exception of inputs & files) by passing a filter in the subdocument. Filtering follows the same convention as top-level pagination. # Sort Joined documents can be sorted as well, following the convention as top-level pagination. # Limit Joins can be limited to a the first N documents by specifying a limit in the subdocument. # Join-origin Passing true for the join-origin flag in the files subdocument will populates the join-origin map for each container with files.

Parameters

body (flywheel.model.TreeRequest) – (required)
filter (char) – (optional) The filter to apply. (e.g. label=my-label,created>2018-09-22)
sort (char) – (optional) The sort fields and order. (e.g. label:asc,created:desc)
limit (integer) – (optional) The maximum number of entries to return.
skip (integer) – (optional) The number of entries to skip.
page (integer) – (optional) The page number (i.e. skip limit*page entries)
afterId (char) – (optional) Paginate after the given id. (Cannot be used with sort, page or skip)

Returns

[vector[TreeResponseItem], resp]

getAuthStatus()¶

Get Login status

Get the current login status of the requestor

Returns: [AuthLoginStatus, resp]

getConfigJs()¶

Return public Scitran configuration information in javascript format.

Returns: [none, resp]

getTreeGraph()¶

Get a description of the flywheel hiearchy

Returns: [TreeGraph, resp]

getVersion()¶

Get server and database schema version info

Returns: [VersionOutput, resp]

login()¶

Login

Scitran Authentication

Returns: [AuthLoginOutput, resp]

logout()¶

Log Out

Remove authtokens for user

Returns: [AuthLogoutOutput, resp]

lookupPath()¶

Perform path based lookup of a single node in the Flywheel hierarchy

This will perform a deep lookup of a node. See /resolve for more details.

Parameters: body (flywheel.model.ResolverInput) – (required)
Returns: [ResolverNode, resp]

resolvePath()¶

Perform path based lookup of nodes in the Flywheel hierarchy

This will perform a deep lookup of a node (i.e. group/project/session/acquisition) and its children, including any files. The query path is an array of strings in the following order (by default): * group id * project label * session label * acquisition label Additionally, analyses for project/session/acquisition nodes can be resolved by inserting the literal string “analyses”. e.g. [‘scitran’, ‘MyProject’, ‘analyses’]. Files for projects, sessions, acquisitions and analyses can be resolved by inserting the literal string “files”. e.g. [‘scitran’, ‘MyProject’, ‘files’]. An ID can be used instead of a label by formatting the string as <id:project_id>. The full path to the node, and the node’s children will be included in the response.

Parameters

body (flywheel.model.ResolverInput) – (required)
exhaustive (logical) – (optional) Set to return a complete list regardless of permissions
fullTree (logical) – (optional) Parse full download style paths (e.g. group/PROJECTS/project_label/SUBJECTS/…)
minattr (logical) – (optional) Return only minimal attributes

Returns

[ResolverOutput, resp]

createDevice()¶

Create a new device.

Will create a new device record together with an api key. Request must be an admin request.

Parameters: body (flywheel.model.DeviceCreate) – (required)
Returns: [EgressDevice, resp]

deleteDevice()¶

Delete

(post handlers.devicehandler.DeviceHandler.post)

Parameters: deviceId (char) – (required)
Returns: [none, resp]

deleteDeviceKey()¶

Delete Device Key

Parameters

deviceId (char) – (required)
keyId (char) – (required)

Returns

[none, resp]

getAllDevices()¶

List all devices.

Requires login.

Returns: [vector[Device], resp]

getAllDevicesStatus()¶

Get status for all known devices.

ok - missing - error - unknown

Returns: [DeviceStatus, resp]

getCurrentDevice()¶

Get Self

(get handlers.devicehandler.DeviceHandler.get_self)

Returns: [EgressDevice, resp]

getDevice()¶

Get device details

Parameters: deviceId (char) – (required)
Returns: [EgressDevice, resp]

modifyDevice()¶

Update a device

Parameters

deviceId (char) – (required)
body (flywheel.model.Device) – (required)

Returns

[none, resp]

regenerateKey()¶

Regenerate device API key

Parameters: deviceId (char) – (required)
Returns: [InlineResponse2001, resp]

updateDevice()¶

Modify a device’s type, name, interval, info or set errors.

Will modify the device record of the device making the request. Type may only be set once if not already specified at creation. Request must be a drone request.

Parameters: body (flywheel.model.Device) – (required)
Returns: [Device, resp]

createProjectAet()¶

Create a new DIMSE project AET

Will create a new DIMSE AET that refers to a Flywheel project. AETs can only be created by admins and use drone access via DIMSE.

Parameters: body (flywheel.model.DimseProjectInput) – (required)
Returns: [Map, resp]

createServiceAet()¶

Create a new DIMSE service AET

Will create a new DIMSE AET that refers to an external DICOM node. Service AETs can be used to issue C-MOVEs to from project AETs. Requires login. AETs can only be created by admins.

Parameters: body (flywheel.model.DimseServiceInput) – (required)
Returns: [Map, resp]

deleteProjectAet()¶

Delete a DIMSE project AET

Delete DIMSE project by AET. AETs can only be deleted by admins.

Parameters: projectAET (char) – (required)
Returns: [none, resp]

deleteServiceAet()¶

Delete a DIMSE service AET

Delete DIMSE service by AET. AETs can only be deleted by admins.

Parameters: serviceAET (char) – (required)
Returns: [none, resp]

getAllProjectAets()¶

List all DIMSE project AETs

Will list all DIMSE AETs referring to a Flywheel project. Project AETs can be used to issue C-FIND and C-MOVE on Flywheel projects. Requires login and admin privilege.

Returns: [vector[DimseProjectOutput], resp]

getAllServiceAets()¶

List all DIMSE services AETs

Will list all DIMSE AETs referring to external DICOM nodes. Requires login and admin privilege.

Returns: [vector[DimseServiceOutput], resp]

getProjectAet()¶

Get DIMSE project AET

Get DIMSE project by AET, id or project id. Requires admin privilege.

Parameters: projectAET (char) – (required)
Returns: [DimseProjectOutput, resp]

getServiceAet()¶

Get DIMSE service by AET or id

Get a DIMSE service. Requires login and admin privilege.

Parameters: serviceAET (char) – (required)
Returns: [DimseServiceOutput, resp]

addFileTags()¶

Add list of tags on a file.

Add the tags on a file to the list of tags

Parameters

fileId (char) – (required)
body (flywheel.model.vector[char]) – (required)

Returns

[vector[char], resp]

completeS3MultipartUpload()¶

Complete S3 multipart signed url upload

Complete S3 uploads exceeding 5GB and create the final object in the bucket. Expected an upload id returned previously by the POST /upload/signed-url endpoint and the e-tags returned by S3 after uploaded each file part.

Parameters: body (flywheel.model.UploadCompleteS3MultipartInput) – (required)
Returns: [UploadCompleteS3MultipartOutput, resp]

createDownloadTicket()¶

Create a download ticket

Use filters in the payload to exclude/include files. To pass a single filter, each of its conditions should be satisfied. If a file pass at least one filter, it is included in the targets.

Parameters

body (flywheel.model.Download) – (required) Download files with tag ‘incomplete’ OR type ‘dicom’
type (char) – (optional) The download type, one of: bulk, classic or full. Default is classic.
analyses (logical) – (optional) For “full” download, whether or not to include analyses. Default is false.
metadata (logical) – (optional) For “full” download, whether or not to include metadata sidecars. Default is false.
prefix (char) – (optional) A string to customize the name of the download in the format <prefix>_<timestamp>.tar. Defaults to “scitran”.

Returns

[DownloadTicketWithSummary, resp]

createSignedUploadUrl()¶

Create new signed upload URL

Return a signed upload URL for the requested storage provider_id. Multiple URLs are returned for S3 uploads exceeding 5GB.

Parameters: body (flywheel.model.UploadSignedUploadUrlInput) – (required)
Returns: [UploadSignedUploadUrlOutput, resp]

deleteFile()¶

Delete a File

A user with read-write or higher permissions on the container may delete files that were uploaded by users or were the output of jobs. (Specifically, files whose origin.type is either job or user.) A user with admin permissions on the container may delete any file.

Parameters

fileId (char) – (required)
version (integer) – (optional)
deleteReason (Object) – (optional) A reason for deletion when change-logging is enabled
force (logical) – (optional) Force deletion of the file even if some checks fail

Returns

[DeletedResult, resp]

downloadTicket()¶

Download files listed in the given ticket.

You can use POST to create a download ticket The files listed in the ticket are put into a tar archive

Parameters

ticket (char) – (required) ID of the download ticket
format (char) – (optional) Archive format the download will be wrapped in

Returns

[none, resp]

getFile()¶

Get File

Get file details

Parameters

fileId (char) – (required)
version (integer) – (optional)

Returns

[FileEntry, resp]

getFileVersions()¶

Get Versions

Get file version details

Parameters: fileId (char) – (required)
Returns: [vector[FileVersionOutput], resp]

moveFile()¶

Move and/or rename a file

Move a file to a new container and/or give it a new name

Parameters

fileId (char) – (required)
body (flywheel.model.FileMoveInput) – (required)

Returns

[ModifiedResult, resp]

restoreFile()¶

Restore a File

Restore a specific version of a file as the active version. This will create a new version which will be identical to the restored version.

Parameters

fileId (char) – (required)
version (integer) – (required)
evaluateGearRules (logical) – (required) Specify if gear rules should be reevaluated on the newly created file version

Returns

[FileEntry, resp]

setFileTags()¶

Set list of tags on a file.

Set the tags on a file to the list of tags provided

Parameters

fileId (char) – (required)
body (flywheel.model.vector[char]) – (required)

Returns

[ModifiedResult, resp]

uploadByLabel()¶

Multipart form upload with N file fields, each with their desired filename.

### Default behavior: > For technical reasons, no form field names can be repeated. Instead, use (file1, file2) and so forth. > A non-file form field called “metadata” is also required, which must be a string containing JSON. > See api/schemas/input/labelupload.json for the format of this metadata. ### Signed URL upload with ticket > Upload a single file directly to the storage backend. The workflow is the following: - Send a request with an empty ?ticket= query parameter to get an upload ticket and URL - Upload the file using a PUT request to the upload URL - Once done, send a POST request to this endpoint with the upload ticket to finalize the upload. The file will be placed into the DB via this POST request.

Parameters

ticket (char) – (optional) Use empty value to get a ticket, and provide the ticket id to finalize the upload
body (char) – (optional) Object encoded as a JSON string. It is required and used only when the ticket parameter is used. See schemas/input/signedurlmetadata.json for the format of the json payload.
formData (char) – (optional)

Returns

[Map, resp]

uploadByReaper()¶

Bottom-up UID matching of Multipart form upload with N file fields, each with their desired filename.

### Default behavior: > Upload data, allowing users to move sessions during scans without causing new data to be created in referenced project/group. ### Evaluation Order: * If a matching acquisition UID is found anywhere on the system, the related files will be placed under that acquisition. * OR If a matching session UID is found, a new acquistion is created with the specified UID under that Session UID. * OR If a matching group ID and project label are found, a new session and acquisition will be created within that project * OR If a matching group ID is found, a new project and session and acquisition will be created within that group. * OR A new session and acquisition will be created within a special “Unknown” group and project, which is only visible to system administrators. ### Signed URL upload with ticket > Upload a single file directly to the storage backend. The workflow is the following: - Send a request with an empty ?ticket= query parameter to get an upload ticket and URL - Upload the file using a PUT request to the upload URL - Once done, send a POST request to this endpoint with the upload ticket to finalize the upload. The file will be placed into the DB via this POST request.

Parameters

ticket (char) – (optional) Use empty value to get a ticket, and provide the ticket id to finalize the upload
body (char) – (optional) Object encoded as a JSON string. It is required and used only when the ticket parameter is used. See schemas/input/signedurlmetadata.json for the format of the json payload.
formData (char) – (optional)

Returns

[vector[FileEntry], resp]

uploadByUid()¶

Multipart form upload with N file fields, each with their desired filename.

### Default behavior: > Same behavior as /api/upload/label, except the metadata field must be uid format See api/schemas/input/uidupload.json for the format of this metadata. ### Signed URL upload with ticket > Upload a single file directly to the storage backend. The workflow is the following: - Send a request with an empty ?ticket= query parameter to get an upload ticket and URL - Upload the file using a PUT request to the upload URL - Once done, send a POST request to this endpoint with the upload ticket to finalize the upload. The file will be placed into the DB via this POST request.

Parameters

ticket (char) – (optional) Use empty value to get a ticket, and provide the ticket id to finalize the upload
body (char) – (optional) Object encoded as a JSON string. It is required and used only when the ticket parameter is used. See schemas/input/signedurlmetadata.json for the format of the json payload.
formData (char) – (optional)

Returns

[Map, resp]

uploadMatchUid()¶

Multipart form upload with N file fields, each with their desired filename.

### Default behavior: > Accepts uploads to an existing data hierarchy, matched via Session and Acquisition UID See api/schemas/input/uidmatchupload.json for the format of this metadata. ### Signed URL upload with ticket > Upload a single file directly to the storage backend. The workflow is the following: - Send a request with an empty ?ticket= query parameter to get an upload ticket and URL - Upload the file using a PUT request to the upload URL - Once done, send a POST request to this endpoint with the upload ticket to finalize the upload. The file will be placed into the DB via this POST request.

Parameters

ticket (char) – (optional) Use empty value to get a ticket, and provide the ticket id to finalize the upload
body (char) – (optional) Object encoded as a JSON string. It is required and used only when the ticket parameter is used. See schemas/input/signedurlmetadata.json for the format of the json payload.
formData (char) – (optional)

Returns

[Map, resp]

uploadSignedFsFile()¶

Upload file to local filesystem storage provider

The POST /api/upload/signed-url endpoint returns a url with a jwt token pointing to this endpoint if the storage provider is a local filesystem then the file can be uploaded simply by sending the file content in the body of the payload. The destination storage provider and the file path are encoded in the jwt token.

Parameters

token (char) – (required) Upload token
body (flywheel.model.Object) – (required)

Returns

[UploadSignedFsFileUploadOutput, resp]

upsertFile()¶

Upsert a File

Create or update a file

Parameters: body (flywheel.model.FileUpsertInput) – (required)
Returns: [FileUpsertOutput, resp]

addGear()¶

Create or update a gear.

If no existing gear is found, one will be created Otherwise, the specified gear will be updated

Parameters

gearName (char) – (required) Name of the gear to interact with
body (flywheel.model.GearDocumentLegacyInput) – (required)

Returns

[GearDocument, resp]

addGearPermission()¶

Add an individual permission to the given gear

Parameters

gearName (char) – (required) Name of the gear to interact with
permissionType (flywheel.model.GearPermissionsType) – (required)
body (flywheel.model.GearPermissionsInput) – (required)

Returns

[GearSeries, resp]

deleteGear()¶

Delete a gear (not recommended)

Parameters: gearId (char) – (required) Id of the gear to interact with
Returns: [none, resp]

deleteGearPermission()¶

Delete an individual permission of the given gear

Parameters

gearName (char) – (required)
permissionType (flywheel.model.GearPermissionsType) – (required)
permissionId (char) – (required)

Returns

[none, resp]

deleteGearPermissions()¶

Delete permissions of the given gear

Parameters: gearName (char) – (required)
Returns: [none, resp]

getAllGears()¶

List all gears

Parameters

allVersions (logical) – (optional) return all versions of each gear
includeInvalid (logical) – (optional) return gears with the ‘invalid’ flag set
filter (char) – (optional) The filter to apply. (e.g. label=my-label,created>2018-09-22)
sort (char) – (optional) The sort fields and order. (e.g. label:asc,created:desc)
limit (integer) – (optional) The maximum number of entries to return.
skip (integer) – (optional) The number of entries to skip.
page (integer) – (optional) The page number (i.e. skip limit*page entries)
afterId (char) – (optional) Paginate after the given id. (Cannot be used with sort, page or skip)

Returns

[vector[GearDoc], resp]

getGear()¶

Retrieve details about a specific gear

Parameters: gearIdOrName (char) – (required) Id of the gear to interact with
Returns: [GearDoc, resp]

getGearContext()¶

Get context values for the given gear and container.

Ref: https://github.com/flywheel-io/gears/tree/master/spec#contextual-values

Parameters

gearId (char) – (required) Id of the gear to interact with
containerType (char) – (required) Type of the container to interact with
containerId (char) – (required) Id of the container to interact with

Returns

[GearContextLookup, resp]

getGearInvocation()¶

Get a schema for invoking a gear.

Parameters: gearId (char) – (required) Id of the gear to interact with
Returns: [Map, resp]

getGearSeries()¶

Get gear series.

Gets the series for the gear by its name

Parameters: gearName (char) – (required)
Returns: [GearSeries, resp]

getGearSuggest()¶

Get files with input suggestions, parent containers, and child containers for the given container.

Parameters

gearId (char) – (required) Id of the gear to interact with
containerType (char) – (required) Type of the container to interact with
containerId (char) – (required) Id of the container to interact with
collectionId (char) – (optional) Get suggestions for a collection
include (char) – (optional) Include only “children” or “files”

Returns

[Map, resp]

getGearTicket()¶

Retrieve a specific gear ticket

Parameters: gearTicketId (char) – (required) The ID of the the gear ticket to retrieve
Returns: [Map, resp]

getMyGearTickets()¶

Retrieve all gear tickets for the current user

Parameters: gearNamesOnly (logical) – (optional) If set, returns a string array of ticket IDs instead of the tickets themselves.
Returns: [Map, resp]

modifyGearSeries()¶

Update a gear series

Parameters

gearName (char) – (required) Name of the gear series to modify
body (flywheel.model.GearSeriesUpdate) – (required)

Returns

[GearSeries, resp]

prepareAddGear()¶

Prepare a gear upload

Parameters: body (flywheel.model.GearDoc) – (required)
Returns: [GearReturnTicket, resp]

replaceGearPermissions()¶

Replace permissions for the given gear

Parameters

gearName (char) – (required) Name of the gear to interact with
body (flywheel.model.GearPermissions) – (required)

Returns

[GearSeries, resp]

saveGear()¶

Report the result of a gear upload and save the ticket

Parameters: body (flywheel.model.GearSaveSubmission) – (required) The ticket, repo and pointer
Returns: [Map, resp]

addGroup()¶

Add a group

Create a new group.

Parameters: body (flywheel.model.GroupInput) – (required)
Returns: [InsertedId, resp]

addGroupPermission()¶

Add a permission

Parameters

groupId (char) – (required)
body (flywheel.model.PermissionAccessPermission) – (required)

Returns

[InlineResponse200, resp]

addGroupPermissionTemplate()¶

Add a permission template

Parameters

groupId (char) – (required)
body (flywheel.model.RolesRoleAssignment) – (required)
propagate (logical) – (optional)

Returns

[InlineResponse200, resp]

addGroupTag()¶

Add a tag to group.

Propagates changes to projects, sessions and acquisitions

Parameters

cid (char) – (required)
body (flywheel.model.Tag) – (required)

Returns

[ModifiedResult, resp]

addRoleToGroup()¶

Add a role to the pool of roles in a group

Add a group role.

Parameters

groupId (char) – (required)
body (flywheel.model.GroupRole) – (required)

Returns

[RoleOutput, resp]

deleteGroup()¶

Delete group

Delete a group.

Parameters: groupId (char) – (required)
Returns: [DeletedResult, resp]

deleteGroupTag()¶

Delete a tag

Parameters

cid (char) – (required)
value (char) – (required) The tag to interact with

Returns

[DeletedResult, resp]

deleteGroupUserPermission()¶

Delete a permission

Deletes a permission from the group Args: group_id: the id of the group user_id: The id of the user auth_session: The auth session of the user

Parameters

groupId (char) – (required)
userId (char) – (required)

Returns

[ModifiedResult, resp]

deleteGroupUserPermissionTemplate()¶

Delete a permission

Parameters

groupId (char) – (required)
userId (char) – (required)
propagate (logical) – (optional)

Returns

[InlineResponse200, resp]

getAllGroupRoles()¶

Get list of group roles

Parameters: groupId (char) – (required)
Returns: [vector[RolesRole], resp]

getAllGroups()¶

List all groups

Find all groups.

Parameters

exhaustive (logical) – (optional) Set to return a complete list regardless of permissions
filter (char) – (optional) The filter to apply. (e.g. label=my-label,created>2018-09-22)
sort (char) – (optional) The sort fields and order. (e.g. label:asc,created:desc)
limit (integer) – (optional) The maximum number of entries to return.
skip (integer) – (optional) The number of entries to skip.
page (integer) – (optional) The page number (i.e. skip limit*page entries)
afterId (char) – (optional) Paginate after the given id. (Cannot be used with sort, page or skip)
xAcceptFeature (vector[Object]) – (optional)

Returns

[none, resp]

getGroup()¶

Get group info

Get a group by ID.

Parameters: groupId (char) – (required)
Returns: [GroupOutput, resp]

getGroupProjects()¶

Get all projects in a group

Get projects for a group

Parameters

groupId (char) – (required)
exhaustive (logical) – (optional)
filter (char) – (optional) The filter to apply. (e.g. label=my-label,created>2018-09-22)
sort (char) – (optional) The sort fields and order. (e.g. label:asc,created:desc)
limit (integer) – (optional) The maximum number of entries to return.
skip (integer) – (optional) The number of entries to skip.
page (integer) – (optional) The page number (i.e. skip limit*page entries)
afterId (char) – (optional) Paginate after the given id. (Cannot be used with sort, page or skip)
xAcceptFeature (vector[char]) – (optional)

Returns

[none, resp]

getGroupRole()¶

Return the role identified by the RoleId

Parameters

groupId (char) – (required)
roleId (char) – (required)

Returns

[RolesRole, resp]

getGroupTag()¶

Get the value of a tag, by name.

Get the value of a tag, by name

Parameters

cid (char) – (required)
value (char) – (required) The tag to interact with

Returns

[char, resp]

getGroupUserPermission()¶

List a user’s permissions for this group.

Parameters

groupId (char) – (required)
userId (char) – (required)

Returns

[PermissionAccessPermission, resp]

getGroupUserPermissionTemplate()¶

List a user’s permissions for this {{resource}}.

Parameters

groupId (char) – (required)
userId (char) – (required)
propagate (logical) – (optional)

Returns

[InlineResponse2003, resp]

modifyGroup()¶

Update group

Modify a group.

Parameters

groupId (char) – (required)
body (flywheel.model.GroupUpdate) – (required)

Returns

[ModifiedResult, resp]

modifyGroupUserPermission()¶

Update a user’s permission for this group.

Parameters

groupId (char) – (required)
userId (char) – (required)
body (flywheel.model.PermissionAccessPermission) – (required)

Returns

[InlineResponse200, resp]

modifyGroupUserPermissionTemplate()¶

Update a user’s permission for this {{resource}}.

Parameters

groupId (char) – (required)
userId (char) – (required)
body (flywheel.model.RolesRoleAssignment) – (required)
propagate (logical) – (optional)

Returns

[InlineResponse200, resp]

removeRoleFromGroup()¶

Remove the role from the group

Parameters

groupId (char) – (required)
roleId (char) – (required)

Returns

[none, resp]

renameGroupTag()¶

Rename a tag.

Rename a tag

Parameters

cid (char) – (required)
value (char) – (required) The tag to interact with
body (flywheel.model.Tag) – (required)

Returns

[char, resp]

acceptFailedOutput()¶

Accept failed job output.

Remove the ‘from_failed_job’ flag from the files. Create any automatic jobs for the accepted files.

Parameters: jobId (char) – (required)
Returns: [none, resp]

addJob()¶

Add a job

Parameters: body (flywheel.model.Job) – (required)
Returns: [CommonObjectCreated, resp]

addJobLogs()¶

Add logs to a job.

Parameters

jobId (char) – (required)
body (flywheel.model.vector[JobLog]) – (required)

Returns

[none, resp]

askJobs()¶

Ask the queue a question

Ask the queue a question, receiving work or statistics in return.

Parameters: body (flywheel.model.JobAsk) – (required)
Returns: [JobAskResponse, resp]

askJobsState()¶

Ask job count by state

Ask the queue for the number of jobs for a given state and query.

Parameters

jobState (char) – (required)
body (flywheel.model.JobAskState) – (required)

Returns

[JobAskStateResponse, resp]

completeJob()¶

Complete a job, with information

Parameters

jobId (char) – (required)
body (flywheel.model.JobCompletionInput) – (required)
jobTicketId (char) – (optional)

Returns

[none, resp]

determineProviderForJob()¶

Determine the effective compute provider for a proposed job.

Parameters: body (flywheel.model.Job) – (required)
Returns: [Provider, resp]

getAllJobs()¶

Return all jobs

Parameters

states (char) – (optional) filter results by job state
tags (char) – (optional) filter results by job tags
filter (char) – (optional) The filter to apply. (e.g. label=my-label,created>2018-09-22)
sort (char) – (optional) The sort fields and order. (e.g. label:asc,created:desc)
limit (integer) – (optional) The maximum number of entries to return.
skip (integer) – (optional) The number of entries to skip.
page (integer) – (optional) The page number (i.e. skip limit*page entries)
afterId (char) – (optional) Paginate after the given id. (Cannot be used with sort, page or skip)

Returns

[vector[JobListEntry], resp]

getJob()¶

Get job details

Parameters: jobId (char) – (required)
Returns: [JobOutput, resp]

getJobConfig()¶

Get a job’s config

Parameters: jobId (char) – (required)
Returns: [JobConfigOutput, resp]

getJobDetail()¶

Get job container details

Parameters: jobId (char) – (required)
Returns: [JobDetail, resp]

getJobLogs()¶

Get job logs

Parameters: jobId (char) – (required)
Returns: [JobLogRecord, resp]

getJobsStats()¶

Get stats about all current jobs

Returns: [Map, resp]

getNextJob()¶

Get the next job in the queue

Used by the engine.

Parameters: tags (vector[char]) – (optional)
Returns: [Job, resp]

modifyJob()¶

Update a job.

Updates timestamp. Enforces a valid state machine transition, if any. Rejects any change to a job that is not currently in ‘pending’ or ‘running’ state. Accepts the same body as /api/jobs/add, except all fields are optional.

Parameters

jobId (char) – (required)
body (flywheel.model.JobModify) – (required)

Returns

[ModifiedResult, resp]

prepareCompleteJob()¶

Create a ticket for completing a job, with id and status.

Parameters: jobId (char) – (required)
Returns: [JobCompletionTicket, resp]

reapJobs()¶

Reap stale jobs

Returns: [Map, resp]

retryJob()¶

Retry a job.

The job must have a state of ‘failed’, and must not have already been retried. The failed jobs config is copied to a new job. The ID of the new job is returned

Parameters

jobId (char) – (required)
computeProviderId (char) – (optional)
ignoreState (logical) – (optional)

Returns

[Map, resp]

updateJobProfile()¶

Update profile information on a job. (e.g. machine type, etc)

Parameters

jobId (char) – (required)
body (flywheel.model.JobProfileInput) – (required)

Returns

[InlineResponse200, resp]

addModality()¶

Create a new modality.

handlers.modalityhandler.ModalityHandler.post

Parameters: body (flywheel.model.ModalityInput) – (required)
Returns: [ModalityOutput, resp]

deleteModality()¶

Delete a modality

Parameters: modalityId (char) – (required)
Returns: [DeletedResult, resp]

getAllModalities()¶

List all modalities.

Requires login.

Returns: [vector[Modality], resp]

getModality()¶

Get a modality’s classification specification

Parameters: modalityId (char) – (required)
Returns: [Modality, resp]

replaceModality()¶

Replace modality

Parameters

modalityId (char) – (required)
body (flywheel.model.ModalityModify) – (required)

Returns

[ModalityOutput, resp]

addProject()¶

Create a new project

Parameters

body (flywheel.model.ProjectInput) – (required)
inherit (logical) – (optional) Inherit permissions from the group permission template

Returns

[InsertedId, resp]

addProjectAnalysis()¶

Create an analysis and upload files.

When query param “job” is “true”, send JSON to create an analysis and job. Otherwise, multipart/form-data to upload files and create an analysis.

Parameters

cid (char) – (required)
body (flywheel.model.Object) – (required)
job (logical) – (optional) returns job_id instead of analysis.id

Returns

[InsertedId, resp]

addProjectAnalysisNote()¶

Add a note to project analysis.

Parameters

containerId (char) – (required) 24-char hex id
analysisId (char) – (required) 24-char hex analysis id
body (flywheel.model.Object) – (required)

Returns

[Note, resp]

addProjectNote()¶

Add a note to project.

Parameters

containerId (char) – (required)
body (flywheel.model.NoteInput) – (required)

Returns

[Note, resp]

addProjectPermission()¶

Add a permission

Parameters

projectId (char) – (required)
body (flywheel.model.RolesRoleAssignment) – (required)

Returns

[InlineResponse200, resp]

addProjectRule()¶

Create a new rule for a project.

Parameters

projectId (char) – (required)
body (flywheel.model.GearRuleInput) – (required)

Returns

[GearRule, resp]

addProjectTag()¶

Add a tag to project.

Propagates changes to projects, sessions and acquisitions

Parameters

cid (char) – (required)
body (flywheel.model.Tag) – (required)

Returns

[ModifiedResult, resp]

catalogList()¶

Catalog List

Parameters

searchString (char) – (optional) Include only results containing the search string
filter (char) – (optional) The filter to apply. (e.g. label=my-label,created>2018-09-22)
sort (char) – (optional) The sort fields and order.(e.g. label:asc,created:desc)
limit (integer) – (optional) The maximum number of entries to return
skip (integer) – (optional) The number of entries to skip
page (integer) – (optional) The page number (i.e. skip limit*page entries)
afterId (char) – (optional) Paginate after the given id. (Cannot be used with sort, page or skip)
xAcceptFeature (vector[Object]) – (optional)

Returns

[none, resp]

deleteProject()¶

Delete a project

Only site admins and users with “admin” project permissions may delete a project

Parameters

projectId (char) – (required)
deleteReason (Object) – (optional) A reason for deletion when change-logging is enabled

Returns

[DeletedResult, resp]

deleteProjectAnalysis()¶

Delete an anaylsis

Delete an analysis for a container.

Parameters

cid (char) – (required)
analysisId (char) – (required)
deleteReason (Object) – (optional) Provide a reason for the deletion

Returns

[DeletedResult, resp]

deleteProjectAnalysisNote()¶

Remove a note from project analysis.

Parameters

cid (char) – (required) 24-char hex id
analysisId (char) – (required) 24-char hex analysis id
noteId (char) – (required) 24-char hex note id

Returns

[DeletedResult, resp]

deleteProjectFile()¶

Delete a file

A user with read-write or higher permissions on the container may delete files that were uploaded by users or were the output of jobs. (Specifically, files whose origin.type is either job or user.) A user with admin permissions on the container may delete any file.

Parameters

cid (char) – (required)
filename (char) – (required)
deleteReason (Object) – (optional) A reason for deletion when change-logging is enabled
force (logical) – (optional) Force deletion of the file even if some checks fail

Returns

[DeletedResult, resp]

deleteProjectNote()¶

Remove a note from project

Parameters

cid (char) – (required)
noteId (char) – (required)

Returns

[DeletedResult, resp]

deleteProjectTag()¶

Delete a tag

Parameters

cid (char) – (required)
value (char) – (required) The tag to interact with

Returns

[DeletedResult, resp]

deleteProjectUserPermission()¶

Delete a permission

Parameters

projectId (char) – (required)
uid (char) – (required)

Returns

[DeletedResult, resp]

downloadFileFromProject()¶

Download a file.

Files can be downloaded directly from this endpoint with a valid “Authorization” header or via a ticket id. To generate a ticket: - Make a request with an empty “ticket” parameter and a valid “Authorization” header. The server will respond with a generated ticket id. - Make another request with the received ticket id in the “ticket” parameter. A valid “Authorization” header is no longer required. When “view” is true, [RFC7233](https://tools.ietf.org/html/rfc7233) range request headers are supported. When virus_scan feature is enabled the quarantined files only can be downloaded using signed urls otherwise it will return with a HTTP 400 response.

Parameters

projectId (char) – (required)
fileName (char) – (required)
view (logical) – (optional) If true, the proper “Content-Type” header based on the file’s mimetype is set on response If false, the “Content-Type” header is set to “application/octet-stream”
info (logical) – (optional) If the file is a zipfile, return a json response of zipfile member information
member (char) – (optional) The filename of a zipfile member to download rather than the entire file
signature (char) – (optional) Url’s signature (signed download url)
expires (char) – (optional) Signed url expiration time (epoch time)

Returns

[DownloadTicket, resp]

getProjectFileZipInfo()¶

Download a file.

Files can be downloaded directly from this endpoint with a valid “Authorization” header or via a ticket id. To generate a ticket: - Make a request with an empty “ticket” parameter and a valid “Authorization” header. The server will respond with a generated ticket id. - Make another request with the received ticket id in the “ticket” parameter. A valid “Authorization” header is no longer required. When “view” is true, [RFC7233](https://tools.ietf.org/html/rfc7233) range request headers are supported. When virus_scan feature is enabled the quarantined files only can be downloaded using signed urls otherwise it will return with a HTTP 400 response.

Parameters

projectId (char) – (required)
fileName (char) – (required)
ticket (char) – (optional) The generated ticket id for the download, or present but empty to generate a ticket id
view (logical) – (optional) If true, the proper “Content-Type” header based on the file’s mimetype is set on response If false, the “Content-Type” header is set to “application/octet-stream”
info (logical) – (optional) If the file is a zipfile, return a json response of zipfile member information
member (char) – (optional) The filename of a zipfile member to download rather than the entire file
signature (char) – (optional) Url’s signature (signed download url)
expires (char) – (optional) Signed url expiration time (epoch time)

Returns

[FileZipInfo, resp]

getProjectDownloadTicket()¶

Download a file.

Files can be downloaded directly from this endpoint with a valid “Authorization” header or via a ticket id. To generate a ticket: - Make a request with an empty “ticket” parameter and a valid “Authorization” header. The server will respond with a generated ticket id. - Make another request with the received ticket id in the “ticket” parameter. A valid “Authorization” header is no longer required. When “view” is true, [RFC7233](https://tools.ietf.org/html/rfc7233) range request headers are supported. When virus_scan feature is enabled the quarantined files only can be downloaded using signed urls otherwise it will return with a HTTP 400 response.

Parameters

projectId (char) – (required)
fileName (char) – (required)
ticket (char) – (optional) The generated ticket id for the download, or present but empty to generate a ticket id
view (logical) – (optional) If true, the proper “Content-Type” header based on the file’s mimetype is set on response If false, the “Content-Type” header is set to “application/octet-stream”
info (logical) – (optional) If the file is a zipfile, return a json response of zipfile member information
member (char) – (optional) The filename of a zipfile member to download rather than the entire file
signature (char) – (optional) Url’s signature (signed download url)
expires (char) – (optional) Signed url expiration time (epoch time)

Returns

[DownloadTicket, resp]

downloadInputFromProjectAnalysis()¶

Download analysis inputs with filter.

If “ticket” query param is included and not empty, download inputs. If “ticket” query param is included and empty, create a ticket for matching inputs in the analysis. If no “ticket” query param is included, inputs will be downloaded directly.

Parameters

projectId (char) – (required)
analysisId (char) – (required)
filename (char) – (required) filename to download (get tar of all if empty)
info (logical) – (optional) If the file is a zipfile, return a json response of zipfile member information
member (char) – (optional) The filename of a zipfile member to download rather than the entire file

Returns

[AnalysisFilesCreateTicketOutput, resp]

getProjectAnalysisInputZipInfo()¶

Download analysis inputs with filter.

If “ticket” query param is included and not empty, download inputs. If “ticket” query param is included and empty, create a ticket for matching inputs in the analysis. If no “ticket” query param is included, inputs will be downloaded directly.

Parameters

projectId (char) – (required)
analysisId (char) – (required)
filename (char) – (required) filename to download (get tar of all if empty)
ticket (char) – (optional) ticket id of the inputs to download
info (logical) – (optional) If the file is a zipfile, return a json response of zipfile member information
member (char) – (optional) The filename of a zipfile member to download rather than the entire file

Returns

[FileZipInfo, resp]

getProjectAnalysisInputDownloadTicket()¶

Download analysis inputs with filter.

If “ticket” query param is included and not empty, download inputs. If “ticket” query param is included and empty, create a ticket for matching inputs in the analysis. If no “ticket” query param is included, inputs will be downloaded directly.

Parameters

projectId (char) – (required)
analysisId (char) – (required)
filename (char) – (required) filename to download (get tar of all if empty)
ticket (char) – (optional) ticket id of the inputs to download
info (logical) – (optional) If the file is a zipfile, return a json response of zipfile member information
member (char) – (optional) The filename of a zipfile member to download rather than the entire file

Returns

[AnalysisFilesCreateTicketOutput, resp]

downloadOutputFromProjectAnalysis()¶

Download analysis outputs with filter.

If “ticket” query param is included and not empty, download outputs. If “ticket” query param is included and empty, create a ticket for matching outputs in the analysis. If no “ticket” query param is included, outputs will be downloaded directly.

Parameters

projectId (char) – (required)
analysisId (char) – (required)
filename (char) – (required) filename to download (get tar of all if empty)
info (logical) – (optional) If the file is a zipfile, return a json response of zipfile member information
member (char) – (optional) The filename of a zipfile member to download rather than the entire file

Returns

[AnalysisFilesCreateTicketOutput, resp]

getProjectAnalysisOutputZipInfo()¶

Download analysis outputs with filter.

If “ticket” query param is included and not empty, download outputs. If “ticket” query param is included and empty, create a ticket for matching outputs in the analysis. If no “ticket” query param is included, outputs will be downloaded directly.

Parameters

projectId (char) – (required)
analysisId (char) – (required)
filename (char) – (required) filename to download (get tar of all if empty)
ticket (char) – (optional) ticket id of the outputs to download
info (logical) – (optional) If the file is a zipfile, return a json response of zipfile member information
member (char) – (optional) The filename of a zipfile member to download rather than the entire file

Returns

[FileZipInfo, resp]

getProjectAnalysisOutputDownloadTicket()¶

Download analysis outputs with filter.

If “ticket” query param is included and not empty, download outputs. If “ticket” query param is included and empty, create a ticket for matching outputs in the analysis. If no “ticket” query param is included, outputs will be downloaded directly.

Parameters

projectId (char) – (required)
analysisId (char) – (required)
filename (char) – (required) filename to download (get tar of all if empty)
ticket (char) – (optional) ticket id of the outputs to download
info (logical) – (optional) If the file is a zipfile, return a json response of zipfile member information
member (char) – (optional) The filename of a zipfile member to download rather than the entire file

Returns

[AnalysisFilesCreateTicketOutput, resp]

downloadProjectAnalysisInputs()¶

Download analysis inputs.

If “ticket” query param is included and not empty, download inputs. If “ticket” query param is included and empty, create a ticket for all inputs in the anlaysis If no “ticket” query param is included, server error 500

Parameters

projectId (char) – (required)
analysisId (char) – (required)
ticket (char) – (optional) ticket id of the inputs to download

Returns

[AnalysisFilesCreateTicketOutput, resp]

downloadProjectAnalysisOutputs()¶

Download analysis outputs.

If “ticket” query param is included and not empty, download outputs. If “ticket” query param is included and empty, create a ticket for all outputs in the anlaysis If no “ticket” query param is included, server error 500

Parameters

projectId (char) – (required)
analysisId (char) – (required)
ticket (char) – (optional) ticket id of the outputs to download

Returns

[AnalysisFilesCreateTicketOutput, resp]

endProjectPackfileUpload()¶

End a packfile upload

Parameters

token (char) – (required)
metadata (char) – (required) string-encoded metadata json object.
fileCount (integer) – (required) Number of files uploaded into this packfile.
projectId (char) – (required)

Returns

[none, resp]

getAllProjects()¶

Get a list of projects

Parameters

filter (char) – (optional) The filter to apply. (e.g. label=my-label,created>2018-09-22)
sort (char) – (optional) The sort fields and order. (e.g. label:asc,created:desc)
limit (integer) – (optional) The maximum number of entries to return.
skip (integer) – (optional) The number of entries to skip.
page (integer) – (optional) The page number (i.e. skip limit*page entries)
afterId (char) – (optional) Paginate after the given id. (Cannot be used with sort, page or skip)
counts (logical) – (optional) Append the count of subjects in each project
stats (logical) – (optional) Return the status of subjects and sessions in each project
joinAvatars (logical) – (optional) Return the joined avatars of the permissions
join (JoinType) – (optional)
exhaustive (logical) – (optional) Set to return a complete list regardless of permissions
xAcceptFeature (vector[Object]) – (optional)

Returns

[none, resp]

getAllProjectsGroups()¶

List all groups which have a project in them

Parameters

filter (char) – (optional) The filter to apply. (e.g. label=my-label,created>2018-09-22)
sort (char) – (optional) The sort fields and order.(e.g. label:asc,created:desc)
limit (integer) – (optional) The maximum number of entries to return
skip (integer) – (optional) The number of entries to skip
page (integer) – (optional) The page number (i.e. skip limit*page entries)
afterId (char) – (optional) Paginate after the given id. (Cannot be used with sort, page or skip)
exhaustive (logical) – (optional) returns exhaustive list if correct permissions
xAcceptFeature (vector[char]) – (optional)

Returns

[vector[GroupOutput], resp]

getCatalogListFilterOptions()¶

Get all filter options for sharing a project

Returns: [SharingFilterOptions, resp]

getProject()¶

Get a single project

Parameters

projectId (char) – (required)
join (JoinType) – (optional)
joinAvatars (logical) – (optional) add name and avatar to notes
xAcceptFeature (vector[Object]) – (optional)

Returns

[ProjectOutput, resp]

getProjectAcquisitions()¶

List all acquisitions for the given project.

Parameters

projectId (char) – (required)
filter (char) – (optional) The filter to apply. (e.g. label=my-label,created>2018-09-22)
sort (char) – (optional) The sort fields and order. (e.g. label:asc,created:desc)
limit (integer) – (optional) The maximum number of entries to return.
skip (integer) – (optional) The number of entries to skip.
page (integer) – (optional) The page number (i.e. skip limit*page entries)
afterId (char) – (optional) Paginate after the given id. (Cannot be used with sort, page or skip)
collectionId (char) – (optional)
exhaustive (logical) – (optional)
join (JoinType) – (optional)
xAcceptFeature (vector[char]) – (optional)

Returns

[none, resp]

getProjectAnalyses()¶

Get analyses for project.

Returns analyses that directly belong to this resource.

Parameters

cid (char) – (required)
filter (char) – (optional) The filter to apply. (e.g. label=my-label,created>2018-09-22)
sort (char) – (optional) The sort fields and order. (e.g. label:asc,created:desc)
limit (integer) – (optional) The maximum number of entries to return.
skip (integer) – (optional) The number of entries to skip.
page (integer) – (optional) The page number (i.e. skip limit*page entries)
afterId (char) – (optional) Paginate after the given id. (Cannot be used with sort, page or skip)
inflateJob (logical) – (optional)
joinAvatars (logical) – (optional)
join (JoinType) – (optional)
xAcceptFeature (vector[char]) – (optional)

Returns

[none, resp]

getProjectAnalysis()¶

Get an analysis.

partial(func, *args, **keywords) - new function with partial application of the given arguments and keywords.

Parameters

cid (char) – (required)
analysisId (char) – (required)
inflateJob (logical) – (optional) Return job as an object instead of an id
joinAvatars (logical) – (optional)
join (JoinType) – (optional)

Returns

[none, resp]

getProjectFileInfo()¶

Get info for a particular file.

Parameters

projectId (char) – (required)
fileName (char) – (required)

Returns

[FileEntry, resp]

getProjectNote()¶

Get a note on project.

Get a note on project

Parameters

cid (char) – (required)
noteId (char) – (required)

Returns

[Note, resp]

getProjectRule()¶

Get a project rule.

Parameters

projectId (char) – (required)
ruleId (char) – (required)

Returns

[Rule, resp]

getProjectRules()¶

List all rules for a project.

Parameters: projectId (char) – (required)
Returns: [vector[GearRule], resp]

getProjectSessions()¶

List all sessions for the given project.

Returns a page of sessions by their parent

Parameters

projectId (char) – (required) 24-char hex subject id
join (Object) – (optional) join file origins
filter (char) – (optional) The filter to apply. (e.g. label=my-label,created>2018-09-22)
sort (char) – (optional) The sort fields and order. (e.g. label:asc,created:desc)
limit (integer) – (optional) The maximum number of entries to return.
skip (integer) – (optional) The number of entries to skip.
page (integer) – (optional) The page number (i.e. skip limit*page entries)
afterId (char) – (optional) Paginate after the given id. (Cannot be used with sort, page or skip)
xAcceptFeature (vector[Object]) – (optional)

Returns

[none, resp]

getProjectSettings()¶

Get settings on project

Parameters: projectId (char) – (required)
Returns: [ProjectSettingsOutput, resp]

getProjectSubjects()¶

List all subjects for the given project.

Parameters

projectId (char) – (required)
filter (char) – (optional) The filter to apply. (e.g. label=my-label,created>2018-09-22)
sort (char) – (optional) The sort fields and order. (e.g. label:asc,created:desc)
limit (integer) – (optional) The maximum number of entries to return.
skip (integer) – (optional) The number of entries to skip.
page (integer) – (optional) The page number (i.e. skip limit*page entries)
afterId (char) – (optional) Paginate after the given id. (Cannot be used with sort, page or skip)
join (JoinType) – (optional)
xAcceptFeature (vector[char]) – (optional)

Returns

[none, resp]

getProjectTag()¶

Get the value of a tag, by name.

Get the value of a tag, by name

Parameters

cid (char) – (required)
value (char) – (required) The tag to interact with

Returns

[char, resp]

getProjectUserPermission()¶

List a user’s permissions for this project.

Parameters

projectId (char) – (required)
userId (char) – (required)

Returns

[InlineResponse2003, resp]

modifyProject()¶

Update a project

Parameters

projectId (char) – (required)
body (flywheel.model.ProjectModify) – (required)

Returns

[ModifiedResult, resp]

modifyProjectAnalysis()¶

Modify an analysis.

Parameters

cid (char) – (required)
analysisId (char) – (required)
body (flywheel.model.AnalysisModifyInput) – (required)

Returns

[ModifiedResult, resp]

modifyProjectFile()¶

Modify a file’s attributes

Note: If modifying a file’s modality, the current classification will be cleared (except for items in the “Custom” list)

Parameters

cid (char) – (required)
filename (char) – (required)
body (flywheel.model.FileModifyInput) – (required)

Returns

[ModifiedResult, resp]

modifyProjectFileClassification()¶

Update classification for a particular file.

If replacing a file’s classification, the modality can optionally be modified as well.

Parameters

cid (char) – (required)
filename (char) – (required)
body (flywheel.model.FileClassificationDelta) – (required)

Returns

[ModifiedResult, resp]

modifyProjectFileInfo()¶

Update info for a particular file.

Parameters

projectId (char) – (required)
fileName (char) – (required)
body (flywheel.model.InfoUpdateInput) – (required)

Returns

[InlineResponse200, resp]

modifyProjectInfo()¶

Update or replace info for a project.

Parameters

projectId (char) – (required)
body (flywheel.model.InfoUpdateInput) – (required)

Returns

[none, resp]

modifyProjectNote()¶

Update a note on project.

Update a note on project

Parameters

cid (char) – (required)
noteId (char) – (required)
body (flywheel.model.NoteInput) – (required)

Returns

[integer, resp]

modifyProjectRule()¶

Update a rule on a project.

Parameters

projectId (char) – (required)
ruleId (char) – (required)
body (flywheel.model.Rule) – (required)

Returns

[none, resp]

modifyProjectSettings()¶

Modify project settings

Parameters

projectId (char) – (required)
body (flywheel.model.ProjectSharingSettingsProjectSettingsInput) – (required)

Returns

[ProjectSharingSettingsProjectSettingsOutput, resp]

modifyProjectUserPermission()¶

Update a user’s permission for this project.

Parameters

projectId (char) – (required)
userId (char) – (required)
body (flywheel.model.RolesRoleAssignment) – (required)

Returns

[InlineResponse200, resp]

projectCopy()¶

Copy By Reference

Copy a project and its descendants to a new project tree

Parameters

projectId (char) – (required)
body (flywheel.model.ProjectCopyInput) – (required)

Returns

[ProjectCopyOutput, resp]

projectPackfileUpload()¶

Add files to an in-progress packfile

Parameters

projectId (char) – (required)
token (char) – (required)
file (vector) – (required)

Returns

[vector[FileEntry], resp]

recalcAllProjects()¶

Recalculate all sessions against their project templates.

Iterates all projects that have a session template. Recalculate if projects’ sessions satisfy the template. Returns list of modified session ids.

Returns: [SessionTemplateRecalcOutput, resp]

recalcProject()¶

Recalculate if sessions in the project satisfy the template.

Returns list of modified session ids.

Parameters: projectId (char) – (required)
Returns: [SessionTemplateRecalcOutput, resp]

removeProjectRule()¶

Remove a project rule.

Parameters

projectId (char) – (required)
ruleId (char) – (required)

Returns

[InlineResponse2002, resp]

removeProjectTemplate()¶

Remove the session template for a project.

Parameters: projectId (char) – (required)
Returns: [InlineResponse2002, resp]

renameProjectTag()¶

Rename a tag.

Rename a tag

Parameters

cid (char) – (required)
value (char) – (required) The tag to interact with
body (flywheel.model.Tag) – (required)

Returns

[char, resp]

replaceProjectFile()¶

Replace a file

Parameters

projectId (char) – (required)
fileName (char) – (required)

Returns

[none, resp]

setProjectTemplate()¶

Set the session template for a project.

Parameters

projectId (char) – (required)
body (flywheel.model.vector[ProjectTemplateSessionTemplate]) – (required)

Returns

[InlineResponse200, resp]

startProjectPackfileUpload()¶

Start a packfile upload to project

Parameters: projectId (char) – (required)
Returns: [UploadTokenOutput, resp]

uploadFileToProject()¶

Upload a file to project.

Parameters

cid (char) – (required)
file (vector) – (required) The file to upload
preserveMetadata (logical) – (optional)
ticket (char) – (optional)
metadata (char) – (optional) File metadata
xAcceptFeature (vector[char]) – (optional) redirect header

Returns

[none, resp]

uploadOutputToProjectAnalysis()¶

Upload an output file to analysis.

Parameters

projectId (char) – (required)
analysisId (char) – (required)
file (vector) – (required) The file to upload

Returns

[none, resp]

upsertProjectHierarchy()¶

Create or update subject, session and acquisition containers in the project.

Create, update or just return an existing container sub-hierarchy as-is for the given project. Useful for efficient and highly parallel automated imports using device authN, based on common routing fields such as id, uid and label.

Parameters

projectId (char) – (required)
body (flywheel.model.ProjectHierarchyUpsertInput) – (required)

Returns

[ProjectHierarchyUpsertOutput, resp]

collectUsage()¶

Collect daily usage statistics.

Collects usage statistics for the selected day (or yesterday if no day is given)

Parameters

year (integer) – (optional) The year portion of the date
month (integer) – (optional) The month portion of the date
day (integer) – (optional) The day portion of the date

Returns

[none, resp]

getAccessLogReport()¶

Get a report of access log entries for the given parameters

Parameters

startDate (char) – (optional) An ISO formatted timestamp for the start time of the report
endDate (char) – (optional) An ISO formatted timestamp for the end time of the report
uid (char) – (optional) User id of the target user
limit (integer) – (optional) Maximum number of records to return
subject (char) – (optional) Limit the report to the subject code of subject accessed
project (char) – (optional) Limit the report to the project id
accessType (vector[char]) – (optional) The list of access_types to filter logs
csv (logical) – (optional) Set to download a csv file instead of json

Returns

[vector[ReportAccessLogEntry], resp]

getAccessLogTypes()¶

Get the list of types of access log entries

Returns: [vector[char], resp]

getDailyUsageReport()¶

Get a daily usage report for the given month.

If no year/month pair is given, the current month will be used.

Parameters

year (integer) – (optional) The year portion of the date
month (integer) – (optional) The month portion of the date
group (char) – (optional) Limit the report to the given group id
project (char) – (optional) Limit the report to the given project id
csv (logical) – (optional) Download the report as a CSV file

Returns

[vector[ReportDailyUsageEntry], resp]

getLegacyUsageReport()¶

Get a usage report for the site grouped by month or project

This report is DEPRECATED and will be removed in a future release

Parameters

type (char) – (required) The type of usage report to generate
startDate (char) – (optional) An ISO formatted timestamp for the start time of the report
endDate (char) – (optional) An ISO formatted timestamp for the end time of the report

Returns

[vector[ReportLegacyUsageEntry], resp]

getProjectReport()¶

Parameters

projects (char) – (optional) Specify multiple times to include projects in the report
startDate (char) – (optional) Report start date
endDate (char) – (optional) Report end date

Returns

[ReportProject, resp]

getSiteReport()¶

Returns: [ReportSite, resp]

getUsageAvailability()¶

Get year/month combinations where report data is available.

Returns: [vector[ReportTimePeriod], resp]

getUsageReport()¶

Get a usage report for the given month.

If no year/month pair is given, the current month will be used.

Parameters

year (integer) – (optional) The year portion of the date
month (integer) – (optional) The month portion of the date

Returns

[vector[ReportUsageEntry], resp]

addRole()¶

Add a new role

Parameters: body (flywheel.model.RolesRoleInput) – (required)
Returns: [RolesRole, resp]

deleteRole()¶

Delete the role

Parameters: roleId (char) – (required) The ID of the role
Returns: [none, resp]

getAllRoles()¶

Get list of all roles

Returns: [vector[RolesRole], resp]

getRole()¶

Return the role identified by the RoleId

Parameters: roleId (char) – (required) The ID of the role
Returns: [RolesRole, resp]

modifyRole()¶

Update the role identified by RoleId

Parameters

roleId (char) – (required) The ID of the role
body (flywheel.model.RolesRoleInput) – (required)

Returns

[none, resp]

addSiteRule()¶

Create a new site rule.

Parameters: body (flywheel.model.Rule) – (required)
Returns: [none, resp]

getSiteRule()¶

Get a site rule.

Parameters: ruleId (char) – (required)
Returns: [Rule, resp]

getSiteRules()¶

List all site rules.

Returns: [vector[Rule], resp]

modifySiteRule()¶

Update a site rule.

Parameters

ruleId (char) – (required)
body (flywheel.model.Rule) – (required)

Returns

[none, resp]

removeSiteRule()¶

Remove a site rule.

Parameters: ruleId (char) – (required)
Returns: [InlineResponse2002, resp]

addSession()¶

Create a new session

Create a session.

Parameters: body (flywheel.model.SessionInput) – (required)
Returns: [InsertedId, resp]

addSessionAnalysis()¶

Create an analysis and upload files.

When query param “job” is “true”, send JSON to create an analysis and job. Otherwise, multipart/form-data to upload files and create an analysis.

Parameters

cid (char) – (required)
body (flywheel.model.Object) – (required)
job (logical) – (optional) returns job_id instead of analysis.id

Returns

[InsertedId, resp]

addSessionAnalysisNote()¶

Add a note to session analysis.

Parameters

containerId (char) – (required) 24-char hex id
analysisId (char) – (required) 24-char hex analysis id
body (flywheel.model.Object) – (required)

Returns

[Note, resp]

addSessionNote()¶

Add a note to session.

Parameters

containerId (char) – (required)
body (flywheel.model.NoteInput) – (required)

Returns

[Note, resp]

addSessionTag()¶

Add a tag to session.

Propagates changes to projects, sessions and acquisitions

Parameters

cid (char) – (required)
body (flywheel.model.Tag) – (required)

Returns

[ModifiedResult, resp]

deleteSession()¶

Delete a session

Read-write project permissions are required to delete a session. Admin project permissions are required if the session or it’s acquisitions contain data uploaded by sources other than users and jobs.

Parameters

sessionId (char) – (required)
deleteReason (ContainerDeleteReason) – (optional)

Returns

[DeletedResult, resp]

deleteSessionAnalysis()¶

Delete an anaylsis

Delete an analysis for a container.

Parameters

cid (char) – (required)
analysisId (char) – (required)
deleteReason (Object) – (optional) Provide a reason for the deletion

Returns

[DeletedResult, resp]

deleteSessionAnalysisNote()¶

Remove a note from session analysis.

Parameters

cid (char) – (required) 24-char hex id
analysisId (char) – (required) 24-char hex analysis id
noteId (char) – (required) 24-char hex note id

Returns

[DeletedResult, resp]

deleteSessionFile()¶

Delete a file

A user with read-write or higher permissions on the container may delete files that were uploaded by users or were the output of jobs. (Specifically, files whose origin.type is either job or user.) A user with admin permissions on the container may delete any file.

Parameters

cid (char) – (required)
filename (char) – (required)
deleteReason (Object) – (optional) A reason for deletion when change-logging is enabled
force (logical) – (optional) Force deletion of the file even if some checks fail

Returns

[DeletedResult, resp]

deleteSessionNote()¶

Remove a note from session

Parameters

cid (char) – (required)
noteId (char) – (required)

Returns

[DeletedResult, resp]

deleteSessionTag()¶

Delete a tag

Parameters

cid (char) – (required)
value (char) – (required) The tag to interact with

Returns

[DeletedResult, resp]

downloadFileFromSession()¶

Download a file.

Files can be downloaded directly from this endpoint with a valid “Authorization” header or via a ticket id. To generate a ticket: - Make a request with an empty “ticket” parameter and a valid “Authorization” header. The server will respond with a generated ticket id. - Make another request with the received ticket id in the “ticket” parameter. A valid “Authorization” header is no longer required. When “view” is true, [RFC7233](https://tools.ietf.org/html/rfc7233) range request headers are supported. When virus_scan feature is enabled the quarantined files only can be downloaded using signed urls otherwise it will return with a HTTP 400 response.

Parameters

sessionId (char) – (required)
fileName (char) – (required)
view (logical) – (optional) If true, the proper “Content-Type” header based on the file’s mimetype is set on response If false, the “Content-Type” header is set to “application/octet-stream”
info (logical) – (optional) If the file is a zipfile, return a json response of zipfile member information
member (char) – (optional) The filename of a zipfile member to download rather than the entire file
signature (char) – (optional) Url’s signature (signed download url)
expires (char) – (optional) Signed url expiration time (epoch time)

Returns

[DownloadTicket, resp]

getSessionFileZipInfo()¶

Download a file.

Files can be downloaded directly from this endpoint with a valid “Authorization” header or via a ticket id. To generate a ticket: - Make a request with an empty “ticket” parameter and a valid “Authorization” header. The server will respond with a generated ticket id. - Make another request with the received ticket id in the “ticket” parameter. A valid “Authorization” header is no longer required. When “view” is true, [RFC7233](https://tools.ietf.org/html/rfc7233) range request headers are supported. When virus_scan feature is enabled the quarantined files only can be downloaded using signed urls otherwise it will return with a HTTP 400 response.

Parameters

sessionId (char) – (required)
fileName (char) – (required)
ticket (char) – (optional) The generated ticket id for the download, or present but empty to generate a ticket id
view (logical) – (optional) If true, the proper “Content-Type” header based on the file’s mimetype is set on response If false, the “Content-Type” header is set to “application/octet-stream”
info (logical) – (optional) If the file is a zipfile, return a json response of zipfile member information
member (char) – (optional) The filename of a zipfile member to download rather than the entire file
signature (char) – (optional) Url’s signature (signed download url)
expires (char) – (optional) Signed url expiration time (epoch time)

Returns

[FileZipInfo, resp]

getSessionDownloadTicket()¶

Download a file.

Files can be downloaded directly from this endpoint with a valid “Authorization” header or via a ticket id. To generate a ticket: - Make a request with an empty “ticket” parameter and a valid “Authorization” header. The server will respond with a generated ticket id. - Make another request with the received ticket id in the “ticket” parameter. A valid “Authorization” header is no longer required. When “view” is true, [RFC7233](https://tools.ietf.org/html/rfc7233) range request headers are supported. When virus_scan feature is enabled the quarantined files only can be downloaded using signed urls otherwise it will return with a HTTP 400 response.

Parameters

sessionId (char) – (required)
fileName (char) – (required)
ticket (char) – (optional) The generated ticket id for the download, or present but empty to generate a ticket id
view (logical) – (optional) If true, the proper “Content-Type” header based on the file’s mimetype is set on response If false, the “Content-Type” header is set to “application/octet-stream”
info (logical) – (optional) If the file is a zipfile, return a json response of zipfile member information
member (char) – (optional) The filename of a zipfile member to download rather than the entire file
signature (char) – (optional) Url’s signature (signed download url)
expires (char) – (optional) Signed url expiration time (epoch time)

Returns

[DownloadTicket, resp]

downloadInputFromSessionAnalysis()¶

Download analysis inputs with filter.

If “ticket” query param is included and not empty, download inputs. If “ticket” query param is included and empty, create a ticket for matching inputs in the analysis. If no “ticket” query param is included, inputs will be downloaded directly.

Parameters

sessionId (char) – (required)
analysisId (char) – (required)
filename (char) – (required) filename to download (get tar of all if empty)
info (logical) – (optional) If the file is a zipfile, return a json response of zipfile member information
member (char) – (optional) The filename of a zipfile member to download rather than the entire file

Returns

[AnalysisFilesCreateTicketOutput, resp]

getSessionAnalysisInputZipInfo()¶

Download analysis inputs with filter.

If “ticket” query param is included and not empty, download inputs. If “ticket” query param is included and empty, create a ticket for matching inputs in the analysis. If no “ticket” query param is included, inputs will be downloaded directly.

Parameters

sessionId (char) – (required)
analysisId (char) – (required)
filename (char) – (required) filename to download (get tar of all if empty)
ticket (char) – (optional) ticket id of the inputs to download
info (logical) – (optional) If the file is a zipfile, return a json response of zipfile member information
member (char) – (optional) The filename of a zipfile member to download rather than the entire file

Returns

[FileZipInfo, resp]

getSessionAnalysisInputDownloadTicket()¶

Download analysis inputs with filter.

If “ticket” query param is included and not empty, download inputs. If “ticket” query param is included and empty, create a ticket for matching inputs in the analysis. If no “ticket” query param is included, inputs will be downloaded directly.

Parameters

sessionId (char) – (required)
analysisId (char) – (required)
filename (char) – (required) filename to download (get tar of all if empty)
ticket (char) – (optional) ticket id of the inputs to download
info (logical) – (optional) If the file is a zipfile, return a json response of zipfile member information
member (char) – (optional) The filename of a zipfile member to download rather than the entire file

Returns

[AnalysisFilesCreateTicketOutput, resp]

downloadOutputFromSessionAnalysis()¶

Download analysis outputs with filter.

If “ticket” query param is included and not empty, download outputs. If “ticket” query param is included and empty, create a ticket for matching outputs in the analysis. If no “ticket” query param is included, outputs will be downloaded directly.

Parameters

sessionId (char) – (required)
analysisId (char) – (required)
filename (char) – (required) filename to download (get tar of all if empty)
info (logical) – (optional) If the file is a zipfile, return a json response of zipfile member information
member (char) – (optional) The filename of a zipfile member to download rather than the entire file

Returns

[AnalysisFilesCreateTicketOutput, resp]

getSessionAnalysisOutputZipInfo()¶

Download analysis outputs with filter.

If “ticket” query param is included and not empty, download outputs. If “ticket” query param is included and empty, create a ticket for matching outputs in the analysis. If no “ticket” query param is included, outputs will be downloaded directly.

Parameters

sessionId (char) – (required)
analysisId (char) – (required)
filename (char) – (required) filename to download (get tar of all if empty)
ticket (char) – (optional) ticket id of the outputs to download
info (logical) – (optional) If the file is a zipfile, return a json response of zipfile member information
member (char) – (optional) The filename of a zipfile member to download rather than the entire file

Returns

[FileZipInfo, resp]

getSessionAnalysisOutputDownloadTicket()¶

Download analysis outputs with filter.

If “ticket” query param is included and not empty, download outputs. If “ticket” query param is included and empty, create a ticket for matching outputs in the analysis. If no “ticket” query param is included, outputs will be downloaded directly.

Parameters

sessionId (char) – (required)
analysisId (char) – (required)
filename (char) – (required) filename to download (get tar of all if empty)
ticket (char) – (optional) ticket id of the outputs to download
info (logical) – (optional) If the file is a zipfile, return a json response of zipfile member information
member (char) – (optional) The filename of a zipfile member to download rather than the entire file

Returns

[AnalysisFilesCreateTicketOutput, resp]

downloadSessionAnalysisInputs()¶

Download analysis inputs.

If “ticket” query param is included and not empty, download inputs. If “ticket” query param is included and empty, create a ticket for all inputs in the anlaysis If no “ticket” query param is included, server error 500

Parameters

sessionId (char) – (required)
analysisId (char) – (required)
ticket (char) – (optional) ticket id of the inputs to download

Returns

[AnalysisFilesCreateTicketOutput, resp]

downloadSessionAnalysisOutputs()¶

Download analysis outputs.

If “ticket” query param is included and not empty, download outputs. If “ticket” query param is included and empty, create a ticket for all outputs in the anlaysis If no “ticket” query param is included, server error 500

Parameters

sessionId (char) – (required)
analysisId (char) – (required)
ticket (char) – (optional) ticket id of the outputs to download

Returns

[AnalysisFilesCreateTicketOutput, resp]

getAllSessions()¶

Get a list of sessions

Finds all sessions.

Parameters

exhaustive (logical) – (optional) Set to return a complete list regardless of permissions
joinAvatars (logical) – (optional) add name and avatar to notes
join (Object) – (optional) join file origins
userId (char) – (optional)
filter (char) – (optional) The filter to apply. (e.g. label=my-label,created>2018-09-22)
sort (char) – (optional) The sort fields and order. (e.g. label:asc,created:desc)
limit (integer) – (optional) The maximum number of entries to return.
skip (integer) – (optional) The number of entries to skip.
page (integer) – (optional) The page number (i.e. skip limit*page entries)
afterId (char) – (optional) Paginate after the given id. (Cannot be used with sort, page or skip)
xAcceptFeature (vector[Object]) – (optional)

Returns

[none, resp]

getSession()¶

Get a single session

Parameters

sessionId (char) – (required)
joinAvatars (logical) – (optional) add name and avatar to notes
join (JoinType) – (optional)
xAcceptFeature (vector[Object]) – (optional)

Returns

[SessionOutput, resp]

getSessionAcquisitions()¶

List acquisitions in a session

Get acquisitions.

Parameters

sessionId (char) – (required)
collectionId (char) – (optional)
exhaustive (logical) – (optional)
join (JoinType) – (optional)
filter (char) – (optional) The filter to apply. (e.g. label=my-label,created>2018-09-22)
sort (char) – (optional) The sort fields and order. (e.g. label:asc,created:desc)
limit (integer) – (optional) The maximum number of entries to return.
skip (integer) – (optional) The number of entries to skip.
page (integer) – (optional) The page number (i.e. skip limit*page entries)
afterId (char) – (optional) Paginate after the given id. (Cannot be used with sort, page or skip)
xAcceptFeature (vector[char]) – (optional)

Returns

[none, resp]

getSessionAnalyses()¶

Get analyses for session.

Returns analyses that directly belong to this resource.

Parameters

cid (char) – (required)
filter (char) – (optional) The filter to apply. (e.g. label=my-label,created>2018-09-22)
sort (char) – (optional) The sort fields and order. (e.g. label:asc,created:desc)
limit (integer) – (optional) The maximum number of entries to return.
skip (integer) – (optional) The number of entries to skip.
page (integer) – (optional) The page number (i.e. skip limit*page entries)
afterId (char) – (optional) Paginate after the given id. (Cannot be used with sort, page or skip)
inflateJob (logical) – (optional)
joinAvatars (logical) – (optional)
join (JoinType) – (optional)
xAcceptFeature (vector[char]) – (optional)

Returns

[none, resp]

getSessionAnalysis()¶

Get an analysis.

partial(func, *args, **keywords) - new function with partial application of the given arguments and keywords.

Parameters

cid (char) – (required)
analysisId (char) – (required)
inflateJob (logical) – (optional) Return job as an object instead of an id
joinAvatars (logical) – (optional)
join (JoinType) – (optional)

Returns

[none, resp]

getSessionFileInfo()¶

Get info for a particular file.

Parameters

sessionId (char) – (required)
fileName (char) – (required)

Returns

[FileEntry, resp]

getSessionJobs()¶

Return any jobs that use inputs from this session

Gets session jobs.

Parameters

sessionId (char) – (required)
states (vector[char]) – (optional) filter results by job state
tags (vector[char]) – (optional) filter results by job tags
filter (char) – (optional) The filter to apply. (e.g. label=my-label,created>2018-09-22)
sort (char) – (optional) The sort fields and order. (e.g. label:asc,created:desc)
limit (integer) – (optional) The maximum number of entries to return.
skip (integer) – (optional) The number of entries to skip.
page (integer) – (optional) The page number (i.e. skip limit*page entries)
afterId (char) – (optional) Paginate after the given id. (Cannot be used with sort, page or skip)
xAcceptFeature (vector[char]) – (optional)

Returns

[none, resp]

getSessionNote()¶

Get a note on session.

Get a note on session

Parameters

cid (char) – (required)
noteId (char) – (required)

Returns

[Note, resp]

getSessionTag()¶

Get the value of a tag, by name.

Get the value of a tag, by name

Parameters

cid (char) – (required)
value (char) – (required) The tag to interact with

Returns

[char, resp]

modifySession()¶

Update a session

Modify a session.

Parameters

sessionId (char) – (required)
body (flywheel.model.SessionModify) – (required)

Returns

[ModifiedResult, resp]

modifySessionAnalysis()¶

Modify an analysis.

Parameters

cid (char) – (required)
analysisId (char) – (required)
body (flywheel.model.AnalysisModifyInput) – (required)

Returns

[ModifiedResult, resp]

modifySessionFile()¶

Modify a file’s attributes

Note: If modifying a file’s modality, the current classification will be cleared (except for items in the “Custom” list)

Parameters

cid (char) – (required)
filename (char) – (required)
body (flywheel.model.FileModifyInput) – (required)

Returns

[ModifiedResult, resp]

modifySessionFileClassification()¶

Update classification for a particular file.

If replacing a file’s classification, the modality can optionally be modified as well.

Parameters

cid (char) – (required)
filename (char) – (required)
body (flywheel.model.FileClassificationDelta) – (required)

Returns

[ModifiedResult, resp]

modifySessionFileInfo()¶

Update info for a particular file.

Parameters

sessionId (char) – (required)
fileName (char) – (required)
body (flywheel.model.InfoUpdateInput) – (required)

Returns

[InlineResponse200, resp]

modifySessionInfo()¶

Update or replace info for a session.

Parameters

sessionId (char) – (required)
body (flywheel.model.InfoUpdateInput) – (required)

Returns

[none, resp]

modifySessionNote()¶

Update a note on session.

Parameters

sessionId (char) – (required)
noteId (char) – (required)
body (flywheel.model.Note) – (required)

Returns

[InlineResponse200, resp]

renameSessionTag()¶

Rename a tag.

Rename a tag

Parameters

cid (char) – (required)
value (char) – (required) The tag to interact with
body (flywheel.model.Tag) – (required)

Returns

[char, resp]

replaceSessionFile()¶

Replace a file

Parameters

sessionId (char) – (required)
fileName (char) – (required)

Returns

[none, resp]

uploadFileToSession()¶

Upload a file to session.

Parameters

cid (char) – (required)
file (vector) – (required) The file to upload
preserveMetadata (logical) – (optional)
ticket (char) – (optional)
metadata (char) – (optional) File metadata
xAcceptFeature (vector[char]) – (optional) redirect header

Returns

[none, resp]

uploadOutputToSessionAnalysis()¶

Upload an output file to analysis.

Parameters

sessionId (char) – (required)
analysisId (char) – (required)
file (vector) – (required) The file to upload

Returns

[none, resp]

addProvider()¶

Add a new provider

Parameters: body (flywheel.model.IngressProvider) – (required)
Returns: [EgressProviderId, resp]

getProvider()¶

Return the provider identified by ProviderId

Parameters: providerId (char) – (required) The ID of the provider
Returns: [Provider, resp]

getProviderConfig()¶

Return the configuration for provider identified by ProviderId

The returned configuration will be redacted, with any privileged values replaced with null.

Parameters: providerId (char) – (required) The ID of the provider
Returns: [Map, resp]

getProviders()¶

Return a list of all providers on the site

Parameters: class (char) – (optional) Limit the response to the given provider class
Returns: [vector[Provider], resp]

getSiteSettings()¶

Return administrative site settings

Returns the site settings, which includes center-pays gear list. If the site settings have never been created, then center_gears will be null, rather than an empty list.

Returns: [SiteSettings, resp]

modifyProvider()¶

Update the provider identified by ProviderId

Parameters

providerId (char) – (required) The ID of the provider
body (flywheel.model.ProviderInput) – (required)

Returns

[none, resp]

modifySiteSettings()¶

Update administrative site settings

Parameters: body (flywheel.model.ConfigSiteSettingsInput) – (required)
Returns: [none, resp]

addSubject()¶

Create a new subject

Parameters: body (flywheel.model.Object) – (required)
Returns: [InsertedId, resp]

addSubjectAnalysis()¶

Create an analysis and upload files.

When query param “job” is “true”, send JSON to create an analysis and job. Otherwise, multipart/form-data to upload files and create an analysis.

Parameters

cid (char) – (required)
body (flywheel.model.Object) – (required)
job (logical) – (optional) returns job_id instead of analysis.id

Returns

[InsertedId, resp]

addSubjectAnalysisNote()¶

Add a note to subject analysis.

Parameters

containerId (char) – (required) 24-char hex id
analysisId (char) – (required) 24-char hex analysis id
body (flywheel.model.Object) – (required)

Returns

[Note, resp]

addSubjectNote()¶

Add a note to subject.

Parameters

containerId (char) – (required)
body (flywheel.model.NoteInput) – (required)

Returns

[Note, resp]

addSubjectTag()¶

Add a tag to subject.

Propagates changes to projects, sessions and acquisitions

Parameters

cid (char) – (required)
body (flywheel.model.Tag) – (required)

Returns

[ModifiedResult, resp]

createMasterSubjectCode()¶

Request a master subject code for the given patient

The workflow is the following. - send patient_id (e.g., MRN) and/or first_name, last_name, date_of_birth - indicate whether to use patient_id for identification or first_name, last_name, date_of_birth by the use_patient_id field - the response will contain a master subject code - if you send the same identifying information again, you will receive the same code Note that if you received a MSC code for example by just providing the patient_id, you can save more information for that MSC in a second request (first_name, last_name, date_of_birth). Only the missing fields will be set, so you can’t update any existing field (e.g. changing the name). Since you can create multiple MSC codes with the same name and date of birth using different patient ids, you will get HTTP 400 error if you request an MSC code by name and date of birth and there are multiple matches. In this case you need to use patient id.

Parameters: body (flywheel.model.Body) – (required)
Returns: [MasterSubjectCodeCodeOutput, resp]

deleteSubject()¶

Delete a subject

Read-write project permissions are required to delete a subject. Admin project permissions are required if the subject or it’s acquisitions contain data uploaded by sources other than users and jobs.

Parameters

subjectId (char) – (required) 24-char hex subject id
deleteReason (ContainerDeleteReason) – (optional)

Returns

[DeletedResult, resp]

deleteSubjectAnalysis()¶

Delete an anaylsis

Delete an analysis for a container.

Parameters

cid (char) – (required)
analysisId (char) – (required)
deleteReason (Object) – (optional) Provide a reason for the deletion

Returns

[DeletedResult, resp]

deleteSubjectAnalysisNote()¶

Remove a note from subject analysis.

Parameters

cid (char) – (required) 24-char hex id
analysisId (char) – (required) 24-char hex analysis id
noteId (char) – (required) 24-char hex note id

Returns

[DeletedResult, resp]

deleteSubjectFile()¶

Delete a file

A user with read-write or higher permissions on the container may delete files that were uploaded by users or were the output of jobs. (Specifically, files whose origin.type is either job or user.) A user with admin permissions on the container may delete any file.

Parameters

cid (char) – (required)
filename (char) – (required)
deleteReason (Object) – (optional) A reason for deletion when change-logging is enabled
force (logical) – (optional) Force deletion of the file even if some checks fail

Returns

[DeletedResult, resp]

deleteSubjectNote()¶

Remove a note from subject

Parameters

cid (char) – (required)
noteId (char) – (required)

Returns

[DeletedResult, resp]

deleteSubjectTag()¶

Delete a tag

Parameters

cid (char) – (required)
value (char) – (required) The tag to interact with

Returns

[DeletedResult, resp]

downloadFileFromSubject()¶

Download a file.

Files can be downloaded directly from this endpoint with a valid “Authorization” header or via a ticket id. To generate a ticket: - Make a request with an empty “ticket” parameter and a valid “Authorization” header. The server will respond with a generated ticket id. - Make another request with the received ticket id in the “ticket” parameter. A valid “Authorization” header is no longer required. When “view” is true, [RFC7233](https://tools.ietf.org/html/rfc7233) range request headers are supported. When virus_scan feature is enabled the quarantined files only can be downloaded using signed urls otherwise it will return with a HTTP 400 response.

Parameters

subjectId (char) – (required)
fileName (char) – (required)
view (logical) – (optional) If true, the proper “Content-Type” header based on the file’s mimetype is set on response If false, the “Content-Type” header is set to “application/octet-stream”
info (logical) – (optional) If the file is a zipfile, return a json response of zipfile member information
member (char) – (optional) The filename of a zipfile member to download rather than the entire file
signature (char) – (optional) Url’s signature (signed download url)
expires (char) – (optional) Signed url expiration time (epoch time)

Returns

[DownloadTicket, resp]

getSubjectFileZipInfo()¶

Download a file.

Files can be downloaded directly from this endpoint with a valid “Authorization” header or via a ticket id. To generate a ticket: - Make a request with an empty “ticket” parameter and a valid “Authorization” header. The server will respond with a generated ticket id. - Make another request with the received ticket id in the “ticket” parameter. A valid “Authorization” header is no longer required. When “view” is true, [RFC7233](https://tools.ietf.org/html/rfc7233) range request headers are supported. When virus_scan feature is enabled the quarantined files only can be downloaded using signed urls otherwise it will return with a HTTP 400 response.

Parameters

subjectId (char) – (required)
fileName (char) – (required)
ticket (char) – (optional) The generated ticket id for the download, or present but empty to generate a ticket id
view (logical) – (optional) If true, the proper “Content-Type” header based on the file’s mimetype is set on response If false, the “Content-Type” header is set to “application/octet-stream”
info (logical) – (optional) If the file is a zipfile, return a json response of zipfile member information
member (char) – (optional) The filename of a zipfile member to download rather than the entire file
signature (char) – (optional) Url’s signature (signed download url)
expires (char) – (optional) Signed url expiration time (epoch time)

Returns

[FileZipInfo, resp]

getSubjectDownloadTicket()¶

Download a file.

Files can be downloaded directly from this endpoint with a valid “Authorization” header or via a ticket id. To generate a ticket: - Make a request with an empty “ticket” parameter and a valid “Authorization” header. The server will respond with a generated ticket id. - Make another request with the received ticket id in the “ticket” parameter. A valid “Authorization” header is no longer required. When “view” is true, [RFC7233](https://tools.ietf.org/html/rfc7233) range request headers are supported. When virus_scan feature is enabled the quarantined files only can be downloaded using signed urls otherwise it will return with a HTTP 400 response.

Parameters

subjectId (char) – (required)
fileName (char) – (required)
ticket (char) – (optional) The generated ticket id for the download, or present but empty to generate a ticket id
view (logical) – (optional) If true, the proper “Content-Type” header based on the file’s mimetype is set on response If false, the “Content-Type” header is set to “application/octet-stream”
info (logical) – (optional) If the file is a zipfile, return a json response of zipfile member information
member (char) – (optional) The filename of a zipfile member to download rather than the entire file
signature (char) – (optional) Url’s signature (signed download url)
expires (char) – (optional) Signed url expiration time (epoch time)

Returns

[DownloadTicket, resp]

downloadInputFromSubjectAnalysis()¶

Download analysis inputs with filter.

If “ticket” query param is included and not empty, download inputs. If “ticket” query param is included and empty, create a ticket for matching inputs in the analysis. If no “ticket” query param is included, inputs will be downloaded directly.

Parameters

subjectId (char) – (required)
analysisId (char) – (required)
filename (char) – (required) filename to download (get tar of all if empty)
info (logical) – (optional) If the file is a zipfile, return a json response of zipfile member information
member (char) – (optional) The filename of a zipfile member to download rather than the entire file

Returns

[AnalysisFilesCreateTicketOutput, resp]

getSubjectAnalysisInputZipInfo()¶

Download analysis inputs with filter.

If “ticket” query param is included and not empty, download inputs. If “ticket” query param is included and empty, create a ticket for matching inputs in the analysis. If no “ticket” query param is included, inputs will be downloaded directly.

Parameters

subjectId (char) – (required)
analysisId (char) – (required)
filename (char) – (required) filename to download (get tar of all if empty)
ticket (char) – (optional) ticket id of the inputs to download
info (logical) – (optional) If the file is a zipfile, return a json response of zipfile member information
member (char) – (optional) The filename of a zipfile member to download rather than the entire file

Returns

[FileZipInfo, resp]

getSubjectAnalysisInputDownloadTicket()¶

Download analysis inputs with filter.

If “ticket” query param is included and not empty, download inputs. If “ticket” query param is included and empty, create a ticket for matching inputs in the analysis. If no “ticket” query param is included, inputs will be downloaded directly.

Parameters

subjectId (char) – (required)
analysisId (char) – (required)
filename (char) – (required) filename to download (get tar of all if empty)
ticket (char) – (optional) ticket id of the inputs to download
info (logical) – (optional) If the file is a zipfile, return a json response of zipfile member information
member (char) – (optional) The filename of a zipfile member to download rather than the entire file

Returns

[AnalysisFilesCreateTicketOutput, resp]

downloadOutputFromSubjectAnalysis()¶

Download analysis outputs with filter.

If “ticket” query param is included and not empty, download outputs. If “ticket” query param is included and empty, create a ticket for matching outputs in the analysis. If no “ticket” query param is included, outputs will be downloaded directly.

Parameters

subjectId (char) – (required)
analysisId (char) – (required)
filename (char) – (required) filename to download (get tar of all if empty)
info (logical) – (optional) If the file is a zipfile, return a json response of zipfile member information
member (char) – (optional) The filename of a zipfile member to download rather than the entire file

Returns

[AnalysisFilesCreateTicketOutput, resp]

getSubjectAnalysisOutputZipInfo()¶

Download analysis outputs with filter.

If “ticket” query param is included and not empty, download outputs. If “ticket” query param is included and empty, create a ticket for matching outputs in the analysis. If no “ticket” query param is included, outputs will be downloaded directly.

Parameters

subjectId (char) – (required)
analysisId (char) – (required)
filename (char) – (required) filename to download (get tar of all if empty)
ticket (char) – (optional) ticket id of the outputs to download
info (logical) – (optional) If the file is a zipfile, return a json response of zipfile member information
member (char) – (optional) The filename of a zipfile member to download rather than the entire file

Returns

[FileZipInfo, resp]

getSubjectAnalysisOutputDownloadTicket()¶

Download analysis outputs with filter.

If “ticket” query param is included and not empty, download outputs. If “ticket” query param is included and empty, create a ticket for matching outputs in the analysis. If no “ticket” query param is included, outputs will be downloaded directly.

Parameters

subjectId (char) – (required)
analysisId (char) – (required)
filename (char) – (required) filename to download (get tar of all if empty)
ticket (char) – (optional) ticket id of the outputs to download
info (logical) – (optional) If the file is a zipfile, return a json response of zipfile member information
member (char) – (optional) The filename of a zipfile member to download rather than the entire file

Returns

[AnalysisFilesCreateTicketOutput, resp]

downloadSubjectAnalysisInputs()¶

Download analysis inputs.

If “ticket” query param is included and not empty, download inputs. If “ticket” query param is included and empty, create a ticket for all inputs in the anlaysis If no “ticket” query param is included, server error 500

Parameters

subjectId (char) – (required)
analysisId (char) – (required)
ticket (char) – (optional) ticket id of the inputs to download

Returns

[AnalysisFilesCreateTicketOutput, resp]

downloadSubjectAnalysisOutputs()¶

Download analysis outputs.

If “ticket” query param is included and not empty, download outputs. If “ticket” query param is included and empty, create a ticket for all outputs in the anlaysis If no “ticket” query param is included, server error 500

Parameters

subjectId (char) – (required)
analysisId (char) – (required)
ticket (char) – (optional) ticket id of the outputs to download

Returns

[AnalysisFilesCreateTicketOutput, resp]

getAllSubjects()¶

Get a list of subjects

Parameters

exhaustive (logical) – (optional) Set to return a complete list regardless of permissions
join (Object) – (optional) join file origins
joinAvatars (logical) – (optional) add name and avatar to notes
filter (char) – (optional) The filter to apply. (e.g. label=my-label,created>2018-09-22)
sort (char) – (optional) The sort fields and order. (e.g. label:asc,created:desc)
limit (integer) – (optional) The maximum number of entries to return.
skip (integer) – (optional) The number of entries to skip.
page (integer) – (optional) The page number (i.e. skip limit*page entries)
afterId (char) – (optional) Paginate after the given id. (Cannot be used with sort, page or skip)
xAcceptFeature (vector[Object]) – (optional)

Returns

[none, resp]

getSubject()¶

Get a single subject

Get an subject by its id Args: subject_id: The id of the subject join: Attribute to join on join_avatars: Join the user avatars for permissions auth_session: The auth session Returns: SubjectOutput

Parameters

subjectId (char) – (required) 24-char hex subject id
join (Object) – (optional) join file origins
joinAvatars (logical) – (optional) add name and avatar to notes
xAcceptFeature (vector[Object]) – (optional)

Returns

[SubjectOutput, resp]

getSubjectAnalyses()¶

Get analyses for subject.

Returns analyses that directly belong to this resource.

Parameters

cid (char) – (required)
filter (char) – (optional) The filter to apply. (e.g. label=my-label,created>2018-09-22)
sort (char) – (optional) The sort fields and order. (e.g. label:asc,created:desc)
limit (integer) – (optional) The maximum number of entries to return.
skip (integer) – (optional) The number of entries to skip.
page (integer) – (optional) The page number (i.e. skip limit*page entries)
afterId (char) – (optional) Paginate after the given id. (Cannot be used with sort, page or skip)
inflateJob (logical) – (optional)
joinAvatars (logical) – (optional)
join (JoinType) – (optional)
xAcceptFeature (vector[char]) – (optional)

Returns

[none, resp]

getSubjectAnalysis()¶

Get an analysis.

partial(func, *args, **keywords) - new function with partial application of the given arguments and keywords.

Parameters

cid (char) – (required)
analysisId (char) – (required)
inflateJob (logical) – (optional) Return job as an object instead of an id
joinAvatars (logical) – (optional)
join (JoinType) – (optional)

Returns

[none, resp]

getSubjectFileInfo()¶

Get info for a particular file.

Parameters

subjectId (char) – (required)
fileName (char) – (required)

Returns

[FileEntry, resp]

getSubjectNote()¶

Get a note on subject.

Get a note on subject

Parameters

cid (char) – (required)
noteId (char) – (required)

Returns

[Note, resp]

getSubjectSessions()¶

List sessions of a subject

Parameters

subjectId (char) – (required) 24-char hex subject id
join (Object) – (optional) join file origins
filter (char) – (optional) The filter to apply. (e.g. label=my-label,created>2018-09-22)
sort (char) – (optional) The sort fields and order. (e.g. label:asc,created:desc)
limit (integer) – (optional) The maximum number of entries to return.
skip (integer) – (optional) The number of entries to skip.
page (integer) – (optional) The page number (i.e. skip limit*page entries)
afterId (char) – (optional) Paginate after the given id. (Cannot be used with sort, page or skip)
xAcceptFeature (vector[Object]) – (optional)

Returns

[none, resp]

getSubjectTag()¶

Get the value of a tag, by name.

Get the value of a tag, by name

Parameters

cid (char) – (required)
value (char) – (required) The tag to interact with

Returns

[char, resp]

modifySubject()¶

Update a subject

Parameters

subjectId (char) – (required) 24-char hex subject id
body (flywheel.model.Object) – (required)

Returns

[ModifiedResult, resp]

modifySubjectAnalysis()¶

Modify an analysis.

Parameters

cid (char) – (required)
analysisId (char) – (required)
body (flywheel.model.AnalysisModifyInput) – (required)

Returns

[ModifiedResult, resp]

modifySubjectFile()¶

Modify a file’s attributes

Note: If modifying a file’s modality, the current classification will be cleared (except for items in the “Custom” list)

Parameters

cid (char) – (required)
filename (char) – (required)
body (flywheel.model.FileModifyInput) – (required)

Returns

[ModifiedResult, resp]

modifySubjectFileClassification()¶

Update classification for a particular file.

If replacing a file’s classification, the modality can optionally be modified as well.

Parameters

cid (char) – (required)
filename (char) – (required)
body (flywheel.model.FileClassificationDelta) – (required)

Returns

[ModifiedResult, resp]

modifySubjectFileInfo()¶

Update info for a particular file.

Parameters

subjectId (char) – (required)
fileName (char) – (required)
body (flywheel.model.InfoUpdateInput) – (required)

Returns

[InlineResponse200, resp]

modifySubjectInfo()¶

Update or replace info for a subject.

Parameters

subjectId (char) – (required)
body (flywheel.model.InfoUpdateInput) – (required)

Returns

[none, resp]

modifySubjectNote()¶

Update a note on subject.

Parameters

subjectId (char) – (required)
noteId (char) – (required)
body (flywheel.model.Note) – (required)

Returns

[InlineResponse200, resp]

renameSubjectTag()¶

Rename a tag.

Rename a tag

Parameters

cid (char) – (required)
value (char) – (required) The tag to interact with
body (flywheel.model.Tag) – (required)

Returns

[char, resp]

replaceSubjectFile()¶

Replace a file

Parameters

subjectId (char) – (required)
fileName (char) – (required)

Returns

[none, resp]

uploadFileToSubject()¶

Upload a file to subject.

Parameters

cid (char) – (required)
file (vector) – (required) The file to upload
preserveMetadata (logical) – (optional)
ticket (char) – (optional)
metadata (char) – (optional) File metadata
xAcceptFeature (vector[char]) – (optional) redirect header

Returns

[none, resp]

uploadOutputToSubjectAnalysis()¶

Upload an output file to analysis.

Parameters

subjectId (char) – (required)
analysisId (char) – (required)
file (vector) – (required) The file to upload

Returns

[none, resp]

verifyMasterSubjectCode()¶

Verify that the given master subject code exists or not

Parameters: code (char) – (required)
Returns: [none, resp]

addUser()¶

Add a new user

Parameters: body (flywheel.model.UserInput) – (required)
Returns: [UserOutput, resp]

deleteUser()¶

Delete a user

Parameters

userId (char) – (required)
includeDeleted (char) – (optional)

Returns

[none, resp]

deleteUserKey()¶

Delete User Api Key

Parameters: id (char) – (required)
Returns: [none, resp]

generateUserKey()¶

Generates user api key

Generate user api key for the current user.

Parameters: body (flywheel.model.CoreModelsApiKeyApiKeyInput) – (required)
Returns: [ApiKeyOutput, resp]

getAllUsers()¶

Return a list of all users

Parameters

filter (char) – (optional) The filter to apply. (e.g. label=my-label,created>2018-09-22)
sort (char) – (optional) The sort fields and order. (e.g. label:asc,created:desc)
limit (integer) – (optional) The maximum number of entries to return.
skip (integer) – (optional) The number of entries to skip.
page (integer) – (optional) The page number (i.e. skip limit*page entries)
afterId (char) – (optional) Paginate after the given id. (Cannot be used with sort, page or skip)

Returns

[vector[User], resp]

getCurrentUser()¶

Get information about the current user

Returns: [User, resp]

getCurrentUserAvatar()¶

Get the avatar of the current user

Returns: [none, resp]

getCurrentUserInfo()¶

Get info of the current user

Parameters: fields (char) – (optional) Get only the specified fields from user’s info. Accept multiple fields separated by comma.
Returns: [none, resp]

getCurrentUserJobs()¶

Return list of jobs created by the current user

Parameters

gear (char) – (optional) Gear name. Get only the jobs which are related to a specific gear.
filter (char) – (optional) The filter to apply. (e.g. label=my-label,created>2018-09-22)
sort (char) – (optional) The sort fields and order. (e.g. label:asc,created:desc)
limit (integer) – (optional) The maximum number of entries to return.
skip (integer) – (optional) The number of entries to skip.
page (integer) – (optional) The page number (i.e. skip limit*page entries)
afterId (char) – (optional) Paginate after the given id. (Cannot be used with sort, page or skip)

Returns

[UserJobsOutput, resp]

getUser()¶

Get information about the specified user

Parameters

userId (char) – (required)
includeDeleted (char) – (optional)

Returns

[User, resp]

getUserAcquisitions()¶

Get all acquisitions that belong to the given user.

Parameters

uid (char) – (required)
filter (char) – (optional) The filter to apply. (e.g. label=my-label,created>2018-09-22)
sort (char) – (optional) The sort fields and order. (e.g. label:asc,created:desc)
limit (integer) – (optional) The maximum number of entries to return.
skip (integer) – (optional) The number of entries to skip.
page (integer) – (optional) The page number (i.e. skip limit*page entries)
exhaustive (logical) – (optional) Set to return a complete list regardless of permissions
afterId (char) – (optional) Paginate after the given id. (Cannot be used with sort, page or skip)

Returns

[vector[AcquisitionListOutput], resp]

getUserAvatar()¶

Get the avatar of the specified user

Parameters: userId (char) – (required)
Returns: [none, resp]

getUserCollections()¶

Get all collections that belong to the given user.

Parameters

userId (char) – (required)
filter (char) – (optional)
sort (char) – (optional)
limit (integer) – (optional)
skip (integer) – (optional)
page (integer) – (optional)
afterId (char) – (optional)
xAcceptFeature (vector[char]) – (optional)

Returns

[none, resp]

getUserGroups()¶

List all groups the specified user is a member of

Parameters

uid (char) – (required)
exhaustive (logical) – (optional) Set to return a complete list regardless of permissions
filter (char) – (optional) The filter to apply. (e.g. label=my-label,created>2018-09-22)
sort (char) – (optional) The sort fields and order. (e.g. label:asc,created:desc)
limit (integer) – (optional) The maximum number of entries to return.
skip (integer) – (optional) The number of entries to skip.
page (integer) – (optional) The page number (i.e. skip limit*page entries)
afterId (char) – (optional) Paginate after the given id. (Cannot be used with sort, page or skip)
xAcceptFeature (vector[char]) – (optional) redirect header

Returns

[vector[GroupOutput], resp]

getUserProjects()¶

Get all projects that belong to the given user.

Parameters

uid (char) – (required)
filter (char) – (optional) The filter to apply. (e.g. label=my-label,created>2018-09-22)
sort (char) – (optional) The sort fields and order. (e.g. label:asc,created:desc)
limit (integer) – (optional) The maximum number of entries to return.
skip (integer) – (optional) The number of entries to skip.
page (integer) – (optional) The page number (i.e. skip limit*page entries)
afterId (char) – (optional) Paginate after the given id. (Cannot be used with sort, page or skip)
exhaustive (logical) – (optional) Set to return a complete list regardless of permissions

Returns

[vector[ProjectListOutput], resp]

getUserSessions()¶

Get all sessions that belong to the given user.

Parameters

uid (char) – (required)
filter (char) – (optional)
sort (char) – (optional)
limit (integer) – (optional)
skip (integer) – (optional)
page (integer) – (optional)
afterId (char) – (optional)
exhaustive (logical) – (optional)

Returns

[vector[SessionListOutput], resp]

modifyCurrentUserInfo()¶

Update or replace info for the current user.

Parameters: body (flywheel.model.InfoUpdateInput) – (required)
Returns: [none, resp]

modifyUser()¶

Update the specified user

Parameters

uid (char) – (required)
body (flywheel.model.ModifyUserInput) – (required)
clearPermissions (logical) – (optional)

Returns

[ModifiedResult, resp]

dataViewColumns()¶

Return a list of all known column aliases for use in data views

Returns: [vector[DataViewColumnAlias], resp]

deleteView()¶

Delete a data view

Soft deletes data view in database

Parameters: viewId (char) – (required)
Returns: [DeletedResult, resp]

evaluateView()¶

Execute a view, returning data in the preferred format.

Parameters

viewId (char) – (required) The ID of the view
containerId (char) – (required) The target container for view execution
format (char) – (optional)
filter (char) – (optional) An optional filter expression
skip (integer) – (optional) The optional number of rows to skip
limit (integer) – (optional) The optional max number of rows to return

Returns

[none, resp]

evaluateViewAdhoc()¶

Execute an ad-hoc view, returning data in the preferred format.

Parameters

containerId (char) – (required) The target container for view execution
body (flywheel.model.DataView) – (required)
format (char) – (optional)
filter (char) – (optional) An optional filter expression
skip (integer) – (optional) The optional number of rows to skip
limit (integer) – (optional) The optional max number of rows to return

Returns

[none, resp]

getView()¶

Return the view identified by ViewId

Parameters: viewId (char) – (required) The ID of the view
Returns: [DataView, resp]

getViews()¶

Return a list of all views belonging to container

Parameters: containerId (char) – (required) The ID of the container, one of user, group or project. Use “site” as containerId to save or get a site data view.
Returns: [vector[DataView], resp]

modifyView()¶

Update the view identified by ViewId

Parameters

viewId (char) – (required) The ID of the view
body (flywheel.model.DataView) – (required)

Returns

[InlineResponse200, resp]

queueAdhoc()¶

Execute an ad-hoc view, returning a reference to the created data view execution.

Parameters

containerId (char) – (required) The target container for view execution
body (flywheel.model.DataView) – (required)
filter (char) – (optional) An optional filter expression
skip (integer) – (optional) The optional number of rows to skip
limit (integer) – (optional) The optional max number of rows to return

Returns

[DataViewExecution, resp]

queueSaved()¶

Execute a view, returning a reference to the created data view execution.

Parameters

viewId (char) – (required) The ID of the view
containerId (char) – (required) The target container for view execution
filter (char) – (optional) An optional filter expression
skip (integer) – (optional) The optional number of rows to skip
limit (integer) – (optional) The optional max number of rows to return

Returns

[DataViewExecution, resp]

saveViewDataToContainer()¶

Execute a view, saving data to the target container / file

Parameters

containerId (char) – (required) The target container for view execution
body (flywheel.model.DataViewSaveDataViewInput) – (required)
format (char) – (optional)
filter (char) – (optional) An optional filter expression
skip (integer) – (optional) The optional number of rows to skip
limit (integer) – (optional) The optional max number of rows to return

Returns

[none, resp]

flywheel package¶

Subpackages¶

FileSpec Class¶

Flywheel Class¶