flywheel.api package

Submodules

flywheel.api.acquisitions_api module

Flywheel

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501

OpenAPI spec version: 0.0.1

Generated by: https://github.com/swagger-api/swagger-codegen.git

class flywheel.api.acquisitions_api.AcquisitionsApi(api_client=None)

Bases: object

add_acquisition(body, **kwargs)

Create a new acquisition

Create a new acquisition This method makes a synchronous HTTP request by default.

Parameters:

body (AcquisitionInput) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

InsertedId

add_acquisition_analysis(cid, body, **kwargs)

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. This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
body (union[AdhocAnalysisInput,JobAnalysisInput]) – (required)
job (bool) – returns job_id instead of analysis.id
job – returns job_id instead of analysis.id
async_ (bool) – Perform the request asynchronously

Returns:

InsertedId

add_acquisition_analysis_note(container_id, analysis_id, body, **kwargs)

Add a note to a(n) acquisition analysis.

Add a note to a(n) acquisition analysis. This method makes a synchronous HTTP request by default.

Parameters:

container_id (str) – 24-char hex id (required)
analysis_id (str) – 24-char hex analysis id (required)
body (NoteInput) – note content (required)
async_ (bool) – Perform the request asynchronously

Returns:

Note

add_acquisition_note(container_id, body, **kwargs)

Add a note to a(n) acquisition.

Add a note to a(n) acquisition. This method makes a synchronous HTTP request by default.

Parameters:

container_id (str) – (required)
body (NoteInput) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

Note

add_acquisition_tag(cid, body, **kwargs)

Add a tag to a(n) acquisition.

Propagates changes to projects, sessions and acquisitions This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
body (Tag) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

ModifiedResult

add_acquisition_tags(cid, body, **kwargs)

Add multiple tags to a(n) acquisition

Add multiple tags to a(n) acquisition This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
body (list[str]) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

None

delete_acquisition(acquisition_id, **kwargs)

Delete a acquisition

Read-write project permissions are required to delete an acquisition. Admin project permissions are required if the acquisition contains data uploaded by sources other than users and jobs. This method makes a synchronous HTTP request by default.

Parameters:

acquisition_id (str) – (required)
delete_reason (ContainerDeleteReason) – Provide a reason for the deletion
async_ (bool) – Perform the request asynchronously

Returns:

DeletedResult

delete_acquisition_analysis(cid, analysis_id, **kwargs)

Delete an analysis

Delete an analysis for a container. This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
analysis_id (str) – (required)
delete_reason (ContainerDeleteReason) – Provide a reason for the deletion
async_ (bool) – Perform the request asynchronously

Returns:

DeletedResult

delete_acquisition_analysis_note(cid, analysis_id, note_id, **kwargs)

Remove a note from a(n) acquisition analysis.

Remove a note from a(n) acquisition analysis. This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – 24-char hex id (required)
analysis_id (str) – 24-char hex analysis id (required)
note_id (str) – 24-char hex note id (required)
async_ (bool) – Perform the request asynchronously

Returns:

DeletedResult

delete_acquisition_file(cid, filename, **kwargs)

Delete a file

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

Parameters:

cid (str) – (required)
filename (str) – (required)
delete_reason (ContainerDeleteReason) – A reason for deletion when audit-trail is enabled
force (bool) – Force deletion of the file even if some checks fail. Deprecated, will be removed in a future release.
async_ (bool) – Perform the request asynchronously

Returns:

DeletedResult

delete_acquisition_note(cid, note_id, **kwargs)

Remove a note from a(n) acquisition

Remove a note from a(n) acquisition This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
note_id (str) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

DeletedResult

delete_acquisition_tag(cid, value, **kwargs)

Delete a tag

Delete a tag This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
value (str) – The tag to interact with (required)
async_ (bool) – Perform the request asynchronously

Returns:

DeletedResult

delete_acquisition_tags(cid, body, **kwargs)

Delete multiple tags from a(n) acquisition

Delete multiple tags from a(n) acquisition This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
body (list[str]) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

None

delete_acquisitions_by_ids(body, **kwargs)

Delete multiple acquisitions by ID list

Delete multiple acquisitions by ID list This method makes a synchronous HTTP request by default.

Parameters:

body (list[str]) – List of IDs to delete (required)
delete_reason (ContainerDeleteReason)
async_ (bool) – Perform the request asynchronously

Returns:

DeletedResult

delete_acquisitions_by_query(body, **kwargs)

Delete multiple acquisitions by query

Delete multiple acquisitions by query This method makes a synchronous HTTP request by default.

Parameters:

body (list[Filter]) – Query for containers to delete (required)
delete_reason (ContainerDeleteReason)
async_ (bool) – Perform the request asynchronously

Returns:

DeletedResult

download_file_from_acquisition(acquisition_id, file_name, dest_file, **kwargs)

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. This method makes a synchronous HTTP request by default.

Parameters:

acquisition_id (str) – 24-character hex ID (required)
file_name (str) – output file name (required)
info (bool) – If the file is a zipfile, return a json response of zipfile member information
member (str) – The filename of a zipfile member to download rather than the entire file
view (bool) – 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”
version (int) – version of the file to download
hash (str) – file hash for comparison
range (str) – byte ranges to return
x_accept_feature (list[str]) – redirect header
dest_file (str) – Destination file path
async_ (bool) – Perform the request asynchronously

Returns:

union[DownloadTicketStub,ZipfileInfo]

download_input_from_acquisition_analysis(acquisition_id, analysis_id, filename, dest_file, **kwargs)

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. This method makes a synchronous HTTP request by default.

Parameters:

acquisition_id (str) – 24-character hex ID (required)
analysis_id (str) – 24-char hex analysis id (required)
filename (str) – filename to download (get tar of all if empty) (required)
info (bool) – get file info only
member (str) – get zipfile member
view (bool) – feature flag for view/download
range (str) – byte ranges to return
x_accept_feature (list[str]) – redirect header
dest_file (str) – Destination file path
async_ (bool) – Perform the request asynchronously

Returns:

union[DownloadTicketStub,ZipfileInfo]

download_output_from_acquisition_analysis(acquisition_id, analysis_id, filename, dest_file, **kwargs)

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. This method makes a synchronous HTTP request by default.

Parameters:

acquisition_id (str) – 24-character hex ID (required)
analysis_id (str) – 24-char hex analysis id (required)
filename (str) – filename to download (get tar of all if empty) (required)
info (bool) – If the file is a zipfile, return a json response of zipfile member information
member (str) – The filename of a zipfile member to download rather than the entire file
view (bool) – feature flag for view/download
range (str) – byte ranges to return
x_accept_feature (list[str]) – redirect header
dest_file (str) – Destination file path
async_ (bool) – Perform the request asynchronously

Returns:

union[DownloadTicketStub,ZipfileInfo]

get_acquisition(acquisition_id, **kwargs)

Get a single acquisition

Get a single acquisition This method makes a synchronous HTTP request by default.

Parameters:

acquisition_id (str) – (required)
join (JoinType)
join_avatars (bool) – add name and avatar to notes
x_accept_feature (list[union[HeaderFeature,str]])
async_ (bool) – Perform the request asynchronously

Returns:

AcquisitionOutput

get_acquisition_analyses(cid, **kwargs)

Get analyses for a(n) acquisition.

Returns analyses that directly belong to this resource. This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
inflate_job (bool)
join_avatars (bool)
join (JoinType)
include_all_info (bool) – Include all info in returned objects
filter (str) – The filter to apply. (e.g. label=my-label,created>2018-09-22)
sort (str) – The sort fields and order. (e.g. label:asc,created:desc)
limit (int) – The maximum number of entries to return.
skip (int) – The number of entries to skip.
page (int) – The page number (i.e. skip limit*page entries)
after_id (str) – Paginate after the given id. (Cannot be used with sort, page or skip)
x_accept_feature (list[str])
async_ (bool) – Perform the request asynchronously

Returns:

union[Page,list[union[AnalysisListOutput,AnalysisListOutputInflatedJob]]]

get_acquisition_analysis(cid, analysis_id, **kwargs)

Get an analysis.

Get an analysis. This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
analysis_id (str) – (required)
inflate_job (bool) – Return job as an object instead of an id
join_avatars (bool)
join (JoinType)
async_ (bool) – Perform the request asynchronously

Returns:

union[AnalysisOutputInflatedJob,AnalysisOutput]

get_acquisition_analysis_input_download_ticket(acquisition_id, analysis_id, filename, **kwargs)

Get a signed URL to download a named child file.

This method makes a synchronous HTTP request by default.

Parameters:

acquisition_id (str) – 24-character hex ID (required)
analysis_id (str) – 24-char hex analysis id (required)
filename (str) – filename to download (get tar of all if empty) (required)
ticket (str) – 24-char hex ticket id
info (bool) – get file info only
member (str) – get zipfile member
view (bool) – feature flag for view/download
range (str) – byte ranges to return
x_accept_feature (list[str]) – redirect header
async_ (bool) – Perform the request asynchronously

Returns:

union[DownloadTicketStub,ZipfileInfo]

get_acquisition_analysis_input_zip_info(acquisition_id, analysis_id, filename, **kwargs)

Retrieve the zip info of a child file by name.

Does not work on files whose names contain a forward slash. This method makes a synchronous HTTP request by default.

Parameters:

acquisition_id (str) – 24-character hex ID (required)
analysis_id (str) – 24-char hex analysis id (required)
filename (str) – filename to download (get tar of all if empty) (required)
ticket (str) – 24-char hex ticket id
info (bool) – get file info only
member (str) – get zipfile member
view (bool) – feature flag for view/download
range (str) – byte ranges to return
x_accept_feature (list[str]) – redirect header
async_ (bool) – Perform the request asynchronously

Returns:

FileZipInfo

get_acquisition_analysis_output_download_ticket(acquisition_id, analysis_id, filename, **kwargs)

Get a signed URL to download a named child file.

This method makes a synchronous HTTP request by default.

Parameters:

acquisition_id (str) – 24-character hex ID (required)
analysis_id (str) – 24-char hex analysis id (required)
filename (str) – filename to download (get tar of all if empty) (required)
ticket (str) – ticket id of the outputs to download
info (bool) – If the file is a zipfile, return a json response of zipfile member information
member (str) – The filename of a zipfile member to download rather than the entire file
view (bool) – feature flag for view/download
range (str) – byte ranges to return
x_accept_feature (list[str]) – redirect header
async_ (bool) – Perform the request asynchronously

Returns:

union[DownloadTicketStub,ZipfileInfo]

get_acquisition_analysis_output_zip_info(acquisition_id, analysis_id, filename, **kwargs)

Retrieve the zip info of a child file by name.

Does not work on files whose names contain a forward slash. This method makes a synchronous HTTP request by default.

Parameters:

acquisition_id (str) – 24-character hex ID (required)
analysis_id (str) – 24-char hex analysis id (required)
filename (str) – filename to download (get tar of all if empty) (required)
ticket (str) – ticket id of the outputs to download
info (bool) – If the file is a zipfile, return a json response of zipfile member information
member (str) – The filename of a zipfile member to download rather than the entire file
view (bool) – feature flag for view/download
range (str) – byte ranges to return
x_accept_feature (list[str]) – redirect header
async_ (bool) – Perform the request asynchronously

Returns:

FileZipInfo

get_acquisition_download_ticket(acquisition_id, file_name, **kwargs)

Get a signed URL to download a named child file.

This method makes a synchronous HTTP request by default.

Parameters:

acquisition_id (str) – 24-character hex ID (required)
file_name (str) – output file name (required)
ticket (str) – The generated ticket id for the download, or present but empty to generate a ticket id
info (bool) – If the file is a zipfile, return a json response of zipfile member information
member (str) – The filename of a zipfile member to download rather than the entire file
view (bool) – 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”
version (int) – version of the file to download
hash (str) – file hash for comparison
range (str) – byte ranges to return
x_accept_feature (list[str]) – redirect header
async_ (bool) – Perform the request asynchronously

Returns:

union[DownloadTicketStub,ZipfileInfo]

get_acquisition_file_info(cid, filename, **kwargs)

Get info for a particular file.

Get info for a particular file. This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – Container Id (required)
filename (str) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

FileOutput

get_acquisition_file_zip_info(acquisition_id, file_name, **kwargs)

Retrieve the zip info of a child file by name.

Does not work on files whose names contain a forward slash. This method makes a synchronous HTTP request by default.

Parameters:

acquisition_id (str) – 24-character hex ID (required)
file_name (str) – output file name (required)
ticket (str) – The generated ticket id for the download, or present but empty to generate a ticket id
info (bool) – If the file is a zipfile, return a json response of zipfile member information
member (str) – The filename of a zipfile member to download rather than the entire file
view (bool) – 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”
version (int) – version of the file to download
hash (str) – file hash for comparison
range (str) – byte ranges to return
x_accept_feature (list[str]) – redirect header
async_ (bool) – Perform the request asynchronously

Returns:

FileZipInfo

get_acquisition_note(cid, note_id, **kwargs)

Get a note of a(n) acquisition.

Get a note of a(n) acquisition This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
note_id (str) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

Note

get_acquisition_tag(cid, value, **kwargs)

Get the value of a tag, by name.

Get the value of a tag, by name This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
value (str) – The tag to interact with (required)
async_ (bool) – Perform the request asynchronously

Returns:

str

get_all_acquisitions(**kwargs)

Get a list of acquisitions

Get a list of acquisitions. This method makes a synchronous HTTP request by default.

Parameters:

exhaustive (bool) – Set to return a complete list regardless of permissions
join (JoinType)
join_avatars (bool) – add name and avatar to notes
collection_id (str)
include_all_info (bool) – Include all info in returned objects
filter (str) – The filter to apply. (e.g. label=my-label,created>2018-09-22)
sort (str) – The sort fields and order. (e.g. label:asc,created:desc)
limit (int) – The maximum number of entries to return.
skip (int) – The number of entries to skip.
page (int) – The page number (i.e. skip limit*page entries)
after_id (str) – Paginate after the given id. (Cannot be used with sort, page or skip)
x_accept_feature (list[union[HeaderFeature,str]])
async_ (bool) – Perform the request asynchronously

Returns:

union[list[AcquisitionListOutput],Page]

modify_acquisition(acquisition_id, body, **kwargs)

Update an acquisition

Update an acquisition This method makes a synchronous HTTP request by default.

Parameters:

acquisition_id (str) – (required)
body (AcquisitionModifyInput) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

ModifiedResult

modify_acquisition_analysis(cid, analysis_id, body, **kwargs)

Modify an analysis.

Modify an analysis. This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
analysis_id (str) – (required)
body (AnalysisModifyInput) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

ModifiedResult

modify_acquisition_file(cid, filename, body, **kwargs)

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) This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
filename (str) – (required)
body (FileModifyInput) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

ModifiedResult

modify_acquisition_file_classification(cid, filename, body, **kwargs)

Update classification for a particular file.

If replacing a file’s classification, the modality can optionally be modified as well. This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
filename (str) – (required)
body (FileClassificationDelta) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

ModifiedResult

modify_acquisition_file_info(cid, filename, body, **kwargs)

Update info for a particular file.

Modify and return the file ‘info’ field This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
filename (str) – (required)
body (Info) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

ModifiedResult

modify_acquisition_info(cid, body, **kwargs)

Update or replace info for a(n) acquisition.

Update or replace info for a(n) acquisition. Keys that contain ‘$’ or ‘.’ will be sanitized in the process of being updated on the container. This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
body (Info) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

ModifiedResult

modify_acquisition_note(cid, note_id, body, **kwargs)

Update a note of a(n) acquisition.

Update a note of a(n) acquisition This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
note_id (str) – (required)
body (NoteInput) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

int

rename_acquisition_tag(cid, value, body, **kwargs)

Rename a tag.

Rename a tag This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
value (str) – The tag to interact with (required)
body (Tag) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

str

upload_file_to_acquisition(container_id, file, **kwargs)

Upload a file to a(n) acquisition.

Upload a file to a(n) acquisition. This method makes a synchronous HTTP request by default.

Parameters:

container_id (str) – (required)
file (str) – The file to upload (required)
preserve_metadata (bool)
ticket (str)
id (str)
level (ContainerType)
job (str)
metadata (str) – Metadata object as a JSON-encoded string
x_accept_feature (list[str]) – redirect header
content_type (str)
async_ (bool) – Perform the request asynchronously

Returns:

union[list[FileOutput],UploadTicketOutput]

upload_output_to_acquisition_analysis(cid, analysis_id, file, **kwargs)

Upload an output file to an analysis.

Upload an output file to an analysis This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
analysis_id (str) – (required)
file (str) – The file to upload (required)
ticket (str)
id (str)
level (ContainerType)
job (str)
content_type (str)
async_ (bool) – Perform the request asynchronously

Returns:

list[FileOutput]

flywheel.api.analyses_api module

Flywheel

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501

OpenAPI spec version: 0.0.1

Generated by: https://github.com/swagger-api/swagger-codegen.git

class flywheel.api.analyses_api.AnalysesApi(api_client=None)

Bases: object

add_analysis_note(container_id, body, **kwargs)

Add a note to a(n) analysis.

Add a note to a(n) analysis. This method makes a synchronous HTTP request by default.

Parameters:

container_id (str) – (required)
body (NoteInput) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

Note

add_analysis_tag(container_id, body, **kwargs)

Add a tag to a(n) analysis.

Propagates changes to projects, sessions and acquisitions This method makes a synchronous HTTP request by default.

Parameters:

container_id (str) – (required)
body (Tag) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

ModifiedResult

delete_analyses_by_ids(body, **kwargs)

Delete multiple analyses by ID list

Delete multiple analyses by ID list This method makes a synchronous HTTP request by default.

Parameters:

body (list[str]) – List of IDs to delete (required)
delete_reason (ContainerDeleteReason)
async_ (bool) – Perform the request asynchronously

Returns:

DeletedResult

delete_analyses_by_query(body, **kwargs)

Delete multiple analyses by query

Delete multiple analyses by query This method makes a synchronous HTTP request by default.

Parameters:

body (list[Filter]) – Query for containers to delete (required)
delete_reason (ContainerDeleteReason)
async_ (bool) – Perform the request asynchronously

Returns:

DeletedResult

delete_analysis(analysis_id, **kwargs)

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 audit-trail is enabled) This method makes a synchronous HTTP request by default.

Parameters:

analysis_id (str) – 24-char hex analysis id (required)
delete_reason (ContainerDeleteReason)
async_ (bool) – Perform the request asynchronously

Returns:

DeletedResult

delete_analysis_note(container_id, note_id, **kwargs)

Remove a note from a(n) analysis

Remove a note from a(n) analysis This method makes a synchronous HTTP request by default.

Parameters:

container_id (str) – (required)
note_id (str) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

DeletedResult

delete_analysis_tag(container_id, value, **kwargs)

Delete a tag

Delete a tag This method makes a synchronous HTTP request by default.

Parameters:

container_id (str) – (required)
value (str) – The tag to interact with (required)
async_ (bool) – Perform the request asynchronously

Returns:

DeletedResult

download_input_from_analysis(analysis_id, filename, dest_file, **kwargs)

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. This method makes a synchronous HTTP request by default.

Parameters:

analysis_id (str) – 24-character hex ID (required)
filename (str) – input filename (required)
info (bool) – get file info only
member (str) – get zipfile member
view (bool) – feature flag for view/download
range (str) – byte ranges to return
x_accept_feature (list[str]) – redirect header
dest_file (str) – Destination file path
async_ (bool) – Perform the request asynchronously

Returns:

union[DownloadTicketStub,ZipfileInfo]

download_output_from_analysis(analysis_id, filename, dest_file, **kwargs)

Get Output File

Get Output File This method makes a synchronous HTTP request by default.

Parameters:

analysis_id (str) – Container ID (required)
filename (str) – output file name (required)
info (bool) – get file info only
member (str) – get zipfile member
view (bool) – feature flag for view/download
range (str) – byte ranges to return
x_accept_feature (list[str]) – redirect header
dest_file (str) – Destination file path
async_ (bool) – Perform the request asynchronously

Returns:

union[DownloadTicketStub,ZipfileInfo]

get_all_analyses(**kwargs)

Find all analyses

