flywheel.api package¶

Create a new acquisition

Parameters

body (flywheel.model.Acquisition) – (required)

Returns

[ContainerNewOutput, resp]

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

• acquisitionId (char) – (required)

• body (flywheel.model.AnalysisInput) – (required)

• job (logical) – (optional) Return job as an object instead of an id

Returns

[ContainerNewOutput, resp]

Add a note to acquisition analysis.

Parameters

• acquisitionId (char) – (required)

• analysisId (char) – (required)

• body (flywheel.model.Note) – (required)

Returns

[InlineResponse200, resp]

Add a note to acquisition.

Parameters

• acquisitionId (char) – (required)

• body (flywheel.model.Note) – (required)

Returns

[InlineResponse200, resp]

Add a tag to acquisition.

Progates changes to projects, sessions and acquisitions

Parameters

• acquisitionId (char) – (required)

• body (flywheel.model.Tag) – (required)

Returns

[InlineResponse200, resp]

Delete a acquisition

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

Parameters

acquisitionId (char) – (required)

Returns

[InlineResponse2002, resp]

Delete an anaylsis

Parameters

• acquisitionId (char) – (required)

• analysisId (char) – (required)

Returns

[InlineResponse2002, resp]

Remove a note from acquisition analysis.

Parameters

• acquisitionId (char) – (required)

• analysisId (char) – (required)

• noteId (char) – (required)

Returns

[InlineResponse200, resp]

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.) <br/> A user with admin permissions on the container may delete any file.

Parameters

• acquisitionId (char) – (required)

• fileName (char) – (required)

Returns

[InlineResponse200, resp]

Remove a note from acquisition

Parameters

• acquisitionId (char) – (required)

• noteId (char) – (required)

Returns

[InlineResponse200, resp]

Delete a tag

Parameters

• acquisitionId (char) – (required)

• tagValue (char) – (required) The tag to interact with

Returns

[InlineResponse200, resp]

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]

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]

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]

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]

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]

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]

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]

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]

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]

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]

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]

Get a single acquisition

Parameters

acquisitionId (char) – (required)

Returns

[Acquisition, resp]

Get analyses for acquisition.

Returns analyses that directly belong to this resource.

Parameters

• acquisitionId (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)

Returns

[vector[AnalysisListEntry], resp]

Get an analysis.

Parameters

• acquisitionId (char) – (required)

• analysisId (char) – (required)

• inflateJob (logical) – (optional) Return job as an object instead of an id

Returns

[AnalysisOutput, resp]

Get info for a particular file.

Parameters

• acquisitionId (char) – (required)

• fileName (char) – (required)

Returns

[FileEntry, resp]

Get a note on acquisition.

Parameters

• acquisitionId (char) – (required)

• noteId (char) – (required)

Returns

[Note, resp]

Get the value of a tag, by name.

Parameters

• acquisitionId (char) – (required)

• tagValue (char) – (required) The tag to interact with

Returns

[Tag, resp]

Get a list of acquisitions

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)

Returns

[vector[Acquisition], resp]

Update a acquisition

Parameters

• acquisitionId (char) – (required)

• body (flywheel.model.Acquisition) – (required)

Returns

[InlineResponse200, resp]

Modify an analysis.

Parameters

• acquisitionId (char) – (required)

• analysisId (char) – (required)

• body (flywheel.model.AnalysisUpdate) – (required)

Returns

[InlineResponse200, resp]

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

• acquisitionId (char) – (required)

• fileName (char) – (required)

• body (flywheel.model.FileEntry) – (required)

Returns

[InlineResponse2005, resp]

Update classification for a particular file.

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

Parameters

• acquisitionId (char) – (required)

• fileName (char) – (required)

• body (flywheel.model.ClassificationUpdateInput) – (required)

Returns

[InlineResponse2005, resp]

Update info for a particular file.

Parameters

• acquisitionId (char) – (required)

• fileName (char) – (required)

• body (flywheel.model.InfoUpdateInput) – (required)

Returns

[InlineResponse200, resp]

Update or replace info for a acquisition.

Parameters

• acquisitionId (char) – (required)

• body (flywheel.model.InfoUpdateInput) – (required)

Returns

[none, resp]

Update a note on acquisition.

Parameters

• acquisitionId (char) – (required)

• noteId (char) – (required)

• body (flywheel.model.Note) – (required)

Returns

[InlineResponse200, resp]

Rename a tag.

