flywheel.api package¶

Create a new acquisition

Create a new acquisition

Parameters

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

Returns

[InsertedId, 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

• cid (char) – (required)

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

• job (logical) – (optional) returns job_id instead of analysis.id

Returns

[InsertedId, resp]

Add a note to acquisition analysis.

Parameters

• containerId (char) – (required) 24-char hex id

• analysisId (char) – (required) 24-char hex analysis id

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

Returns

[Note, resp]

Add a note to acquisition.

Parameters

• containerId (char) – (required)

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

Returns

[Note, resp]

Add a tag to acquisition.

Propagates changes to projects, sessions and acquisitions

Parameters

• cid (char) – (required)

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

Returns

[ModifiedResult, 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)

• deleteReason (Object) – (optional) Provide a reason for the deletion

Returns

[DeletedResult, resp]

Delete an anaylsis

Delete an analysis for a container.

Parameters

• cid (char) – (required)

• analysisId (char) – (required)

• deleteReason (Object) – (optional) Provide a reason for the deletion

Returns

[DeletedResult, resp]

Remove a note from acquisition analysis.

Remove a note from acquisition analysis.

Parameters

• cid (char) – (required) 24-char hex id

• analysisId (char) – (required) 24-char hex analysis id

• noteId (char) – (required) 24-char hex note id

Returns

[DeletedResult, resp]

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

• cid (char) – (required)

• filename (char) – (required)

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

• force (logical) – (optional) Force deletion of the file even if some checks fail

Returns

[DeletedResult, resp]

Remove a note from acquisition

Remove a note from acquisition

Parameters

• cid (char) – (required)

• noteId (char) – (required)

Returns

[DeletedResult, resp]

Delete a tag

Delete a tag

Parameters

• cid (char) – (required)

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

Returns

[DeletedResult, 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

Get a single acquisition

Parameters

• acquisitionId (char) – (required)

• join (JoinType) – (optional)

• joinAvatars (logical) – (optional) add name and avatar to notes

• xAcceptFeature (vector[Object]) – (optional)

Returns

[AcquisitionOutput, resp]

Get analyses for acquisition.

Returns analyses that directly belong to this resource.

Parameters

• cid (char) – (required)

• filter (char) – (optional) The filter to apply. (e.g. label=my-label,created>2018-09-22)

• sort (char) – (optional) The sort fields and order. (e.g. label:asc,created:desc)

• limit (integer) – (optional) The maximum number of entries to return.

• skip (integer) – (optional) The number of entries to skip.

• page (integer) – (optional) The page number (i.e. skip limit*page entries)

• afterId (char) – (optional) Paginate after the given id. (Cannot be used with sort, page or skip)

• inflateJob (logical) – (optional)

• joinAvatars (logical) – (optional)

• join (JoinType) – (optional)

• xAcceptFeature (vector[char]) – (optional)

Returns

[none, resp]

Get an analysis.

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

Parameters

• cid (char) – (required)

• analysisId (char) – (required)

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

• joinAvatars (logical) – (optional)

• join (JoinType) – (optional)

Returns

[none, resp]

Get info for a particular file.

Get info for a particular file.

Parameters

• cid (char) – (required)

• filename (char) – (required)

Returns

[FileOutput, resp]

Get a note on acquisition.

Get a note on acquisition

Parameters

• cid (char) – (required)

• noteId (char) – (required)

Returns

[Note, resp]

Get the value of a tag, by name.

Get the value of a tag, by name

Parameters

• cid (char) – (required)

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

Returns

[char, resp]

Get a list of acquisitions

Get a list of acquisitions.

Parameters

• exhaustive (logical) – (optional) Set to return a complete list regardless of permissions

• join (JoinType) – (optional)

• joinAvatars (logical) – (optional) add name and avatar to notes

• collectionId (char) – (optional)

• filter (char) – (optional) The filter to apply. (e.g. label=my-label,created>2018-09-22)

• sort (char) – (optional) The sort fields and order. (e.g. label:asc,created:desc)

• limit (integer) – (optional) The maximum number of entries to return.

• skip (integer) – (optional) The number of entries to skip.

• page (integer) – (optional) The page number (i.e. skip limit*page entries)

• afterId (char) – (optional) Paginate after the given id. (Cannot be used with sort, page or skip)

• xAcceptFeature (vector[Object]) – (optional)

Returns

[none, resp]

Update an acquisition

Update an acquisition

Parameters

• acquisitionId (char) – (required)

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

Returns

[ModifiedResult, resp]

Modify an analysis.

Modify an analysis.

Parameters

• cid (char) – (required)

• analysisId (char) – (required)

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

Returns

[ModifiedResult, 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

• cid (char) – (required)

• filename (char) – (required)

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

Returns

[ModifiedResult, resp]

Update classification for a particular file.

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

Parameters

• cid (char) – (required)

• filename (char) – (required)

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

Returns

[ModifiedResult, resp]

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.

Update a note on acquisition

Parameters

• cid (char) – (required)

• noteId (char) – (required)

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

Returns

[integer, resp]

Rename a tag.

Rename a tag

Parameters

• cid (char) – (required)

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

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

Returns

[char, resp]

Replace a file

Parameters

• acquisitionId (char) – (required)

• fileName (char) – (required)

Returns

[none, resp]

Upload a file to acquisition.

Parameters

• cid (char) – (required)

• file (vector) – (required) The file to upload

• preserveMetadata (logical) – (optional)

• ticket (char) – (optional)

• metadata (char) – (optional) File metadata

• xAcceptFeature (vector[char]) – (optional) redirect header

Returns

[none, resp]

Upload an output file to analysis.

Parameters

• acquisitionId (char) – (required)

• analysisId (char) – (required)

• file (vector) – (required) The file to upload

Returns

[none, resp]

Add a note to analysis.

Add a note to analysis.

Parameters

• containerId (char) – (required) Container id

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

Returns

[Note, resp]

Add a tag to analysis.

Propagates changes to projects, sessions and acquisitions

Parameters

• containerId (char) – (required)

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

Returns

[ModifiedResult, resp]

Delete an analysis

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

Parameters

• analysisId (char) – (required) 24-char hex analysis id

• deleteReason (ContainerDeleteReason) – (optional)

Returns

[DeletedResult, resp]

Remove a note from analysis

Remove a note from analysis

Parameters

• containerId (char) – (required) Container id

• noteId (char) – (required) 24-char hex note id

Returns

[none, resp]

Delete a tag

Delete a tag

Parameters

• containerId (char) – (required)

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

Returns

[none, 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. Ex: projects/{ProjectId}/acquisitions/analyses will return any analyses that have an acquisition that is under that project as a parent. The all keyword is also supported, for example: projects/{ProjectId}/all/analyses will return any analyses that have any session or acquisition or the project itself as a parent.

Parameters

• containerName (char) – (required) The parent container type

• containerId (char) – (required) The parent container id

• subcontainerName (char) – (required) The sub container type

Returns

[vector[AnalysisListOutput], resp]

Get an analysis.

Get an analysis by its id

Parameters

• analysisId (char) – (required) 24-char hex analysis id

• inflateJob (logical) – (optional) expand job info

• joinAvatars (logical) – (optional) add name and avatar to notes

• join (JoinType) – (optional)

Returns

[none, resp]

Get info for a particular file.

Get info for a particular file.

Parameters

• containerId (char) – (required) Container id

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

Returns

[FileOutput, resp]

Get a note on analysis.

Get a note on analysis

Parameters

• containerId (char) – (required) Container id

• noteId (char) – (required) 24-char hex note id

Returns

[Note, resp]

Get the value of a tag, by name.

Get the value of a tag, by name

Parameters

• containerId (char) – (required)

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

Returns

[char, resp]

Modify an analysis.

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

Parameters

• analysisId (char) – (required) 24-char hex analysis id

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

Returns

[ModifiedResult, resp]

Update or replace info for a analysis.

Parameters

• analysisId (char) – (required)

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

Returns

[none, resp]

Update a note on analysis.

Update a note on analysis

Parameters

• containerId (char) – (required) Container id

• noteId (char) – (required) 24-char hex note id

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

Returns

[integer, resp]

Rename a tag.

Rename a tag

Parameters

• containerId (char) – (required)

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

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

Returns

[char, resp]

Upload an output file to analysis.

Parameters

• analysisId (char) – (required)

• file (vector) – (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[JobOutput], 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 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

Create a collection

Parameters

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

Returns

[InsertedId, 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

• cid (char) – (required)

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

• job (logical) – (optional) returns job_id instead of analysis.id

Returns

[InsertedId, resp]

Add a note to collection analysis.

Parameters

• containerId (char) – (required) 24-char hex id

• analysisId (char) – (required) 24-char hex analysis id

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

Returns

[Note, resp]

Add a note to collection.

Parameters

• containerId (char) – (required)

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

Returns

[Note, resp]

Add a permission

Parameters

• collectionId (char) – (required)

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

Returns

[InlineResponse200, resp]

Add a tag to collection.

Propagates changes to projects, sessions and acquisitions

Parameters

• cid (char) – (required)

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

Returns

[ModifiedResult, resp]

Delete a collection

Delete Collections.

Parameters

collectionId (char) – (required)

Returns

[DeletedResult, resp]

Delete an anaylsis

Delete an analysis for a container.

Parameters

• cid (char) – (required)

• analysisId (char) – (required)

• deleteReason (Object) – (optional) Provide a reason for the deletion

Returns

[DeletedResult, resp]

Remove a note from collection analysis.

Remove a note from collection analysis.

Parameters

• cid (char) – (required) 24-char hex id

• analysisId (char) – (required) 24-char hex analysis id

• noteId (char) – (required) 24-char hex note id

Returns

[DeletedResult, resp]

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

• cid (char) – (required)

• filename (char) – (required)

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

• force (logical) – (optional) Force deletion of the file even if some checks fail

Returns

[DeletedResult, resp]

Remove a note from collection

Remove a note from collection

Parameters

• cid (char) – (required)

• noteId (char) – (required)

Returns

[DeletedResult, resp]

Delete a tag

Delete a tag

Parameters

• cid (char) – (required)

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

Returns

[DeletedResult, 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.

List all collections.

Parameters

• exhaustive (logical) – (optional)

• joinAvatars (logical) – (optional) add name and avatar to notes

• joinFiles (logical) – (optional)

• join (JoinType) – (optional)

• stats (logical) – (optional)

• userId (char) – (optional)

• filter (char) – (optional) The filter to apply. (e.g. label=my-label,created>2018-09-22)

• sort (char) – (optional) The sort fields and order. (e.g. label:asc,created:desc)

• limit (integer) – (optional) The maximum number of entries to return.

• skip (integer) – (optional) The number of entries to skip.

• page (integer) – (optional) The page number (i.e. skip limit*page entries)

• afterId (char) – (optional) Paginate after the given id. (Cannot be used with sort, page or skip)

• xAcceptFeature (vector[Object]) – (optional)

Returns

[none, resp]

List all curators of collections

Returns

[Map], resp]

Retrieve a single collection

Retrieve a single collection

Parameters

• collectionId (char) – (required)

• joinAvatars (logical) – (optional) add name and avatar to notes

• join (JoinType) – (optional)

• xAcceptFeature (vector[Object]) – (optional)

Returns

[CollectionOutput, resp]

List acquisitions in a collection

List acquisitions in a collection

Parameters

• collectionId (char) – (required)

• session (char) – (optional) The id of a session, to which the acquisitions returned will be restricted

• filter (char) – (optional) The filter to apply. (e.g. label=my-label,created>2018-09-22)

• sort (char) – (optional) The sort fields and order. (e.g. label:asc,created:desc)

• limit (integer) – (optional) The maximum number of entries to return.

• skip (integer) – (optional) The number of entries to skip.

• page (integer) – (optional) The page number (i.e. skip limit*page entries)

• afterId (char) – (optional) Paginate after the given id. (Cannot be used with sort, page or skip)

• xAcceptFeature (vector[char]) – (optional)

Returns

[none, resp]

Get analyses for collection.

Returns analyses that directly belong to this resource.

Parameters

• cid (char) – (required)

• filter (char) – (optional) The filter to apply. (e.g. label=my-label,created>2018-09-22)

• sort (char) – (optional) The sort fields and order. (e.g. label:asc,created:desc)

• limit (integer) – (optional) The maximum number of entries to return.

• skip (integer) – (optional) The number of entries to skip.

• page (integer) – (optional) The page number (i.e. skip limit*page entries)

• afterId (char) – (optional) Paginate after the given id. (Cannot be used with sort, page or skip)

• inflateJob (logical) – (optional)

• joinAvatars (logical) – (optional)

• join (JoinType) – (optional)

• xAcceptFeature (vector[char]) – (optional)

Returns

[none, resp]

Get an analysis.

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

Parameters

• cid (char) – (required)

• analysisId (char) – (required)

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

• joinAvatars (logical) – (optional)

• join (JoinType) – (optional)

Returns

[none, resp]

Get info for a particular file.

Get info for a particular file.

Parameters

• cid (char) – (required)

• filename (char) – (required)

Returns

[FileOutput, resp]

Get a note on collection.

Get a note on collection

Parameters

• cid (char) – (required)

• noteId (char) – (required)

Returns

[Note, resp]

List sessions in a collection

List sessions in a collection.

Parameters

• collectionId (char) – (required)

• filter (char) – (optional) The filter to apply. (e.g. label=my-label,created>2018-09-22)

• sort (char) – (optional) The sort fields and order. (e.g. label:asc,created:desc)

• limit (integer) – (optional) The maximum number of entries to return.

• skip (integer) – (optional) The number of entries to skip.

• page (integer) – (optional) The page number (i.e. skip limit*page entries)

• afterId (char) – (optional) Paginate after the given id. (Cannot be used with sort, page or skip)

• xAcceptFeature (vector[char]) – (optional)

Returns

[none, resp]

Get the value of a tag, by name.

Get the value of a tag, by name

Parameters

• cid (char) – (required)

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

Returns

[char, resp]

List a user’s permissions for this group.

Parameters

• collectionId (char) – (required)

• userId (char) – (required)

Returns

[PermissionAccessPermission, resp]

Update a collection and its contents

Update a collection and its contents

Parameters

• collectionId (char) – (required)

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

Returns

[ModifiedResult, resp]

Modify an analysis.

Modify an analysis.

Parameters

• cid (char) – (required)

• analysisId (char) – (required)

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

Returns

[ModifiedResult, 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

• cid (char) – (required)

• filename (char) – (required)

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

Returns

[ModifiedResult, resp]

Update classification for a particular file.

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

Parameters

• cid (char) – (required)

• filename (char) – (required)

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

Returns

[ModifiedResult, resp]

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.

Update a note on collection

Parameters

• cid (char) – (required)

• noteId (char) – (required)

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

Returns

[integer, 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.

Rename a tag

Parameters

• cid (char) – (required)

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

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

Returns

[char, resp]

Replace a file

Parameters

• collectionId (char) – (required)

• fileName (char) – (required)

Returns

[none, resp]

Upload a file to collection.

Parameters

• cid (char) – (required)

• file (vector) – (required) The file to upload

• preserveMetadata (logical) – (optional)

• ticket (char) – (optional)

• metadata (char) – (optional) File metadata

• xAcceptFeature (vector[char]) – (optional) redirect header

Returns

[none, resp]

Upload an output file to analysis.

Parameters

• collectionId (char) – (required)

• analysisId (char) – (required)

• file (vector) – (required) The file to upload

Returns

[none, resp]

Get public configuration

return config dict

Returns

[ConfigOut, 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

• cid (char) – (required)

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

• job (logical) – (optional) returns job_id instead of analysis.id

Returns

[InsertedId, resp]

Add a note to container analysis.

Parameters

• containerId (char) – (required) 24-char hex id

• analysisId (char) – (required) 24-char hex analysis id

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

Returns

[Note, resp]

Add a note to container.

Parameters

• containerId (char) – (required)

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

Returns

[Note, resp]

Add a tag to container.

Propagates changes to projects, sessions and acquisitions

Parameters

• cid (char) – (required)

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

Returns

[ModifiedResult, resp]

Add a new data view

Create container view

Parameters

• containerId (char) – (required)

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

Returns

[ViewIdOutput, resp]

Check for existence of UIDs system-wide

Parameters

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

Returns

[ContainerUidcheck, resp]

Delete a container

Delete Container

Parameters

• containerId (char) – (required)

• deleteReason (ContainerDeleteReason) – (optional)

Returns

[DeletedResult, resp]

Delete an anaylsis

Delete an analysis for a container.

Parameters

• cid (char) – (required)

• analysisId (char) – (required)

• deleteReason (Object) – (optional) Provide a reason for the deletion

Returns

[DeletedResult, resp]

Remove a note from container analysis.

Remove a note from container analysis.

Parameters

• cid (char) – (required) 24-char hex id

• analysisId (char) – (required) 24-char hex analysis id

• noteId (char) – (required) 24-char hex note id

Returns

[DeletedResult, resp]

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

• cid (char) – (required)

• filename (char) – (required)

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

• force (logical) – (optional) Force deletion of the file even if some checks fail

Returns

[DeletedResult, resp]

Remove a note from container

Remove a note from container

Parameters

• cid (char) – (required)

• noteId (char) – (required)

Returns

[DeletedResult, resp]

Delete a tag

Delete a tag

Parameters

• cid (char) – (required)

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

Returns

[DeletedResult, 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

• cid (char) – (required)

• filter (char) – (optional) The filter to apply. (e.g. label=my-label,created>2018-09-22)

• sort (char) – (optional) The sort fields and order. (e.g. label:asc,created:desc)

• limit (integer) – (optional) The maximum number of entries to return.

• skip (integer) – (optional) The number of entries to skip.

• page (integer) – (optional) The page number (i.e. skip limit*page entries)

• afterId (char) – (optional) Paginate after the given id. (Cannot be used with sort, page or skip)

• inflateJob (logical) – (optional)

• joinAvatars (logical) – (optional)

• join (JoinType) – (optional)

• xAcceptFeature (vector[char]) – (optional)

Returns

[none, resp]

Get an analysis.

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

Parameters

• cid (char) – (required)

• analysisId (char) – (required)

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

• joinAvatars (logical) – (optional)

• join (JoinType) – (optional)

Returns

[none, resp]

Get info for a particular file.

Parameters

• containerId (char) – (required)

• fileName (char) – (required)

Returns

[FileEntry, resp]

Get a note on container.

Get a note on container

Parameters

• cid (char) – (required)

• noteId (char) – (required)

Returns

[Note, resp]

Get the value of a tag, by name.

Get the value of a tag, by name

Parameters

• cid (char) – (required)

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

Returns

[char, resp]

Update a container and its contents

Parameters

• containerId (char) – (required)

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

Returns

[none, resp]

Modify an analysis.

Modify an analysis.

Parameters

• cid (char) – (required)

• analysisId (char) – (required)

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

Returns

[ModifiedResult, 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

• cid (char) – (required)

• filename (char) – (required)

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

Returns

[ModifiedResult, resp]

Update classification for a particular file.

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

Parameters

• cid (char) – (required)

• filename (char) – (required)

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

Returns

[ModifiedResult, resp]

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.

Update a note on container

Parameters

• cid (char) – (required)

• noteId (char) – (required)

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

Returns

[integer, resp]

Rename a tag.

Rename a tag

Parameters

• cid (char) – (required)

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

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

Returns

[char, resp]

Replace a file

Parameters

• containerId (char) – (required)

• fileName (char) – (required)

Returns

[none, resp]

Upload a file to container.

Parameters

• cid (char) – (required)

• file (vector) – (required) The file to upload

• preserveMetadata (logical) – (optional)

• ticket (char) – (optional)

• metadata (char) – (optional) File metadata

• xAcceptFeature (vector[char]) – (optional) redirect header

Returns

[none, resp]

Upload an output file to analysis.

Parameters

• containerId (char) – (required)

• analysisId (char) – (required)

• file (vector) – (required) The file to upload

Returns

[none, resp]

Delete a data_view_execution

Parameters

dataViewExecutionId (char) – (required)

Returns

[DeletedResult, resp]

Get a list of data_view_executions

Parameters

• exhaustive (logical) – (optional) Set to return a complete list regardless of permissions

• filter (char) – (optional) The filter to apply. (e.g. label=my-label,created>2018-09-22)

• sort (char) – (optional) The sort fields and order. (e.g. label:asc,created:desc)

• limit (integer) – (optional) The maximum number of entries to return.

• skip (integer) – (optional) The number of entries to skip.

• page (integer) – (optional) The page number (i.e. skip limit*page entries)

• afterId (char) – (optional) Paginate after the given id. (Cannot be used with sort, page or skip)

• xAcceptFeature (vector[char]) – (optional)

Returns

[vector[DataViewExecution], resp]

Get a single data_view_execution

Parameters

dataViewExecutionId (char) – (required)

Returns

[DataViewExecution, resp]

Get the data from a data_view_execution

Parameters

• dataViewExecutionId (char) – (required)

• ticket (char) – (optional) download ticket id

• fileFormat (char) – (optional)

• fileName (char) – (optional) download ticket filename

Returns

[none, resp]

Save a data_view_execution to a project

Parameters

• dataViewExecutionId (char) – (required)

• fileFormat (char) – (optional)

Returns

[FileEntry, 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) Unwrap result documents into a list.

• size (integer) – (optional) The maximum number of results to return.

• facets (logical) – (optional) Include additional statistics about the search results. Internal use only.

• csv (logical) – (optional) Format the response as a CSV file

Returns

[none, resp]

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

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

• body (char) – (optional) Object encoded as a JSON string. It is required and used only when the upload_ticket parameter is used. See schemas/input/signedurlmetadata.json for the format of the json payload.

• formData (char) – (optional)

Returns

[Map, resp]

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

Returns

[EgressDevice, resp]

Delete

(post handlers.devicehandler.DeviceHandler.post)

Parameters

deviceId (char) – (required)

Returns

[none, resp]

Delete Device Key

Parameters

• deviceId (char) – (required)

• keyId (char) – (required)

Returns

[none, resp]

List all devices.

Requires login.

Returns

[vector[Device], resp]

Get status for all known devices.

ok - missing - error - unknown

Returns

[DeviceStatus, resp]

Get Self

(get handlers.devicehandler.DeviceHandler.get_self)

Returns

[EgressDevice, resp]

Get device details

Parameters

deviceId (char) – (required)

Returns

[EgressDevice, 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]

Add list of tags on a file.

Add the tags on a file to the list of tags

Parameters

• fileId (char) – (required)

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

Returns

[vector[char], resp]

Complete S3 multipart signed url upload

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

Parameters

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

Returns

[UploadCompleteS3MultipartOutput, resp]

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]

Create new signed upload URL

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

Parameters

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

Returns

[UploadSignedUploadUrlOutput, resp]

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)

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

• force (logical) – (optional) Force deletion of the file even if some checks fail

Returns

[DeletedResult, resp]

Download files listed in the given ticket.

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

Parameters

• ticket (char) – (required) ID of the download ticket

• format (char) – (optional) Archive format the download will be wrapped in

Returns

[none, resp]

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]

Move and/or rename a file

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

Parameters

• fileId (char) – (required)

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

Returns

[ModifiedResult, resp]

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]

Set list of tags on a file.

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

Parameters

• fileId (char) – (required)

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

Returns

[ModifiedResult, resp]

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

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

Parameters

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

• body (char) – (optional) Object encoded as a JSON string. It is required and used only when the ticket parameter is used. See schemas/input/signedurlmetadata.json for the format of the json payload.

• formData (char) – (optional)

Returns

[Map, resp]

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

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

Parameters

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

• body (char) – (optional) Object encoded as a JSON string. It is required and used only when the ticket parameter is used. See schemas/input/signedurlmetadata.json for the format of the json payload.

• formData (char) – (optional)

Returns

[vector[FileEntry], resp]

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

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

Parameters

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

• body (char) – (optional) Object encoded as a JSON string. It is required and used only when the ticket parameter is used. See schemas/input/signedurlmetadata.json for the format of the json payload.

• formData (char) – (optional)

Returns

[Map, resp]

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

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

Parameters

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

• body (char) – (optional) Object encoded as a JSON string. It is required and used only when the ticket parameter is used. See schemas/input/signedurlmetadata.json for the format of the json payload.

• formData (char) – (optional)

Returns

[Map, resp]

Upload file to local filesystem storage provider

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

Parameters

• token (char) – (required) Upload token

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

Returns

[UploadSignedFsFileUploadOutput, resp]

Upsert a File

Create or update a file

Parameters

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

Returns

[FileUpsertOutput, resp]

Create or update a gear.

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

Parameters

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

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

Returns

[GearDocument, resp]

Add an individual permission to the given gear

Parameters

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

• permissionType (flywheel.model.GearPermissionsType) – (required)

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

Returns

[GearSeries, resp]

Delete a gear (not recommended)

Parameters

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

Returns

[none, resp]

Delete an individual permission of the given gear

Parameters

• gearName (char) – (required)

• permissionType (flywheel.model.GearPermissionsType) – (required)

• permissionId (char) – (required)

Returns

[none, resp]

Delete permissions of the given gear

Parameters

gearName (char) – (required)

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 gear series.

Gets the series for the gear by its name

Parameters

gearName (char) – (required)

Returns

[GearSeries, 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]

Update a gear series

Parameters

• gearName (char) – (required) Name of the gear series to modify

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

Returns

[GearSeries, resp]

Prepare a gear upload

Parameters

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

Returns

[GearReturnTicket, resp]

Replace permissions for the given gear

Parameters

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

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

Returns

[GearSeries, resp]

Report the result of a gear upload and save the ticket

Parameters

body (flywheel.model.GearSaveSubmission) – (required) The ticket, repo and pointer

Returns

[Map, resp]

Add a group

Create a new group.

Parameters

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

Returns

[InsertedId, 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.

Propagates changes to projects, sessions and acquisitions

Parameters

• cid (char) – (required)

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

Returns

[ModifiedResult, resp]

Add a role to the pool of roles in a group

Add a group role.

Parameters

• groupId (char) – (required)

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

Returns

[RoleOutput, resp]

Delete group

Delete a group.

Parameters

groupId (char) – (required)

Returns

[DeletedResult, resp]

Delete a tag

Delete a tag

Parameters

• cid (char) – (required)

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

Returns

[DeletedResult, resp]

Delete a permission

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

Parameters

• groupId (char) – (required)

• userId (char) – (required)

Returns

[ModifiedResult, resp]

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

Find all groups.

Parameters

• exhaustive (logical) – (optional) Set to return a complete list regardless of permissions

• filter (char) – (optional) The filter to apply. (e.g. label=my-label,created>2018-09-22)

• sort (char) – (optional) The sort fields and order. (e.g. label:asc,created:desc)

• limit (integer) – (optional) The maximum number of entries to return.

• skip (integer) – (optional) The number of entries to skip.

• page (integer) – (optional) The page number (i.e. skip limit*page entries)

• afterId (char) – (optional) Paginate after the given id. (Cannot be used with sort, page or skip)

• xAcceptFeature (vector[Object]) – (optional)

Returns

[none, resp]

Get group info

Get a group by ID.

Parameters

groupId (char) – (required)

Returns

[GroupOutput, resp]

Get all projects in a group

Get projects for a group

Parameters

• groupId (char) – (required)

• exhaustive (logical) – (optional)

• filter (char) – (optional) The filter to apply. (e.g. label=my-label,created>2018-09-22)

• sort (char) – (optional) The sort fields and order. (e.g. label:asc,created:desc)

• limit (integer) – (optional) The maximum number of entries to return.

• skip (integer) – (optional) The number of entries to skip.

• page (integer) – (optional) The page number (i.e. skip limit*page entries)

• afterId (char) – (optional) Paginate after the given id. (Cannot be used with sort, page or skip)

• xAcceptFeature (vector[char]) – (optional)

Returns

[none, resp]

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.

Get the value of a tag, by name

Parameters

• cid (char) – (required)

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

Returns

[char, 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

Modify a group.

Parameters

• groupId (char) – (required)

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

Returns

[ModifiedResult, 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.

Rename a tag

Parameters

• cid (char) – (required)

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

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

Returns

[char, 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[JobLog]) – (required)

Returns

[none, resp]

Ask the queue a question

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

Parameters

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

Returns

[JobAskResponse, resp]

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

[JobOutput, 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

[JobLogRecord, 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.JobModify) – (required)

Returns

[ModifiedResult, resp]