Returns a page of analyses Args: filter (t.Optional[str]): The filters to apply sort (t.List[Tuple[str,int]): Sorting, as a list of (str, int) tuples limit (t.Optional[int]): The maximum number of entries to return skip (t.Optional[int]): The number of entries to skip page (t.Optional[int]): Page number after_id (t.Optional[str]): Id to return results after Returns: Page: if a above argument is not None This method makes a synchronous HTTP request by default.

Parameters:

inflate_job (bool) – Return job as an object instead of an id
include_all_info (bool) – Include all info in returned objects
filter (str) – The filter to apply. (e.g. label=my-label,created>2018-09-22)
sort (str) – The sort fields and order. (e.g. label:asc,created:desc)
limit (int) – The maximum number of entries to return.
skip (int) – The number of entries to skip.
page (int) – The page number (i.e. skip limit*page entries)
after_id (str) – Paginate after the given id. (Cannot be used with sort, page or skip)
x_accept_feature (list[str])
async_ (bool) – Perform the request asynchronously

Returns:

union[Page,list[union[AnalysisListOutput,AnalysisListOutputInflatedJob]]]

get_analyses(container_name, container_id, subcontainer_name, **kwargs)

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. This method makes a synchronous HTTP request by default.

Parameters:

container_name (str) – The parent container type (required)
container_id (str) – The parent container id (required)
subcontainer_name (str) – The sub container type (required)
async_ (bool) – Perform the request asynchronously

Returns:

list[AnalysisListOutput]

get_analysis(analysis_id, **kwargs)

Get an analysis.

Get an analysis by its id This method makes a synchronous HTTP request by default.

Parameters:

analysis_id (str) – 24-char hex analysis id (required)
inflate_job (bool) – expand job info
join_avatars (bool) – add name and avatar to notes
join (JoinType)
async_ (bool) – Perform the request asynchronously

Returns:

union[AnalysisOutput,AnalysisOutputInflatedJob]

get_analysis_file_info(container_id, filename, **kwargs)

Get info for a particular file.

Get info for a particular file. This method makes a synchronous HTTP request by default.

Parameters:

container_id (str) – Container Id (required)
filename (str) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

FileOutput

get_analysis_input_download_ticket(analysis_id, filename, **kwargs)

Get a signed URL to download a named child file.

This method makes a synchronous HTTP request by default.

Parameters:

analysis_id (str) – 24-character hex ID (required)
filename (str) – input filename (required)
ticket (str) – 24-char hex ticket id
info (bool) – get file info only
member (str) – get zipfile member
view (bool) – feature flag for view/download
range (str) – byte ranges to return
x_accept_feature (list[str]) – redirect header
async_ (bool) – Perform the request asynchronously

Returns:

union[DownloadTicketStub,ZipfileInfo]

get_analysis_input_zip_info(analysis_id, filename, **kwargs)

Retrieve the zip info of a child file by name.

Does not work on files whose names contain a forward slash. This method makes a synchronous HTTP request by default.

Parameters:

analysis_id (str) – 24-character hex ID (required)
filename (str) – input filename (required)
ticket (str) – 24-char hex ticket id
info (bool) – get file info only
member (str) – get zipfile member
view (bool) – feature flag for view/download
range (str) – byte ranges to return
x_accept_feature (list[str]) – redirect header
async_ (bool) – Perform the request asynchronously

Returns:

FileZipInfo

get_analysis_note(container_id, note_id, **kwargs)

Get a note of a(n) analysis.

Get a note of a(n) analysis This method makes a synchronous HTTP request by default.

Parameters:

container_id (str) – (required)
note_id (str) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

Note

get_analysis_output_download_ticket(analysis_id, filename, **kwargs)

Get a signed URL to download a named child file.

This method makes a synchronous HTTP request by default.

Parameters:

analysis_id (str) – Container ID (required)
filename (str) – output file name (required)
ticket (str) – 24-char hex ticket id
info (bool) – get file info only
member (str) – get zipfile member
view (bool) – feature flag for view/download
range (str) – byte ranges to return
x_accept_feature (list[str]) – redirect header
async_ (bool) – Perform the request asynchronously

Returns:

union[DownloadTicketStub,ZipfileInfo]

get_analysis_output_zip_info(analysis_id, filename, **kwargs)

Retrieve the zip info of a child file by name.

Does not work on files whose names contain a forward slash. This method makes a synchronous HTTP request by default.

Parameters:

analysis_id (str) – Container ID (required)
filename (str) – output file name (required)
ticket (str) – 24-char hex ticket id
info (bool) – get file info only
member (str) – get zipfile member
view (bool) – feature flag for view/download
range (str) – byte ranges to return
x_accept_feature (list[str]) – redirect header
async_ (bool) – Perform the request asynchronously

Returns:

FileZipInfo

get_analysis_tag(container_id, value, **kwargs)

Get the value of a tag, by name.

Get the value of a tag, by name This method makes a synchronous HTTP request by default.

Parameters:

container_id (str) – (required)
value (str) – The tag to interact with (required)
async_ (bool) – Perform the request asynchronously

Returns:

str

modify_analysis(analysis_id, body, **kwargs)

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 This method makes a synchronous HTTP request by default.

Parameters:

analysis_id (str) – 24-char hex analysis id (required)
body (AnalysisModifyInput) – new analysis fields (required)
async_ (bool) – Perform the request asynchronously

Returns:

ModifiedResult

modify_analysis_info(container_id, body, **kwargs)

Update or replace info for a(n) analysis.

Update or replace info for a(n) analysis. Keys that contain ‘$’ or ‘.’ will be sanitized in the process of being updated on the container. This method makes a synchronous HTTP request by default.

Parameters:

container_id (str) – (required)
body (Info) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

ModifiedResult

modify_analysis_note(container_id, note_id, body, **kwargs)

Update a note of a(n) analysis.

Update a note of a(n) analysis This method makes a synchronous HTTP request by default.

Parameters:

container_id (str) – (required)
note_id (str) – (required)
body (NoteInput) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

int

rename_analysis_tag(container_id, value, body, **kwargs)

Rename a tag.

Rename a tag This method makes a synchronous HTTP request by default.

Parameters:

container_id (str) – (required)
value (str) – The tag to interact with (required)
body (Tag) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

str

upload_output_to_analysis(container_id, file, **kwargs)

Upload an output file to an analysis.

Upload an output file to an analysis This method makes a synchronous HTTP request by default.

Parameters:

container_id (str) – (required)
file (str) – The file to upload (required)
ticket (str)
preserve_metadata (bool)
id (str)
level (ContainerType)
job (str)
x_accept_feature (list[str]) – redirect header
content_type (str)
async_ (bool) – Perform the request asynchronously

Returns:

None

flywheel.api.audit_trail_api module

Flywheel

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501

OpenAPI spec version: 0.0.1

Generated by: https://github.com/swagger-api/swagger-codegen.git

class flywheel.api.audit_trail_api.AuditTrailApi(api_client=None)

Bases: object

add_audit_trail_report(body, **kwargs)

Starts generation of an Audit Trail Report

Start generation of a new Audit Trail Report. This method makes a synchronous HTTP request by default.

Parameters:

body (CreateReportInput) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

AuditTrailReport

delete_audit_trail_report(report_id, **kwargs)

Deletes an Audit Trail Report

Delete an Audit Trail Report This method makes a synchronous HTTP request by default.

Parameters:

report_id (str) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

DeletedResult

download_audit_trail_report(report_id, **kwargs)

Download Audit Trail Report

Download Audit Trail Reports This method makes a synchronous HTTP request by default.

Parameters:

report_id (str) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

None

list_audit_trail_reports(**kwargs)

List Audit Trail Reports

List Audit Trail Reports. This method makes a synchronous HTTP request by default.

Parameters:

filter (str) – The filter to apply. (e.g. label=my-label,created>2018-09-22)
sort (str) – The sort fields and order. (e.g. label:asc,created:desc)
limit (int) – The maximum number of entries to return.
skip (int) – The number of entries to skip.
page (int) – The page number (i.e. skip limit*page entries)
after_id (str) – Paginate after the given id. (Cannot be used with sort, page or skip)
x_accept_feature (list[union[HeaderFeature,str]])
async_ (bool) – Perform the request asynchronously

Returns:

union[Page,list[AuditTrailReport]]

modify_audit_trail_report(report_id, body, **kwargs)

Modify an Audit Trail Report

Modify an Audit Trail Report This method makes a synchronous HTTP request by default.

Parameters:

report_id (str) – (required)
body (ModifyReportInput) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

AuditTrailReport

flywheel.api.auth_api module

Flywheel

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501

OpenAPI spec version: 0.0.1

Generated by: https://github.com/swagger-api/swagger-codegen.git

class flywheel.api.auth_api.AuthApi(api_client=None)

Bases: object

get_auth_status(**kwargs)

Get Login status

Get the current login status of the requestor This method makes a synchronous HTTP request by default.

Parameters:: async_ (bool) – Perform the request asynchronously
Returns:: AuthSessionOutput

flywheel.api.batch_api module

Flywheel

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501

OpenAPI spec version: 0.0.1

Generated by: https://github.com/swagger-api/swagger-codegen.git

class flywheel.api.batch_api.BatchApi(api_client=None)

Bases: object

cancel_batch(batch_id, **kwargs)

Cancel a Job

Cancels jobs that are still pending, returns number of jobs cancelled. Moves a ‘running’ batch job to ‘cancelled’. This method makes a synchronous HTTP request by default.

Parameters:

batch_id (str) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

CancelledBatchOutput

create_batch_job_from_jobs(body, **kwargs)

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

Create a batch job proposal from preconstructed jobs and insert it as ‘pending’. This method makes a synchronous HTTP request by default.

Parameters:

body (PremadeJobsBatchProposalInput) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

PremadeJobsBatchProposal

get_all_batches(**kwargs)

Get a list of batch jobs the user has created.

Requires login. This method makes a synchronous HTTP request by default.

Parameters:: async_ (bool) – Perform the request asynchronously
Returns:: list[Batch]

get_batch(batch_id, **kwargs)

Get batch job details.

This method makes a synchronous HTTP request by default.

Parameters:

batch_id (str) – (required)
jobs (bool) – If true, return job objects instead of job ids
async_ (bool) – Perform the request asynchronously

Returns:

union[ClassicBatchJobOutput,ClassicBatchJobOutputInflatedJobs,PremadeJobsBatchJobOutput,PremadeJobsBatchJobOutputInflatedJobs]

propose_batch(body, **kwargs)

Create a batch job proposal and insert it as 'pending'.

Create a batch job proposal and insert it as ‘pending’. This method makes a synchronous HTTP request by default.

Parameters:

body (ClassicBatchProposalInput) – The batch proposal (required)
async_ (bool) – Perform the request asynchronously

Returns:

ClassicBatchProposalOutput

start_batch(batch_id, **kwargs)

Launch a job.

Creates jobs from proposed inputs, returns jobs enqueued. Moves ‘pending’ batch job to ‘running’. This method makes a synchronous HTTP request by default.

Parameters:

batch_id (str) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

list[JobOutput]

flywheel.api.bulk_api module

Flywheel

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501

OpenAPI spec version: 0.0.1

Generated by: https://github.com/swagger-api/swagger-codegen.git

class flywheel.api.bulk_api.BulkApi(api_client=None)

Bases: object

bulk_move_sessions(body, **kwargs)

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

Move sessions This method makes a synchronous HTTP request by default.

Parameters:

body (BulkMoveInput) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

list[MoveConflict]

flywheel.api.change_log_api module

Flywheel

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501

OpenAPI spec version: 0.0.1

Generated by: https://github.com/swagger-api/swagger-codegen.git

class flywheel.api.change_log_api.ChangeLogApi(api_client=None)

Bases: object

get_change_log(container_type, container_id, **kwargs)

Get Change Log

This method makes a synchronous HTTP request by default.

Parameters:

container_type (ChangeLogContainerType) – (required)
container_id (str) – (required)
version (int) – Optional version if retrieving logs for file
async_ (bool) – Perform the request asynchronously

Returns:

ChangeLogDocument

get_field_change_log(container_type, container_id, field, **kwargs)

Get change logs by specific field, in reverse chronological order

This method makes a synchronous HTTP request by default.

Parameters:

container_type (ChangeLogContainerType) – (required)
container_id (str) – (required)
field (str) – (required)
version (int) – Optional version if retrieving logs for file
async_ (bool) – Perform the request asynchronously

Returns:

FieldChangeLogDocument

flywheel.api.collections_api module

Flywheel

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501

OpenAPI spec version: 0.0.1

Generated by: https://github.com/swagger-api/swagger-codegen.git

class flywheel.api.collections_api.CollectionsApi(api_client=None)

Bases: object

add_collection(body, **kwargs)

Create a collection

Create a collection This method makes a synchronous HTTP request by default.

Parameters:

body (CollectionInput) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

InsertedId

add_collection_note(container_id, body, **kwargs)

Add a note to a(n) collection.

Add a note to a(n) collection. This method makes a synchronous HTTP request by default.

Parameters:

container_id (str) – (required)
body (NoteInput) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

Note

add_collection_permission(collection_id, body, **kwargs)

Add a permission

Add a permission This method makes a synchronous HTTP request by default.

Parameters:

collection_id (str) – (required)
body (AccessPermission) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

AccessPermissionOutput

add_collection_tag(cid, body, **kwargs)

Add a tag to a(n) collection.

Propagates changes to projects, sessions and acquisitions This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
body (Tag) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

ModifiedResult

add_collection_tags(cid, body, **kwargs)

Add multiple tags to a(n) collection

Add multiple tags to a(n) collection This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
body (list[str]) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

None

delete_collection(collection_id, **kwargs)

Delete a collection

Delete Collections. This method makes a synchronous HTTP request by default.

Parameters:

collection_id (str) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

DeletedResult

delete_collection_file(cid, filename, **kwargs)

Delete a file

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

Parameters:

cid (str) – (required)
filename (str) – (required)
delete_reason (ContainerDeleteReason) – A reason for deletion when audit-trail is enabled
force (bool) – Force deletion of the file even if some checks fail. Deprecated, will be removed in a future release.
async_ (bool) – Perform the request asynchronously

Returns:

DeletedResult

delete_collection_note(cid, note_id, **kwargs)

Remove a note from a(n) collection

Remove a note from a(n) collection This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
note_id (str) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

DeletedResult

delete_collection_tag(cid, value, **kwargs)

Delete a tag

Delete a tag This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
value (str) – The tag to interact with (required)
async_ (bool) – Perform the request asynchronously

Returns:

DeletedResult

delete_collection_tags(cid, body, **kwargs)

Delete multiple tags from a(n) collection

Delete multiple tags from a(n) collection This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
body (list[str]) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

None

delete_collection_user_permission(collection_id, user_id, **kwargs)

Delete a permission

Delete a permission This method makes a synchronous HTTP request by default.

Parameters:

collection_id (str) – (required)
user_id (str) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

ModifiedResult

delete_collections_by_ids(body, **kwargs)

Delete multiple collections by ID list

Delete multiple collections by ID list This method makes a synchronous HTTP request by default.

Parameters:

body (list[str]) – List of IDs to delete (required)
delete_reason (ContainerDeleteReason)
async_ (bool) – Perform the request asynchronously

Returns:

DeletedResult

delete_collections_by_query(body, **kwargs)

Delete multiple collections by query

Delete multiple collections by query This method makes a synchronous HTTP request by default.

Parameters:

body (list[Filter]) – Query for containers to delete (required)
delete_reason (ContainerDeleteReason)
async_ (bool) – Perform the request asynchronously

Returns:

DeletedResult

download_file_from_collection(collection_id, file_name, dest_file, **kwargs)

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. This method makes a synchronous HTTP request by default.

Parameters:

collection_id (str) – 24-character hex ID (required)
file_name (str) – output file name (required)
info (bool) – If the file is a zipfile, return a json response of zipfile member information
member (str) – The filename of a zipfile member to download rather than the entire file
view (bool) – 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”
version (int) – version of the file to download
hash (str) – file hash for comparison
range (str) – byte ranges to return
x_accept_feature (list[str]) – redirect header
dest_file (str) – Destination file path
async_ (bool) – Perform the request asynchronously

Returns:

union[DownloadTicketStub,ZipfileInfo]

get_all_collections(**kwargs)

List all collections.

List all collections. This method makes a synchronous HTTP request by default.

Parameters:

exhaustive (bool)
join_avatars (bool) – add name and avatar to notes
join_files (bool)
join (JoinType)
stats (bool)
include_all_info (bool) – Include all info in returned objects
user_id (str)
filter (str) – The filter to apply. (e.g. label=my-label,created>2018-09-22)
sort (str) – The sort fields and order. (e.g. label:asc,created:desc)
limit (int) – The maximum number of entries to return.
skip (int) – The number of entries to skip.
page (int) – The page number (i.e. skip limit*page entries)
after_id (str) – Paginate after the given id. (Cannot be used with sort, page or skip)
x_accept_feature (list[union[HeaderFeature,str]])
async_ (bool) – Perform the request asynchronously

Returns:

union[Page,list[CollectionWithStats],list[CollectionOutput]]

get_all_collections_curators(**kwargs)

List all curators of collections

List all curators of collections This method makes a synchronous HTTP request by default.

Parameters:

filter (str) – The filter to apply. (e.g. label=my-label,created>2018-09-22)
sort (str) – The sort fields and order. (e.g. label:asc,created:desc)
limit (int) – The maximum number of entries to return.
skip (int) – The number of entries to skip.
page (int) – The page number (i.e. skip limit*page entries)
after_id (str) – Paginate after the given id. (Cannot be used with sort, page or skip)
async_ (bool) – Perform the request asynchronously

Returns:

list[Curator]

get_collection(collection_id, **kwargs)

Retrieve a single collection

Retrieve a single collection This method makes a synchronous HTTP request by default.

Parameters:

collection_id (str) – (required)
join_avatars (bool) – add name and avatar to notes
join (JoinType)
x_accept_feature (list[union[HeaderFeature,str]])
async_ (bool) – Perform the request asynchronously

Returns:

CollectionOutput

get_collection_acquisitions(collection_id, **kwargs)

List acquisitions in a collection

List acquisitions in a collection This method makes a synchronous HTTP request by default.

Parameters:

collection_id (str) – (required)
session (str) – The id of a session, to which the acquisitions returned will be restricted
filter (str) – The filter to apply. (e.g. label=my-label,created>2018-09-22)
sort (str) – The sort fields and order. (e.g. label:asc,created:desc)
limit (int) – The maximum number of entries to return.
skip (int) – The number of entries to skip.
page (int) – The page number (i.e. skip limit*page entries)
after_id (str) – Paginate after the given id. (Cannot be used with sort, page or skip)
x_accept_feature (list[str])
async_ (bool) – Perform the request asynchronously

Returns:

union[list[AcquisitionListOutput],Page]

get_collection_download_ticket(collection_id, file_name, **kwargs)

Get a signed URL to download a named child file.

This method makes a synchronous HTTP request by default.

Parameters:

collection_id (str) – 24-character hex ID (required)
file_name (str) – output file name (required)
ticket (str) – The generated ticket id for the download, or present but empty to generate a ticket id
info (bool) – If the file is a zipfile, return a json response of zipfile member information
member (str) – The filename of a zipfile member to download rather than the entire file
view (bool) – 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”
version (int) – version of the file to download
hash (str) – file hash for comparison
range (str) – byte ranges to return
x_accept_feature (list[str]) – redirect header
async_ (bool) – Perform the request asynchronously

Returns:

union[DownloadTicketStub,ZipfileInfo]

get_collection_file_info(cid, filename, **kwargs)

Get info for a particular file.

Get info for a particular file. This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – Container Id (required)
filename (str) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

FileOutput

get_collection_file_zip_info(collection_id, file_name, **kwargs)

Retrieve the zip info of a child file by name.

Does not work on files whose names contain a forward slash. This method makes a synchronous HTTP request by default.

Parameters:

collection_id (str) – 24-character hex ID (required)
file_name (str) – output file name (required)
ticket (str) – The generated ticket id for the download, or present but empty to generate a ticket id
info (bool) – If the file is a zipfile, return a json response of zipfile member information
member (str) – The filename of a zipfile member to download rather than the entire file
view (bool) – 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”
version (int) – version of the file to download
hash (str) – file hash for comparison
range (str) – byte ranges to return
x_accept_feature (list[str]) – redirect header
async_ (bool) – Perform the request asynchronously

Returns:

FileZipInfo

get_collection_note(cid, note_id, **kwargs)

Get a note of a(n) collection.

Get a note of a(n) collection This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
note_id (str) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

Note

get_collection_sessions(collection_id, **kwargs)

List sessions in a collection

List sessions in a collection. This method makes a synchronous HTTP request by default.

Parameters:

collection_id (str) – (required)
include_all_info (bool) – Include all info in returned objects
filter (str) – The filter to apply. (e.g. label=my-label,created>2018-09-22)
sort (str) – The sort fields and order. (e.g. label:asc,created:desc)
limit (int) – The maximum number of entries to return.
skip (int) – The number of entries to skip.
page (int) – The page number (i.e. skip limit*page entries)
after_id (str) – Paginate after the given id. (Cannot be used with sort, page or skip)
x_accept_feature (list[str])
async_ (bool) – Perform the request asynchronously

Returns:

union[list[SessionListOutput],Page]

get_collection_tag(cid, value, **kwargs)

Get the value of a tag, by name.

Get the value of a tag, by name This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
value (str) – The tag to interact with (required)
async_ (bool) – Perform the request asynchronously

Returns:

str

get_collection_user_permission(collection_id, user_id, **kwargs)

List a user's permissions for this group.

List a user’s permissions for this group This method makes a synchronous HTTP request by default.

Parameters:

collection_id (str) – (required)
user_id (str) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

AccessPermissionOutput

modify_collection(collection_id, body, **kwargs)

Update a collection and its contents

Update a collection and its contents This method makes a synchronous HTTP request by default.

Parameters:

collection_id (str) – (required)
body (CollectionInputWithContents) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

ModifiedResult

modify_collection_file(cid, filename, body, **kwargs)

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) This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
filename (str) – (required)
body (FileModifyInput) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

ModifiedResult

modify_collection_file_classification(cid, filename, body, **kwargs)

Update classification for a particular file.

If replacing a file’s classification, the modality can optionally be modified as well. This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
filename (str) – (required)
body (FileClassificationDelta) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

ModifiedResult

modify_collection_file_info(cid, filename, body, **kwargs)

Update info for a particular file.

Modify and return the file ‘info’ field This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
filename (str) – (required)
body (Info) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

ModifiedResult

modify_collection_info(cid, body, **kwargs)

Update or replace info for a(n) collection.

Update or replace info for a(n) collection. Keys that contain ‘$’ or ‘.’ will be sanitized in the process of being updated on the container. This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
body (Info) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

ModifiedResult

modify_collection_note(cid, note_id, body, **kwargs)

Update a note of a(n) collection.

Update a note of a(n) collection This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
note_id (str) – (required)
body (NoteInput) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

int

modify_collection_user_permission(collection_id, user_id, body, **kwargs)

Update a user's permission for this group.

Update a users permission for this group This method makes a synchronous HTTP request by default.

Parameters:

collection_id (str) – (required)
user_id (str) – (required)
body (AccessPermissionUpdate) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

AccessPermissionOutput

rename_collection_tag(cid, value, body, **kwargs)

Rename a tag.

Rename a tag This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
value (str) – The tag to interact with (required)
body (Tag) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

str

upload_file_to_collection(container_id, file, **kwargs)

Upload a file to a(n) collection.

Upload a file to a(n) collection. This method makes a synchronous HTTP request by default.

Parameters:

container_id (str) – (required)
file (str) – The file to upload (required)
preserve_metadata (bool)
ticket (str)
id (str)
level (ContainerType)
job (str)
metadata (str) – Metadata object as a JSON-encoded string
x_accept_feature (list[str]) – redirect header
content_type (str)
async_ (bool) – Perform the request asynchronously

Returns:

union[list[FileOutput],UploadTicketOutput]

flywheel.api.config_api module

Flywheel

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501

OpenAPI spec version: 0.0.1

Generated by: https://github.com/swagger-api/swagger-codegen.git

class flywheel.api.config_api.ConfigApi(api_client=None)

Bases: object

get_config(**kwargs)

Get public configuration

return config dict This method makes a synchronous HTTP request by default.

Parameters:: async_ (bool) – Perform the request asynchronously
Returns:: ConfigOut

get_config_js(**kwargs)

Return public Scitran configuration information in javascript format.

return config as a JavaScript string assignment This method makes a synchronous HTTP request by default.

Parameters:: async_ (bool) – Perform the request asynchronously
Returns:: object

get_version(**kwargs)

Get server and database schema version info

return database version dict This method makes a synchronous HTTP request by default.

Parameters:: async_ (bool) – Perform the request asynchronously
Returns:: Version

flywheel.api.containers_api module

Flywheel

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501

OpenAPI spec version: 0.0.1

Generated by: https://github.com/swagger-api/swagger-codegen.git

class flywheel.api.containers_api.ContainersApi(api_client=None)

Bases: object

add_container_analysis(cid, body, **kwargs)

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. This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
body (union[AdhocAnalysisInput,JobAnalysisInput]) – (required)
job (bool) – returns job_id instead of analysis.id
job – returns job_id instead of analysis.id
async_ (bool) – Perform the request asynchronously

Returns:

InsertedId

add_container_analysis_note(container_id, analysis_id, body, **kwargs)

Add a note to a(n) container analysis.

Add a note to a(n) container analysis. This method makes a synchronous HTTP request by default.

Parameters:

container_id (str) – 24-char hex id (required)
analysis_id (str) – 24-char hex analysis id (required)
body (NoteInput) – note content (required)
async_ (bool) – Perform the request asynchronously

Returns:

Note

add_container_note(container_id, body, **kwargs)

Add a note to a(n) container.

Add a note to a(n) container. This method makes a synchronous HTTP request by default.

Parameters:

container_id (str) – (required)
body (NoteInput) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

Note

add_container_tag(cid, body, **kwargs)

Add a tag to a(n) container.

Propagates changes to projects, sessions and acquisitions This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
body (Tag) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

ModifiedResult

add_container_tags(cid, body, **kwargs)

Add multiple tags to a(n) container

Add multiple tags to a(n) container This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
body (list[str]) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

None

add_view(container_id, body, **kwargs)

Add a new data view

Create container view This method makes a synchronous HTTP request by default.

Parameters:

container_id (str) – (required)
body (ContainerIdViewInput) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

ViewIdOutput

delete_container(container_id, **kwargs)

Delete a container

Delete Container This method makes a synchronous HTTP request by default.

Parameters:

container_id (str) – (required)
delete_reason (ContainerDeleteReason)
async_ (bool) – Perform the request asynchronously

Returns:

DeletedResult

delete_container_analysis(cid, analysis_id, **kwargs)

Delete an analysis

Delete an analysis for a container. This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
analysis_id (str) – (required)
delete_reason (ContainerDeleteReason) – Provide a reason for the deletion
async_ (bool) – Perform the request asynchronously

Returns:

DeletedResult

delete_container_analysis_note(cid, analysis_id, note_id, **kwargs)

Remove a note from a(n) container analysis.

Remove a note from a(n) container analysis. This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – 24-char hex id (required)
analysis_id (str) – 24-char hex analysis id (required)
note_id (str) – 24-char hex note id (required)
async_ (bool) – Perform the request asynchronously

Returns:

DeletedResult

delete_container_file(cid, filename, **kwargs)

Delete a file

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

Parameters:

cid (str) – (required)
filename (str) – (required)
delete_reason (ContainerDeleteReason) – A reason for deletion when audit-trail is enabled
force (bool) – Force deletion of the file even if some checks fail. Deprecated, will be removed in a future release.
async_ (bool) – Perform the request asynchronously

Returns:

DeletedResult

delete_container_note(cid, note_id, **kwargs)

Remove a note from a(n) container

Remove a note from a(n) container This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
note_id (str) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

DeletedResult

delete_container_tag(cid, value, **kwargs)

Delete a tag

Delete a tag This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
value (str) – The tag to interact with (required)
async_ (bool) – Perform the request asynchronously

Returns:

DeletedResult

delete_container_tags(cid, body, **kwargs)

Delete multiple tags from a(n) container

Delete multiple tags from a(n) container This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
body (list[str]) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

None

download_file_from_container(container_id, file_name, dest_file, **kwargs)

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. This method makes a synchronous HTTP request by default.

Parameters:

container_id (str) – 24-character hex ID (required)
file_name (str) – output file name (required)
info (bool) – If the file is a zipfile, return a json response of zipfile member information
member (str) – The filename of a zipfile member to download rather than the entire file
view (bool) – 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”
version (int) – version of the file to download
hash (str) – file hash for comparison
range (str) – byte ranges to return
x_accept_feature (list[str]) – redirect header
dest_file (str) – Destination file path
async_ (bool) – Perform the request asynchronously

Returns:

union[DownloadTicketStub,ZipfileInfo]

download_input_from_container_analysis(container_id, analysis_id, filename, dest_file, **kwargs)

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. This method makes a synchronous HTTP request by default.

Parameters:

container_id (str) – 24-character hex ID (required)
analysis_id (str) – 24-char hex analysis id (required)
filename (str) – filename to download (get tar of all if empty) (required)
info (bool) – get file info only
member (str) – get zipfile member
view (bool) – feature flag for view/download
range (str) – byte ranges to return
x_accept_feature (list[str]) – redirect header
dest_file (str) – Destination file path
async_ (bool) – Perform the request asynchronously

Returns:

union[DownloadTicketStub,ZipfileInfo]

download_output_from_container_analysis(container_id, analysis_id, filename, dest_file, **kwargs)

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. This method makes a synchronous HTTP request by default.

Parameters:

container_id (str) – 24-character hex ID (required)
analysis_id (str) – 24-char hex analysis id (required)
filename (str) – filename to download (get tar of all if empty) (required)
info (bool) – If the file is a zipfile, return a json response of zipfile member information
member (str) – The filename of a zipfile member to download rather than the entire file
view (bool) – feature flag for view/download
range (str) – byte ranges to return
x_accept_feature (list[str]) – redirect header
dest_file (str) – Destination file path
async_ (bool) – Perform the request asynchronously

Returns:

union[DownloadTicketStub,ZipfileInfo]

get_container(container_id, **kwargs)

Retrieve a single container

Find Container by ID This method makes a synchronous HTTP request by default.

Parameters:

container_id (str) – (required)
join (JoinType)
join_avatars (bool)
async_ (bool) – Perform the request asynchronously

Returns:

union[GroupContainerOutput,ProjectContainerOutput,SubjectContainerOutput,SessionContainerOutput,AcquisitionContainerOutput,AnalysisContainerOutput,CollectionContainerOutput]

get_container_analyses(cid, **kwargs)

Get analyses for a(n) container.

Returns analyses that directly belong to this resource. This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
inflate_job (bool)
join_avatars (bool)
join (JoinType)
include_all_info (bool) – Include all info in returned objects
filter (str) – The filter to apply. (e.g. label=my-label,created>2018-09-22)
sort (str) – The sort fields and order. (e.g. label:asc,created:desc)
limit (int) – The maximum number of entries to return.
skip (int) – The number of entries to skip.
page (int) – The page number (i.e. skip limit*page entries)
after_id (str) – Paginate after the given id. (Cannot be used with sort, page or skip)
x_accept_feature (list[str])
async_ (bool) – Perform the request asynchronously

Returns:

union[Page,list[union[AnalysisListOutput,AnalysisListOutputInflatedJob]]]

get_container_analysis(cid, analysis_id, **kwargs)

Get an analysis.

Get an analysis. This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
analysis_id (str) – (required)
inflate_job (bool) – Return job as an object instead of an id
join_avatars (bool)
join (JoinType)
async_ (bool) – Perform the request asynchronously

Returns:

union[AnalysisOutputInflatedJob,AnalysisOutput]

get_container_analysis_input_download_ticket(container_id, analysis_id, filename, **kwargs)

Get a signed URL to download a named child file.

This method makes a synchronous HTTP request by default.

Parameters:

container_id (str) – 24-character hex ID (required)
analysis_id (str) – 24-char hex analysis id (required)
filename (str) – filename to download (get tar of all if empty) (required)
ticket (str) – 24-char hex ticket id
info (bool) – get file info only
member (str) – get zipfile member
view (bool) – feature flag for view/download
range (str) – byte ranges to return
x_accept_feature (list[str]) – redirect header
async_ (bool) – Perform the request asynchronously

Returns:

union[DownloadTicketStub,ZipfileInfo]

get_container_analysis_input_zip_info(container_id, analysis_id, filename, **kwargs)

Retrieve the zip info of a child file by name.

Does not work on files whose names contain a forward slash. This method makes a synchronous HTTP request by default.

Parameters:

container_id (str) – 24-character hex ID (required)
analysis_id (str) – 24-char hex analysis id (required)
filename (str) – filename to download (get tar of all if empty) (required)
ticket (str) – 24-char hex ticket id
info (bool) – get file info only
member (str) – get zipfile member
view (bool) – feature flag for view/download
range (str) – byte ranges to return
x_accept_feature (list[str]) – redirect header
async_ (bool) – Perform the request asynchronously

Returns:

FileZipInfo

get_container_analysis_output_download_ticket(container_id, analysis_id, filename, **kwargs)

Get a signed URL to download a named child file.

This method makes a synchronous HTTP request by default.

Parameters:

container_id (str) – 24-character hex ID (required)
analysis_id (str) – 24-char hex analysis id (required)
filename (str) – filename to download (get tar of all if empty) (required)
ticket (str) – ticket id of the outputs to download
info (bool) – If the file is a zipfile, return a json response of zipfile member information
member (str) – The filename of a zipfile member to download rather than the entire file
view (bool) – feature flag for view/download
range (str) – byte ranges to return
x_accept_feature (list[str]) – redirect header
async_ (bool) – Perform the request asynchronously

Returns:

union[DownloadTicketStub,ZipfileInfo]

get_container_analysis_output_zip_info(container_id, analysis_id, filename, **kwargs)

Retrieve the zip info of a child file by name.

Does not work on files whose names contain a forward slash. This method makes a synchronous HTTP request by default.

Parameters:

container_id (str) – 24-character hex ID (required)
analysis_id (str) – 24-char hex analysis id (required)
filename (str) – filename to download (get tar of all if empty) (required)
ticket (str) – ticket id of the outputs to download
info (bool) – If the file is a zipfile, return a json response of zipfile member information
member (str) – The filename of a zipfile member to download rather than the entire file
view (bool) – feature flag for view/download
range (str) – byte ranges to return
x_accept_feature (list[str]) – redirect header
async_ (bool) – Perform the request asynchronously

Returns:

FileZipInfo

get_container_download_ticket(container_id, file_name, **kwargs)

Get a signed URL to download a named child file.

This method makes a synchronous HTTP request by default.

Parameters:

container_id (str) – 24-character hex ID (required)
file_name (str) – output file name (required)
ticket (str) – The generated ticket id for the download, or present but empty to generate a ticket id
info (bool) – If the file is a zipfile, return a json response of zipfile member information
member (str) – The filename of a zipfile member to download rather than the entire file
view (bool) – 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”
version (int) – version of the file to download
hash (str) – file hash for comparison
range (str) – byte ranges to return
x_accept_feature (list[str]) – redirect header
async_ (bool) – Perform the request asynchronously

Returns:

union[DownloadTicketStub,ZipfileInfo]

get_container_file_info(cid, filename, **kwargs)

Get info for a particular file.

Get info for a particular file. This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – Container Id (required)
filename (str) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

FileOutput

get_container_file_zip_info(container_id, file_name, **kwargs)

Retrieve the zip info of a child file by name.

Does not work on files whose names contain a forward slash. This method makes a synchronous HTTP request by default.

Parameters:

container_id (str) – 24-character hex ID (required)
file_name (str) – output file name (required)
ticket (str) – The generated ticket id for the download, or present but empty to generate a ticket id
info (bool) – If the file is a zipfile, return a json response of zipfile member information
member (str) – The filename of a zipfile member to download rather than the entire file
view (bool) – 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”
version (int) – version of the file to download
hash (str) – file hash for comparison
range (str) – byte ranges to return
x_accept_feature (list[str]) – redirect header
async_ (bool) – Perform the request asynchronously

Returns:

FileZipInfo

get_container_note(cid, note_id, **kwargs)

Get a note of a(n) container.

Get a note of a(n) container This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
note_id (str) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

Note

get_container_tag(cid, value, **kwargs)

Get the value of a tag, by name.

Get the value of a tag, by name This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
value (str) – The tag to interact with (required)
async_ (bool) – Perform the request asynchronously

Returns:

str

get_views(container_id, **kwargs)

Return a list of all views belonging to container

View all containers This method makes a synchronous HTTP request by default.

Parameters:

container_id (str) – The ID of the container, one of user, group or project. Use “site” as containerId to save or get a site data view. (required)
filter (str)
sort (str)
limit (int)
skip (int)
page (int)
after_id (str)
async_ (bool) – Perform the request asynchronously

Returns:

list[ViewOutput]

modify_container(container_id, body, **kwargs)

Update a container and its contents

Modify Container This method makes a synchronous HTTP request by default.

Parameters:

container_id (str) – (required)
body (ContainerUpdate) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

ModifiedResult

modify_container_analysis(cid, analysis_id, body, **kwargs)

Modify an analysis.

Modify an analysis. This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
analysis_id (str) – (required)
body (AnalysisModifyInput) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

ModifiedResult

modify_container_file(cid, filename, body, **kwargs)

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) This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
filename (str) – (required)
body (FileModifyInput) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

ModifiedResult

modify_container_file_classification(cid, filename, body, **kwargs)

Update classification for a particular file.

If replacing a file’s classification, the modality can optionally be modified as well. This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
filename (str) – (required)
body (FileClassificationDelta) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

ModifiedResult

modify_container_file_info(cid, filename, body, **kwargs)

Update info for a particular file.

Modify and return the file ‘info’ field This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
filename (str) – (required)
body (Info) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

ModifiedResult

modify_container_info(cid, body, **kwargs)

Update or replace info for a(n) container.

Update or replace info for a(n) container. Keys that contain ‘$’ or ‘.’ will be sanitized in the process of being updated on the container. This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
body (Info) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

ModifiedResult

modify_container_note(cid, note_id, body, **kwargs)

Update a note of a(n) container.

Update a note of a(n) container This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
note_id (str) – (required)
body (NoteInput) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

int

rename_container_tag(cid, value, body, **kwargs)

Rename a tag.

Rename a tag This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
value (str) – The tag to interact with (required)
body (Tag) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

str

upload_file_to_container(container_id, file, **kwargs)

Upload a file to a(n) container.

Upload a file to a(n) container. This method makes a synchronous HTTP request by default.

Parameters:

container_id (str) – (required)
file (str) – The file to upload (required)
preserve_metadata (bool)
ticket (str)
id (str)
level (ContainerType)
job (str)
metadata (str) – Metadata object as a JSON-encoded string
x_accept_feature (list[str]) – redirect header
content_type (str)
async_ (bool) – Perform the request asynchronously

Returns:

union[list[FileOutput],UploadTicketOutput]

upload_output_to_container_analysis(cid, analysis_id, file, **kwargs)

Upload an output file to an analysis.

Upload an output file to an analysis This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
analysis_id (str) – (required)
file (str) – The file to upload (required)
ticket (str)
id (str)
level (ContainerType)
job (str)
content_type (str)
async_ (bool) – Perform the request asynchronously

Returns:

list[FileOutput]

flywheel.api.data_view_executions_api module

Flywheel

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501

OpenAPI spec version: 0.0.1

Generated by: https://github.com/swagger-api/swagger-codegen.git

class flywheel.api.data_view_executions_api.DataViewExecutionsApi(api_client=None)

Bases: object

delete_view_execution(data_view_execution_id, **kwargs)

Delete a data_view_execution

This method makes a synchronous HTTP request by default.

Parameters:

data_view_execution_id (str) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

DeletedResult

get_all_data_view_executions(**kwargs)

Get a list of data_view_executions

This method makes a synchronous HTTP request by default.

Parameters:

exhaustive (bool) – Set to return a complete list regardless of permissions
filter (str) – The filter to apply. (e.g. label=my-label,created>2018-09-22)
sort (str) – The sort fields and order. (e.g. label:asc,created:desc)
limit (int) – The maximum number of entries to return.
skip (int) – The number of entries to skip.
page (int) – The page number (i.e. skip limit*page entries)
after_id (str) – Paginate after the given id. (Cannot be used with sort, page or skip)
x_accept_feature (list[str])
async_ (bool) – Perform the request asynchronously

Returns:

union[Page,list[DataViewExecution]]

get_data_view_execution(data_view_execution_id, **kwargs)

Get a single data_view_execution

This method makes a synchronous HTTP request by default.

Parameters:

data_view_execution_id (str) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

DataViewExecution

get_data_view_execution_data(data_view_execution_id, **kwargs)

Get the data from a data_view_execution

This method makes a synchronous HTTP request by default.

Parameters:

data_view_execution_id (str) – (required)
ticket (str) – download ticket id
file_format (FileFormat)
file_name (str) – download ticket filename
async_ (bool) – Perform the request asynchronously

Returns:

None

save_data_view_execution(data_view_execution_id, **kwargs)

Save a data_view_execution to a project

This method makes a synchronous HTTP request by default.

Parameters:

data_view_execution_id (str) – (required)
file_format (FileFormat)
async_ (bool) – Perform the request asynchronously

Returns:

File

flywheel.api.dataexplorer_api module

Flywheel

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501

OpenAPI spec version: 0.0.1

Generated by: https://github.com/swagger-api/swagger-codegen.git

class flywheel.api.dataexplorer_api.DataexplorerApi(api_client=None)

Bases: object

delete_save_search(search_id, **kwargs)

Delete a saved search

This method makes a synchronous HTTP request by default.

Parameters:

search_id (str) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

DeletedResult

get_all_saved_searches(**kwargs)

Get Queries

This method makes a synchronous HTTP request by default.

Parameters:

exhaustive (bool) – Return all queries, Admin only
filter (str) – The filter to apply. (e.g. label=my-label,created>2018-09-22)
sort (str) – The sort fields and order. (e.g. label:asc,created:desc)
limit (int) – The maximum number of entries to return.
skip (int) – The number of entries to skip.
page (int) – The page number (i.e. skip limit*page entries)
after_id (str) – Paginate after the given id. (Cannot be used with sort, page or skip)
x_accept_feature (list[str])
async_ (bool) – Perform the request asynchronously

Returns:

union[list[SaveSearchOutput],SaveSearchPage]

get_saved_search(sid, **kwargs)

Return a saved search query

This method makes a synchronous HTTP request by default.

Parameters:

sid (str) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

SaveSearch

get_search_query_suggestions(body, **kwargs)

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”. This method makes a synchronous HTTP request by default.

Parameters:

body (StructuredQuery) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

StructuredQuerySuggestions

get_search_status(**kwargs)

Get the status of search (Mongo Connector)

This method makes a synchronous HTTP request by default.

Parameters:: async_ (bool) – Perform the request asynchronously
Returns:: SearchStatus

parse_search_query(body, **kwargs)

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. This method makes a synchronous HTTP request by default.

Parameters:

body (StructuredQuery) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

ParsedQueryResponse

replace_search(sid, body, **kwargs)

Replace a search query

This method makes a synchronous HTTP request by default.

Parameters:

sid (str) – (required)
body (SaveSearchUpdate) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

SaveSearch

save_search(body, **kwargs)

Save a search query

This method makes a synchronous HTTP request by default.

Parameters:

body (SaveSearchInput) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

InsertedId

search(body, **kwargs)

Perform a search query

This method makes a synchronous HTTP request by default.

Parameters:

body (SearchQuery) – (required)
simple (bool) – Unwrap result documents into a list.
size (int) – The maximum number of results to return.
facets (bool) – Include additional statistics about the search results. Internal use only.
csv (bool) – Format the response as a CSV file
async_ (bool) – Perform the request asynchronously

Returns:

union[list[SearchResponse],object]

flywheel.api.devices_api module

Flywheel

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501

OpenAPI spec version: 0.0.1

Generated by: https://github.com/swagger-api/swagger-codegen.git

class flywheel.api.devices_api.DevicesApi(api_client=None)

Bases: object

create_device(body, **kwargs)

Create a new device.

Will create a new device record together with an api key. Request must be an admin request. This method makes a synchronous HTTP request by default.

Parameters:

body (DeviceCreate) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

EgressDevice

delete_device(device_id, **kwargs)

Delete a device

Delete a device This method makes a synchronous HTTP request by default.

Parameters:

device_id (str) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

None

delete_device_key(device_id, key_id, **kwargs)

Delete Device Key

This method makes a synchronous HTTP request by default.

Parameters:

device_id (str) – (required)
key_id (str) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

None

get_all_devices(**kwargs)

List all devices.

Requires login. This method makes a synchronous HTTP request by default.

Parameters:

join_keys (bool) – Return device key. Admins only
filter (str) – The filter to apply. (e.g. label=my-label,created>2018-09-22)
sort (str) – The sort fields and order. (e.g. label:asc,created:desc)
limit (int) – The maximum number of entries to return.
skip (int) – The number of entries to skip.
page (int) – The page number (i.e. skip limit*page entries)
after_id (str) – Paginate after the given id. (Cannot be used with sort, page or skip)
x_accept_feature (list[str])
async_ (bool) – Perform the request asynchronously

Returns:

union[list[EgressDevice],EgressDevicePage]

get_all_devices_status(**kwargs)

Get status for all known devices.

ok - missing - error - unknown This method makes a synchronous HTTP request by default.

Parameters:: async_ (bool) – Perform the request asynchronously
Returns:: dict(str, DeviceStatusEntry)

get_current_device(**kwargs)

Get current device.

Get current device. This method makes a synchronous HTTP request by default.

Parameters:: async_ (bool) – Perform the request asynchronously
Returns:: EgressDevice

get_device(device_id, **kwargs)

Get device details

This method makes a synchronous HTTP request by default.

Parameters:

device_id (str) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

EgressDevice

modify_device(device_id, body, **kwargs)

Update a device

Update a device This method makes a synchronous HTTP request by default.

Parameters:

device_id (str) – (required)
body (DeviceAdminUpdate) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

EgressDevice

regenerate_key(device_id, **kwargs)

Regenerate device API key

Regenerate device API key This method makes a synchronous HTTP request by default.

Parameters:

device_id (str) – (required)
body (ApiKeyInputWithOptionalLabel)
async_ (bool) – Perform the request asynchronously

Returns:

object

update_device(body, **kwargs)

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. This method makes a synchronous HTTP request by default.

Parameters:

body (DeviceSelfUpdate) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

EgressDevice

flywheel.api.dimse_api module

Flywheel

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501

OpenAPI spec version: 0.0.1

Generated by: https://github.com/swagger-api/swagger-codegen.git

class flywheel.api.dimse_api.DimseApi(api_client=None)

Bases: object

create_project_aet(body, **kwargs)

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. This method makes a synchronous HTTP request by default.

Parameters:

body (ProjectAETInput) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

BaseAET

create_service_aet(body, **kwargs)

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. This method makes a synchronous HTTP request by default.

Parameters:

body (union[ProjectAETInput,ServiceAETInput]) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

ServiceAET

delete_project_aet(project_aet, **kwargs)

Delete a DIMSE project AET

Delete DIMSE project by AET. AETs can only be deleted by admins. This method makes a synchronous HTTP request by default.

Parameters:

project_aet (str) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

dict(str, int)

delete_service_aet(service_aet, **kwargs)

Delete a DIMSE service AET

Delete DIMSE service by AET. AETs can only be deleted by admins. This method makes a synchronous HTTP request by default.

Parameters:

service_aet (str) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

dict(str, int)

get_all_project_aets(**kwargs)

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. This method makes a synchronous HTTP request by default.

Parameters:: async_ (bool) – Perform the request asynchronously
Returns:: list[ProjectAET]

get_all_service_aets(**kwargs)

List all DIMSE services AETs

Will list all DIMSE AETs referring to external DICOM nodes. Requires login and admin privilege. This method makes a synchronous HTTP request by default.

Parameters:: async_ (bool) – Perform the request asynchronously
Returns:: list[ServiceAET]

get_project_aet(project_aet, **kwargs)

Get DIMSE project AET

Get DIMSE project by AET, id or project id. Requires admin privilege. This method makes a synchronous HTTP request by default.

Parameters:

project_aet (str) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

ProjectAET

get_service_aet(service_aet, **kwargs)

Get DIMSE service by AET or id

Get a DIMSE service. Requires login and admin privilege. This method makes a synchronous HTTP request by default.

Parameters:

service_aet (str) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

ServiceAET

flywheel.api.download_api module

Flywheel

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501

OpenAPI spec version: 0.0.1