Parameters

• acquisitionId (char) – (required)

• tagValue (char) – (required) The tag to interact with

• body (flywheel.model.Tag) – (required)

Returns

[InlineResponse200, resp]

Replace a file

Parameters

• acquisitionId (char) – (required)

• fileName (char) – (required)

Returns

[none, resp]

Upload a file to acquisition.

Parameters

• acquisitionId (char) – (required)

• file (flywheel.model.char) – (required) The file to upload

• metadata (char) – (optional) File metadata

Returns

[none, resp]

Upload an output file to analysis.

Parameters

• acquisitionId (char) – (required)

• analysisId (char) – (required)

• file (flywheel.model.char) – (required) The file to upload

Returns

[none, resp]

Add a note to analysis.

Parameters

• analysisId (char) – (required)

• body (flywheel.model.Note) – (required)

Returns

[InlineResponse200, resp]

Add a tag to analysis.

Progates changes to projects, sessions and acquisitions

Parameters

• analysisId (char) – (required)

• body (flywheel.model.Tag) – (required)

Returns

[InlineResponse200, resp]

Remove a note from analysis

Parameters

• analysisId (char) – (required)

• noteId (char) – (required)

Returns

[InlineResponse200, resp]

Delete a tag

Parameters

• analysisId (char) – (required)

• tagValue (char) – (required) The tag to interact with

Returns

[InlineResponse200, resp]

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]

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]

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]

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]

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]

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]

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]

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]

Get nested analyses for a container

Returns analyses that belong to containers of the specified type that belong to ContainerId. For example: 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[AnalysisListEntry], resp]

Get an analysis.

Parameters

• analysisId (char) – (required)

• inflateJob (logical) – (optional) Return job as an object instead of an id

Returns

[AnalysisOutput, resp]

Get info for a particular file.

Parameters

• analysisId (char) – (required) The analysis id

• fileName (char) – (required) The name of the file

Returns

[FileEntry, resp]

Get a note on analysis.

Parameters

• analysisId (char) – (required)

• noteId (char) – (required)

Returns

[Note, resp]

Get the value of a tag, by name.

Parameters

• analysisId (char) – (required)

• tagValue (char) – (required) The tag to interact with

Returns

[Tag, resp]

Modify an analysis.

Parameters

• analysisId (char) – (required)

• body (flywheel.model.AnalysisUpdate) – (required)

Returns

[InlineResponse200, resp]

Update or replace info for a analysis.

Parameters

• analysisId (char) – (required)

• body (flywheel.model.InfoUpdateInput) – (required)

Returns

[none, resp]

Update a note on analysis.

Parameters

• analysisId (char) – (required)

• noteId (char) – (required)

• body (flywheel.model.Note) – (required)

Returns

[InlineResponse200, resp]

Rename a tag.

Parameters

• analysisId (char) – (required)

• tagValue (char) – (required) The tag to interact with

• body (flywheel.model.Tag) – (required)

Returns

[InlineResponse200, resp]

Upload an output file to analysis.

Parameters

• analysisId (char) – (required)

• file (flywheel.model.char) – (required) The file to upload

Returns

[none, resp]

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]

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]

Get a list of batch jobs the user has created.

Requires login.

Returns

[vector[Batch], resp]

Get batch job details.

Parameters

• batchId (char) – (required)

• jobs (logical) – (optional) If true, return job objects instead of job ids

Returns

[Batch, resp]

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

Parameters

body (flywheel.model.BatchProposalInput) – (required) The batch proposal

Returns

[BatchProposal, resp]

Launch a job.

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

Parameters

batchId (char) – (required)

Returns

[vector[Job], resp]

Perform a bulk copy operation

Parameters

body (flywheel.model.BulkMoveSessions) – (required)

Returns

[Map, resp]

Perform a bulk delete operation

Parameters

body (flywheel.model.BulkMoveSessions) – (required)

Returns

[Map, resp]

Perform a bulk move operation

Parameters

body (flywheel.model.BulkMoveSessions) – (required)

Returns

[Map, resp]

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

Parameters

body (flywheel.model.BulkMoveSessions) – (required)

Returns

[Map, resp]

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]

Create a collection

Parameters

body (flywheel.model.Collection) – (required)

Returns

[CollectionNewOutput, resp]

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

• collectionId (char) – (required)

• body (flywheel.model.AnalysisInput) – (required)

• job (logical) – (optional) Return job as an object instead of an id

Returns

[ContainerNewOutput, resp]

Add a note to collection analysis.

Parameters

• collectionId (char) – (required)

• analysisId (char) – (required)

• body (flywheel.model.Note) – (required)

Returns

[InlineResponse200, resp]

Add a note to collection.

Parameters

• collectionId (char) – (required)

• body (flywheel.model.Note) – (required)

Returns

[InlineResponse200, resp]

Add a permission

Parameters

• collectionId (char) – (required)

• body (flywheel.model.PermissionAccessPermission) – (required)

Returns

[InlineResponse200, resp]

Add a tag to collection.

Progates changes to projects, sessions and acquisitions

Parameters

• collectionId (char) – (required)

• body (flywheel.model.Tag) – (required)

Returns

[InlineResponse200, resp]

Delete a collection

Parameters

collectionId (char) – (required)

Returns

[none, resp]

Delete an anaylsis

Parameters

• collectionId (char) – (required)

• analysisId (char) – (required)

Returns

[InlineResponse2002, resp]

Remove a note from collection analysis.

Parameters

• collectionId (char) – (required)

• analysisId (char) – (required)

• noteId (char) – (required)

Returns

[InlineResponse200, resp]

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.) <br/> A user with admin permissions on the container may delete any file.

Parameters

• collectionId (char) – (required)

• fileName (char) – (required)

Returns

[InlineResponse200, resp]

Remove a note from collection

Parameters

• collectionId (char) – (required)

• noteId (char) – (required)

Returns

[InlineResponse200, resp]

Delete a tag

Parameters

• collectionId (char) – (required)

• tagValue (char) – (required) The tag to interact with

Returns

[InlineResponse200, resp]

Delete a permission

Parameters

• collectionId (char) – (required)

• userId (char) – (required)

Returns

[InlineResponse200, resp]

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]

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]

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]

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]

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]

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]

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]

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]

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]

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]

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]

List all collections.

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[Collection], resp]

List all curators of collections

Returns

[Map], resp]

Retrieve a single collection

Parameters

collectionId (char) – (required)

Returns

[Collection, resp]

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

Returns

[vector[Acquisition], resp]

Get analyses for collection.

Returns analyses that directly belong to this resource.

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)

Returns

[vector[AnalysisListEntry], resp]

Get an analysis.

Parameters

• collectionId (char) – (required)

• analysisId (char) – (required)

• inflateJob (logical) – (optional) Return job as an object instead of an id

Returns

[AnalysisOutput, resp]

Get info for a particular file.

Parameters

• collectionId (char) – (required)

• fileName (char) – (required)

Returns

[FileEntry, resp]

Get a note on collection.

Parameters

• collectionId (char) – (required)

• noteId (char) – (required)

Returns

[Note, resp]

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)

Returns

[vector[Session], resp]

Get the value of a tag, by name.

Parameters

• collectionId (char) – (required)

• tagValue (char) – (required) The tag to interact with

Returns

[Tag, resp]

List a user’s permissions for this group.

Parameters

• collectionId (char) – (required)

• userId (char) – (required)

Returns

[PermissionAccessPermission, resp]

Update a collection and its contents

Parameters

• collectionId (char) – (required)

• body (flywheel.model.Collection) – (required)

Returns

[none, resp]

Modify an analysis.

Parameters

• collectionId (char) – (required)

• analysisId (char) – (required)

• body (flywheel.model.AnalysisUpdate) – (required)

Returns

[InlineResponse200, resp]

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

• collectionId (char) – (required)

• fileName (char) – (required)

• body (flywheel.model.FileEntry) – (required)

Returns

[InlineResponse2005, resp]

Update classification for a particular file.

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

Parameters

• collectionId (char) – (required)

• fileName (char) – (required)

• body (flywheel.model.ClassificationUpdateInput) – (required)

Returns

[InlineResponse2005, resp]

Update info for a particular file.

Parameters

• collectionId (char) – (required)

• fileName (char) – (required)

• body (flywheel.model.InfoUpdateInput) – (required)

Returns

[InlineResponse200, resp]

Update or replace info for a collection.

Parameters

• collectionId (char) – (required)

• body (flywheel.model.InfoUpdateInput) – (required)

Returns

[none, resp]

Update a note on collection.

Parameters

• collectionId (char) – (required)

• noteId (char) – (required)

• body (flywheel.model.Note) – (required)

Returns