Generated by: https://github.com/swagger-api/swagger-codegen.git

class flywheel.api.download_api.DownloadApi(api_client=None)

Bases: object

create_download_ticket(body, **kwargs)

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. This method makes a synchronous HTTP request by default.

Parameters:

body (DownloadInput) – Specification for the download to be performed (required)
type (DownloadStrategy) – The download type, one of: bulk, classic or full. Default is classic.
bulk (bool)
metadata (bool) – For “full” download, whether or not to include metadata sidecars. Default is false.
analyses (bool) – For “full” download, whether or not to include analyses. Default is false.
prefix (str) – A string to customize the name of the download in the format <prefix>_<timestamp>.tar. Defaults to “scitran”.
async_ (bool) – Perform the request asynchronously

Returns:

DownloadTicketStub

download_ticket(ticket, dest_file, **kwargs)

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 This method makes a synchronous HTTP request by default.

Parameters:

ticket (str) – ID of the download ticket (required)
format (DownloadFormat)
dest_file (str) – Destination file path
async_ (bool) – Perform the request asynchronously

Returns:

None

flywheel.api.files_api module

Flywheel

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501

OpenAPI spec version: 0.0.1

Generated by: https://github.com/swagger-api/swagger-codegen.git

class flywheel.api.files_api.FilesApi(api_client=None)

Bases: object

add_file_tags(file_id, body, **kwargs)

Add list of tags on a file.

Add the tags on a file to the list of tags This method makes a synchronous HTTP request by default.

Parameters:

file_id (str) – (required)
body (list[str]) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

list[str]

delete_file(file_id, **kwargs)

Delete a File

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

Parameters:

file_id (str) – (required)
version (int) – Version of the file to delete (defaults to current version)
delete_reason (ContainerDeleteReason) – A reason for deletion when audit-trail is enabled
force (bool) – Force deletion of the file even if some checks fail. Deprecated, will be removed in a future release.
async_ (bool) – Perform the request asynchronously

Returns:

DeletedResult

delete_file_tags(file_id, **kwargs)

Remove the specified tags from most recent file version

Remove the specified tags from most recent file version This method makes a synchronous HTTP request by default.

Parameters:

file_id (str) – (required)
body (list[str]) – List of application-specific tags
async_ (bool) – Perform the request asynchronously

Returns:

None

delete_files_by_ids(body, **kwargs)

Delete multiple files by ID list

Delete multiple files by ID list This method makes a synchronous HTTP request by default.

Parameters:

body (list[str]) – List of IDs to delete (required)
delete_reason (ContainerDeleteReason)
async_ (bool) – Perform the request asynchronously

Returns:

DeletedResult

delete_files_by_query(body, **kwargs)

Delete multiple files by query

Delete multiple files by query This method makes a synchronous HTTP request by default.

Parameters:

body (list[Filter]) – Query for containers to delete (required)
delete_reason (ContainerDeleteReason)
async_ (bool) – Perform the request asynchronously

Returns:

DeletedResult

get_all_files(**kwargs)

Return all files

Get metadata of all current user files This method makes a synchronous HTTP request by default.

Parameters:

filter (str) – The filter to apply. (e.g. label=my-label,created>2018-09-22)
sort (str) – The sort fields and order. (e.g. label:asc,created:desc)
limit (int) – The maximum number of entries to return.
skip (int) – The number of entries to skip.
page (int) – The page number (i.e. skip limit*page entries)
after_id (str) – Paginate after the given id. (Cannot be used with sort, page or skip)
async_ (bool) – Perform the request asynchronously

Returns:

PageGenericFileOutput

get_file(file_id, **kwargs)

Get File

Get file details This method makes a synchronous HTTP request by default.

Parameters:

file_id (str) – (required)
version (int)
async_ (bool) – Perform the request asynchronously

Returns:

FileOutput

get_file_tags(file_id, **kwargs)

Return a file tags, from any version

Return a file tags, from any version This method makes a synchronous HTTP request by default.

Parameters:

file_id (str) – (required)
version (int)
async_ (bool) – Perform the request asynchronously

Returns:

list[str]

get_file_versions(file_id, **kwargs)

Get Versions

Get file version details This method makes a synchronous HTTP request by default.

Parameters:

file_id (str) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

list[FileVersionOutput]

get_file_zip_info(file_id, **kwargs)

Get Zip Info

Get info on zipfile This method makes a synchronous HTTP request by default.

Parameters:

file_id (str) – (required)
version (int)
ticket (str)
async_ (bool) – Perform the request asynchronously

Returns:

ZipfileInfo

move_file(file_id, body, **kwargs)

Move and/or rename a file

Move a file to a new container and/or give it a new name This method makes a synchronous HTTP request by default.

Parameters:

file_id (str) – (required)
body (FileMoveInput) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

ModifiedResult

restore_file(file_id, version, evaluate_gear_rules, **kwargs)

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. This method makes a synchronous HTTP request by default.

Parameters:

file_id (str) – (required)
version (int) – (required)
evaluate_gear_rules (bool) – Specify if gear rules should be reevaluated on the newly created file version (required)
async_ (bool) – Perform the request asynchronously

Returns:

FileOutput

set_file_tags(file_id, body, **kwargs)

Set list of tags on a file.

Set the tags on a file to the list of tags provided This method makes a synchronous HTTP request by default.

Parameters:

file_id (str) – (required)
body (list[str]) – List of application-specific tags (required)
async_ (bool) – Perform the request asynchronously

Returns:

ModifiedResult

upsert_file(body, **kwargs)

Upsert a File

Create or update a file This method makes a synchronous HTTP request by default.

Parameters:

body (FileUpsertInput) – (required)
force_update (bool)
async_ (bool) – Perform the request asynchronously

Returns:

FileUpsertOutput

flywheel.api.gears_api module

Flywheel

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501

OpenAPI spec version: 0.0.1

Generated by: https://github.com/swagger-api/swagger-codegen.git

class flywheel.api.gears_api.GearsApi(api_client=None)

Bases: object

add_gear(gear_name, body, **kwargs)

Create or update a gear.

If no existing gear is found, one will be created Otherwise, the specified gear will be updated This method makes a synchronous HTTP request by default.

Parameters:

gear_name (str) – Name of the gear to interact with (required)
body (GearDocumentLegacyInput) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

GearIdOutput

add_gear_permission(gear_name, permission_type, body, **kwargs)

Add an individual permission to the given gear

This method makes a synchronous HTTP request by default.

Parameters:

gear_name (str) – Name of the gear to interact with (required)
permission_type (GearPermissionsType) – (required)
body (GearPermissionsInput) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

GearSeries

delete_gear(gear_id, **kwargs)

Delete a gear (not recommended)

This method makes a synchronous HTTP request by default.

Parameters:

gear_id (str) – Id of the gear to interact with (required)
async_ (bool) – Perform the request asynchronously

Returns:

None

delete_gear_permission(gear_name, permission_type, permission_id, **kwargs)

Delete an individual permission of the given gear

This method makes a synchronous HTTP request by default.

Parameters:

gear_name (str) – (required)
permission_type (GearPermissionsType) – (required)
permission_id (str) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

None

delete_gear_permissions(gear_name, **kwargs)

Delete permissions of the given gear

This method makes a synchronous HTTP request by default.

Parameters:

gear_name (str) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

None

get_all_gears(**kwargs)

List all gears

List all gears This method makes a synchronous HTTP request by default.

Parameters:

project_id (str)
all_versions (bool) – return all versions of each gear
include_invalid (bool) – return gears with the ‘invalid’ flag set
filter (str) – The filter to apply. (e.g. label=my-label,created>2018-09-22)
sort (str) – The sort fields and order. (e.g. label:asc,created:desc)
limit (int) – The maximum number of entries to return.
skip (int) – The number of entries to skip.
page (int) – The page number (i.e. skip limit*page entries)
after_id (str) – Paginate after the given id. (Cannot be used with sort, page or skip)
exhaustive (bool) – Set to return a complete list regardless of permissions
x_accept_feature (list[union[HeaderFeature,str]])
async_ (bool) – Perform the request asynchronously

Returns:

union[list[GearDocument],Page]

get_gear(gear_id, **kwargs)

Retrieve details about a specific gear

Retrieve details about a specific gear This method makes a synchronous HTTP request by default.

Parameters:

gear_id (str) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

GearDocument

get_gear_context(gear_id, container_name, container_id, **kwargs)

Get context values for the given gear and container.

Ref: https://github.com/flywheel-io/gears/tree/master/spec#contextual-values This method makes a synchronous HTTP request by default.

Parameters:

gear_id (str) – (required)
container_name (str) – (required)
container_id (str) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

dict(str, union[GearContextValueOutput,GearContextValueOutputUnfound])

get_gear_invocation(gear_id, **kwargs)

Get a schema for invoking a gear

Get a schema for invoking a gear. This method makes a synchronous HTTP request by default.

Parameters:

gear_id (str) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

object

get_gear_series(gear_name, **kwargs)

Get gear series.

Gets the series for the gear by its name This method makes a synchronous HTTP request by default.

Parameters:

gear_name (str) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

GearSeries

get_gear_suggest(gear_id, container_name, container_id, **kwargs)

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

This method makes a synchronous HTTP request by default.

Parameters:

gear_id (str) – Id of the gear to interact with (required)
container_name (str) – Type of the container to interact with (required)
container_id (str) – Id of the container to interact with (required)
filter (str)
sort (str)
limit (int)
skip (int)
page (int)
include (list[str]) – Include only “children” or “files”
collection (str) – Get suggestions for a collection
async_ (bool) – Perform the request asynchronously

Returns:

GearSuggestionOutput

get_gear_ticket(ticket_id, **kwargs)

Retrieve a specific gear ticket

This method makes a synchronous HTTP request by default.

Parameters:

ticket_id (str) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

GearTicket

get_my_gear_tickets(**kwargs)

Retrieve all gear tickets for the current user

This method makes a synchronous HTTP request by default.

Parameters:: async_ (bool) – Perform the request asynchronously
Returns:: list[str]

modify_gear_series(gear_name, body, **kwargs)

Update a gear series

This method makes a synchronous HTTP request by default.

Parameters:

gear_name (str) – Name of the gear series to modify (required)
body (GearSeriesUpdate) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

GearSeries

prepare_add_gear(body, **kwargs)

Prepare a gear upload

Prepare a gear upload This method makes a synchronous HTTP request by default.

Parameters:

body (GearDocumentInput) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

GearTicketOutput

replace_gear_permissions(gear_name, body, **kwargs)

Replace permissions for the given gear

This method makes a synchronous HTTP request by default.

Parameters:

gear_name (str) – Name of the gear to interact with (required)
body (GearPermissions) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

GearSeries

save_gear(body, **kwargs)

Report the result of a gear upload and save the ticket

Report the result of a gear upload and save the ticket This method makes a synchronous HTTP request by default.

Parameters:

body (GearSaveSubmission) – The ticket, repo and pointer (required)
async_ (bool) – Perform the request asynchronously

Returns:

GearDocument

flywheel.api.groups_api module

Flywheel

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501

OpenAPI spec version: 0.0.1

Generated by: https://github.com/swagger-api/swagger-codegen.git

class flywheel.api.groups_api.GroupsApi(api_client=None)

Bases: object

add_group(body, **kwargs)

Add a group

Create a new group. This method makes a synchronous HTTP request by default.

Parameters:

body (GroupInput) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

InsertedId

add_group_permission(group_id, body, **kwargs)

Add a permission

Adds permission to the group Args: group_id: the id of the group permission: The access permission auth_session: The auth session of the user Returns AccessPermissionOutput: The added permission This method makes a synchronous HTTP request by default.

Parameters:

group_id (str) – (required)
body (AccessPermission) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

AccessPermissionOutput

add_group_permission_template(group_id, body, **kwargs)

Add a permission template

Add a permission template This method makes a synchronous HTTP request by default.

Parameters:

group_id (str) – (required)
body (RolePermission) – (required)
propagate (bool)
x_accept_feature (list[union[HeaderFeature,str]])
async_ (bool) – Perform the request asynchronously

Returns:

RolePermissionOutput

add_group_tag(cid, body, **kwargs)

Add a tag to a(n) group.

Propagates changes to projects, sessions and acquisitions This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
body (Tag) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

ModifiedResult

add_group_tags(cid, body, **kwargs)

Add multiple tags to a(n) group

Add multiple tags to a(n) group This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
body (list[str]) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

None

add_role_to_group(group_id, body, **kwargs)

Add a role to the pool of roles in a group

Add a group role. This method makes a synchronous HTTP request by default.

Parameters:

group_id (str) – (required)
body (GroupRole) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

RoleOutput

delete_group(group_id, **kwargs)

Delete group

Delete a group. This method makes a synchronous HTTP request by default.

Parameters:

group_id (str) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

DeletedResult

delete_group_tag(cid, value, **kwargs)

Delete a tag

Delete a tag This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
value (str) – The tag to interact with (required)
async_ (bool) – Perform the request asynchronously

Returns:

DeletedResult

delete_group_tags(cid, body, **kwargs)

Delete multiple tags from a(n) group

Delete multiple tags from a(n) group This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
body (list[str]) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

None

delete_group_user_permission(group_id, user_id, **kwargs)

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 This method makes a synchronous HTTP request by default.

Parameters:

group_id (str) – (required)
user_id (str) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

ModifiedResult

delete_group_user_permission_template(group_id, user_id, **kwargs)

Delete a permission

Delete a permission This method makes a synchronous HTTP request by default.

Parameters:

group_id (str) – (required)
user_id (str) – (required)
propagate (bool)
x_accept_feature (list[union[HeaderFeature,str]])
async_ (bool) – Perform the request asynchronously

Returns:

ModifiedResult

delete_groups_by_ids(body, **kwargs)

Delete multiple groups by ID list

Delete multiple groups by ID list This method makes a synchronous HTTP request by default.

Parameters:

body (list[str]) – List of IDs to delete (required)
delete_reason (ContainerDeleteReason)
async_ (bool) – Perform the request asynchronously

Returns:

DeletedResult

delete_groups_by_query(body, **kwargs)

Delete multiple groups by query

Delete multiple groups by query This method makes a synchronous HTTP request by default.

Parameters:

body (list[Filter]) – Query for containers to delete (required)
delete_reason (ContainerDeleteReason)
async_ (bool) – Perform the request asynchronously

Returns:

DeletedResult

get_all_group_roles(group_id, **kwargs)

Get list of group roles

Gets all group roles This method makes a synchronous HTTP request by default.

Parameters:

group_id (str) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

list[RoleOutput]

get_all_groups(**kwargs)

List all groups

Find all groups. This method makes a synchronous HTTP request by default.

Parameters:

exhaustive (bool) – Set to return a complete list regardless of permissions
filter (str) – The filter to apply. (e.g. label=my-label,created>2018-09-22)
sort (str) – The sort fields and order. (e.g. label:asc,created:desc)
limit (int) – The maximum number of entries to return.
skip (int) – The number of entries to skip.
page (int) – The page number (i.e. skip limit*page entries)
after_id (str) – Paginate after the given id. (Cannot be used with sort, page or skip)
x_accept_feature (list[union[HeaderFeature,str]])
async_ (bool) – Perform the request asynchronously

Returns:

union[Page,list[GroupOutput]]

get_group(group_id, **kwargs)

Get group info

Get a group by ID. This method makes a synchronous HTTP request by default.

Parameters:

group_id (str) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

GroupOutput

get_group_projects(group_id, **kwargs)

Get all projects in a group

Get projects for a group This method makes a synchronous HTTP request by default.

Parameters:

group_id (str) – (required)
exhaustive (bool)
include_all_info (bool) – Include all info in returned objects
filter (str) – The filter to apply. (e.g. label=my-label,created>2018-09-22)
sort (str) – The sort fields and order. (e.g. label:asc,created:desc)
limit (int) – The maximum number of entries to return.
skip (int) – The number of entries to skip.
page (int) – The page number (i.e. skip limit*page entries)
after_id (str) – Paginate after the given id. (Cannot be used with sort, page or skip)
x_accept_feature (list[str])
async_ (bool) – Perform the request asynchronously

Returns:

union[Page,list[ProjectListOutput]]

get_group_role(group_id, role_id, **kwargs)

Return the role identified by the RoleId

Get a group role. This method makes a synchronous HTTP request by default.

Parameters:

group_id (str) – (required)
role_id (str) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

RoleOutput

get_group_tag(cid, value, **kwargs)

Get the value of a tag, by name.

Get the value of a tag, by name This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
value (str) – The tag to interact with (required)
async_ (bool) – Perform the request asynchronously

Returns:

str

get_group_user_permission(group_id, user_id, **kwargs)

List a user's permissions for this group.

List a user’s permissions for this group This method makes a synchronous HTTP request by default.

Parameters:

group_id (str) – (required)
user_id (str) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

AccessPermissionOutput

get_group_user_permission_template(group_id, user_id, **kwargs)

List a user's permissions for this group.

List a user’s permissions for this group. This method makes a synchronous HTTP request by default.

Parameters:

group_id (str) – (required)
user_id (str) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

RolePermissionOutput

modify_group(group_id, body, **kwargs)

Update group

Modify a group. This method makes a synchronous HTTP request by default.

Parameters:

group_id (str) – (required)
body (GroupUpdate) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

ModifiedResult

modify_group_user_permission(group_id, user_id, body, **kwargs)

Update a user's permission for this group.

Update a user’s permission for this group. This method makes a synchronous HTTP request by default.

Parameters:

group_id (str) – (required)
user_id (str) – (required)
body (AccessPermissionUpdate) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

AccessPermissionOutput

modify_group_user_permission_template(group_id, user_id, body, **kwargs)

Update a user's permission for this group.

Update a user’s permission for this group. This method makes a synchronous HTTP request by default.

Parameters:

group_id (str) – (required)
user_id (str) – (required)
body (RolePermissionUpdate) – (required)
propagate (bool)
x_accept_feature (list[union[HeaderFeature,str]])
async_ (bool) – Perform the request asynchronously

Returns:

RolePermissionOutput

remove_role_from_group(group_id, role_id, **kwargs)

Remove the role from the group

Delete a group role. This method makes a synchronous HTTP request by default.

Parameters:

group_id (str) – (required)
role_id (str) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

None

rename_group_tag(cid, value, body, **kwargs)

Rename a tag.

Rename a tag This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
value (str) – The tag to interact with (required)
body (Tag) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

str

flywheel.api.jobs_api module

Flywheel

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501

OpenAPI spec version: 0.0.1

Generated by: https://github.com/swagger-api/swagger-codegen.git

class flywheel.api.jobs_api.JobsApi(api_client=None)

Bases: object

add_job(body, **kwargs)

Add a job

Add a job This method makes a synchronous HTTP request by default.

Parameters:

body (InputJob) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

InsertedId

add_job_logs(job_id, body, **kwargs)

Add logs to a job.

This method makes a synchronous HTTP request by default.

Parameters:

job_id (str) – (required)
body (list[JobLog]) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

None

ask_jobs(body, **kwargs)

Ask the queue a question

Ask the queue a question, receiving work or statistics in return. This method makes a synchronous HTTP request by default.

Parameters:

body (JobAsk) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

JobAskResponse

ask_jobs_state(job_state, body, **kwargs)

Ask job count by state

Ask the queue for the number of jobs for a given state and query. This method makes a synchronous HTTP request by default.

Parameters:

job_state (JobState) – (required)
body (JobAsk) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

JobAskStateResponse

complete_job(job_id, body, **kwargs)

Complete a job, with information

This method makes a synchronous HTTP request by default.

Parameters:

job_id (str) – (required)
body (JobComplete) – (required)
job_ticket_id (str) – ticket id for job completion
async_ (bool) – Perform the request asynchronously

Returns:

None

determine_provider_for_job(body, **kwargs)

Determine the effective compute provider for a proposed job.

This method makes a synchronous HTTP request by default.

Parameters:

body (InputJob) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

Provider

get_all_jobs(**kwargs)

Return all jobs

This method makes a synchronous HTTP request by default.

Parameters:

include_parent_info (bool) – Include the parent info for the jobs
include_all_info (bool) – Include all info in returned objects
filter (str) – The filter to apply. (e.g. label=my-label,created>2018-09-22)
sort (str) – The sort fields and order. (e.g. label:asc,created:desc)
limit (int) – The maximum number of entries to return.
skip (int) – The number of entries to skip.
page (int) – The page number (i.e. skip limit*page entries)
after_id (str) – Paginate after the given id. (Cannot be used with sort, page or skip)
x_accept_feature (list[str])
async_ (bool) – Perform the request asynchronously

Returns:

union[list[JobListOutput],Page]

get_job(job_id, **kwargs)

Get job details

This method makes a synchronous HTTP request by default.

Parameters:

job_id (str) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

JobOutput

get_job_config(job_id, **kwargs)

Get a job's config

This method makes a synchronous HTTP request by default.

Parameters:

job_id (str) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

JobOutputConfig

get_job_detail(job_id, **kwargs)

Get job container details

This method makes a synchronous HTTP request by default.

Parameters:

job_id (str) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

JobDetail

get_job_logs(job_id, **kwargs)

Get job logs

This method makes a synchronous HTTP request by default.

Parameters:

job_id (str) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

JobLogRecord

get_jobs_stats(**kwargs)

Get stats about all current jobs

This method makes a synchronous HTTP request by default.

Parameters:: async_ (bool) – Perform the request asynchronously
Returns:: object

get_next_job(**kwargs)

Get the next job in the queue

Used by the engine. This method makes a synchronous HTTP request by default.

Parameters:

tags (list[str])
tags
async_ (bool) – Perform the request asynchronously

Returns:

Job

modify_job(job_id, body, **kwargs)

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. This method makes a synchronous HTTP request by default.

Parameters:

job_id (str) – (required)
body (JobModify) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

ModifiedResult

prepare_complete_job(job_id, **kwargs)

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

This method makes a synchronous HTTP request by default.

Parameters:

job_id (str) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

JobTicketOutput

reap_jobs(**kwargs)

Reap stale jobs

This method makes a synchronous HTTP request by default.

Parameters:: async_ (bool) – Perform the request asynchronously
Returns:: OrphanedCount

retry_job(job_id, **kwargs)

Retry a job.

The job must have a state of ‘failed’, and must not have already been retried. The failed jobs config is copied to a new job. The ID of the new job is returned. This method makes a synchronous HTTP request by default.

Parameters:

job_id (str) – (required)
compute_provider_id (str)
ignore_state (bool)
async_ (bool) – Perform the request asynchronously

Returns:

InsertedId

update_job_profile(job_id, body, **kwargs)

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

Update profile information on a job. (e.g. machine type, etc) This method makes a synchronous HTTP request by default.

Parameters:

job_id (str) – (required)
body (InputJobProfile) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

ModifiedResult

update_jobs_priority(body, **kwargs)

Update a job priority.

This method makes a synchronous HTTP request by default.

Parameters:

body (JobPriorityUpdate) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

ModifiedResult

flywheel.api.jupyterlab_servers_api module

Flywheel

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501

OpenAPI spec version: 0.0.1