[InlineResponse200, resp]

Update a user’s permission for this group.

Parameters

• collectionId (char) – (required)

• userId (char) – (required)

• body (flywheel.model.PermissionAccessPermission) – (required)

Returns

[InlineResponse200, resp]

Rename a tag.

Parameters

• collectionId (char) – (required)

• tagValue (char) – (required) The tag to interact with

• body (flywheel.model.Tag) – (required)

Returns

[InlineResponse200, resp]

Replace a file

Parameters

• collectionId (char) – (required)

• fileName (char) – (required)

Returns

[none, resp]

Upload a file to collection.

Parameters

• collectionId (char) – (required)

• file (flywheel.model.char) – (required) The file to upload

• metadata (char) – (optional) File metadata

Returns

[none, resp]

Upload an output file to analysis.

Parameters

• collectionId (char) – (required)

• analysisId (char) – (required)

• file (flywheel.model.char) – (required) The file to upload

Returns

[none, resp]

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

• containerId (char) – (required)

• body (flywheel.model.AnalysisInput) – (required)

• job (logical) – (optional) Return job as an object instead of an id

Returns

[ContainerNewOutput, resp]

Add a note to container analysis.

Parameters

• containerId (char) – (required)

• analysisId (char) – (required)

• body (flywheel.model.Note) – (required)

Returns

[InlineResponse200, resp]

Add a note to container.

Parameters

• containerId (char) – (required)

• body (flywheel.model.Note) – (required)

Returns

[InlineResponse200, resp]

Add a tag to container.

Progates changes to projects, sessions and acquisitions

Parameters

• containerId (char) – (required)

• body (flywheel.model.Tag) – (required)

Returns

[InlineResponse200, resp]

Check for existence of UIDs system-wide

Parameters

body (flywheel.model.ContainerUidcheck) – (required)

Returns

[ContainerUidcheck, resp]

Delete a container

Parameters

containerId (char) – (required)

Returns

[none, resp]

Delete an anaylsis

Parameters

• containerId (char) – (required)

• analysisId (char) – (required)

Returns

[InlineResponse2002, resp]

Remove a note from container analysis.

Parameters

• containerId (char) – (required)

• analysisId (char) – (required)

• noteId (char) – (required)

Returns

[InlineResponse200, resp]

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.) <br/> A user with admin permissions on the container may delete any file.

Parameters

• containerId (char) – (required)

• fileName (char) – (required)

Returns

[InlineResponse200, resp]

Remove a note from container

Parameters

• containerId (char) – (required)

• noteId (char) – (required)

Returns

[InlineResponse200, resp]

Delete a tag

Parameters

• containerId (char) – (required)

• tagValue (char) – (required) The tag to interact with

Returns

[InlineResponse200, resp]

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]

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]

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]

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]

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]

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]

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]

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]

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]

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]

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]

Retrieve a single container

Parameters

containerId (char) – (required)

Returns

[ContainerOutput, resp]

Get analyses for container.

Returns analyses that directly belong to this resource.

Parameters

• containerId (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)

Returns

[vector[AnalysisListEntry], resp]

Get an analysis.

Parameters

• containerId (char) – (required)

• analysisId (char) – (required)

• inflateJob (logical) – (optional) Return job as an object instead of an id

Returns

[AnalysisOutput, resp]

Get info for a particular file.

Parameters

• containerId (char) – (required)

• fileName (char) – (required)

Returns

[FileEntry, resp]

Get a note on container.

Parameters

• containerId (char) – (required)

• noteId (char) – (required)

Returns

[Note, resp]

Get the value of a tag, by name.

Parameters

• containerId (char) – (required)

• tagValue (char) – (required) The tag to interact with

Returns

[Tag, resp]

Update a container and its contents

Parameters

• containerId (char) – (required)

• body (flywheel.model.ContainerUpdate) – (required)

Returns

[none, resp]

Modify an analysis.

Parameters

• containerId (char) – (required)

• analysisId (char) – (required)

• body (flywheel.model.AnalysisUpdate) – (required)

Returns

[InlineResponse200, resp]

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

• containerId (char) – (required)

• fileName (char) – (required)

• body (flywheel.model.FileEntry) – (required)

Returns

[InlineResponse2005, resp]

Update classification for a particular file.

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

Parameters

• containerId (char) – (required)

• fileName (char) – (required)

• body (flywheel.model.ClassificationUpdateInput) – (required)

Returns

[InlineResponse2005, resp]

Update info for a particular file.

Parameters

• containerId (char) – (required)

• fileName (char) – (required)

• body (flywheel.model.InfoUpdateInput) – (required)

Returns

[InlineResponse200, resp]

Update or replace info for a container.

Parameters

• containerId (char) – (required)

• body (flywheel.model.InfoUpdateInput) – (required)

Returns

[none, resp]

Update a note on container.

Parameters

• containerId (char) – (required)

• noteId (char) – (required)

• body (flywheel.model.Note) – (required)

Returns

[InlineResponse200, resp]

Rename a tag.

Parameters

• containerId (char) – (required)

• tagValue (char) – (required) The tag to interact with

• body (flywheel.model.Tag) – (required)

Returns

[InlineResponse200, resp]

Replace a file

Parameters

• containerId (char) – (required)

• fileName (char) – (required)

Returns

[none, resp]

Upload a file to container.

Parameters

• containerId (char) – (required)

• file (flywheel.model.char) – (required) The file to upload

• metadata (char) – (optional) File metadata

Returns

[none, resp]

Upload an output file to analysis.

Parameters

• containerId (char) – (required)

• analysisId (char) – (required)

• file (flywheel.model.char) – (required) The file to upload

Returns

[none, resp]

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]

Get the status of search (Mongo Connector)

Returns

[SearchStatus, resp]

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]

Perform a search query

Parameters

• body (flywheel.model.SearchQuery) – (required)

• simple (logical) – (optional)

• size (integer) – (optional)

Returns

[vector[SearchResponse], resp]

Clean up expired upload tokens and invalid token directories.

Returns

[Map, resp]

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

• 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)

• uploadTicket (char) – (optional) Use empty value to get a ticket, and provide the ticket id to finalize the upload

Returns

[Map, resp]

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]

Get Login status

Get the current login status of the requestor

Returns

[AuthLoginStatus, resp]

Return public Scitran configuration information

Returns

[ConfigOutput, resp]

Return public Scitran configuration information in javascript format.

Returns

[none, resp]

Get a description of the flywheel hiearchy

Returns

[TreeGraph, resp]

Get server and database schema version info

Returns

[VersionOutput, resp]

Login

Scitran Authentication

Returns

[AuthLoginOutput, resp]

Log Out

Remove authtokens for user

Returns

[AuthLogoutOutput, resp]

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]

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]

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.Device) – (required)

Returns

[Map, resp]

List all devices.

Requires login.

Returns

[vector[Device], resp]

Get status for all known devices.

ok - missing - error - unknown

Returns

[DeviceStatus, resp]

Get device details

Parameters

deviceId (char) – (required)

Returns

[Device, resp]

Update a device

Parameters

• deviceId (char) – (required)

• body (flywheel.model.Device) – (required)

Returns

[none, resp]

Regenerate device API key

Parameters

deviceId (char) – (required)

Returns

[InlineResponse2001, resp]

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]

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]

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]

Delete a DIMSE project AET

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

Parameters

projectAET (char) – (required)

Returns

[none, resp]

Delete a DIMSE service AET

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

Parameters

serviceAET (char) – (required)

Returns

[none, resp]

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]

List all DIMSE services AETs

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

Returns

[vector[DimseServiceOutput], resp]

Get DIMSE project AET

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

Parameters

projectAET (char) – (required)

Returns

[DimseProjectOutput, resp]

Get DIMSE service by AET or id

Get a DIMSE service. Requires login and admin privilege.

Parameters

serviceAET (char) – (required)

Returns

[DimseServiceOutput, resp]

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]

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.) <br/> A user with admin permissions on the container may delete any file.

Parameters

• fileId (char) – (required)

• version (integer) – (optional)

Returns

[InlineResponse2002, resp]

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

Returns

[none, resp]

Get File

Get file details

Parameters

• fileId (char) – (required)

• version (integer) – (optional)

Returns

[FileEntry, resp]

Get Versions

Get file version details

Parameters

fileId (char) – (required)

Returns

[vector[FileVersionOutput], resp]

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]

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

• 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)

• ticket (char) – (optional) Use empty value to get a ticket, and provide the ticket id to finalize the upload

Returns

[Map, resp]

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

• 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)

• ticket (char) – (optional) Use empty value to get a ticket, and provide the ticket id to finalize the upload

Returns

[vector[FileEntry], resp]

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

• 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)