Generated by: https://github.com/swagger-api/swagger-codegen.git

class flywheel.api.jupyterlab_servers_api.JupyterlabServersApi(api_client=None)

Bases: object

get_jupyterlab_server(jupyterlab_server_id, **kwargs)

Get jupyterlab server

Get jupyterlab server This method makes a synchronous HTTP request by default.

Parameters:

jupyterlab_server_id (str) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

JupyterlabServerResponse

modify_jupyterlab_server(jupyterlab_server_id, body, **kwargs)

Update a jupyterlab server

Update a jupyterlab server This method makes a synchronous HTTP request by default.

Parameters:

jupyterlab_server_id (str) – (required)
body (JupyterlabServerModify) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

ModifiedResult

flywheel.api.modalities_api module

Flywheel

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501

OpenAPI spec version: 0.0.1

Generated by: https://github.com/swagger-api/swagger-codegen.git

class flywheel.api.modalities_api.ModalitiesApi(api_client=None)

Bases: object

add_modality(body, **kwargs)

Create a new modality.

handlers.modalityhandler.ModalityHandler.post This method makes a synchronous HTTP request by default.

Parameters:

body (ModalityInput) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

InsertedId

delete_modality(modality_id, **kwargs)

Delete a modality

This method makes a synchronous HTTP request by default.

Parameters:

modality_id (str) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

DeletedResult

get_all_modalities(**kwargs)

List all modalities.

Requires login. This method makes a synchronous HTTP request by default.

Parameters:

filter (str) – The filter to apply. (e.g. label=my-label,created>2018-09-22)
sort (str) – The sort fields and order. (e.g. label:asc,created:desc)
limit (int) – The maximum number of entries to return.
skip (int) – The number of entries to skip.
page (int) – The page number (i.e. skip limit*page entries)
after_id (str) – Paginate after the given id. (Cannot be used with sort, page or skip)
x_accept_feature (list[str])
async_ (bool) – Perform the request asynchronously

Returns:

union[list[ModalityOutput],Page]

get_modality(modality_id, **kwargs)

Get a modality's classification specification

This method makes a synchronous HTTP request by default.

Parameters:

modality_id (str) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

ModalityOutput

replace_modality(modality_id, body, **kwargs)

Replace modality

This method makes a synchronous HTTP request by default.

Parameters:

modality_id (str) – (required)
body (ModalityModify) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

ModalityOutput

flywheel.api.packfiles_api module

Flywheel

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501

OpenAPI spec version: 0.0.1

Generated by: https://github.com/swagger-api/swagger-codegen.git

class flywheel.api.packfiles_api.PackfilesApi(api_client=None)

Bases: object

clean_packfiles(**kwargs)

Clean up expired upload tokens and invalid token directories.

Clean up expired upload tokens and invalid token directories. This method makes a synchronous HTTP request by default.

Parameters:: async_ (bool) – Perform the request asynchronously
Returns:: PackfileCleanupOutput

flywheel.api.projects_api module

Flywheel

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501

OpenAPI spec version: 0.0.1

Generated by: https://github.com/swagger-api/swagger-codegen.git

class flywheel.api.projects_api.ProjectsApi(api_client=None)

Bases: object

add_project(body, **kwargs)

Create a new project

This method makes a synchronous HTTP request by default.

Parameters:

body (ProjectInput) – (required)
inherit (bool) – Inherit permissions from the group permission template
async_ (bool) – Perform the request asynchronously

Returns:

InsertedId

add_project_analysis(cid, body, **kwargs)

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. This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
body (union[AdhocAnalysisInput,JobAnalysisInput]) – (required)
job (bool) – returns job_id instead of analysis.id
job – returns job_id instead of analysis.id
async_ (bool) – Perform the request asynchronously

Returns:

InsertedId

add_project_analysis_note(container_id, analysis_id, body, **kwargs)

Add a note to a(n) project analysis.

Add a note to a(n) project analysis. This method makes a synchronous HTTP request by default.

Parameters:

container_id (str) – 24-char hex id (required)
analysis_id (str) – 24-char hex analysis id (required)
body (NoteInput) – note content (required)
async_ (bool) – Perform the request asynchronously

Returns:

Note

add_project_note(container_id, body, **kwargs)

Add a note to a(n) project.

Add a note to a(n) project. This method makes a synchronous HTTP request by default.

Parameters:

container_id (str) – (required)
body (NoteInput) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

Note

add_project_permission(project_id, body, **kwargs)

Add a permission

Add user to a project Args: project_id: The id of the project permission: The permission to add auth_session: The auth session Returns: RolePermissionOutput: The added permission This method makes a synchronous HTTP request by default.

Parameters:

project_id (str) – (required)
body (RolePermission) – (required)
x_accept_feature (list[union[HeaderFeature,str]])
async_ (bool) – Perform the request asynchronously

Returns:

RolePermissionOutput

add_project_rule(project_id, body, **kwargs)

Create a new rule for a project.

This method makes a synchronous HTTP request by default.

Parameters:

project_id (str) – (required)
body (GearRuleInput) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

GearRuleOutput

add_project_tag(cid, body, **kwargs)

Add a tag to a(n) project.

Propagates changes to projects, sessions and acquisitions This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
body (Tag) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

ModifiedResult

add_project_tags(cid, body, **kwargs)

Add multiple tags to a(n) project

Add multiple tags to a(n) project This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
body (list[str]) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

None

catalog_list(**kwargs)

Catalog List

This method makes a synchronous HTTP request by default.

Parameters:

search_string (str) – Include only results containing the search string
filter (str) – The filter to apply. (e.g. label=my-label,created>2018-09-22)
sort (str) – The sort fields and order. (e.g. label:asc,created:desc)
limit (int) – The maximum number of entries to return.
skip (int) – The number of entries to skip.
page (int) – The page number (i.e. skip limit*page entries)
after_id (str) – Paginate after the given id. (Cannot be used with sort, page or skip)
x_accept_feature (list[union[HeaderFeature,str]])
async_ (bool) – Perform the request asynchronously

Returns:

union[list[CatalogListOutput],Page]

delete_project(project_id, **kwargs)

Delete a project

Only site admins and users with “admin” project permissions may delete a project This method makes a synchronous HTTP request by default.

Parameters:

project_id (str) – (required)
delete_reason (ContainerDeleteReason) – A reason for deletion when audit-trail is enabled
async_ (bool) – Perform the request asynchronously

Returns:

DeletedResult

delete_project_analysis(cid, analysis_id, **kwargs)

Delete an analysis

Delete an analysis for a container. This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
analysis_id (str) – (required)
delete_reason (ContainerDeleteReason) – Provide a reason for the deletion
async_ (bool) – Perform the request asynchronously

Returns:

DeletedResult

delete_project_analysis_note(cid, analysis_id, note_id, **kwargs)

Remove a note from a(n) project analysis.

Remove a note from a(n) project analysis. This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – 24-char hex id (required)
analysis_id (str) – 24-char hex analysis id (required)
note_id (str) – 24-char hex note id (required)
async_ (bool) – Perform the request asynchronously

Returns:

DeletedResult

delete_project_file(cid, filename, **kwargs)

Delete a file

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

Parameters:

cid (str) – (required)
filename (str) – (required)
delete_reason (ContainerDeleteReason) – A reason for deletion when audit-trail is enabled
force (bool) – Force deletion of the file even if some checks fail. Deprecated, will be removed in a future release.
async_ (bool) – Perform the request asynchronously

Returns:

DeletedResult

delete_project_note(cid, note_id, **kwargs)

Remove a note from a(n) project

Remove a note from a(n) project This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
note_id (str) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

DeletedResult

delete_project_tag(cid, value, **kwargs)

Delete a tag

Delete a tag This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
value (str) – The tag to interact with (required)
async_ (bool) – Perform the request asynchronously

Returns:

DeletedResult

delete_project_tags(cid, body, **kwargs)

Delete multiple tags from a(n) project

Delete multiple tags from a(n) project This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
body (list[str]) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

None

delete_project_user_permission(project_id, uid, **kwargs)

Delete a permission

This method makes a synchronous HTTP request by default.

Parameters:

project_id (str) – (required)
uid (str) – (required)
x_accept_feature (list[union[HeaderFeature,str]])
async_ (bool) – Perform the request asynchronously

Returns:

ModifiedResult

delete_projects_by_ids(body, **kwargs)

Delete multiple projects by ID list

Delete multiple projects by ID list This method makes a synchronous HTTP request by default.

Parameters:

body (list[str]) – List of IDs to delete (required)
delete_reason (ContainerDeleteReason)
async_ (bool) – Perform the request asynchronously

Returns:

DeletedResult

delete_projects_by_query(body, **kwargs)

Delete multiple projects by query

Delete multiple projects by query This method makes a synchronous HTTP request by default.

Parameters:

body (list[Filter]) – Query for containers to delete (required)
delete_reason (ContainerDeleteReason)
async_ (bool) – Perform the request asynchronously

Returns:

DeletedResult

download_file_from_project(project_id, file_name, dest_file, **kwargs)

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. This method makes a synchronous HTTP request by default.

Parameters:

project_id (str) – 24-character hex ID (required)
file_name (str) – output file name (required)
info (bool) – If the file is a zipfile, return a json response of zipfile member information
member (str) – The filename of a zipfile member to download rather than the entire file
view (bool) – 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”
version (int) – version of the file to download
hash (str) – file hash for comparison
range (str) – byte ranges to return
x_accept_feature (list[str]) – redirect header
dest_file (str) – Destination file path
async_ (bool) – Perform the request asynchronously

Returns:

union[DownloadTicketStub,ZipfileInfo]

download_input_from_project_analysis(project_id, analysis_id, filename, dest_file, **kwargs)

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. This method makes a synchronous HTTP request by default.

Parameters:

project_id (str) – 24-character hex ID (required)
analysis_id (str) – 24-char hex analysis id (required)
filename (str) – filename to download (get tar of all if empty) (required)
info (bool) – get file info only
member (str) – get zipfile member
view (bool) – feature flag for view/download
range (str) – byte ranges to return
x_accept_feature (list[str]) – redirect header
dest_file (str) – Destination file path
async_ (bool) – Perform the request asynchronously

Returns:

union[DownloadTicketStub,ZipfileInfo]

download_output_from_project_analysis(project_id, analysis_id, filename, dest_file, **kwargs)

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. This method makes a synchronous HTTP request by default.

Parameters:

project_id (str) – 24-character hex ID (required)
analysis_id (str) – 24-char hex analysis id (required)
filename (str) – filename to download (get tar of all if empty) (required)
info (bool) – If the file is a zipfile, return a json response of zipfile member information
member (str) – The filename of a zipfile member to download rather than the entire file
view (bool) – feature flag for view/download
range (str) – byte ranges to return
x_accept_feature (list[str]) – redirect header
dest_file (str) – Destination file path
async_ (bool) – Perform the request asynchronously

Returns:

union[DownloadTicketStub,ZipfileInfo]

end_project_packfile_upload(token, metadata, file_count, project_id, **kwargs)

End a packfile upload

This method makes a synchronous HTTP request by default.

Parameters:

token (str) – (required)
metadata (str) – Metadata object as a JSON-encoded string (required)
file_count (int) – Number of files uploaded into this packfile. (required)
project_id (str) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

None

get_all_projects(**kwargs)

Get a list of projects

This method makes a synchronous HTTP request by default.

Parameters:

counts (bool) – Append the count of subjects in each project
stats (bool) – Return the status of subjects and sessions in each project
join_avatars (bool) – Return the joined avatars of the permissions
join (JoinType)
exhaustive (bool) – Set to return a complete list regardless of permissions
include_all_info (bool) – Include all info in returned objects
filter (str) – The filter to apply. (e.g. label=my-label,created>2018-09-22)
sort (str) – The sort fields and order. (e.g. label:asc,created:desc)
limit (int) – The maximum number of entries to return.
skip (int) – The number of entries to skip.
page (int) – The page number (i.e. skip limit*page entries)
after_id (str) – Paginate after the given id. (Cannot be used with sort, page or skip)
x_accept_feature (list[union[HeaderFeature,str]])
async_ (bool) – Perform the request asynchronously

Returns:

union[list[ProjectListOutput],Page]

get_all_projects_groups(**kwargs)

List all groups which have a project in them

This method makes a synchronous HTTP request by default.

Parameters:

exhaustive (bool) – returns exhaustive list if correct permissions
filter (str) – The filter to apply. (e.g. label=my-label,created>2018-09-22)
sort (str) – The sort fields and order. (e.g. label:asc,created:desc)
limit (int) – The maximum number of entries to return.
skip (int) – The number of entries to skip.
page (int) – The page number (i.e. skip limit*page entries)
after_id (str) – Paginate after the given id. (Cannot be used with sort, page or skip)
x_accept_feature (list[str])
async_ (bool) – Perform the request asynchronously

Returns:

list[GroupOutput]

get_catalog_list_filter_options(**kwargs)

Get all filter options for sharing a project

This method makes a synchronous HTTP request by default.

Parameters:: async_ (bool) – Perform the request asynchronously
Returns:: SharingFilterOptions

get_project(project_id, **kwargs)

Get a single project

This method makes a synchronous HTTP request by default.

Parameters:

project_id (str) – (required)
join (JoinType)
join_avatars (bool) – add name and avatar to notes
x_accept_feature (list[union[HeaderFeature,str]])
async_ (bool) – Perform the request asynchronously

Returns:

ProjectOutput

get_project_acquisitions(project_id, **kwargs)

List all acquisitions for the given project.

This method makes a synchronous HTTP request by default.

Parameters:

project_id (str) – (required)
collection_id (str)
exhaustive (bool)
join (JoinType)
include_all_info (bool) – Include all info in returned objects
filter (str) – The filter to apply. (e.g. label=my-label,created>2018-09-22)
sort (str) – The sort fields and order. (e.g. label:asc,created:desc)
limit (int) – The maximum number of entries to return.
skip (int) – The number of entries to skip.
page (int) – The page number (i.e. skip limit*page entries)
after_id (str) – Paginate after the given id. (Cannot be used with sort, page or skip)
x_accept_feature (list[str])
async_ (bool) – Perform the request asynchronously

Returns:

union[list[AcquisitionListOutput],Page]

get_project_analyses(cid, **kwargs)

Get analyses for a(n) project.

Returns analyses that directly belong to this resource. This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
inflate_job (bool)
join_avatars (bool)
join (JoinType)
include_all_info (bool) – Include all info in returned objects
filter (str) – The filter to apply. (e.g. label=my-label,created>2018-09-22)
sort (str) – The sort fields and order. (e.g. label:asc,created:desc)
limit (int) – The maximum number of entries to return.
skip (int) – The number of entries to skip.
page (int) – The page number (i.e. skip limit*page entries)
after_id (str) – Paginate after the given id. (Cannot be used with sort, page or skip)
x_accept_feature (list[str])
async_ (bool) – Perform the request asynchronously

Returns:

union[Page,list[union[AnalysisListOutput,AnalysisListOutputInflatedJob]]]

get_project_analysis(cid, analysis_id, **kwargs)

Get an analysis.

Get an analysis. This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
analysis_id (str) – (required)
inflate_job (bool) – Return job as an object instead of an id
join_avatars (bool)
join (JoinType)
async_ (bool) – Perform the request asynchronously

Returns:

union[AnalysisOutputInflatedJob,AnalysisOutput]

get_project_analysis_input_download_ticket(project_id, analysis_id, filename, **kwargs)

Get a signed URL to download a named child file.

This method makes a synchronous HTTP request by default.

Parameters:

project_id (str) – 24-character hex ID (required)
analysis_id (str) – 24-char hex analysis id (required)
filename (str) – filename to download (get tar of all if empty) (required)
ticket (str) – 24-char hex ticket id
info (bool) – get file info only
member (str) – get zipfile member
view (bool) – feature flag for view/download
range (str) – byte ranges to return
x_accept_feature (list[str]) – redirect header
async_ (bool) – Perform the request asynchronously

Returns:

union[DownloadTicketStub,ZipfileInfo]

get_project_analysis_input_zip_info(project_id, analysis_id, filename, **kwargs)

Retrieve the zip info of a child file by name.

Does not work on files whose names contain a forward slash. This method makes a synchronous HTTP request by default.

Parameters:

project_id (str) – 24-character hex ID (required)
analysis_id (str) – 24-char hex analysis id (required)
filename (str) – filename to download (get tar of all if empty) (required)
ticket (str) – 24-char hex ticket id
info (bool) – get file info only
member (str) – get zipfile member
view (bool) – feature flag for view/download
range (str) – byte ranges to return
x_accept_feature (list[str]) – redirect header
async_ (bool) – Perform the request asynchronously

Returns:

FileZipInfo

get_project_analysis_output_download_ticket(project_id, analysis_id, filename, **kwargs)

Get a signed URL to download a named child file.

This method makes a synchronous HTTP request by default.

Parameters:

project_id (str) – 24-character hex ID (required)
analysis_id (str) – 24-char hex analysis id (required)
filename (str) – filename to download (get tar of all if empty) (required)
ticket (str) – ticket id of the outputs to download
info (bool) – If the file is a zipfile, return a json response of zipfile member information
member (str) – The filename of a zipfile member to download rather than the entire file
view (bool) – feature flag for view/download
range (str) – byte ranges to return
x_accept_feature (list[str]) – redirect header
async_ (bool) – Perform the request asynchronously

Returns:

union[DownloadTicketStub,ZipfileInfo]

get_project_analysis_output_zip_info(project_id, analysis_id, filename, **kwargs)

Retrieve the zip info of a child file by name.

Does not work on files whose names contain a forward slash. This method makes a synchronous HTTP request by default.

Parameters:

project_id (str) – 24-character hex ID (required)
analysis_id (str) – 24-char hex analysis id (required)
filename (str) – filename to download (get tar of all if empty) (required)
ticket (str) – ticket id of the outputs to download
info (bool) – If the file is a zipfile, return a json response of zipfile member information
member (str) – The filename of a zipfile member to download rather than the entire file
view (bool) – feature flag for view/download
range (str) – byte ranges to return
x_accept_feature (list[str]) – redirect header
async_ (bool) – Perform the request asynchronously

Returns:

FileZipInfo

get_project_download_ticket(project_id, file_name, **kwargs)

Get a signed URL to download a named child file.

This method makes a synchronous HTTP request by default.

Parameters:

project_id (str) – 24-character hex ID (required)
file_name (str) – output file name (required)
ticket (str) – The generated ticket id for the download, or present but empty to generate a ticket id
info (bool) – If the file is a zipfile, return a json response of zipfile member information
member (str) – The filename of a zipfile member to download rather than the entire file
view (bool) – 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”
version (int) – version of the file to download
hash (str) – file hash for comparison
range (str) – byte ranges to return
x_accept_feature (list[str]) – redirect header
async_ (bool) – Perform the request asynchronously

Returns:

union[DownloadTicketStub,ZipfileInfo]

get_project_file_info(cid, filename, **kwargs)

Get info for a particular file.

Get info for a particular file. This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – Container Id (required)
filename (str) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

FileOutput

get_project_file_zip_info(project_id, file_name, **kwargs)

Retrieve the zip info of a child file by name.

Does not work on files whose names contain a forward slash. This method makes a synchronous HTTP request by default.

Parameters:

project_id (str) – 24-character hex ID (required)
file_name (str) – output file name (required)
ticket (str) – The generated ticket id for the download, or present but empty to generate a ticket id
info (bool) – If the file is a zipfile, return a json response of zipfile member information
member (str) – The filename of a zipfile member to download rather than the entire file
view (bool) – 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”
version (int) – version of the file to download
hash (str) – file hash for comparison
range (str) – byte ranges to return
x_accept_feature (list[str]) – redirect header
async_ (bool) – Perform the request asynchronously

Returns:

FileZipInfo

get_project_note(cid, note_id, **kwargs)

Get a note of a(n) project.

Get a note of a(n) project This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
note_id (str) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

Note

get_project_rule(project_id, rule_id, **kwargs)

Get a project rule.

Get a project rule. This method makes a synchronous HTTP request by default.

Parameters:

project_id (str) – (required)
rule_id (str) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

GearRuleOutput

get_project_rules(project_id, **kwargs)

List all rules for a project.

This method makes a synchronous HTTP request by default.

Parameters:

project_id (str) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

list[GearRuleOutput]

get_project_sessions(project_id, **kwargs)

List all sessions for the given project.

Returns a page of sessions by their parent This method makes a synchronous HTTP request by default.

Parameters:

project_id (str) – 24-char hex subject id (required)
join (JoinType) – join file origins
include_all_info (bool) – Include all info in returned objects
filter (str) – The filter to apply. (e.g. label=my-label,created>2018-09-22)
sort (str) – The sort fields and order. (e.g. label:asc,created:desc)
limit (int) – The maximum number of entries to return.
skip (int) – The number of entries to skip.
page (int) – The page number (i.e. skip limit*page entries)
after_id (str) – Paginate after the given id. (Cannot be used with sort, page or skip)
x_accept_feature (list[union[HeaderFeature,str]])
async_ (bool) – Perform the request asynchronously

Returns:

union[Page,list[SessionListOutput]]

get_project_settings(project_id, **kwargs)

Get a(n) project settings

Route for getting settings from a a(n) project This method makes a synchronous HTTP request by default.

Parameters:

project_id (str) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

ProjectSettingsOutput

get_project_subjects(project_id, **kwargs)

List all subjects for the given project.

List all subjects for the given project. This method makes a synchronous HTTP request by default.

Parameters:

project_id (str) – (required)
join (JoinType)
include_all_info (bool) – Include all info in returned objects
filter (str) – The filter to apply. (e.g. label=my-label,created>2018-09-22)
sort (str) – The sort fields and order. (e.g. label:asc,created:desc)
limit (int) – The maximum number of entries to return.
skip (int) – The number of entries to skip.
page (int) – The page number (i.e. skip limit*page entries)
after_id (str) – Paginate after the given id. (Cannot be used with sort, page or skip)
x_accept_feature (list[str])
async_ (bool) – Perform the request asynchronously

Returns:

union[Page,list[SubjectOutputForList]]

get_project_tag(cid, value, **kwargs)

Get the value of a tag, by name.

Get the value of a tag, by name This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
value (str) – The tag to interact with (required)
async_ (bool) – Perform the request asynchronously

Returns:

str

get_project_user_permission(project_id, uid, **kwargs)

List a user's permissions for this project.

Get a user’s permission from a project Args: project_id: The id of the project uid: The id of the user auth_session: The auth session Returns: RolePermissionOutput: The permission This method makes a synchronous HTTP request by default.

Parameters:

project_id (str) – (required)
uid (str) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

RolePermissionOutput

modify_project(project_id, body, **kwargs)

Update a project

This method makes a synchronous HTTP request by default.

Parameters:

project_id (str) – (required)
body (ProjectModify) – (required)
x_accept_feature (list[union[HeaderFeature,str]])
async_ (bool) – Perform the request asynchronously

Returns:

ModifiedResult

modify_project_analysis(cid, analysis_id, body, **kwargs)

Modify an analysis.