• ticket (char) – (optional) Use empty value to get a ticket, and provide the ticket id to finalize the upload

Returns

[Map, resp]

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

• 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)

• ticket (char) – (optional) Use empty value to get a ticket, and provide the ticket id to finalize the upload

Returns

[Map, resp]

Create or update a gear.

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

Parameters

• gearIdOrName (char) – (required) Name of the gear to interact with

• body (flywheel.model.GearDoc) – (required)

Returns

[CollectionNewOutput, resp]

Delete a gear (not recommended)

Parameters

gearIdOrName (char) – (required) Id of the gear to interact with

Returns

[none, resp]

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]

Retrieve details about a specific gear

Parameters

gearIdOrName (char) – (required) Id of the gear to interact with

Returns

[GearDoc, resp]

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]

Get a schema for invoking a gear.

Parameters

gearId (char) – (required) Id of the gear to interact with

Returns

[Map, resp]

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]

Retrieve a specific gear ticket

Parameters

gearTicketId (char) – (required) The ID of the the gear ticket to retrieve

Returns

[Map, resp]

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]

Prepare a gear upload

Returns

[Map, resp]

Report the result of a gear upload and save the ticket

Parameters

ticket (logical) – (required) The ticket ID to save

Returns

[Map, resp]

Add a group

Parameters

body (flywheel.model.Group) – (required)

Returns

[GroupNewOutput, resp]

Add a permission

Parameters

• groupId (char) – (required)

• body (flywheel.model.PermissionAccessPermission) – (required)

Returns

[InlineResponse200, resp]

Add a permission template

Parameters

• groupId (char) – (required)

• body (flywheel.model.RolesRoleAssignment) – (required)

• propagate (logical) – (optional)

Returns

[InlineResponse200, resp]

Add a tag to group.

Progates changes to projects, sessions and acquisitions

Parameters

• groupId (char) – (required)

• body (flywheel.model.Tag) – (required)

Returns

[InlineResponse200, resp]

Add a role to the pool of roles in a group

Parameters

• groupId (char) – (required)

• body (flywheel.model.RolesGroupRolePoolInput) – (required)

Returns

[none, resp]

Delete a group

Parameters

groupId (char) – (required)

Returns

[InlineResponse2002, resp]

Delete a tag

Parameters

• groupId (char) – (required)

• tagValue (char) – (required) The tag to interact with

Returns

[InlineResponse200, resp]

Delete a permission

Parameters

• groupId (char) – (required)

• userId (char) – (required)

Returns

[InlineResponse200, resp]

Delete a permission

Parameters

• groupId (char) – (required)

• userId (char) – (required)

• propagate (logical) – (optional)

Returns

[InlineResponse200, resp]

Get list of group roles

Parameters

groupId (char) – (required)

Returns

[vector[RolesRole], resp]

List 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)

Returns

[vector[Group], resp]

Get group info

Parameters

groupId (char) – (required)

Returns

[Group, resp]

Get all projects in a group

Parameters

• groupId (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)

Returns

[vector[Project], resp]

Return the role identified by the RoleId

Parameters

• groupId (char) – (required)

• roleId (char) – (required)

Returns

[RolesRole, resp]

Get the value of a tag, by name.

Parameters

• groupId (char) – (required)

• tagValue (char) – (required) The tag to interact with

Returns

[Tag, resp]

List a user’s permissions for this group.

Parameters

• groupId (char) – (required)

• userId (char) – (required)

Returns

[PermissionAccessPermission, resp]

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

Parameters

• groupId (char) – (required)

• userId (char) – (required)

• propagate (logical) – (optional)

Returns

[InlineResponse2003, resp]

Update group

Parameters

• groupId (char) – (required)

• body (flywheel.model.Group) – (required)

Returns

[none, resp]

Update a user’s permission for this group.

Parameters

• groupId (char) – (required)

• userId (char) – (required)

• body (flywheel.model.PermissionAccessPermission) – (required)

Returns

[InlineResponse200, resp]

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]

Remove the role from the group

Parameters

• groupId (char) – (required)

• roleId (char) – (required)

Returns

[none, resp]

Rename a tag.

Parameters

• groupId (char) – (required)

• tagValue (char) – (required) The tag to interact with

• body (flywheel.model.Tag) – (required)

Returns

[InlineResponse200, resp]

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]

Add a job

Parameters

body (flywheel.model.Job) – (required)

Returns

[CommonObjectCreated, resp]