Modify an analysis. This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
analysis_id (str) – (required)
body (AnalysisModifyInput) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

ModifiedResult

modify_project_file(cid, filename, body, **kwargs)

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) This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
filename (str) – (required)
body (FileModifyInput) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

ModifiedResult

modify_project_file_classification(cid, filename, body, **kwargs)

Update classification for a particular file.

If replacing a file’s classification, the modality can optionally be modified as well. This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
filename (str) – (required)
body (FileClassificationDelta) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

ModifiedResult

modify_project_file_info(cid, filename, body, **kwargs)

Update info for a particular file.

Modify and return the file ‘info’ field This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
filename (str) – (required)
body (Info) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

ModifiedResult

modify_project_info(cid, body, **kwargs)

Update or replace info for a(n) project.

Update or replace info for a(n) project. Keys that contain ‘$’ or ‘.’ will be sanitized in the process of being updated on the container. This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
body (Info) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

ModifiedResult

modify_project_note(cid, note_id, body, **kwargs)

Update a note of a(n) project.

Update a note of a(n) project This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
note_id (str) – (required)
body (NoteInput) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

int

modify_project_rule(project_id, rule_id, body, **kwargs)

Update a rule on a project.

Update a rule on a project. This method makes a synchronous HTTP request by default.

Parameters:

project_id (str) – (required)
rule_id (str) – (required)
body (GearRuleModifyInput) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

GearRuleOutput

modify_project_settings(project_id, body, **kwargs)

Modify a(n) project settings

Route for modifying settings for a a(n) project This method makes a synchronous HTTP request by default.

Parameters:

project_id (str) – (required)
body (ProjectSettingsInput) – (required)
x_accept_feature (list[union[HeaderFeature,str]])
async_ (bool) – Perform the request asynchronously

Returns:

ProjectSettingsOutput

modify_project_user_permission(project_id, uid, body, **kwargs)

Update a user's permission for this project.

Update a user’s permission for this project. This method makes a synchronous HTTP request by default.

Parameters:

project_id (str) – (required)
uid (str) – (required)
body (RolePermissionUpdate) – (required)
x_accept_feature (list[union[HeaderFeature,str]])
async_ (bool) – Perform the request asynchronously

Returns:

RolePermissionOutput

project_copy(project_id, body, **kwargs)

Copy By Reference

Copy a project and its descendants to a new project tree This method makes a synchronous HTTP request by default.

Parameters:

project_id (str) – (required)
body (ProjectCopyInput) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

ProjectCopyOutput

project_packfile_upload(project_id, token, file, **kwargs)

Add files to an in-progress packfile

This method makes a synchronous HTTP request by default.

Parameters:

project_id (str) – (required)
token (str) – (required)
file (str) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

list[FileOutput]

recalc_all_projects(**kwargs)

Recalculate all sessions against their project templates.

Iterates all projects that have a session template. Recalculate if projects’ sessions satisfy the template. Returns list of modified session ids. This method makes a synchronous HTTP request by default.

Parameters:: async_ (bool) – Perform the request asynchronously
Returns:: SessionTemplateRecalcOutput

recalc_project(project_id, **kwargs)

Currently does nothing–will eventually calculate if sessions in the project satisfy the template.

Currently does nothing–will eventually calculate if sessions in the project satisfy the template. This method makes a synchronous HTTP request by default.

Parameters:

project_id (str) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

SessionTemplateRecalcOutput

remove_project_rule(project_id, rule_id, **kwargs)

Remove a project rule.

This method makes a synchronous HTTP request by default.

Parameters:

project_id (str) – (required)
rule_id (str) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

None

remove_project_template(project_id, **kwargs)

Remove the session template for a project.

This method makes a synchronous HTTP request by default.

Parameters:

project_id (str) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

DeletedResult

rename_project_tag(cid, value, body, **kwargs)

Rename a tag.

Rename a tag This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
value (str) – The tag to interact with (required)
body (Tag) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

str

set_project_template(project_id, body, **kwargs)

Set the session template for a project.

This method makes a synchronous HTTP request by default.

Parameters:

project_id (str) – (required)
body (ProjectTemplateListInput) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

ModifiedResult

start_project_packfile_upload(project_id, **kwargs)

Start a packfile upload to project

This method makes a synchronous HTTP request by default.

Parameters:

project_id (str) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

UploadTokenOutput

upload_file_to_project(container_id, file, **kwargs)

Upload a file to a(n) project.

Upload a file to a(n) project. This method makes a synchronous HTTP request by default.

Parameters:

container_id (str) – (required)
file (str) – The file to upload (required)
preserve_metadata (bool)
ticket (str)
id (str)
level (ContainerType)
job (str)
metadata (str) – Metadata object as a JSON-encoded string
x_accept_feature (list[str]) – redirect header
content_type (str)
async_ (bool) – Perform the request asynchronously

Returns:

union[list[FileOutput],UploadTicketOutput]

upload_output_to_project_analysis(cid, analysis_id, file, **kwargs)

Upload an output file to an analysis.

Upload an output file to an analysis This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
analysis_id (str) – (required)
file (str) – The file to upload (required)
ticket (str)
id (str)
level (ContainerType)
job (str)
content_type (str)
async_ (bool) – Perform the request asynchronously

Returns:

list[FileOutput]

upsert_project_hierarchy(project_id, body, **kwargs)

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

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

Parameters:

project_id (str) – (required)
body (ProjectHierarchyInput) – (required)
uid_scope (str)
async_ (bool) – Perform the request asynchronously

Returns:

ProjectHierarchyOutput

flywheel.api.reports_api module

Flywheel

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501

OpenAPI spec version: 0.0.1

Generated by: https://github.com/swagger-api/swagger-codegen.git

class flywheel.api.reports_api.ReportsApi(api_client=None)

Bases: object

collect_usage(**kwargs)

Collect daily usage statistics.

Collects usage statistics for the selected day (or yesterday if no day is given) This method makes a synchronous HTTP request by default.

Parameters:

year (int) – The year portion of the date
month (int) – The month portion of the date
day (int) – The day portion of the date
async_ (bool) – Perform the request asynchronously

Returns:

None

get_access_log_report(**kwargs)

Get a report of access log entries for the given parameters

This method makes a synchronous HTTP request by default.

Parameters:

csv (bool) – Set to download a csv file instead of json
filter (str) – The filter to apply. (e.g. label=my-label,created>2018-09-22)
sort (str) – The sort fields and order.(e.g. label:asc,created:desc)
limit (int) – The maximum number of entries to return
skip (int) – The number of entries to skip
page (int) – The page number (i.e. skip limit*page entries)
after_id (str) – Paginate after the given id. (Cannot be used with sort, page or skip)
start_date (datetime) – An ISO formatted timestamp for the start time of the report
end_date (datetime) – An ISO formatted timestamp for the end time of the report
user (str) – User id of the target user
subject (str) – Limit the report to the subject code of subject accessed
project (str) – Limit the report to the project id
access_types (list[AccessType]) – The list of access_types to filter logs
x_accept_feature (list[str])
async_ (bool) – Perform the request asynchronously

Returns:

list[ReportAccessLogEntry]

get_access_log_types(**kwargs)

Get the list of types of access log entries

This method makes a synchronous HTTP request by default.

Parameters:: async_ (bool) – Perform the request asynchronously
Returns:: list[str]

get_daily_usage_report(**kwargs)

Get a daily usage report for the given month.

If no year/month pair is given, the current month will be used. This method makes a synchronous HTTP request by default.

Parameters:

year (int) – The year portion of the date
month (int) – The month portion of the date
group (str) – Limit the report to the given group id
project (str) – Limit the report to the given project id
async_ (bool) – Perform the request asynchronously

Returns:

list[DailyReportUsage]

get_legacy_usage_report(type, **kwargs)

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

This report is DEPRECATED and will be removed in a future release This method makes a synchronous HTTP request by default.

Parameters:

type (str) – The type of usage report to generate (required)
start_date (datetime) – An ISO formatted timestamp for the start time of the report
end_date (datetime) – An ISO formatted timestamp for the end time of the report
async_ (bool) – Perform the request asynchronously

Returns:

list[LegacyUsageReport]

get_project_report(**kwargs)

Get project report

Get project report This method makes a synchronous HTTP request by default.

Parameters:

projects (list[str]) – Specify multiple times to include projects in the report
start_date (datetime) – Report start date
end_date (datetime) – Report end date
async_ (bool) – Perform the request asynchronously

Returns:

ProjectReportList

get_site_report(**kwargs)

Get the site report

This method makes a synchronous HTTP request by default.

Parameters:: async_ (bool) – Perform the request asynchronously
Returns:: SiteReport

get_usage_availability(**kwargs)

Get year/month combinations where report data is available.

Get year/month combinations where report data is available. Returns: Returns the list of months where report data is available This method makes a synchronous HTTP request by default.

Parameters:: async_ (bool) – Perform the request asynchronously
Returns:: ReportAvailabilityList

get_usage_report(**kwargs)

Get a usage report for the given month.

If no year/month pair is given, the current month will be used. This method makes a synchronous HTTP request by default.

Parameters:

year (int) – The year portion of the date
month (int) – The month portion of the date
project (str) – Project to filter to
async_ (bool) – Perform the request asynchronously

Returns:

list[ReportUsage]

flywheel.api.resolve_api module

Flywheel

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501

OpenAPI spec version: 0.0.1

Generated by: https://github.com/swagger-api/swagger-codegen.git

class flywheel.api.resolve_api.ResolveApi(api_client=None)

Bases: object

lookup_path(body, **kwargs)

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. This method makes a synchronous HTTP request by default.

Parameters:

body (ResolveInput) – (required)
full_tree (bool)
exhaustive (bool)
async_ (bool) – Perform the request asynchronously

Returns:

ResolverNode

resolve_path(body, **kwargs)

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. This method makes a synchronous HTTP request by default.

Parameters:

body (ResolveInput) – (required)
full_tree (bool) – Parse full download style paths (e.g. group/PROJECTS/project_label/SUBJECTS/…)
minattr (bool) – Return only minimal attributes
exhaustive (bool) – Set to return a complete list regardless of permissions
async_ (bool) – Perform the request asynchronously

Returns:

ResolveOutput

flywheel.api.roles_api module

Flywheel

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501

OpenAPI spec version: 0.0.1

Generated by: https://github.com/swagger-api/swagger-codegen.git

class flywheel.api.roles_api.RolesApi(api_client=None)

Bases: object

add_role(body, **kwargs)

Add a new role

This method makes a synchronous HTTP request by default.

Parameters:

body (RoleInput) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

RoleOutput

delete_role(role_id, **kwargs)

Delete the role

This method makes a synchronous HTTP request by default.

Parameters:

role_id (str) – The ID of the role (required)
async_ (bool) – Perform the request asynchronously

Returns:

None

get_all_roles(**kwargs)

Get list of all roles

This method makes a synchronous HTTP request by default.

Parameters:

filter (str) – The filter to apply. (e.g. label=my-label,created>2018-09-22)
sort (str) – The sort fields and order. (e.g. label:asc,created:desc)
limit (int) – The maximum number of entries to return.
skip (int) – The number of entries to skip.
page (int) – The page number (i.e. skip limit*page entries)
after_id (str) – Paginate after the given id. (Cannot be used with sort, page or skip)
x_accept_feature (list[str])
async_ (bool) – Perform the request asynchronously

Returns:

union[list[RoleOutput],Page]

get_role(role_id, **kwargs)

Return the role identified by the RoleId

This method makes a synchronous HTTP request by default.

Parameters:

role_id (str) – The ID of the role (required)
async_ (bool) – Perform the request asynchronously

Returns:

RoleOutput

modify_role(role_id, body, **kwargs)

Update the role identified by RoleId

This method makes a synchronous HTTP request by default.

Parameters:

role_id (str) – (required)
body (RoleUpdate) – (required)
x_accept_feature (list[union[HeaderFeature,str]])
async_ (bool) – Perform the request asynchronously

Returns:

RoleOutput

flywheel.api.sessions_api module

Flywheel

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501

OpenAPI spec version: 0.0.1

Generated by: https://github.com/swagger-api/swagger-codegen.git

class flywheel.api.sessions_api.SessionsApi(api_client=None)

Bases: object

add_session(body, **kwargs)

Create a new session

Create a session. This method makes a synchronous HTTP request by default.

Parameters:

body (SessionInput) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

InsertedId

add_session_analysis(cid, body, **kwargs)

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. This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
body (union[AdhocAnalysisInput,JobAnalysisInput]) – (required)
job (bool) – returns job_id instead of analysis.id
job – returns job_id instead of analysis.id
async_ (bool) – Perform the request asynchronously

Returns:

InsertedId

add_session_analysis_note(container_id, analysis_id, body, **kwargs)

Add a note to a(n) session analysis.

Add a note to a(n) session analysis. This method makes a synchronous HTTP request by default.

Parameters:

container_id (str) – 24-char hex id (required)
analysis_id (str) – 24-char hex analysis id (required)
body (NoteInput) – note content (required)
async_ (bool) – Perform the request asynchronously

Returns:

Note

add_session_note(container_id, body, **kwargs)

Add a note to a(n) session.

Add a note to a(n) session. This method makes a synchronous HTTP request by default.

Parameters:

container_id (str) – (required)
body (NoteInput) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

Note

add_session_tag(cid, body, **kwargs)

Add a tag to a(n) session.

Propagates changes to projects, sessions and acquisitions This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
body (Tag) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

ModifiedResult

add_session_tags(cid, body, **kwargs)

Add multiple tags to a(n) session

Add multiple tags to a(n) session This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
body (list[str]) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

None

delete_session(session_id, **kwargs)

Delete a session

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

Parameters:

session_id (str) – (required)
delete_reason (ContainerDeleteReason)
async_ (bool) – Perform the request asynchronously

Returns:

DeletedResult

delete_session_analysis(cid, analysis_id, **kwargs)

Delete an analysis

Delete an analysis for a container. This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
analysis_id (str) – (required)
delete_reason (ContainerDeleteReason) – Provide a reason for the deletion
async_ (bool) – Perform the request asynchronously

Returns:

DeletedResult

delete_session_analysis_note(cid, analysis_id, note_id, **kwargs)

Remove a note from a(n) session analysis.

Remove a note from a(n) session analysis. This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – 24-char hex id (required)
analysis_id (str) – 24-char hex analysis id (required)
note_id (str) – 24-char hex note id (required)
async_ (bool) – Perform the request asynchronously

Returns:

DeletedResult

delete_session_file(cid, filename, **kwargs)

Delete a file

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

Parameters:

cid (str) – (required)
filename (str) – (required)
delete_reason (ContainerDeleteReason) – A reason for deletion when audit-trail is enabled
force (bool) – Force deletion of the file even if some checks fail. Deprecated, will be removed in a future release.
async_ (bool) – Perform the request asynchronously

Returns:

DeletedResult

delete_session_note(cid, note_id, **kwargs)

Remove a note from a(n) session

Remove a note from a(n) session This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
note_id (str) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

DeletedResult

delete_session_tag(cid, value, **kwargs)

Delete a tag

Delete a tag This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
value (str) – The tag to interact with (required)
async_ (bool) – Perform the request asynchronously

Returns:

DeletedResult

delete_session_tags(cid, body, **kwargs)

Delete multiple tags from a(n) session

Delete multiple tags from a(n) session This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
body (list[str]) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

None

delete_sessions_by_ids(body, **kwargs)

Delete multiple sessions by ID list

Delete multiple sessions by ID list This method makes a synchronous HTTP request by default.

Parameters:

body (list[str]) – List of IDs to delete (required)
delete_reason (ContainerDeleteReason)
async_ (bool) – Perform the request asynchronously

Returns:

DeletedResult

delete_sessions_by_query(body, **kwargs)

Delete multiple sessions by query

Delete multiple sessions by query This method makes a synchronous HTTP request by default.

Parameters:

body (list[Filter]) – Query for containers to delete (required)
delete_reason (ContainerDeleteReason)
async_ (bool) – Perform the request asynchronously

Returns:

DeletedResult

download_file_from_session(session_id, file_name, dest_file, **kwargs)

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. This method makes a synchronous HTTP request by default.

Parameters:

session_id (str) – 24-character hex ID (required)
file_name (str) – output file name (required)
info (bool) – If the file is a zipfile, return a json response of zipfile member information
member (str) – The filename of a zipfile member to download rather than the entire file
view (bool) – 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”
version (int) – version of the file to download
hash (str) – file hash for comparison
range (str) – byte ranges to return
x_accept_feature (list[str]) – redirect header
dest_file (str) – Destination file path
async_ (bool) – Perform the request asynchronously

Returns:

union[DownloadTicketStub,ZipfileInfo]

download_input_from_session_analysis(session_id, analysis_id, filename, dest_file, **kwargs)

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. This method makes a synchronous HTTP request by default.

Parameters:

session_id (str) – 24-character hex ID (required)
analysis_id (str) – 24-char hex analysis id (required)
filename (str) – filename to download (get tar of all if empty) (required)
info (bool) – get file info only
member (str) – get zipfile member
view (bool) – feature flag for view/download
range (str) – byte ranges to return
x_accept_feature (list[str]) – redirect header
dest_file (str) – Destination file path
async_ (bool) – Perform the request asynchronously

Returns:

union[DownloadTicketStub,ZipfileInfo]

download_output_from_session_analysis(session_id, analysis_id, filename, dest_file, **kwargs)

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. This method makes a synchronous HTTP request by default.

Parameters:

session_id (str) – 24-character hex ID (required)
analysis_id (str) – 24-char hex analysis id (required)
filename (str) – filename to download (get tar of all if empty) (required)
info (bool) – If the file is a zipfile, return a json response of zipfile member information
member (str) – The filename of a zipfile member to download rather than the entire file
view (bool) – feature flag for view/download
range (str) – byte ranges to return
x_accept_feature (list[str]) – redirect header
dest_file (str) – Destination file path
async_ (bool) – Perform the request asynchronously

Returns:

union[DownloadTicketStub,ZipfileInfo]

get_all_sessions(**kwargs)

Get a list of sessions

Finds all sessions. This method makes a synchronous HTTP request by default.

Parameters:

exhaustive (bool) – Set to return a complete list regardless of permissions
join_avatars (bool) – add name and avatar to notes
join (JoinType) – join file origins
include_all_info (bool) – Include all info in returned objects
user_id (str)
filter (str) – The filter to apply. (e.g. label=my-label,created>2018-09-22)
sort (str) – The sort fields and order. (e.g. label:asc,created:desc)
limit (int) – The maximum number of entries to return.
skip (int) – The number of entries to skip.
page (int) – The page number (i.e. skip limit*page entries)
after_id (str) – Paginate after the given id. (Cannot be used with sort, page or skip)
x_accept_feature (list[union[HeaderFeature,str]])
async_ (bool) – Perform the request asynchronously

Returns:

union[Page,list[SessionListOutput]]

get_session(session_id, **kwargs)

Get a single session

Get a single session This method makes a synchronous HTTP request by default.

Parameters:

session_id (str) – (required)
join_avatars (bool) – add name and avatar to notes
join (JoinType)
x_accept_feature (list[union[HeaderFeature,str]])
async_ (bool) – Perform the request asynchronously

Returns:

SessionOutput

get_session_acquisitions(session_id, **kwargs)

List acquisitions in a session

Get acquisitions. This method makes a synchronous HTTP request by default.

Parameters:

session_id (str) – (required)
collection_id (str)
exhaustive (bool)
join (JoinType)
include_all_info (bool) – Include all info in returned objects
filter (str) – The filter to apply. (e.g. label=my-label,created>2018-09-22)
sort (str) – The sort fields and order. (e.g. label:asc,created:desc)
limit (int) – The maximum number of entries to return.
skip (int) – The number of entries to skip.
page (int) – The page number (i.e. skip limit*page entries)
after_id (str) – Paginate after the given id. (Cannot be used with sort, page or skip)
x_accept_feature (list[str])
async_ (bool) – Perform the request asynchronously

Returns:

union[list[AcquisitionListOutput],Page]

get_session_analyses(cid, **kwargs)

Get analyses for a(n) session.

Returns analyses that directly belong to this resource. This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
inflate_job (bool)
join_avatars (bool)
join (JoinType)
include_all_info (bool) – Include all info in returned objects
filter (str) – The filter to apply. (e.g. label=my-label,created>2018-09-22)
sort (str) – The sort fields and order. (e.g. label:asc,created:desc)
limit (int) – The maximum number of entries to return.
skip (int) – The number of entries to skip.
page (int) – The page number (i.e. skip limit*page entries)
after_id (str) – Paginate after the given id. (Cannot be used with sort, page or skip)
x_accept_feature (list[str])
async_ (bool) – Perform the request asynchronously

Returns:

union[Page,list[union[AnalysisListOutput,AnalysisListOutputInflatedJob]]]

get_session_analysis(cid, analysis_id, **kwargs)

Get an analysis.

Get an analysis. This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
analysis_id (str) – (required)
inflate_job (bool) – Return job as an object instead of an id
join_avatars (bool)
join (JoinType)
async_ (bool) – Perform the request asynchronously

Returns:

union[AnalysisOutputInflatedJob,AnalysisOutput]

get_session_analysis_input_download_ticket(session_id, analysis_id, filename, **kwargs)

Get a signed URL to download a named child file.

This method makes a synchronous HTTP request by default.

Parameters:

session_id (str) – 24-character hex ID (required)
analysis_id (str) – 24-char hex analysis id (required)
filename (str) – filename to download (get tar of all if empty) (required)
ticket (str) – 24-char hex ticket id
info (bool) – get file info only
member (str) – get zipfile member
view (bool) – feature flag for view/download
range (str) – byte ranges to return
x_accept_feature (list[str]) – redirect header
async_ (bool) – Perform the request asynchronously

Returns:

union[DownloadTicketStub,ZipfileInfo]

get_session_analysis_input_zip_info(session_id, analysis_id, filename, **kwargs)

Retrieve the zip info of a child file by name.

Does not work on files whose names contain a forward slash. This method makes a synchronous HTTP request by default.

Parameters:

session_id (str) – 24-character hex ID (required)
analysis_id (str) – 24-char hex analysis id (required)
filename (str) – filename to download (get tar of all if empty) (required)
ticket (str) – 24-char hex ticket id
info (bool) – get file info only
member (str) – get zipfile member
view (bool) – feature flag for view/download
range (str) – byte ranges to return
x_accept_feature (list[str]) – redirect header
async_ (bool) – Perform the request asynchronously

Returns:

FileZipInfo

get_session_analysis_output_download_ticket(session_id, analysis_id, filename, **kwargs)

Get a signed URL to download a named child file.

This method makes a synchronous HTTP request by default.

Parameters:

session_id (str) – 24-character hex ID (required)
analysis_id (str) – 24-char hex analysis id (required)
filename (str) – filename to download (get tar of all if empty) (required)
ticket (str) – ticket id of the outputs to download
info (bool) – If the file is a zipfile, return a json response of zipfile member information
member (str) – The filename of a zipfile member to download rather than the entire file
view (bool) – feature flag for view/download
range (str) – byte ranges to return
x_accept_feature (list[str]) – redirect header
async_ (bool) – Perform the request asynchronously

Returns:

union[DownloadTicketStub,ZipfileInfo]

get_session_analysis_output_zip_info(session_id, analysis_id, filename, **kwargs)

Retrieve the zip info of a child file by name.

Does not work on files whose names contain a forward slash. This method makes a synchronous HTTP request by default.

Parameters:

session_id (str) – 24-character hex ID (required)
analysis_id (str) – 24-char hex analysis id (required)
filename (str) – filename to download (get tar of all if empty) (required)
ticket (str) – ticket id of the outputs to download
info (bool) – If the file is a zipfile, return a json response of zipfile member information
member (str) – The filename of a zipfile member to download rather than the entire file
view (bool) – feature flag for view/download
range (str) – byte ranges to return
x_accept_feature (list[str]) – redirect header
async_ (bool) – Perform the request asynchronously

Returns:

FileZipInfo

get_session_download_ticket(session_id, file_name, **kwargs)

Get a signed URL to download a named child file.

This method makes a synchronous HTTP request by default.

Parameters:

session_id (str) – 24-character hex ID (required)
file_name (str) – output file name (required)
ticket (str) – The generated ticket id for the download, or present but empty to generate a ticket id
info (bool) – If the file is a zipfile, return a json response of zipfile member information
member (str) – The filename of a zipfile member to download rather than the entire file
view (bool) – 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”
version (int) – version of the file to download
hash (str) – file hash for comparison
range (str) – byte ranges to return
x_accept_feature (list[str]) – redirect header
async_ (bool) – Perform the request asynchronously

Returns:

union[DownloadTicketStub,ZipfileInfo]

get_session_file_info(cid, filename, **kwargs)

Get info for a particular file.

Get info for a particular file. This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – Container Id (required)
filename (str) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

FileOutput

get_session_file_zip_info(session_id, file_name, **kwargs)

Retrieve the zip info of a child file by name.

Does not work on files whose names contain a forward slash. This method makes a synchronous HTTP request by default.

Parameters:

session_id (str) – 24-character hex ID (required)
file_name (str) – output file name (required)
ticket (str) – The generated ticket id for the download, or present but empty to generate a ticket id
info (bool) – If the file is a zipfile, return a json response of zipfile member information
member (str) – The filename of a zipfile member to download rather than the entire file
view (bool) – 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”
version (int) – version of the file to download
hash (str) – file hash for comparison
range (str) – byte ranges to return
x_accept_feature (list[str]) – redirect header
async_ (bool) – Perform the request asynchronously

Returns:

FileZipInfo

get_session_jobs(session_id, **kwargs)

Return any jobs that use inputs from this session

Gets session jobs. This method makes a synchronous HTTP request by default.

Parameters:

session_id (str) – (required)
states (list[str]) – filter results by job state
tags (list[str]) – filter results by job tags
include_all_info (bool) – Include all info in returned objects
filter (str) – The filter to apply. (e.g. label=my-label,created>2018-09-22)
sort (str) – The sort fields and order. (e.g. label:asc,created:desc)
limit (int) – The maximum number of entries to return.
skip (int) – The number of entries to skip.
page (int) – The page number (i.e. skip limit*page entries)
after_id (str) – Paginate after the given id. (Cannot be used with sort, page or skip)
x_accept_feature (list[str])
async_ (bool) – Perform the request asynchronously

Returns:

union[JobsList,Page]

get_session_note(cid, note_id, **kwargs)

Get a note of a(n) session.

Get a note of a(n) session This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
note_id (str) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

Note

get_session_tag(cid, value, **kwargs)

Get the value of a tag, by name.

Get the value of a tag, by name This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
value (str) – The tag to interact with (required)
async_ (bool) – Perform the request asynchronously

Returns:

str

modify_session(session_id, body, **kwargs)

Update a session

Modify a session. This method makes a synchronous HTTP request by default.

Parameters:

session_id (str) – (required)
body (SessionModify) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

ModifiedResult

modify_session_analysis(cid, analysis_id, body, **kwargs)

Modify an analysis.

Modify an analysis. This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
analysis_id (str) – (required)
body (AnalysisModifyInput) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

ModifiedResult

modify_session_file(cid, filename, body, **kwargs)

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) This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
filename (str) – (required)
body (FileModifyInput) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

ModifiedResult

modify_session_file_classification(cid, filename, body, **kwargs)

Update classification for a particular file.

If replacing a file’s classification, the modality can optionally be modified as well. This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
filename (str) – (required)
body (FileClassificationDelta) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

ModifiedResult

modify_session_file_info(cid, filename, body, **kwargs)

Update info for a particular file.

Modify and return the file ‘info’ field This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
filename (str) – (required)
body (Info) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

ModifiedResult

modify_session_info(cid, body, **kwargs)

Update or replace info for a(n) session.

Update or replace info for a(n) session. Keys that contain ‘$’ or ‘.’ will be sanitized in the process of being updated on the container. This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
body (Info) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

ModifiedResult

modify_session_note(cid, note_id, body, **kwargs)

Update a note of a(n) session.

Update a note of a(n) session This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
note_id (str) – (required)
body (NoteInput) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

int

rename_session_tag(cid, value, body, **kwargs)

Rename a tag.

Rename a tag This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
value (str) – The tag to interact with (required)
body (Tag) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

str

upload_file_to_session(container_id, file, **kwargs)

Upload a file to a(n) session.

Upload a file to a(n) session. This method makes a synchronous HTTP request by default.

Parameters:

container_id (str) – (required)
file (str) – The file to upload (required)
preserve_metadata (bool)
ticket (str)
id (str)
level (ContainerType)
job (str)
metadata (str) – Metadata object as a JSON-encoded string
x_accept_feature (list[str]) – redirect header
content_type (str)
async_ (bool) – Perform the request asynchronously

Returns:

union[list[FileOutput],UploadTicketOutput]

upload_output_to_session_analysis(cid, analysis_id, file, **kwargs)

Upload an output file to an analysis.

Upload an output file to an analysis This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
analysis_id (str) – (required)
file (str) – The file to upload (required)
ticket (str)
id (str)
level (ContainerType)
job (str)
content_type (str)
async_ (bool) – Perform the request asynchronously

Returns:

list[FileOutput]

flywheel.api.site_api module

Flywheel

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501

OpenAPI spec version: 0.0.1

Generated by: https://github.com/swagger-api/swagger-codegen.git

class flywheel.api.site_api.SiteApi(api_client=None)

Bases: object

add_provider(body, **kwargs)

Add a new provider

This method makes a synchronous HTTP request by default.

Parameters:

body (IngressProvider) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

EgressProviderId

add_site_rule(body, **kwargs)

Create a new site rule.

This method makes a synchronous HTTP request by default.

Parameters:

body (GearRuleInput) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

GearRule

delete_provider(provider_id, **kwargs)

Delete the provider identified by ProviderId

Returns an empty 204 response if successful. The provider will be deleted asynchronously; if it is a storage provider, any files on the provider that have been deleted but not yet cleaned up will be hard deleted. Use the get_provider operation to check the deletion status. This method makes a synchronous HTTP request by default.

Parameters:

provider_id (str) – The ID of the provider (required)
async_ (bool) – Perform the request asynchronously

Returns:

None

get_bookmark_list(**kwargs)

Get Bookmark List

This method makes a synchronous HTTP request by default.

Parameters:: async_ (bool) – Perform the request asynchronously
Returns:: list[Bookmark]

get_provider(provider_id, **kwargs)

Return the provider identified by ProviderId

Return the provider identified by ProviderId This method makes a synchronous HTTP request by default.

Parameters:

provider_id (str) – The ID of the provider (required)
async_ (bool) – Perform the request asynchronously

Returns:

EgressProvider

get_provider_config(provider_id, **kwargs)

Return the configuration for provider identified by ProviderId

The returned configuration will be redacted, with any privileged values replaced with null. This method makes a synchronous HTTP request by default.

Parameters:

provider_id (str) – The ID of the provider (required)
async_ (bool) – Perform the request asynchronously

Returns:

object

get_providers(**kwargs)

Return a list of all providers on the site

Return a list of all providers on the site This method makes a synchronous HTTP request by default.

Parameters:

_class (ProviderClass) – Limit the response to the given provider class
filter (str) – The filter to apply. (e.g. label=my-label,created>2018-09-22)
sort (str) – The sort fields and order. (e.g. label:asc,created:desc)
limit (int) – The maximum number of entries to return.
skip (int) – The number of entries to skip.
page (int) – The page number (i.e. skip limit*page entries)
after_id (str) – Paginate after the given id. (Cannot be used with sort, page or skip)
async_ (bool) – Perform the request asynchronously

Returns:

list[EgressProvider]

get_site_rule(rule_id, **kwargs)

Get a site rule.

This method makes a synchronous HTTP request by default.

Parameters:

rule_id (str) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

GearRule

get_site_rules(**kwargs)

List all site rules.

This method makes a synchronous HTTP request by default.

Parameters:

limit (int)
after_id (str)
name (str)
async_ (bool) – Perform the request asynchronously

Returns:

list[GearRule]

get_site_settings(**kwargs)

Return administrative site settings

Returns the site settings, which includes center-pays gear list. If the site settings have never been created, then center_gears will be null, rather than an empty list. This method makes a synchronous HTTP request by default.

Parameters:: async_ (bool) – Perform the request asynchronously
Returns:: SiteSettings

modify_bookmark_list(body, **kwargs)

Modify Bookmark List

This method makes a synchronous HTTP request by default.

Parameters:

body (list[Bookmark]) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

list[Bookmark]

modify_provider(provider_id, body, **kwargs)

Update the provider identified by ProviderId

Update the provider identified by ProviderId This method makes a synchronous HTTP request by default.

Parameters:

provider_id (str) – The ID of the provider (required)
body (IngressUpdateProvider) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

EgressProvider

modify_site_rule(rule_id, body, **kwargs)

Update a site rule.

This method makes a synchronous HTTP request by default.

Parameters:

rule_id (str) – (required)
body (GearRuleModifyInput) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

GearRule

modify_site_settings(body, **kwargs)

Update administrative site settings

This method makes a synchronous HTTP request by default.

Parameters:

body (IngressSiteSettings) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

SiteSettings

remove_site_rule(rule_id, **kwargs)

Remove a site rule.

This method makes a synchronous HTTP request by default.

Parameters:

rule_id (str) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

None

flywheel.api.subjects_api module

Flywheel

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501

OpenAPI spec version: 0.0.1

Generated by: https://github.com/swagger-api/swagger-codegen.git

class flywheel.api.subjects_api.SubjectsApi(api_client=None)

Bases: object

add_subject(body, **kwargs)

Create a new subject

Create a new subject This method makes a synchronous HTTP request by default.

Parameters:

body (SubjectInput) – subject object to create (required)
async_ (bool) – Perform the request asynchronously

Returns:

InsertedId

add_subject_analysis(cid, body, **kwargs)

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. This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
body (union[AdhocAnalysisInput,JobAnalysisInput]) – (required)
job (bool) – returns job_id instead of analysis.id
job – returns job_id instead of analysis.id
async_ (bool) – Perform the request asynchronously

Returns:

InsertedId

add_subject_analysis_note(container_id, analysis_id, body, **kwargs)

Add a note to a(n) subject analysis.

Add a note to a(n) subject analysis. This method makes a synchronous HTTP request by default.

Parameters:

container_id (str) – 24-char hex id (required)
analysis_id (str) – 24-char hex analysis id (required)
body (NoteInput) – note content (required)
async_ (bool) – Perform the request asynchronously

Returns:

Note

add_subject_note(container_id, body, **kwargs)

Add a note to a(n) subject.

Add a note to a(n) subject. This method makes a synchronous HTTP request by default.

Parameters:

container_id (str) – (required)
body (NoteInput) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

Note

add_subject_tag(cid, body, **kwargs)

Add a tag to a(n) subject.

Propagates changes to projects, sessions and acquisitions This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
body (Tag) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

ModifiedResult

add_subject_tags(cid, body, **kwargs)

Add multiple tags to a(n) subject

Add multiple tags to a(n) subject This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
body (list[str]) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

None

create_master_subject_code(body, **kwargs)

Request a master subject code for the given patient

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

Parameters:

body (union[MasterSubjectCodeInput,MasterSubjectCodeDobInput]) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

MasterSubjectCodeOutput

delete_subject(subject_id, **kwargs)

Delete a subject

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

Parameters:

subject_id (str) – 24-char hex subject id (required)
delete_reason (ContainerDeleteReason)
async_ (bool) – Perform the request asynchronously

Returns:

DeletedResult

delete_subject_analysis(cid, analysis_id, **kwargs)

Delete an analysis

Delete an analysis for a container. This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
analysis_id (str) – (required)
delete_reason (ContainerDeleteReason) – Provide a reason for the deletion
async_ (bool) – Perform the request asynchronously

Returns:

DeletedResult

delete_subject_analysis_note(cid, analysis_id, note_id, **kwargs)

Remove a note from a(n) subject analysis.

Remove a note from a(n) subject analysis. This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – 24-char hex id (required)
analysis_id (str) – 24-char hex analysis id (required)
note_id (str) – 24-char hex note id (required)
async_ (bool) – Perform the request asynchronously

Returns:

DeletedResult

delete_subject_file(cid, filename, **kwargs)

Delete a file

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

Parameters:

cid (str) – (required)
filename (str) – (required)
delete_reason (ContainerDeleteReason) – A reason for deletion when audit-trail is enabled
force (bool) – Force deletion of the file even if some checks fail. Deprecated, will be removed in a future release.
async_ (bool) – Perform the request asynchronously

Returns:

DeletedResult

delete_subject_note(cid, note_id, **kwargs)

Remove a note from a(n) subject

Remove a note from a(n) subject This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
note_id (str) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

DeletedResult

delete_subject_tag(cid, value, **kwargs)

Delete a tag

Delete a tag This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
value (str) – The tag to interact with (required)
async_ (bool) – Perform the request asynchronously

Returns:

DeletedResult

delete_subject_tags(cid, body, **kwargs)

Delete multiple tags from a(n) subject

Delete multiple tags from a(n) subject This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
body (list[str]) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

None

delete_subjects_by_ids(body, **kwargs)

Delete multiple subjects by ID list

Delete multiple subjects by ID list This method makes a synchronous HTTP request by default.

Parameters:

body (list[str]) – List of IDs to delete (required)
delete_reason (ContainerDeleteReason)
async_ (bool) – Perform the request asynchronously

Returns:

DeletedResult

delete_subjects_by_query(body, **kwargs)

Delete multiple subjects by query

Delete multiple subjects by query This method makes a synchronous HTTP request by default.

Parameters:

body (list[Filter]) – Query for containers to delete (required)
delete_reason (ContainerDeleteReason)
async_ (bool) – Perform the request asynchronously

Returns:

DeletedResult

download_file_from_subject(subject_id, file_name, dest_file, **kwargs)

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. This method makes a synchronous HTTP request by default.

Parameters:

subject_id (str) – 24-character hex ID (required)
file_name (str) – output file name (required)
info (bool) – If the file is a zipfile, return a json response of zipfile member information
member (str) – The filename of a zipfile member to download rather than the entire file
view (bool) – 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”
version (int) – version of the file to download
hash (str) – file hash for comparison
range (str) – byte ranges to return
x_accept_feature (list[str]) – redirect header
dest_file (str) – Destination file path
async_ (bool) – Perform the request asynchronously

Returns:

union[DownloadTicketStub,ZipfileInfo]

download_input_from_subject_analysis(subject_id, analysis_id, filename, dest_file, **kwargs)

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. This method makes a synchronous HTTP request by default.

Parameters:

subject_id (str) – 24-character hex ID (required)
analysis_id (str) – 24-char hex analysis id (required)
filename (str) – filename to download (get tar of all if empty) (required)
info (bool) – get file info only
member (str) – get zipfile member
view (bool) – feature flag for view/download
range (str) – byte ranges to return
x_accept_feature (list[str]) – redirect header
dest_file (str) – Destination file path
async_ (bool) – Perform the request asynchronously

Returns:

union[DownloadTicketStub,ZipfileInfo]

download_output_from_subject_analysis(subject_id, analysis_id, filename, dest_file, **kwargs)

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. This method makes a synchronous HTTP request by default.

Parameters:

subject_id (str) – 24-character hex ID (required)
analysis_id (str) – 24-char hex analysis id (required)
filename (str) – filename to download (get tar of all if empty) (required)
info (bool) – If the file is a zipfile, return a json response of zipfile member information
member (str) – The filename of a zipfile member to download rather than the entire file
view (bool) – feature flag for view/download
range (str) – byte ranges to return
x_accept_feature (list[str]) – redirect header
dest_file (str) – Destination file path
async_ (bool) – Perform the request asynchronously

Returns:

union[DownloadTicketStub,ZipfileInfo]

get_all_subjects(**kwargs)

Get a list of subjects

Get a list of subjects This method makes a synchronous HTTP request by default.

Parameters:

exhaustive (bool) – Set to return a complete list regardless of permissions
join (JoinType) – join file origins
join_avatars (bool) – add name and avatar to notes
include_all_info (bool) – Include all info in returned objects
filter (str) – The filter to apply. (e.g. label=my-label,created>2018-09-22)
sort (str) – The sort fields and order. (e.g. label:asc,created:desc)
limit (int) – The maximum number of entries to return.
skip (int) – The number of entries to skip.
page (int) – The page number (i.e. skip limit*page entries)
after_id (str) – Paginate after the given id. (Cannot be used with sort, page or skip)
x_accept_feature (list[union[HeaderFeature,str]])
async_ (bool) – Perform the request asynchronously

Returns:

union[Page,list[SubjectOutputForList]]

get_subject(subject_id, **kwargs)

Get a single subject

Get an subject by its id Args: subject_id: The id of the subject join: Attribute to join on join_avatars: Join the user avatars for permissions auth_session: The auth session Returns: SubjectOutput This method makes a synchronous HTTP request by default.

Parameters:

subject_id (str) – 24-char hex subject id (required)
join (JoinType) – join file origins
join_avatars (bool) – add name and avatar to notes
x_accept_feature (list[union[HeaderFeature,str]])
async_ (bool) – Perform the request asynchronously

Returns:

SubjectOutput

get_subject_analyses(cid, **kwargs)

Get analyses for a(n) subject.

Returns analyses that directly belong to this resource. This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
inflate_job (bool)
join_avatars (bool)
join (JoinType)
include_all_info (bool) – Include all info in returned objects
filter (str) – The filter to apply. (e.g. label=my-label,created>2018-09-22)
sort (str) – The sort fields and order. (e.g. label:asc,created:desc)
limit (int) – The maximum number of entries to return.
skip (int) – The number of entries to skip.
page (int) – The page number (i.e. skip limit*page entries)
after_id (str) – Paginate after the given id. (Cannot be used with sort, page or skip)
x_accept_feature (list[str])
async_ (bool) – Perform the request asynchronously

Returns:

union[Page,list[union[AnalysisListOutput,AnalysisListOutputInflatedJob]]]

get_subject_analysis(cid, analysis_id, **kwargs)

Get an analysis.

Get an analysis. This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
analysis_id (str) – (required)
inflate_job (bool) – Return job as an object instead of an id
join_avatars (bool)
join (JoinType)
async_ (bool) – Perform the request asynchronously

Returns:

union[AnalysisOutputInflatedJob,AnalysisOutput]

get_subject_analysis_input_download_ticket(subject_id, analysis_id, filename, **kwargs)

Get a signed URL to download a named child file.

This method makes a synchronous HTTP request by default.

Parameters:

subject_id (str) – 24-character hex ID (required)
analysis_id (str) – 24-char hex analysis id (required)
filename (str) – filename to download (get tar of all if empty) (required)
ticket (str) – 24-char hex ticket id
info (bool) – get file info only
member (str) – get zipfile member
view (bool) – feature flag for view/download
range (str) – byte ranges to return
x_accept_feature (list[str]) – redirect header
async_ (bool) – Perform the request asynchronously

Returns:

union[DownloadTicketStub,ZipfileInfo]

get_subject_analysis_input_zip_info(subject_id, analysis_id, filename, **kwargs)

Retrieve the zip info of a child file by name.

Does not work on files whose names contain a forward slash. This method makes a synchronous HTTP request by default.

Parameters:

subject_id (str) – 24-character hex ID (required)
analysis_id (str) – 24-char hex analysis id (required)
filename (str) – filename to download (get tar of all if empty) (required)
ticket (str) – 24-char hex ticket id
info (bool) – get file info only
member (str) – get zipfile member
view (bool) – feature flag for view/download
range (str) – byte ranges to return
x_accept_feature (list[str]) – redirect header
async_ (bool) – Perform the request asynchronously

Returns:

FileZipInfo

get_subject_analysis_output_download_ticket(subject_id, analysis_id, filename, **kwargs)

Get a signed URL to download a named child file.

This method makes a synchronous HTTP request by default.

Parameters:

subject_id (str) – 24-character hex ID (required)
analysis_id (str) – 24-char hex analysis id (required)
filename (str) – filename to download (get tar of all if empty) (required)
ticket (str) – ticket id of the outputs to download
info (bool) – If the file is a zipfile, return a json response of zipfile member information
member (str) – The filename of a zipfile member to download rather than the entire file
view (bool) – feature flag for view/download
range (str) – byte ranges to return
x_accept_feature (list[str]) – redirect header
async_ (bool) – Perform the request asynchronously

Returns:

union[DownloadTicketStub,ZipfileInfo]

get_subject_analysis_output_zip_info(subject_id, analysis_id, filename, **kwargs)

Retrieve the zip info of a child file by name.

Does not work on files whose names contain a forward slash. This method makes a synchronous HTTP request by default.

Parameters:

subject_id (str) – 24-character hex ID (required)
analysis_id (str) – 24-char hex analysis id (required)
filename (str) – filename to download (get tar of all if empty) (required)
ticket (str) – ticket id of the outputs to download
info (bool) – If the file is a zipfile, return a json response of zipfile member information
member (str) – The filename of a zipfile member to download rather than the entire file
view (bool) – feature flag for view/download
range (str) – byte ranges to return
x_accept_feature (list[str]) – redirect header
async_ (bool) – Perform the request asynchronously

Returns:

FileZipInfo

get_subject_download_ticket(subject_id, file_name, **kwargs)

Get a signed URL to download a named child file.

This method makes a synchronous HTTP request by default.

Parameters:

subject_id (str) – 24-character hex ID (required)
file_name (str) – output file name (required)
ticket (str) – The generated ticket id for the download, or present but empty to generate a ticket id
info (bool) – If the file is a zipfile, return a json response of zipfile member information
member (str) – The filename of a zipfile member to download rather than the entire file
view (bool) – 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”
version (int) – version of the file to download
hash (str) – file hash for comparison
range (str) – byte ranges to return
x_accept_feature (list[str]) – redirect header
async_ (bool) – Perform the request asynchronously

Returns:

union[DownloadTicketStub,ZipfileInfo]

get_subject_file_info(cid, filename, **kwargs)

Get info for a particular file.