Add logs to a job.

Parameters

• jobId (char) – (required)

• body (flywheel.model.vector[JobLogStatement]) – (required)

Returns

[none, resp]

Ask the queue a question

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

Parameters

body (flywheel.model.JobAsk) – (required)

Returns

[JobAskResponse, resp]

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]

Complete a job, with information

Parameters

• jobId (char) – (required)

• body (flywheel.model.JobCompletionInput) – (required)

• jobTicketId (char) – (optional)

Returns

[none, resp]

Determine the effective compute provider for a proposed job.

Parameters

body (flywheel.model.Job) – (required)

Returns

[Provider, resp]

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]

Get job details

Parameters

jobId (char) – (required)

Returns

[Job, resp]

Get a job’s config

Parameters

jobId (char) – (required)

Returns

[JobConfigOutput, resp]

Get job container details

Parameters

jobId (char) – (required)

Returns

[JobDetail, resp]

Get job logs

Parameters

jobId (char) – (required)

Returns

[JobLog, resp]

Get stats about all current jobs

Returns

[Map, resp]

Get the next job in the queue

Used by the engine.

Parameters

tags (vector[char]) – (optional)

Returns

[Job, resp]

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.Job) – (required)

Returns

[none, resp]

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

Parameters

jobId (char) – (required)

Returns

[JobCompletionTicket, resp]

Reap stale jobs

Returns

[Map, resp]

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]

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

Parameters

• jobId (char) – (required)

• body (flywheel.model.JobProfileInput) – (required)

Returns

[InlineResponse200, resp]

Create a new modality.

Parameters

body (flywheel.model.Modality) – (required)

Returns

[ContainerNewOutput, resp]

Delete a modality

Parameters

modalityId (char) – (required)

Returns

[none, resp]

List all modalities.

Requires login.

Returns

[vector[Modality], resp]

Get a modality’s classification specification

Parameters

modalityId (char) – (required)

Returns

[Modality, resp]

Replace modality

Parameters

• modalityId (char) – (required)

• body (flywheel.model.Modality) – (required)

Returns

[none, resp]

Create a new project

Parameters

• body (flywheel.model.Project) – (required)

• inherit (logical) – (optional)

Returns

[ContainerNewOutput, resp]

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

• projectId (char) – (required)

• body (flywheel.model.AnalysisInput) – (required)

• job (logical) – (optional) Return job as an object instead of an id

Returns

[ContainerNewOutput, resp]

Add a note to project analysis.

Parameters

• projectId (char) – (required)

• analysisId (char) – (required)

• body (flywheel.model.Note) – (required)

Returns

[InlineResponse200, resp]

Add a note to project.

Parameters

• projectId (char) – (required)

• body (flywheel.model.Note) – (required)

Returns

[InlineResponse200, resp]

Add a permission

Parameters

• projectId (char) – (required)

• body (flywheel.model.RolesRoleAssignment) – (required)

Returns

[InlineResponse200, resp]

Create a new rule for a project.

Parameters

• projectId (char) – (required)

• body (flywheel.model.Rule) – (required)

Returns

[none, resp]

Add a tag to project.

Progates changes to projects, sessions and acquisitions

Parameters

• projectId (char) – (required)

• body (flywheel.model.Tag) – (required)

Returns

[InlineResponse200, resp]

Delete a project

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

Parameters

projectId (char) – (required)

Returns

[InlineResponse2002, resp]

Delete an anaylsis

Parameters

• projectId (char) – (required)

• analysisId (char) – (required)

Returns

[InlineResponse2002, resp]

Remove a note from project analysis.

Parameters

• projectId (char) – (required)

• analysisId (char) – (required)

• noteId (char) – (required)

Returns

[InlineResponse200, resp]

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.) <br/> A user with admin permissions on the container may delete any file.

Parameters

• projectId (char) – (required)

• fileName (char) – (required)

Returns

[InlineResponse200, resp]

Remove a note from project

Parameters

• projectId (char) – (required)

• noteId (char) – (required)

Returns

[InlineResponse200, resp]

Delete a tag

Parameters

• projectId (char) – (required)

• tagValue (char) – (required) The tag to interact with

Returns

[InlineResponse200, resp]

Delete a permission

Parameters

• projectId (char) – (required)

• userId (char) – (required)

Returns

[InlineResponse200, resp]

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]

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]

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]

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]

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]

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]

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]

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]

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]