Get info for a particular file. This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – Container Id (required)
filename (str) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

FileOutput

get_subject_file_zip_info(subject_id, file_name, **kwargs)

Retrieve the zip info of a child file by name.

Does not work on files whose names contain a forward slash. This method makes a synchronous HTTP request by default.

Parameters:

subject_id (str) – 24-character hex ID (required)
file_name (str) – output file name (required)
ticket (str) – The generated ticket id for the download, or present but empty to generate a ticket id
info (bool) – If the file is a zipfile, return a json response of zipfile member information
member (str) – The filename of a zipfile member to download rather than the entire file
view (bool) – 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”
version (int) – version of the file to download
hash (str) – file hash for comparison
range (str) – byte ranges to return
x_accept_feature (list[str]) – redirect header
async_ (bool) – Perform the request asynchronously

Returns:

FileZipInfo

get_subject_note(cid, note_id, **kwargs)

Get a note of a(n) subject.

Get a note of a(n) subject This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
note_id (str) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

Note

get_subject_sessions(subject_id, **kwargs)

List sessions of a subject

List sessions of a subject This method makes a synchronous HTTP request by default.

Parameters:

subject_id (str) – 24-char hex subject id (required)
join (JoinType) – join file origins
include_all_info (bool) – Include all info in returned objects
filter (str) – The filter to apply. (e.g. label=my-label,created>2018-09-22)
sort (str) – The sort fields and order. (e.g. label:asc,created:desc)
limit (int) – The maximum number of entries to return.
skip (int) – The number of entries to skip.
page (int) – The page number (i.e. skip limit*page entries)
after_id (str) – Paginate after the given id. (Cannot be used with sort, page or skip)
x_accept_feature (list[union[HeaderFeature,str]])
async_ (bool) – Perform the request asynchronously

Returns:

union[Page,list[SessionListOutput]]

get_subject_tag(cid, value, **kwargs)

Get the value of a tag, by name.

Get the value of a tag, by name This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
value (str) – The tag to interact with (required)
async_ (bool) – Perform the request asynchronously

Returns:

str

modify_subject(subject_id, body, **kwargs)

Update a subject

Update a subject This method makes a synchronous HTTP request by default.

Parameters:

subject_id (str) – 24-char hex subject id (required)
body (SubjectModify) – subject object to modify (required)
async_ (bool) – Perform the request asynchronously

Returns:

ModifiedResult

modify_subject_analysis(cid, analysis_id, body, **kwargs)

Modify an analysis.

Modify an analysis. This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
analysis_id (str) – (required)
body (AnalysisModifyInput) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

ModifiedResult

modify_subject_file(cid, filename, body, **kwargs)

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) This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
filename (str) – (required)
body (FileModifyInput) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

ModifiedResult

modify_subject_file_classification(cid, filename, body, **kwargs)

Update classification for a particular file.

If replacing a file’s classification, the modality can optionally be modified as well. This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
filename (str) – (required)
body (FileClassificationDelta) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

ModifiedResult

modify_subject_file_info(cid, filename, body, **kwargs)

Update info for a particular file.

Modify and return the file ‘info’ field This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
filename (str) – (required)
body (Info) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

ModifiedResult

modify_subject_info(cid, body, **kwargs)

Update or replace info for a(n) subject.

Update or replace info for a(n) subject. Keys that contain ‘$’ or ‘.’ will be sanitized in the process of being updated on the container. This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
body (Info) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

ModifiedResult

modify_subject_note(cid, note_id, body, **kwargs)

Update a note of a(n) subject.

Update a note of a(n) subject This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
note_id (str) – (required)
body (NoteInput) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

int

rename_subject_tag(cid, value, body, **kwargs)

Rename a tag.

Rename a tag This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
value (str) – The tag to interact with (required)
body (Tag) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

str

upload_file_to_subject(container_id, file, **kwargs)

Upload a file to a(n) subject.

Upload a file to a(n) subject. This method makes a synchronous HTTP request by default.

Parameters:

container_id (str) – (required)
file (str) – The file to upload (required)
preserve_metadata (bool)
ticket (str)
id (str)
level (ContainerType)
job (str)
metadata (str) – Metadata object as a JSON-encoded string
x_accept_feature (list[str]) – redirect header
content_type (str)
async_ (bool) – Perform the request asynchronously

Returns:

union[list[FileOutput],UploadTicketOutput]

upload_output_to_subject_analysis(cid, analysis_id, file, **kwargs)

Upload an output file to an analysis.

Upload an output file to an analysis This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
analysis_id (str) – (required)
file (str) – The file to upload (required)
ticket (str)
id (str)
level (ContainerType)
job (str)
content_type (str)
async_ (bool) – Perform the request asynchronously

Returns:

list[FileOutput]

verify_master_subject_code(code, **kwargs)

Verify that the given master subject code exists or not

Verify that the given master subject code exists or not This method makes a synchronous HTTP request by default.

Parameters:

code (str) – code id (required)
async_ (bool) – Perform the request asynchronously

Returns:

MasterSubjectCodeOutput

flywheel.api.tree_api module

Flywheel

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501

OpenAPI spec version: 0.0.1

Generated by: https://github.com/swagger-api/swagger-codegen.git

class flywheel.api.tree_api.TreeApi(api_client=None)

Bases: object

fetch_tree(body, **kwargs)

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. This method makes a synchronous HTTP request by default.

Parameters:

body (GraphFilter) – (required)
exhaustive (bool)
include_all_info (bool) – Include all info in returned objects
filter (str) – The filter to apply. (e.g. label=my-label,created>2018-09-22)
sort (str) – The sort fields and order. (e.g. label:asc,created:desc)
limit (int) – The maximum number of entries to return.
skip (int) – The number of entries to skip.
page (int) – The page number (i.e. skip limit*page entries)
after_id (str) – Paginate after the given id. (Cannot be used with sort, page or skip)
x_accept_feature (list[str])
async_ (bool) – Perform the request asynchronously

Returns:

union[Page,list[object]]

get_tree_graph(**kwargs)

Get a description of the flywheel hiearchy

Get a description of the flywheel hiearchy This method makes a synchronous HTTP request by default.

Parameters:: async_ (bool) – Perform the request asynchronously
Returns:: dict(str, TreeGraphNode)

flywheel.api.uids_api module

Flywheel

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501

OpenAPI spec version: 0.0.1

Generated by: https://github.com/swagger-api/swagger-codegen.git

class flywheel.api.uids_api.UidsApi(api_client=None)

Bases: object

check_uids_exist(body, **kwargs)

Check for existence of UIDs system-wide

Check if any of the given list of UIDs exist in the system This method makes a synchronous HTTP request by default.

Parameters:

body (union[UidCheckInputSessions,UidCheckInputAcquisitions]) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

UidCheckOutput

flywheel.api.upload_api module

Flywheel

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501

OpenAPI spec version: 0.0.1

Generated by: https://github.com/swagger-api/swagger-codegen.git

class flywheel.api.upload_api.UploadApi(api_client=None)

Bases: object

cleanup_signed_upload_url(body, **kwargs)

Cleanup unused file blob previously uploaded using signed URL

This method makes a synchronous HTTP request by default.

Parameters:

body (SignedUrlCleanupInput) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

None

complete_s3_multipart_upload(body, **kwargs)

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. This method makes a synchronous HTTP request by default.

Parameters:

body (CompleteS3MultipartUploadInput) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

CompleteMultipartUploadOutput

create_signed_upload_url(body, **kwargs)

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. This method makes a synchronous HTTP request by default.

Parameters:

body (SignedUrlUploadInput) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

SignedUrlUploadOutput

upload_by_label(**kwargs)

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. This method makes a synchronous HTTP request by default.

Parameters:

preserve_metadata (bool)
ticket (str) – Use empty value to get a ticket, and provide the ticket id to finalize the upload
id (str)
level (ContainerType)
job (str)
files (str)
metadata (object) – Metadata object
content_type (str)
async_ (bool) – Perform the request asynchronously

Returns:

union[list[File],UploadTicketOutput]

upload_by_reaper(**kwargs)

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. This method makes a synchronous HTTP request by default.

Parameters:

preserve_metadata (bool)
ticket (str) – Use empty value to get a ticket, and provide the ticket id to finalize the upload
uid_placement (bool)
id (str)
level (ContainerType)
job (str)
files (str)
metadata (object) – Metadata object
content_type (str)
async_ (bool) – Perform the request asynchronously

Returns:

union[list[File],UploadTicketOutput]

upload_by_uid(**kwargs)

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. This method makes a synchronous HTTP request by default.

Parameters:

preserve_metadata (bool)
ticket (str) – Use empty value to get a ticket, and provide the ticket id to finalize the upload
id (str)
level (ContainerType)
job (str)
files (str)
metadata (object) – Metadata object
content_type (str)
async_ (bool) – Perform the request asynchronously

Returns:

union[list[File],UploadTicketOutput]

upload_signed_fs_file(token, body, **kwargs)

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. This method makes a synchronous HTTP request by default.

Parameters:

token (str) – Upload token (required)
body (str) – Signed filesystem file upload payload (required)
async_ (bool) – Perform the request asynchronously

Returns:

SignedFSUploadOutput

flywheel.api.users_api module

Flywheel

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501

OpenAPI spec version: 0.0.1

Generated by: https://github.com/swagger-api/swagger-codegen.git

class flywheel.api.users_api.UsersApi(api_client=None)

Bases: object

add_user(body, **kwargs)

Add a new user

Add a new user This method makes a synchronous HTTP request by default.

Parameters:

body (UserInput) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

UserOutputId

delete_user(user_id, **kwargs)

Delete a user

Delete a user This method makes a synchronous HTTP request by default.

Parameters:

user_id (str) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

None

delete_user_key(id_, **kwargs)

Delete User Api Key

This method makes a synchronous HTTP request by default.

Parameters:

id (str) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

None

generate_user_key(body, **kwargs)

Generates user api key

Generate user api key for the current user. This method makes a synchronous HTTP request by default.

Parameters:

body (CoreModelsApiKeyApiKeyInput) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

ApiKeyOutput

get_all_users(**kwargs)

Return a list of all users

Gets all users with pagination Args: This method makes a synchronous HTTP request by default.

Parameters:

filter (str) – The filter to apply. (e.g. label=my-label,created>2018-09-22)
sort (str) – The sort fields and order. (e.g. label:asc,created:desc)
limit (int) – The maximum number of entries to return.
skip (int) – The number of entries to skip.
page (int) – The page number (i.e. skip limit*page entries)
after_id (str) – Paginate after the given id. (Cannot be used with sort, page or skip)
x_accept_feature (list[str])
async_ (bool) – Perform the request asynchronously

Returns:

union[list[UserOutput],OutputUserPage]

get_current_user(**kwargs)

Get information about the current user

Gets the current user Args: auth_session (AuthSession): session from incoming request Returns: CurrentUserOutput: Pydantic model for client side user data This method makes a synchronous HTTP request by default.

Parameters:: async_ (bool) – Perform the request asynchronously
Returns:: CurrentUserOutput

get_current_user_avatar(**kwargs)

Get the avatar of the current user

Gets avatar of current user Args: auth_session (AuthSession): session from incoming request Returns: str: url of avatar This method makes a synchronous HTTP request by default.

Parameters:

default (str)
async_ (bool) – Perform the request asynchronously

Returns:

None

get_current_user_info(**kwargs)

Get info of the current user

Gets user info fields. Args: fields (str): csv of arbitrary keys to look for in user info auth_session (AuthSession): session from incoming request Returns: dict: arbitrary data matching the provided csv values This method makes a synchronous HTTP request by default.

Parameters:

fields (str) – Get only the specified fields from user’s info. Accept multiple fields separated by comma.
async_ (bool) – Perform the request asynchronously

Returns:

object

get_current_user_jobs(**kwargs)

Return list of jobs created by the current user

Gets jobs assigned to user with optional gear name regex Args: gear_name (str): name of gear to filter by auth_session (AuthSession): session from incoming request Returns: list: List of jobs linked to the user This method makes a synchronous HTTP request by default.

Parameters:

gear (str) – Gear name. Get only the jobs which are related to a specific gear.
exhaustive (bool)
filter (str) – The filter to apply. (e.g. label=my-label,created>2018-09-22)
sort (str) – The sort fields and order. (e.g. label:asc,created:desc)
limit (int) – The maximum number of entries to return.
skip (int) – The number of entries to skip.
page (int) – The page number (i.e. skip limit*page entries)
after_id (str) – Paginate after the given id. (Cannot be used with sort, page or skip)
x_accept_feature (list[str])
async_ (bool) – Perform the request asynchronously

Returns:

UserJobs

get_user(user_id, **kwargs)

Get information about the specified user

Get user by id Args: uid (str): string matching uid pattern Returns: UserOutput: Pydantic model for sending data to client This method makes a synchronous HTTP request by default.

Parameters:

user_id (str) – (required)
include_deleted (bool)
async_ (bool) – Perform the request asynchronously

Returns:

UserOutput

get_user_acquisitions(uid, **kwargs)

Get all acquisitions that belong to the given user.

Get all acquisitions that belong to the given user. This method makes a synchronous HTTP request by default.

Parameters:

uid (str) – (required)
exhaustive (bool) – Set to return a complete list regardless of permissions
include_all_info (bool) – Include all info in returned objects
filter (str) – The filter to apply. (e.g. label=my-label,created>2018-09-22)
sort (str) – The sort fields and order. (e.g. label:asc,created:desc)
limit (int) – The maximum number of entries to return.
skip (int) – The number of entries to skip.
page (int) – The page number (i.e. skip limit*page entries)
after_id (str) – Paginate after the given id. (Cannot be used with sort, page or skip)
async_ (bool) – Perform the request asynchronously

Returns:

list[AcquisitionListOutput]

get_user_avatar(user_id, **kwargs)

Get the avatar of the specified user

gets avatar of user and redirects to it Args: user_id (str): user id matching user_id regex Returns: RedirectResponse: redirects user to avatar Raises (ResourceNotFound): Raises 404 if no user avatar This method makes a synchronous HTTP request by default.

Parameters:

user_id (str) – (required)
default (str)
async_ (bool) – Perform the request asynchronously

Returns:

None

get_user_collections(user_id, **kwargs)

Get all collections that belong to the given user.

This method makes a synchronous HTTP request by default.

Parameters:

user_id (str) – (required)
filter (str) – The filter to apply. (e.g. label=my-label,created>2018-09-22)
sort (str) – The sort fields and order. (e.g. label:asc,created:desc)
limit (int) – The maximum number of entries to return.
skip (int) – The number of entries to skip.
page (int) – The page number (i.e. skip limit*page entries)
after_id (str) – Paginate after the given id. (Cannot be used with sort, page or skip)
x_accept_feature (list[str])
async_ (bool) – Perform the request asynchronously

Returns:

union[list[CollectionWithStats],list[CollectionOutput],Page]

get_user_groups(uid, **kwargs)

List all groups the specified user is a member of

This method makes a synchronous HTTP request by default.

Parameters:

uid (str) – (required)
exhaustive (bool) – Set to return a complete list regardless of permissions
filter (str) – The filter to apply. (e.g. label=my-label,created>2018-09-22)
sort (str) – The sort fields and order. (e.g. label:asc,created:desc)
limit (int) – The maximum number of entries to return.
skip (int) – The number of entries to skip.
page (int) – The page number (i.e. skip limit*page entries)
after_id (str) – Paginate after the given id. (Cannot be used with sort, page or skip)
x_accept_feature (list[str]) – redirect header
async_ (bool) – Perform the request asynchronously

Returns:

list[GroupOutput]

get_user_projects(uid, **kwargs)

Get all projects that belong to the given user.

Get all projects that belong to the given user. This method makes a synchronous HTTP request by default.

Parameters:

uid (str) – (required)
exhaustive (bool) – Set to return a complete list regardless of permissions
include_all_info (bool) – Include all info in returned objects
filter (str) – The filter to apply. (e.g. label=my-label,created>2018-09-22)
sort (str) – The sort fields and order. (e.g. label:asc,created:desc)
limit (int) – The maximum number of entries to return.
skip (int) – The number of entries to skip.
page (int) – The page number (i.e. skip limit*page entries)
after_id (str) – Paginate after the given id. (Cannot be used with sort, page or skip)
async_ (bool) – Perform the request asynchronously

Returns:

list[ProjectListOutput]

get_user_sessions(uid, **kwargs)

Get all sessions that belong to the given user.

Get all sessions that belong to the given user. This method makes a synchronous HTTP request by default.

Parameters:

uid (str) – (required)
exhaustive (bool)
include_all_info (bool) – Include all info in returned objects
filter (str) – The filter to apply. (e.g. label=my-label,created>2018-09-22)
sort (str) – The sort fields and order. (e.g. label:asc,created:desc)
limit (int) – The maximum number of entries to return.
skip (int) – The number of entries to skip.
page (int) – The page number (i.e. skip limit*page entries)
after_id (str) – Paginate after the given id. (Cannot be used with sort, page or skip)
async_ (bool) – Perform the request asynchronously

Returns:

list[SessionListOutput]

modify_current_user_info(body, **kwargs)

Update or replace info for the current user.

Modifies user info fields Args: info (Info): Model representing arbitrary data auth_session (AuthSession): session from incoming request Returns: None This method makes a synchronous HTTP request by default.

Parameters:

body (Info) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

None

modify_user(uid, body, **kwargs)

Update the specified user

Update the specified user This method makes a synchronous HTTP request by default.

Parameters:

uid (str) – (required)
body (ModifyUserInput) – (required)
clear_permissions (bool)
async_ (bool) – Perform the request asynchronously

Returns:

ModifiedResult

sync_user(cid, body, **kwargs)

Sync a center user to enterprise (Sync service use ONLY)

This method makes a synchronous HTTP request by default.

Parameters:

cid (str) – (required)
body (SyncUserInput) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

None

flywheel.api.views_api module

Flywheel

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501

OpenAPI spec version: 0.0.1

Generated by: https://github.com/swagger-api/swagger-codegen.git

class flywheel.api.views_api.ViewsApi(api_client=None)

Bases: object

data_view_columns(**kwargs)

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

This method makes a synchronous HTTP request by default.

Parameters:: async_ (bool) – Perform the request asynchronously
Returns:: list[DataViewColumnAlias]

delete_view(view_id, **kwargs)

Delete a data view

Soft deletes data view in database This method makes a synchronous HTTP request by default.

Parameters:

view_id (str) – The ID of the view (required)
async_ (bool) – Perform the request asynchronously

Returns:

DeletedResult

evaluate_view(view_id, container_id, **kwargs)

Execute a view, returning data in the preferred format.

This method makes a synchronous HTTP request by default.

Parameters:

view_id (str) – The ID of the view (required)
container_id (str) – The target container for view execution (required)
ticket (str) – download ticket id
filename (str) – download ticket filename
format (FileFormat) – Available values : csv, tsv, json, ndjson, json_flat, json-row-column
sort (str) – The sort fields and order.(e.g. label:asc,created:desc)
filter (str) – An optional filter expression
skip (int) – The optional number of rows to skip
limit (int) – The optional max number of rows to return
async_ (bool) – Perform the request asynchronously

Returns:

None

evaluate_view_adhoc(container_id, body, **kwargs)

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

This method makes a synchronous HTTP request by default.

Parameters:

container_id (str) – The target container for view execution (required)
body (ContainerPipelineInput) – (required)
filename (str) – download ticket filename
format (FileFormat) – Available values : csv, tsv, json, ndjson, json_flat, json-row-column
ticket (str) – download ticket id
sort (str) – The sort fields and order.(e.g. label:asc,created:desc)
filter (str) – An optional filter expression
skip (int) – The optional number of rows to skip
limit (int) – The optional max number of rows to return
async_ (bool) – Perform the request asynchronously

Returns:

None

get_view(view_id, **kwargs)

Return the view identified by ViewId

This method makes a synchronous HTTP request by default.

Parameters:

view_id (str) – The ID of the view (required)
async_ (bool) – Perform the request asynchronously

Returns:

ViewOutput

modify_view(view_id, body, **kwargs)

Update the view identified by ViewId

This method makes a synchronous HTTP request by default.

Parameters:

view_id (str) – The ID of the view (required)
body (ContainerModify) – (required)
async_ (bool) – Perform the request asynchronously

Returns:

ModifiedResult

queue_adhoc(container_id, body, **kwargs)

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

This method makes a synchronous HTTP request by default.

Parameters:

container_id (str) – The target container for view execution (required)
body (ContainerPipelineInput) – (required)
sort (str) – The sort fields and order.(e.g. label:asc,created:desc)
filter (str) – An optional filter expression
skip (int) – The optional number of rows to skip
limit (int) – The optional max number of rows to return
async_ (bool) – Perform the request asynchronously

Returns:

DataViewExecution

queue_saved(view_id, container_id, **kwargs)

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

Execute a view, returning a reference to the created data view execution. This method makes a synchronous HTTP request by default.

Parameters:

view_id (str) – The ID of the view (required)
container_id (str) – The target container for view execution (required)
sort (str) – The sort fields and order.(e.g. label:asc,created:desc)
filter (str) – An optional filter expression
skip (int) – The optional number of rows to skip
limit (int) – The optional max number of rows to return
async_ (bool) – Perform the request asynchronously

Returns:

DataViewExecution

save_view_data_to_container(container_id, body, **kwargs)

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

Execute a view, saving data to the target container / file This method makes a synchronous HTTP request by default.

Parameters:

container_id (str) – The target container for view execution (required)
body (ContainerIdViewInputExecuteAndSave) – (required)
format (FileFormat) – Available values : csv, tsv, json, ndjson, json_flat, json-row-column
ticket (str) – download ticket id
filter (str) – An optional filter expression
sort (str) – The sort fields and order.(e.g. label:asc,created:desc)
skip (int) – The optional number of rows to skip
limit (int) – The optional max number of rows to return
async_ (bool) – Perform the request asynchronously

Returns:

File

flywheel.api package

Submodules

flywheel.api.acquisitions_api module

flywheel.api.analyses_api module

flywheel.api.audit_trail_api module

flywheel.api.auth_api module

flywheel.api.batch_api module

flywheel.api.bulk_api module

flywheel.api.change_log_api module

flywheel.api.collections_api module

flywheel.api.config_api module

flywheel.api.containers_api module

flywheel.api.data_view_executions_api module

flywheel.api.dataexplorer_api module

flywheel.api.devices_api module

flywheel.api.dimse_api module

flywheel.api.download_api module

flywheel.api.files_api module

flywheel.api.gears_api module

flywheel.api.groups_api module

flywheel.api.jobs_api module

flywheel.api.jupyterlab_servers_api module

flywheel.api.modalities_api module

flywheel.api.packfiles_api module

flywheel.api.projects_api module

flywheel.api.reports_api module

flywheel.api.resolve_api module

flywheel.api.roles_api module

flywheel.api.sessions_api module

flywheel.api.site_api module

flywheel.api.subjects_api module

flywheel.api.tree_api module

flywheel.api.uids_api module

flywheel.api.upload_api module

flywheel.api.users_api module

flywheel.api.views_api module

Module contents